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

reformat code and run PHP Code Sniffer beautifier

Browse Source
pull/2/head
toimtoimtoim 8 years ago
parent 6137326277
commit dea30f53b4
5 changed files with 1835 additions and 1804 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. 213
      src/IecType.php
  2. 2874
      src/ModbusMaster.php
  3. 50
      src/ModbusMasterTcp.php
  4. 50
      src/ModbusMasterUdp.php
  5. 452
      src/PhpType.php

213
src/IecType.php
Unescape View File

@ -22,120 +22,117 @@ 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 * iecINT
* *
* Converts a value to IEC-1131 BYTE data type * Converts a value to IEC-1131 INT data type
* *
* @param int $value from 0 to 255 * @param int $value to be converted
* @return int IEC BYTE data type * @return int IEC-1131 INT data type
* */
*/ public static function iecINT($value)
public static function iecBYTE($value) {
{ return self::iecBYTE(($value >> 8) & 0x00FF) .
return chr($value & 0xFF); self::iecBYTE($value & 0x00FF);
} }
/** /**
* iecINT * iecBYTE
* *
* Converts a value to IEC-1131 INT data type * Converts a value to IEC-1131 BYTE data type
* *
* @param int $value to be converted * @param int $value from 0 to 255
* @return int IEC-1131 INT data type * @return int IEC BYTE 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));
}
/** /**
* iecDINT * iecDINT
* *
* Converts a value to IEC-1131 DINT data type * Converts a value to IEC-1131 DINT data type
* *
* @param int $value to be converted * @param int $value to be converted
* @param int $bigEndian defines endian codding (little endian == 0, big endian == 1) * @param int $bigEndian defines endian codding (little endian == 0, big endian == 1)
* @return int IEC-1131 INT data type * @return int IEC-1131 INT data type
* */
*/ public static function iecDINT($value, $bigEndian = 0)
public static function iecDINT($value, $bigEndian = 0) {
{ // result with right endianness
// result with right endianness return self::endianness($value, $bigEndian);
return self::endianness($value, $bigEndian); }
}
/** /**
* iecREAL * endianness
* *
* Converts a value to IEC-1131 REAL data type. The function uses function @use float2iecReal. * Make endianess as required.
* * For more see http://en.wikipedia.org/wiki/Endianness
* @param int $value to be converted *
* @param bool $bigEndian defines endian codding (little endian == 0, big endian == 1) * @param int $value
* @return int IEC-1131 REAL data type * @param bool $bigEndian
*/ * @return int
public static function iecREAL($value, $bigEndian = 0) */
{ private static function endianness($value, $bigEndian = 0)
// iecREAL representation {
$real = self::float2iecReal($value); if ($bigEndian == 0) {
// result with right endianness return
return self::endianness($real, $bigEndian); 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);
}
}
/** /**
* float2iecReal * iecREAL
* *
* This function converts float value to IEC-1131 REAL single precision form. * Converts a value to IEC-1131 REAL data type. The function uses function @use float2iecReal.
* *
* For more see [{@link http://en.wikipedia.org/wiki/Single_precision Single precision on Wiki}] or * @param int $value to be converted
* [{@link http://de.php.net/manual/en/function.base-convert.php PHP base_convert function commentary}, Todd Stokes * @param bool $bigEndian defines endian codding (little endian == 0, big endian == 1)
* @ Georgia Tech 21-Nov-2007] or * @return int IEC-1131 REAL data type
* [{@link http://www.php.net/manual/en/function.pack.php PHP pack/unpack functionality}] */
* public static function iecREAL($value, $bigEndian = 0)
* @param float $value to be converted {
* @return int IEC REAL data type // iecREAL representation
*/ $real = self::float2iecReal($value);
private static function float2iecReal($value) // result with right endianness
{ return self::endianness($real, $bigEndian);
// get float binary string }
$float = pack("f", $value);
// set 32-bit unsigned integer of the float
$w = unpack("L", $float);
return $w[1];
}
/** /**
* endianness * float2iecReal
* *
* Make endianess as required. * This function converts float value to IEC-1131 REAL single precision form.
* For more see http://en.wikipedia.org/wiki/Endianness *
* * 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
* @param bool $bigEndian * @ 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 endianness($value, $bigEndian = 0) * @param float $value to be converted
{ * @return int IEC REAL data type
if ($bigEndian == 0) { */
return private static function float2iecReal($value)
self::iecBYTE(($value >> 8) & 0x000000FF) . {
self::iecBYTE(($value & 0x000000FF)) . // get float binary string
self::iecBYTE(($value >> 24) & 0x000000FF) . $float = pack('f', $value);
self::iecBYTE(($value >> 16) & 0x000000FF); // set 32-bit unsigned integer of the float
} else { $w = unpack('L', $float);
return return $w[1];
self::iecBYTE(($value >> 24) & 0x000000FF) . }
self::iecBYTE(($value >> 16) & 0x000000FF) .
self::iecBYTE(($value >> 8) & 0x000000FF) .
self::iecBYTE(($value & 0x000000FF));
}
}
} }

2874
src/ModbusMaster.php
View File

File diff suppressed because it is too large Load Diff

50
src/ModbusMasterTcp.php
Unescape View File

@ -8,14 +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.
* *
* * @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$
*
*/ */
/** /**
@ -23,29 +21,21 @@ namespace PHPModbus;
* *
* 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: * @author Jan Krakora
* - FC 1: read coils * @copyright Copyright (c) 2004, 2012 Jan Krakora
* - FC 3: read multiple registers * @package Phpmodbus
* - FC 15: write multiple coils
* - FC 16: write multiple registers
* - FC 23: read write registers
*
* @author Jan Krakora
* @copyright Copyright (c) 2004, 2012 Jan Krakora
* @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".
*/ */
public function __construct($host) public function __construct($host)
{ {
parent::__construct($host, "TCP"); parent::__construct($host, "TCP");
} }
} }

50
src/ModbusMasterUdp.php
Unescape View File

@ -8,14 +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.
* *
* * @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$
*
*/ */
/** /**
@ -23,29 +21,21 @@ namespace PHPModbus;
* *
* This class deals with the MODBUS master using UDP stack. * This class deals with the MODBUS master using UDP stack.
* *
* Implemented MODBUS master functions: * @author Jan Krakora
* - FC 1: read coils * @copyright Copyright (c) 2004, 2012 Jan Krakora
* - FC 3: read multiple registers * @package Phpmodbus
* - FC 15: write multiple coils
* - FC 16: write multiple registers
* - FC 23: read write registers
*
* @author Jan Krakora
* @copyright Copyright (c) 2004, 2012 Jan Krakora
* @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".
*/ */
public function __construct($host) public function __construct($host)
{ {
parent::__construct($host, "UDP"); parent::__construct($host, "UDP");
} }
} }

452
src/PhpType.php
Unescape View File

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

Write Preview
Loading…
Cancel
Save