Skip to content

embedded-php/ext-uart

Repository files navigation

UART PHP Extension

The UART PHP Extension provides an object-oriented wrapper to the UART Linux Kernel driver that gives users the ability to write code that interacts with external hardware using the UART asynchronous serial communication protocol.

Acknowledgements

This project takes a lot of inspiration from WiringPi.

Requirements

  • PHP >= 8.0 (either NTS or TS version);

Note: if you are using this extension on Raspbian or Raspberry Pi OS, the user executing the script must belong to the dialout group or you may run into "Permission denied" errors.

On Raspbian or Raspberry Pi OS:

PHP 8.0:

sudo apt install php8.0-cli php8.0-dev php8.0-phpdbg

PHP 8.1:

sudo apt install php8.1-cli php8.1-dev php8.1-phpdbg

Building

phpize
./configure
make
make test

Stubs

After changing any of the stubs, the main stub file must be updated by running the command below.

php stubs/update-main-stup.php

Once the stub is updated, the regular build process can be executed.

Note: The main stub file (phpuart.stub.php) is a generated file, edit the files on the stubs folder instead.

Classes

Class Description
UART\Serial Represents a Serial Port.
UART\Exception Base exception.

Resources

License

This library is licensed under the PHP License.