packages
/
php-modbus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Cleaned up the code, fixed broken phpdoc tags, formatting

Browse Source
pull/1/head 0.9.1
Ondřej Hruška 8 years ago
parent 7d058ee526
commit dd5a892fb6
6 changed files with 1745 additions and 1666 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 1
      .gitignore
  2. 223
      src/IecType.php
  3. 2636
      src/ModbusMaster.php
  4. 51
      src/ModbusMasterTcp.php
  5. 52
      src/ModbusMasterUdp.php
  6. 448
      src/PhpType.php

1
.gitignore vendored
Unescape View File

@ -1,4 +1,5 @@
/vendor /vendor
composer.lock composer.lock
.idea/
*~ *~

223
src/IecType.php
Unescape View File

@ -8,12 +8,12 @@ namespace PHPModbus;
* This source file is subject to the "PhpModbus license" that is bundled * This source file is subject to the "PhpModbus license" that is bundled
* with this package in the file license.txt. * with this package in the file license.txt.
* *
* @author Jan Krakora * @author Jan Krakora
* @copyright Copyright (c) 2004, 2013 Jan Krakora * @copyright Copyright (c) 2004, 2013 Jan Krakora
* @license PhpModbus license * @license PhpModbus license
* @category Phpmodbus * @category Phpmodbus
* @package Phpmodbus * @package Phpmodbus
* @version $id$ * @version $id$
*/ */
/** /**
@ -22,115 +22,120 @@ namespace PHPModbus;
* The class includes set of IEC-1131 data type functions that converts a PHP * The class includes set of IEC-1131 data type functions that converts a PHP
* data types to a IEC data type. * data types to a IEC data type.
* *
* @author Jan Krakora * @author Jan Krakora
* @copyright Copyright (c) 2004, 2010 Jan Krakora * @copyright Copyright (c) 2004, 2010 Jan Krakora
* @package Phpmodbus * @package Phpmodbus
*/ */
class IecType { class IecType
{
/**
* iecBYTE
*
* Converts a value to IEC-1131 BYTE data type
*
* @param int $value from 0 to 255
* @return int IEC BYTE data type
*
*/
public static function iecBYTE($value)
{
return chr($value & 0xFF);
}
/** /**
* iecBYTE * iecINT
* *
* Converts a value to IEC-1131 BYTE data type * Converts a value to IEC-1131 INT data type
* *
* @param value value from 0 to 255 * @param int $value to be converted
* @return value IEC BYTE data type * @return int IEC-1131 INT data type
* *
*/ */
public static function iecBYTE($value) { public static function iecINT($value)
return chr($value & 0xFF); {
} return self::iecBYTE(($value >> 8) & 0x00FF) .
self::iecBYTE(($value & 0x00FF));
}
/** /**
* iecINT * iecDINT
* *
* Converts a value to IEC-1131 INT data type * Converts a value to IEC-1131 DINT data type
* *
* @param value value to be converted * @param int $value to be converted
* @return value IEC-1131 INT data type * @param int $bigEndian defines endian codding (little endian == 0, big endian == 1)
* * @return int IEC-1131 INT data type
*/ *
public static function iecINT($value) { */
return self::iecBYTE(($value >> 8) & 0x00FF) . public static function iecDINT($value, $bigEndian = 0)
self::iecBYTE(($value & 0x00FF)); {
} // result with right endianness
return self::endianness($value, $bigEndian);
}
/** /**
* iecDINT * iecREAL
* *
* Converts a value to IEC-1131 DINT data type * Converts a value to IEC-1131 REAL data type. The function uses function @use float2iecReal.
* *
* @param value value to be converted * @param int $value to be converted
* @param value endianness defines endian codding (little endian == 0, big endian == 1) * @param bool $bigEndian defines endian codding (little endian == 0, big endian == 1)
* @return value IEC-1131 INT data type * @return int IEC-1131 REAL data type
* */
*/ public static function iecREAL($value, $bigEndian = 0)
public static function iecDINT($value, $endianness = 0) { {
// result with right endianness // iecREAL representation
return self::endianness($value, $endianness); $real = self::float2iecReal($value);
} // result with right endianness
return self::endianness($real, $bigEndian);
}
/** /**
* iecREAL * float2iecReal
* *
* Converts a value to IEC-1131 REAL data type. The function uses function @use float2iecReal. * This function converts float value to IEC-1131 REAL single precision form.
* *
* @param value value to be converted * For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or
* @param value endianness defines endian codding (little endian == 0, big endian == 1) * [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes
* @return value IEC-1131 REAL data type * @ Georgia Tech 21-Nov-2007] or
*/ * [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}]
public static function iecREAL($value, $endianness = 0) { *
// iecREAL representation * @param float $value to be converted
$real = self::float2iecReal($value); * @return int IEC REAL data type
// result with right endianness */
return self::endianness($real, $endianness); private static function float2iecReal($value)
} {
// get float binary string
/** $float = pack("f", $value);
* float2iecReal // set 32-bit unsigned integer of the float
* $w = unpack("L", $float);
* This function converts float value to IEC-1131 REAL single precision form. return $w[1];
* }
* For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or
* [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes @ Georgia Tech 21-Nov-2007] or
* [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}]
*
* @param float value to be converted
* @return value IEC REAL data type
*/
private static function float2iecReal($value) {
// get float binary string
$float = pack("f", $value);
// set 32-bit unsigned integer of the float
$w = unpack("L", $float);
return $w[1];
}
/**
* endianness
*
* Make endianess as required.
* For more see http://en.wikipedia.org/wiki/Endianness
*
* @param int $value
* @param bool $endianness
* @return int
*/
private static function endianness($value, $endianness = 0) {
if ($endianness == 0)
return
self::iecBYTE(($value >> 8) & 0x000000FF) .
self::iecBYTE(($value & 0x000000FF)) .
self::iecBYTE(($value >> 24) & 0x000000FF) .
self::iecBYTE(($value >> 16) & 0x000000FF);
else
return
self::iecBYTE(($value >> 24) & 0x000000FF) .
self::iecBYTE(($value >> 16) & 0x000000FF) .
self::iecBYTE(($value >> 8) & 0x000000FF) .
self::iecBYTE(($value & 0x000000FF));
}
/**
* endianness
*
* Make endianess as required.
* For more see http://en.wikipedia.org/wiki/Endianness
*
* @param int $value
* @param bool $bigEndian
* @return int
*/
private static function endianness($value, $bigEndian = 0)
{
if ($bigEndian == 0) {
return
self::iecBYTE(($value >> 8) & 0x000000FF) .
self::iecBYTE(($value & 0x000000FF)) .
self::iecBYTE(($value >> 24) & 0x000000FF) .
self::iecBYTE(($value >> 16) & 0x000000FF);
} else {
return
self::iecBYTE(($value >> 24) & 0x000000FF) .
self::iecBYTE(($value >> 16) & 0x000000FF) .
self::iecBYTE(($value >> 8) & 0x000000FF) .
self::iecBYTE(($value & 0x000000FF));
}
}
} }
?>

2636
src/ModbusMaster.php
View File

File diff suppressed because it is too large Load Diff

51
src/ModbusMasterTcp.php
Unescape View File

@ -4,47 +4,48 @@ namespace PHPModbus;
/** /**
* Phpmodbus Copyright (c) 2004, 2012 Jan Krakora * Phpmodbus Copyright (c) 2004, 2012 Jan Krakora
* *
* This source file is subject to the "PhpModbus license" that is bundled * This source file is subject to the "PhpModbus license" that is bundled
* with this package in the file license.txt. * with this package in the file license.txt.
* *
* *
* @copyright Copyright (c) 2004, 2012 Jan Krakora * @copyright Copyright (c) 2004, 2012 Jan Krakora
* @license PhpModbus license * @license PhpModbus license
* @category Phpmodbus * @category Phpmodbus
* @tutorial Phpmodbus.pkg * @tutorial Phpmodbus.pkg
* @package Phpmodbus * @package Phpmodbus
* @version $id$ * @version $id$
* *
*/ */
/** /**
* ModbusMasterTcp * ModbusMasterTcp
* *
* This class deals with the MODBUS master using TCP. Extends ModbusMaster class. * This class deals with the MODBUS master using TCP. Extends ModbusMaster class.
* *
* Implemented MODBUS functions: * Implemented MODBUS functions:
* - FC 1: read coils * - FC 1: read coils
* - FC 3: read multiple registers * - FC 3: read multiple registers
* - FC 15: write multiple coils * - FC 15: write multiple coils
* - FC 16: write multiple registers * - FC 16: write multiple registers
* - FC 23: read write registers * - FC 23: read write registers
* *
* @author Jan Krakora * @author Jan Krakora
* @copyright Copyright (c) 2004, 2012 Jan Krakora * @copyright Copyright (c) 2004, 2012 Jan Krakora
* @package Phpmodbus * @package Phpmodbus
* *
*/ */
class ModbusMasterTcp extends ModbusMaster { class ModbusMasterTcp extends ModbusMaster
/** {
* ModbusMasterTcp /**
* * ModbusMasterTcp
* This is the constructor that defines {@link $host} IP address of the object. *
* * This is the constructor that defines {@link $host} IP address of the object.
* @param String $host An IP address of a Modbus TCP device. E.g. "192.168.1.1". *
*/ * @param String $host An IP address of a Modbus TCP device. E.g. "192.168.1.1".
function ModbusMasterTcp($host){ */
$this->host = $host; public function __construct($host)
$this->socket_protocol = "TCP"; {
} parent::__construct($host, "TCP");
}
} }

52
src/ModbusMasterUdp.php
Unescape View File

@ -4,48 +4,48 @@ namespace PHPModbus;
/** /**
* Phpmodbus Copyright (c) 2004, 2012 Jan Krakora * Phpmodbus Copyright (c) 2004, 2012 Jan Krakora
* *
* This source file is subject to the "PhpModbus license" that is bundled * This source file is subject to the "PhpModbus license" that is bundled
* with this package in the file license.txt. * with this package in the file license.txt.
* *
* *
* @copyright Copyright (c) 2004, 2012 Jan Krakora * @copyright Copyright (c) 2004, 2012 Jan Krakora
* @license PhpModbus license * @license PhpModbus license
* @category Phpmodbus * @category Phpmodbus
* @tutorial Phpmodbus.pkg * @tutorial Phpmodbus.pkg
* @package Phpmodbus * @package Phpmodbus
* @version $id$ * @version $id$
* *
*/ */
/** /**
* ModbusMasterUdp * ModbusMasterUdp
* *
* This class deals with the MODBUS master using UDP stack. * This class deals with the MODBUS master using UDP stack.
* *
* Implemented MODBUS master functions: * Implemented MODBUS master functions:
* - FC 1: read coils * - FC 1: read coils
* - FC 3: read multiple registers * - FC 3: read multiple registers
* - FC 15: write multiple coils * - FC 15: write multiple coils
* - FC 16: write multiple registers * - FC 16: write multiple registers
* - FC 23: read write registers * - FC 23: read write registers
* *
* @author Jan Krakora * @author Jan Krakora
* @copyright Copyright (c) 2004, 2012 Jan Krakora * @copyright Copyright (c) 2004, 2012 Jan Krakora
* @package Phpmodbus * @package Phpmodbus
* *
*/ */
class ModbusMasterUdp extends ModbusMaster { class ModbusMasterUdp extends ModbusMaster
{
/** /**
* ModbusMasterUdp * ModbusMasterUdp
* *
* This is the constructor that defines {@link $host} IP address of the object. * This is the constructor that defines {@link $host} IP address of the object.
* *
* @param String $host An IP address of a Modbus UDP device. E.g. "192.168.1.1". * @param String $host An IP address of a Modbus UDP device. E.g. "192.168.1.1".
*/ */
function ModbusMasterUdp($host){ public function __construct($host)
$this->host = $host; {
$this->socket_protocol = "UDP"; parent::__construct($host, "UDP");
} }
} }

448
src/PhpType.php
Unescape View File

@ -1,6 +1,7 @@
<?php <?php
namespace PHPModbus; namespace PHPModbus;
use Exception;
/** /**
* Phpmodbus Copyright (c) 2004, 2012 Jan Krakora * Phpmodbus Copyright (c) 2004, 2012 Jan Krakora
@ -8,12 +9,12 @@ namespace PHPModbus;
* This source file is subject to the "PhpModbus license" that is bundled * This source file is subject to the "PhpModbus license" that is bundled
* with this package in the file license.txt. * with this package in the file license.txt.
* *
* @author Jan Krakora * @author Jan Krakora
* @copyright Copyright (c) 2004, 2012 Jan Krakora * @copyright Copyright (c) 2004, 2012 Jan Krakora
* @license PhpModbus license * @license PhpModbus license
* @category Phpmodbus * @category Phpmodbus
* @package Phpmodbus * @package Phpmodbus
* @version $id$ * @version $id$
* *
*/ */
@ -23,230 +24,243 @@ namespace PHPModbus;
* The class includes set of methods that convert the received Modbus data * The class includes set of methods that convert the received Modbus data
* (array of bytes) to the PHP data type, i.e. signed int, unsigned int and float. * (array of bytes) to the PHP data type, i.e. signed int, unsigned int and float.
* *
* @author Jan Krakora * @author Jan Krakora
* @copyright Copyright (c) 2004, 2012 Jan Krakora * @copyright Copyright (c) 2004, 2012 Jan Krakora
* @package Phpmodbus * @package Phpmodbus
* *
*/ */
class PhpType { class PhpType
{
/**
* bytes2float
*
* The function converts array of 4 bytes to float. The return value
* depends on order of the input bytes (endianning).
*
* @param array $values
* @param bool $bigEndian
* @return float
*/
public static function bytes2float($values, $bigEndian = 0)
{
// Set the array to correct form
$data = self::checkData($values);
// Combine bytes
$real = self::combineBytes($data, $bigEndian);
// Convert the real value to float
return (float)self::real2float($real);
}
/** /**
* bytes2float * bytes2signedInt
* *
* The function converts array of 4 bytes to float. The return value * The function converts array of 2 or 4 bytes to signed integer.
* depends on order of the input bytes (endianning). * The return value depends on order of the input bytes (endianning).
* *
* @param array $values * @param array $values
* @param bool $endianness * @param bool $bigEndian
* @return float * @return int
*/ */
public static function bytes2float($values, $endianness = 0) { public static function bytes2signedInt($values, $bigEndian = 0)
$data = array(); {
$real = 0; $data = array();
$int = 0;
// Set the array to correct form
$data = self::checkData($values);
// Combine bytes
$int = self::combineBytes($data, $bigEndian);
// In the case of signed 2 byte value convert it to 4 byte one
if ((count($values) == 2) && ((0x8000 & $int) > 0)) {
$int = 0xFFFF8000 | $int;
}
// Convert the value
return (int)self::dword2signedInt($int);
}
// Set the array to correct form /**
$data = self::checkData($values); * bytes2unsignedInt
// Combine bytes *
$real = self::combineBytes($data, $endianness); * The function converts array of 2 or 4 bytes to unsigned integer.
// Convert the real value to float * The return value depends on order of the input bytes (endianning).
return (float) self::real2float($real); *
} * @param array $values
* @param bool $bigEndian
* @return int|float
*/
public static function bytes2unsignedInt($values, $bigEndian = 0)
{
$data = array();
$int = 0;
// Set the array to correct form
$data = self::checkData($values);
// Combine bytes
$int = self::combineBytes($data, $bigEndian);
// Convert the value
return self::dword2unsignedInt($int);
}
/** /**
* bytes2signedInt * bytes2string
* *
* The function converts array of 2 or 4 bytes to signed integer. * The function converts an values array to the string. The function detects
* The return value depends on order of the input bytes (endianning). * the end of the string by 0x00 character as defined by string standards.
* *
* @param array $values * @param array $values
* @param bool $endianness * @param bool $bigEndian
* @return int * @return string
*/ */
public static function bytes2signedInt($values, $endianness = 0) { public static function bytes2string($values, $bigEndian = 0)
$data = array(); {
$int = 0; // Prepare string variable
// Set the array to correct form $str = "";
$data = self::checkData($values); // Parse the received data word array
// Combine bytes for ($i = 0; $i < count($values); $i += 2) {
$int = self::combineBytes($data, $endianness); if ($bigEndian) {
// In the case of signed 2 byte value convert it to 4 byte one if ($values[$i] != 0) {
if ((count($values) == 2) && ((0x8000 & $int) > 0)) { $str .= chr($values[$i]);
$int = 0xFFFF8000 | $int; } else {
} break;
// Convert the value }
return (int) self::dword2signedInt($int); if ($values[$i + 1] != 0) {
} $str .= chr($values[$i + 1]);
} else {
break;
}
} else {
if ($values[$i + 1] != 0) {
$str .= chr($values[$i + 1]);
} else {
break;
}
if ($values[$i] != 0) {
$str .= chr($values[$i]);
} else {
break;
}
}
}
// return string
return $str;
}
/** /**
* bytes2unsignedInt * real2float
* *
* The function converts array of 2 or 4 bytes to unsigned integer. * This function converts a value in IEC-1131 REAL single precision form to float.
* The return value depends on order of the input bytes (endianning). *
* * For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or
* @param array $values * [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes
* @param bool $endianness * @ Georgia Tech 21-Nov-2007] or
* @return int|float * [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}]
*/ *
public static function bytes2unsignedInt($values, $endianness = 0) { * @param int $value in IEC REAL data type to be converted
$data = array(); * @return float float value
$int = 0; */
// Set the array to correct form private static function real2float($value)
$data = self::checkData($values); {
// Combine bytes // get unsigned long
$int = self::combineBytes($data, $endianness); $ulong = pack("L", $value);
// Convert the value // set float
return self::dword2unsignedInt($int); $float = unpack("f", $ulong);
}
/** return $float[1];
* bytes2string }
*
* The function converts an values array to the string. The function detects
* the end of the string by 0x00 character as defined by string standards.
*
* @param array $values
* @param bool $endianness
* @return string
*/
public static function bytes2string($values, $endianness = 0) {
// Prepare string variable
$str = "";
// Parse the received data word array
for($i=0;$i<count($values);$i+=2) {
if ($endianness) {
if($values[$i] != 0)
$str .= chr($values[$i]);
else
break;
if($values[$i+1] != 0)
$str .= chr($values[$i+1]);
else
break;
}
else {
if($values[$i+1] != 0)
$str .= chr($values[$i+1]);
else
break;
if($values[$i] != 0)
$str .= chr($values[$i]);
else
break;
}
}
// return string
return $str;
}
/** /**
* real2float * dword2signedInt
* *
* This function converts a value in IEC-1131 REAL single precision form to float. * Switch double word to signed integer
* *
* For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or * @param int $value
* [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes @ Georgia Tech 21-Nov-2007] or * @return int
* [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}] */
* private static function dword2signedInt($value)
* @param value value in IEC REAL data type to be converted {
* @return float float value if ((0x80000000 & $value) != 0) {
*/ return -(0x7FFFFFFF & ~$value) - 1;
private static function real2float($value) { } else {
// get unsigned long return (0x7FFFFFFF & $value);
$ulong = pack("L", $value); }
// set float }
$float = unpack("f", $ulong);
return $float[1];
}
/** /**
* dword2signedInt * dword2signedInt
* *
* Switch double word to signed integer * Switch double word to unsigned integer
* *
* @param int $value * @param int $value
* @return int * @return int|float
*/ */
private static function dword2signedInt($value) { private static function dword2unsignedInt($value)
if ((0x80000000 & $value) != 0) { {
return -(0x7FFFFFFF & ~$value)-1; if ((0x80000000 & $value) != 0) {
} else { return ((float)(0x7FFFFFFF & $value)) + 2147483648;
return (0x7FFFFFFF & $value); } else {
} return (int)(0x7FFFFFFF & $value);
} }
}
/** /**
* dword2signedInt * checkData
* *
* Switch double word to unsigned integer * Check if the data variable is array, and check if the values are numeric
* *
* @param int $value * @param int[] $data
* @return int|float * @return int
*/ * @throws Exception
private static function dword2unsignedInt($value) { */
if ((0x80000000 & $value) != 0) { private static function checkData($data)
return ((float) (0x7FFFFFFF & $value)) + 2147483648; {
} else { // Check the data
return (int) (0x7FFFFFFF & $value); if (!is_array($data) ||
} count($data) < 2 ||
} count($data) > 4 ||
count($data) == 3
) {
throw new Exception('The input data should be an array of 2 or 4 bytes.');
}
// Fill the rest of array by zeroes
if (count($data) == 2) {
$data[2] = 0;
$data[3] = 0;
}
// Check the values to be number
if (!is_numeric($data[0]) ||
!is_numeric($data[1]) ||
!is_numeric($data[2]) ||
!is_numeric($data[3])
) {
throw new Exception('Data are not numeric or the array keys are not indexed by 0,1,2 and 3');
}
/** return $data;
* checkData }
*
* Check if the data variable is array, and check if the values are numeric
*
* @param int $data
* @return int
*/
private static function checkData($data) {
// Check the data
if (!is_array($data) ||
count($data)<2 ||
count($data)>4 ||
count($data)==3) {
throw new Exception('The input data should be an array of 2 or 4 bytes.');
}
// Fill the rest of array by zeroes
if (count($data) == 2) {
$data[2] = 0;
$data[3] = 0;
}
// Check the values to be number
if (!is_numeric($data[0]) ||
!is_numeric($data[1]) ||
!is_numeric($data[2]) ||
!is_numeric($data[3])) {
throw new Exception('Data are not numeric or the array keys are not indexed by 0,1,2 and 3');
}
return $data; /**
} * combineBytes
*
* Combine bytes together
*
* @param int $data
* @param bool $bigEndian
* @return int
*/
private static function combineBytes($data, $bigEndian)
{
$value = 0;
// Combine bytes
if ($bigEndian == 0) {
$value = (($data[3] & 0xFF) << 16) |
(($data[2] & 0xFF) << 24) |
(($data[1] & 0xFF)) |
(($data[0] & 0xFF) << 8);
} else {
$value = (($data[3] & 0xFF) << 24) |
(($data[2] & 0xFF) << 16) |
(($data[1] & 0xFF) << 8) |
(($data[0] & 0xFF));
}
/** return $value;
* combineBytes }
*
* Combine bytes together
*
* @param int $data
* @param bool $endianness
* @return int
*/
private static function combineBytes($data, $endianness) {
$value = 0;
// Combine bytes
if ($endianness == 0)
$value = (($data[3] & 0xFF)<<16) |
(($data[2] & 0xFF)<<24) |
(($data[1] & 0xFF)) |
(($data[0] & 0xFF)<<8);
else
$value = (($data[3] & 0xFF)<<24) |
(($data[2] & 0xFF)<<16) |
(($data[1] & 0xFF)<<8) |
(($data[0] & 0xFF));
return $value;
}
} }
?>
Write Preview
Loading…
Cancel
Save