kba-team/serial-port

Connect to serial ports using TCP connections.

Maintainers

Details

github.com/the-kbA-team/SerialPort

Source

Issues

Installs: 9

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 1

Open Issues: 0

v1.0.0 2020-12-17 10:03 UTC

Requires

  • php: ^7.2
  • ext-json: *
  • ext-sockets: *

Requires (Dev)

MIT 2f9d39140308f1f1de44b209b84ca7187ab39480

  • Gregor J. <gregor-j.woop@users.noreply.github.com>

This package is auto-updated.

Last update: 2024-04-17 19:03:01 UTC

README

License: MIT Build Status Maintainability Test Coverage

PHP class \kbATeam\SerialPort\SerialPort to connect to serial ports using streams. Nothing more. Only socket (TCP) streams are implemented at the moment.

You need to create classes implementing \kbATeam\SerialPort\Interfaces\Communication\Command, \kbATeam\SerialPort\Interfaces\Communication\Container and \kbATeam\SerialPort\Interfaces\Communication\Value. The implementations of these interfaces depend on the device you want to communicate with.

Usage

Use pySerial to map a serial device to a TCP port.

Use Streams\Socket to create a connection to a SerialPort use SerialPort->invoke() to invoke a Communication\Command and get either NULL or a Communication\Container containing at least one Communication\Value.

A Communication\Command instance is a string sent to a SerialPort instance. The SerialPort instance invokes the Communication\Command using its Stream instance.

Your implementation of Communication\Command needs to define how to read the string returned by the device and either return a Communication\Container containing at least one Communication\Value, or NULL.