Modbus TCP and UDP library for PHP., originally from code.google.com/p/phpmodbus
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
toimtoimtoim 2fbbbc5842 read more than 2048 bytes from stream 8 years ago
examples add class autoloading to example scripts to they could be used directly 8 years ago
src read more than 2048 bytes from stream 8 years ago
tests let modbus add send packet to status message, clean a little WriteMultipleCoilsPacket methods 8 years ago
.gitignore refactor/reimplement old (batch script) tests to use phpunit. 8 years ago
.travis.yml read more than 2048 bytes from stream 8 years ago
LICENSE added a namespace 8 years ago
README.md update readme 8 years ago
composer.json replace dependency to sockets extension to built-in stream API 8 years ago
phpunit.xml refactor thrown exceptions to be more specific than just Exception class 8 years ago

README.md

phpmodbus

Implementation of the basic functionality of the Modbus TCP and UDP based protocol using PHP.

NOTE: This is a fork to fix & update the library code.

##What's new

  • This fork adds a namespace and fixes issues encountered when porting to PHP 7
  • Removes dependency to sockets extension. Now uses built-in Stream API
  • Fixes/replaces old MS Windows specific tests

Implemented features

  • Modbus master
  • FC1 - Read coils
  • FC2 - Read input discretes
  • FC3 - Read holding registers
  • FC4 - Read holding input registers
  • FC5 - Write single coil
  • FC6 - Write single register
  • FC15 - Write multiple coils
  • FC16 - Write multiple registers
  • FC23 - Read/Write multiple registers

Requirements

  • PHP 5.5+

Example

use PHPModbus/ModbusMaster; 
use PHPModbus/PhpType; 

// Modbus master UDP
$modbus = new ModbusMaster("192.168.1.1", "UDP"); 
// Read multiple registers
try {
    $recData = $modbus->readMultipleRegisters(0, 12288, 5); 
} catch (Exception $e) {
    // Print error information if any
    echo $modbus;
    echo $e;
    exit;
}
// Print data in string format
echo PhpType::bytes2string($recData); 

Use the setTimeout($seconds) and setSocketTimeout($read_timeout_sec, $write_timeout_sec) methods to adjust wait times.

Most of the code is (to some extent) commented and documented with PhpDoc. You should get useful tooltips in your IDE.

Tests

To run the test suite, you need install the dependencies via composer, then run PHPUnit.

NB: PHP 5.6+ is required for tests

composer install
composer test

To report test coverage (created inside ./report/html):

composer test-coverage

GoogleCode legacy docs & downloads

This project was originally hosted on (now defunct) Google Code. It's still archived here: