本教程详细阐述了php通过lepiafSerialPort库进行串口通信时,read()方法可能导致的无限阻塞问题。我们将深入分析其内部机制,并提供一种修改库源文件以引入超时参数的解决方案,从而实现非阻塞且可控的串口数据读取,避免脚本因长时间等待而终止。
理解lepiaf/SerialPort库的阻塞行为
在使用php进行串口通信时,尤其是在需要等待外部设备响应的场景下,如用户交互或传感器数据,处理串口读取的超时机制至关重要。常见的串口通信库,例如lepiaf/serialport,在默认情况下其read()方法可能存在阻塞问题。尽管该库在底层可能将串口流设置为非阻塞模式,但其read()方法的内部实现却包含一个无限循环,持续等待直到接收到预设的分隔符(separator)。
这种内部无限循环的阻塞行为意味着,如果串口长时间没有数据传入,或者未接收到预期的分隔符,read()方法将永远不会返回。这将导致php脚本持续运行,直至达到php.ini中配置的max_execution_time限制,最终被系统强制终止。即便在外部代码中尝试通过time()函数手动实现超时检查,也无法中断正在执行的阻塞read()调用。
定制lepiaf/SerialPort库以实现超时读取
鉴于lepiaf/SerialPort库的简洁性,最直接且有效的方法是修改其SerialPort.php源文件,为read()方法引入一个超时参数。这将允许我们在指定时间内未收到分隔符时,让read()方法返回一个特定的值(例如false),从而避免无限阻塞。
以下是修改lepaf/SerialPort/SerialPort.php文件中read()方法的具体步骤和代码:
-
定位文件: 找到您的项目vendor/lepiaf/serialport/src/lepiaf/SerialPort/SerialPort.php文件。
立即学习“PHP免费学习笔记(深入)”;
-
修改read()方法: 将原有的read()方法(通常在第107行附近)替换为以下代码:
public function read($maxElapsed = 'infinite') { $this->ensuredeviceOpen(); $chars = []; // 计算超时时间点 // 如果maxElapsed为'infinite',则设置一个极大的值,实际相当于无超时 // 否则,计算当前微秒时间加上超时秒数 $timeout = $maxElapsed == 'infinite' ? 1.7976931348623E+308 : (microtime(true) + $maxElapsed); do { // 从串口读取一个字符 $char = fread($this->fd, 1); // 如果没有读取到字符(即串口无数据) if ($char === '') { // 检查是否已超时 if (microtime(true) > $timeout) { return false; // 超时,返回false } usleep(100); // 短暂休眠100微秒,避免CPU空转 continue; // 继续循环,等待数据 } $chars[] = $char; // 读取到字符,添加到字符数组 } while ($char !== $this->getParser()->getSeparator()); // 循环直到找到分隔符 return $this->getParser()->parse($chars); // 返回解析后的数据 }
修改说明:
- $maxElapsed参数: 新增的参数,用于指定读取操作的最大等待时间(秒)。默认值为’infinite’,表示无超时。
- $timeout计算: 根据$maxElapsed计算出未来的超时时间点。microtime(true)提供当前时间的微秒精度。
- 超时检查: 在每次尝试读取字符但未读取到时($char === ”),会检查当前时间是否已超过$timeout。如果超时,则立即返回false。
- usleep(100): 当串口没有数据时,为了避免CPU空转,我们让脚本短暂休眠100微秒。这可以有效降低CPU占用率,同时不显著影响响应速度。
- 返回值: 如果超时,方法返回false。如果成功读取到分隔符,则返回解析后的数据。
在应用中应用超时机制
修改库文件后,您就可以在laravel或Lumen应用中利用这个新的超时功能了。以下是如何在您的代码中集成这一改进的示例:
use lepiafSerialPortSerialPort; use lepiafSerialPortConfigureTTYConfigure; use lepiafSerialPortParserSeparatorParser; use IlluminateSupportStr; // Laravel/Lumen的字符串辅助函数 // 串口配置 $configure = new TTYConfigure(); $configure->removeOption("9600"); // 移除默认波特率 $configure->setOption("115200"); // 设置新的波特率 // 初始化SerialPort,使用换行符作为分隔符 $this->serialPort = new SerialPort(new SeparatorParser("n"), $configure); // 根据配置确定串口设备路径 $serialDevice = config('app.device_type') === 'usb' ? '/dev/ttyACM0' : '/dev/ttyAMA0'; // 打开串口 $this->serialPort->open($serialDevice); $timeoutDuration = 15; // 设置15秒的读取超时 $aborted = false; while (true) { // 调用修改后的read方法,传入超时时间 $data2 = $this->serialPort->read($timeoutDuration); if ($data2 === false) { // 15秒内未收到分隔符,发生超时 $this->serialPort->write("C,STOPn"); // 发送停止命令 $aborted = true; $this->alert("vending sequence stopped due to timeout"); break; // 退出循环 } elseif (Str::contains($data2, "Whatever I want to check for")) { // 成功读取到数据,且包含特定字符串 // 处理数据并退出循环 $this->info("Received desired data: " . $data2); break; } else { // 成功读取到数据,但不包含特定字符串 // 可以选择继续等待或执行其他逻辑 $this->warn("Received data, but not the desired string: " . $data2); } // 如果需要,可以在这里添加其他循环内的逻辑,例如定期检查其他状态 // sleep(1); // 避免CPU空转,根据实际情况调整 } if ($aborted) { // 执行超时后的api调用或其他恢复操作 $this->apiClient->revertChanges(); $this->info("API call to revert changes executed."); } $this->serialPort->close(); // 关闭串口
通过这种方式,read()方法不再会无限阻塞。如果在$timeoutDuration秒内没有收到分隔符,它将返回false,允许您的while循环继续执行,并根据超时情况采取相应的措施,例如发送停止命令或调用API进行状态回滚。
注意事项
- 修改第三方库的风险: 直接修改vendor目录下的第三方库文件(如lepiaf/SerialPort/SerialPort.php)存在风险。当您更新项目依赖(例如运行composer update)时,这些修改可能会被覆盖。
- php.ini的max_execution_time: 尽管我们已经解决了read()方法的阻塞问题,但PHP脚本仍然受max_execution_time的限制。确保您的整个脚本执行时间不会超过此限制,尤其是在处理长时间运行的任务时。
- usleep()的作用: usleep()函数用于微秒级别的暂停。在没有数据可读时,短暂休眠可以显著降低CPU使用率,防止脚本在等待数据时空转消耗大量资源。
- 错误处理: 除了超时处理,还应考虑串口打开失败、写入失败等其他潜在错误,并进行相应的异常捕获和处理。
总结
为PHP串口通信添加可靠的超时机制是构建健壮物联网(iot)或硬件交互应用的关键。通过直接修改lepiaf/SerialPort库的read()方法,我们成功地引入了超时功能,将一个潜在的无限阻塞点转化为可控的非阻塞读取操作。这不仅避免了脚本因长时间等待而终止,还使得应用能够更灵活地响应外部设备的无响应情况,执行必要的恢复或回滚逻辑。在实际部署时,务必权衡直接修改第三方库的利弊,并考虑采用更可持续的维护策略。