PHP串口通信超时处理：优化lepiaf/SerialPort库的read方法

在使用PHP进行串口通信时，lepiaf\SerialPort库的read方法在未接收到分隔符时会无限阻塞，导致脚本超时。本文将详细介绍如何通过修改该库的read方法，引入超时机制，使其能够及时返回，从而有效管理用户交互等待和避免程序长时间阻塞，提升系统响应性和稳定性。

问题背景与分析

在开发基于php的串口通信应用时，特别是在需要等待外部设备（如树莓派上的用户交互）响应的场景下，常见的做法是使用一个无限循环（while (true)）来持续读取串口数据。然而，当用户长时间不进行操作，或者设备没有发送预期的数据时，lepiaf\serialport库的read()方法可能会导致程序长时间阻塞，甚至因为超出php的最大执行时间（max_execution_time）而被系统终止。

深入分析lepiaf\SerialPort库的源代码可以发现，尽管它将底层流设置为非阻塞模式，但其read方法内部实现了一个无限循环，直到检测到预设的分隔符才会返回。这意味着，如果串口没有收到包含分隔符的数据，read方法将永远不会返回，从而使整个PHP脚本停滞。

原始代码示例中尝试在外部循环中添加一个基于time()的超时判断，但这并不能解决$this->serialPort->read()本身阻塞的问题。一旦read()方法被调用，它将完全控制程序的执行流，直到有数据或者PHP进程被强制终止。

解决方案：为read方法引入超时机制

解决此问题的最直接且有效的方法是修改lepiaf\SerialPort库的read方法，为其添加一个超时参数。这样，read方法在等待数据时，如果超过指定时间仍未收到包含分隔符的数据，便会提前返回，避免无限阻塞。

修改lepiaf\SerialPort库文件

定位到vendor/lepiaf/serialport/src/lepiaf/SerialPort/SerialPort.php文件，找到read方法（通常在第107行左右），并对其进行如下修改：

立即学习“PHP免费学习笔记（深入）”；

// 文件路径: vendor/lepiaf/serialport/src/lepiaf/SerialPort/SerialPort.php

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空转，降低CPU占用
            continue;       // 继续循环，等待数据
        }
        $chars[] = $char; // 读取到字符，添加到字符数组
    } while ($char !== $this->getParser()->getSeparator()); // 继续循环直到找到分隔符

    // 找到分隔符，解析并返回数据
    return $this->getParser()->parse($chars);
}

修改说明：

1. $maxElapsed 参数： read方法现在接受一个可选的$maxElapsed参数，用于指定超时秒数。默认值为'infinite'，表示无超时。
2. $timeout 计算： 根据$maxElapsed的值，计算出一个绝对的超时时间点（以微秒为单位）。如果$maxElapsed是'infinite'，则$timeout被设置为一个极大的浮点数，模拟无限等待。
3. 超时判断： 在do-while循环内部，每次尝试读取字符后，如果fread返回空字符串（表示当前没有数据可读），则会检查当前的微秒时间是否已经超过了$timeout。
4. 返回false： 如果检测到超时，read方法会立即返回false，而不是继续等待。
5. usleep(100)： 在没有数据且未超时的情况下，程序会短暂休眠100微秒。这有助于减少CPU的空转，避免在等待数据时占用过多的系统资源。

实际应用示例

修改库文件后，您就可以在自己的代码中调用带有超时参数的read方法了。例如，设置15秒的超时：

use lepiaf\SerialPort\SerialPort;
use lepiaf\SerialPort\Configure\TTYConfigure;
use lepiaf\SerialPort\Parser\SeparatorParser;
use Illuminate\Support\Str; // 假设在Laravel/Lumen环境中使用Str辅助函数

// 串口配置
$configure = new TTYConfigure();
$configure->removeOption("9600");
$configure->setOption("115200"); // 设置波特率

$this->serialPort = new SerialPort(new SeparatorParser("\n"), $configure);

$serialDevice = config('app.device_type') === 'usb' ? '/dev/ttyACM0' : '/dev/ttyAMA0';

$this->serialPort->open($serialDevice);

$aborted = false;

// 尝试读取串口数据，最长等待15秒
$data2 = $this->serialPort->read(15); 

if ($data2 === false) {
    // 超时发生，执行相应处理，例如发送停止命令，记录日志等
    $this->serialPort->write("C,STOP\n"); 
    $aborted = true;
    $this->alert("vending sequence stopped due to timeout");
    // 可以进行API调用回滚或其他清理操作
} elseif (Str::contains($data2, "Whatever I want to check for")) {
    // 成功读取到数据，且数据包含特定字符串，进行业务处理
    // Process the data and continue
    $this->alert("Received desired data: " . $data2);
} else {
    // 成功读取到数据，但不包含特定字符串，根据业务逻辑处理
    $this->alert("Received data, but not the desired string: " . $data2);
}

// 后续逻辑，根据$aborted状态或其他条件进行判断
if ($aborted) {
    // 执行超时后的清理或回滚操作
}

$this->serialPort->close(); // 关闭串口

通过这种方式，您不再需要外部的while (true)循环和手动的时间戳判断。read方法本身就具备了超时功能，使得代码逻辑更加简洁和可靠。

注意事项与最佳实践

1. 直接修改第三方库的风险： 直接修改vendor目录下的第三方库文件通常不是推荐的做法。当您运行composer update或composer install时，这些修改可能会被覆盖。
   • 替代方案：
     • Fork并维护： 如果该库不活跃或无法满足需求，可以将其Fork到自己的仓库，进行修改后通过composer.json引用您的Fork版本。
     • 扩展或装饰器模式： 对于更复杂的库，可以考虑通过继承或使用装饰器模式来扩展其功能，而不是直接修改源代码。但对于lepiaf\SerialPort这种简单直接修改核心方法的场景，Fork可能是更简单的选择。
2. 错误处理与状态管理： 在串口通信中，务必对各种异常情况（如设备未连接、权限问题、数据格式错误等）进行充分的错误处理。在长运行的守护进程中，应确保程序能够健壮地处理超时、断开连接等事件，并维护清晰的系统状态。
3. usleep的粒度： usleep(100)可以有效降低CPU占用，但也会引入100微秒的延迟。在对实时性要求极高的场景下，可能需要调整这个值，或者在某些情况下完全移除它（以更高的CPU占用为代价）。
4. 分隔符的选择： SeparatorParser依赖于正确的分隔符来判断消息的结束。确保您的串口设备发送的数据包含预期的分隔符，并且SeparatorParser配置正确。
5. 进程管理： 对于在Laravel中通过supervisord运行的PHP命令，确保您的进程能够优雅地处理信号（如SIGTERM），以便在需要时能够平稳地关闭。

总结

通过对lepiaf\SerialPort库的read方法进行简单而关键的修改，我们成功地为其引入了超时机制，解决了在PHP串口通信中长时间阻塞的问题。这不仅提升了应用程序的响应性和用户体验，也增强了系统的稳定性和可靠性。虽然直接修改第三方库存在一定的维护成本，但在特定场景下，这是一种高效且实用的解决方案。在实际部署时，请务必权衡利弊，并考虑采用更规范的库维护策略。

以上就是PHP串口通信超时处理：优化lepiaf/SerialPort库的read方法的详细内容，更多请关注php中文网其它相关文章！