fixed the examples

Minor cleanup, removed duplicate timeout vars & replaced with float [sec], added socket Tout setter
cleanup
2016-11-20 11:29:09 +01:00 · 2016-11-18 16:06:15 +01:00 · 2016-11-05 18:00:41 +02:00 · 2016-11-05 17:57:19 +02:00 · 2016-11-04 22:02:04 +02:00 · 2016-03-11 23:11:21 +01:00
20 changed files with 1992 additions and 1845 deletions
@@ -1,4 +1,5 @@
 /vendor
 composer.lock
+.idea/

 *~
@@ -2,38 +2,44 @@

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

-This is a fork of the original project at https://code.google.com/p/phpmodbus/
+**NOTE: This is a fork to fix & update the library code (and code alone). Notably, the tests are probably all broken.**

 > **What's new**
 > 
 > This fork adds a namespace and fixes issues encountered when porting to PHP 7

-**WARNING: Everything except the actual code in this repo may be broken and outdated.**

-Implemented features:
+## 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
+ * 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

-Example:
+
+## Requirements
+
+ * The PHP extension php_sockets.dll should be enabled (server php.ini file)
+
+ 
+## Example

 ```php
-require_once dirname(__FILE__) . '/Phpmodbus/ModbusMaster.php'; 
+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) {
+} catch (Exception $e) {
    // Print error information if any
    echo $modbus;
    echo $e;
@@ -43,7 +49,14 @@ catch (Exception $e) {
 echo PhpType::bytes2string($recData); 
 ```

-For more see [http://code.google.com/p/phpmodbus/downloads/list documentation] or [http://code.google.com/p/phpmodbus/wiki/FAQ FAQ].
+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.
+
+
+## GoogleCode legacy docs & downloads
+
+This project was originally hosted on (now defunct) Google Code. It's still archived here:
+
+* [GoogleCode Archived Repo](http://code.google.com/p/phpmodbus)

-Note: 
- * The PHP extension php_sockets.dll should be enabled (server php.ini file)
@@ -1,5 +1,5 @@
 {
-  "name": "MightyPork/phpmodbus",
+  "name": "mightypork/phpmodbus",
  "keywords": ["phpmodbus","modbus"],
  "description": "PhpModbus with namespaces and updated to PHP 7",
  "license": "LGPL",
@@ -11,6 +11,10 @@
    {
      "name": "Honza Krakora",
      "email": "krakora.jan@googlemail.com"
+    },
+    {
+      "name": "Ondřej Hruška",
+      "email": "ondra@ondrovo.com"
    }
  ],
  "autoload": {
@@ -1,67 +1,65 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $ip = "192.192.15.51";
 $modbus = new ModbusMaster($ip, "UDP");

 try {
-    // FC 3
-    $moduleId = 0;
-    $reference = 12288;
-    $mw0address = 12288;
-    $quantity = 6;
-    $recData = $modbus->readMultipleRegisters($moduleId, $reference, $quantity);
-}
-catch (Exception $e) {
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC 3
+	$moduleId = 0;
+	$reference = 12288;
+	$mw0address = 12288;
+	$quantity = 6;
+	$recData = $modbus->readMultipleRegisters($moduleId, $reference, $quantity);
+} catch (Exception $e) {
+	echo $modbus;
+	echo $e;
+	exit;
 }

 ?>
 <html>
-    <head>
-        <meta http-equiv="content-type" content="text/html; charset=windows-1250">
-        <meta name="generator" content="PSPad editor, www.pspad.com">
-        <title>WAGO 750-841 M-memory dump</title>
-    </head>
-    <body>
-        <h1>Dump of M-memory from WAGO 750-84x series coupler.</h1>
-        <ul>
-            <li>PLC: 750-84x series</li>
-            <li>IP: <?php echo $ip?></li>
-            <li>Modbus module ID: <?php echo $moduleId?></li>
-            <li>Modbus memory reference: <?php echo $reference?></li>
-            <li>Modbus memory quantity: <?php echo $quantity?></li>
-        </ul>
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=windows-1250">
+		<meta name="generator" content="PSPad editor, www.pspad.com">
+		<title>WAGO 750-841 M-memory dump</title>
+	</head>
+	<body>
+	<h1>Dump of M-memory from WAGO 750-84x series coupler.</h1>
+	<ul>
+		<li>PLC: 750-84x series</li>
+		<li>IP: <?php echo $ip ?></li>
+		<li>Modbus module ID: <?php echo $moduleId ?></li>
+		<li>Modbus memory reference: <?php echo $reference ?></li>
+		<li>Modbus memory quantity: <?php echo $quantity ?></li>
+	</ul>

-        <h2>M-memory dump</h2>
+	<h2>M-memory dump</h2>

-        <table border="1px" width="400px">
-            <tr>
-                <td>Modbus address</td>
-                <td>MWx</td>
-                <td>value</td>
-            </tr>
-            <?php
-            for($i=0;$i<count($recData);$i+=2) {
-                ?>
-            <tr>
-                <td><?php echo $i+$reference?></td>
-                <td>MW<?php echo ($i + $reference - $mw0address)/2?></td>
-                <td><?php echo ($recData[$i] << 8)+ $recData[$i+1]?></td>
-            </tr>
-                <?php
-            }
-            ?>
-        </table>
+	<table border="1px" width="400px">
+		<tr>
+			<td>Modbus address</td>
+			<td>MWx</td>
+			<td>value</td>
+		</tr>
+		<?php
+		for ($i = 0; $i < count($recData); $i += 2) {
+			?>
+			<tr>
+				<td><?php echo $i + $reference ?></td>
+				<td>MW<?php echo ($i + $reference - $mw0address) / 2 ?></td>
+				<td><?php echo ($recData[$i] << 8) + $recData[$i + 1] ?></td>
+			</tr>
+			<?php
+		}
+		?>
+	</table>

-        <h2>Modbus class status</h2>
-        <?php
-        echo $modbus;
-        ?>
+	<h2>Modbus class status</h2>

-    </body>
-</html> 
+	<pre><?= $modbus ?></pre>
+
+	</body>
+</html>
@@ -1,20 +1,20 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;
+use PHPModbus\PhpType;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");

 try {
-    // FC 3
-    // read 10 words (20 bytes) from device ID=0, address=12288
-    $recData = $modbus->readMultipleRegisters(0, 12288, 10);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC 3
+	// read 10 words (20 bytes) from device ID=0, address=12288
+	$recData = $modbus->readMultipleRegisters(0, 12288, 10);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Received data
@@ -28,18 +28,18 @@ $values = array_chunk($recData, 4);

 // Get float from REAL interpretation
 echo "<h3>REAL to Float</h3>\n";
-foreach($values as $bytes)
-    echo PhpType::bytes2float($bytes) . "</br>";
+foreach ($values as $bytes)
+	echo PhpType::bytes2float($bytes) . "</br>";

 // Get integer from DINT interpretation
 echo "<h3>DINT to integer </h3>\n";
-foreach($values as $bytes)
-    echo PhpType::bytes2signedInt($bytes) . "</br>";
+foreach ($values as $bytes)
+	echo PhpType::bytes2signedInt($bytes) . "</br>";

 // Get integer of float from DINT interpretation
 echo "<h3>DWORD to integer (or float) </h3>\n";
-foreach($values as $bytes)
-    echo PhpType::bytes2unsignedInt($bytes) . "</br>";
+foreach ($values as $bytes)
+	echo PhpType::bytes2unsignedInt($bytes) . "</br>";

 echo "<h2>16 bit types</h2>\n";
 // Chunk the data array to set of 4 bytes
@@ -47,15 +47,14 @@ $values = array_chunk($recData, 2);

 // Get signed integer from INT interpretation
 echo "<h3>INT to integer </h3>\n";
-foreach($values as $bytes)
-    echo PhpType::bytes2signedInt($bytes) . "</br>";
+foreach ($values as $bytes)
+	echo PhpType::bytes2signedInt($bytes) . "</br>";

 // Get unsigned integer from WORD interpretation
 echo "<h3>WORD to integer </h3>\n";
-foreach($values as $bytes)
-    echo PhpType::bytes2unsignedInt($bytes) . "</br>";
+foreach ($values as $bytes)
+	echo PhpType::bytes2unsignedInt($bytes) . "</br>";

 // Get string from STRING interpretation
 echo "<h3>STRING to string </h3>\n";
 echo PhpType::bytes2string($recData) . "</br>";
-?>
@@ -1,19 +1,18 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");

 try {
-    // FC 1
-    $recData = $modbus->readCoils(0, 12288, 12);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC 1
+	$recData = $modbus->readCoils(0, 12288, 12);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
@@ -21,5 +20,5 @@ echo "</br>Status:</br>" . $modbus;

 // Print read data
 echo "</br>Data:</br>";
-var_dump($recData); 
-echo "</br>";
+var_dump($recData);
+echo "</br>";
@@ -1,25 +1,26 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");

-// Data to be writen
-$data = array(TRUE, FALSE, TRUE, TRUE, FALSE, TRUE, TRUE, TRUE, 
-              TRUE, TRUE, TRUE, TRUE, FALSE, FALSE, FALSE, FALSE,
-              FALSE, FALSE, FALSE, FALSE, TRUE, TRUE, TRUE, TRUE,
-              TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
+// Data to be written - supports both 0/1 and booleans (true, false)
+$data = array(
+	1, 0, 1, 1, 0, 1, 1, 1,
+	1, 1, 1, 1, 0, 0, 0, 0,
+	0, 0, 0, 0, 1, 1, 1, 1,
+	1, 1, 1, 1, 1, 1, 1, 1,
+);

 try {
-    // FC15
-    $modbus->writeMultipleCoils(0, 12288, $data);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC15
+	$modbus->writeMultipleCoils(0, 12288, $data);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
@@ -1,6 +1,6 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");
@@ -10,17 +10,16 @@ $data = array(10, -1000, 2000, 3.0);
 $dataTypes = array("WORD", "INT", "DINT", "REAL");

 try {
-    // FC16
-    $modbus->writeMultipleRegister(0, 12288, $data, $dataTypes);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC16
+	$modbus->writeMultipleRegister(0, 12288, $data, $dataTypes);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
 echo $modbus;

-?>
+?>
@@ -1,20 +1,19 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");

 try {
-    // FC 2
-    // read 2 input bits from address 0x0 (Wago input image)
-    $recData = $modbus->readInputDiscretes(0, 0, 2);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC 2
+	// read 2 input bits from address 0x0 (Wago input image)
+	$recData = $modbus->readInputDiscretes(0, 0, 2);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
@@ -22,5 +21,5 @@ echo "</br>Status:</br>" . $modbus;

 // Print read data
 echo "</br>Data:</br>";
-var_dump($recData); 
-echo "</br>";
+var_dump($recData);
+echo "</br>";
@@ -1,6 +1,6 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");
@@ -8,21 +8,18 @@ $modbus = new ModbusMaster("192.192.15.51", "UDP");
 // Data to be writen
 $bitValue = true;
 $bitNumber = 2;
-$andMask =  0xFFFF ^ pow(2, $bitNumber) ;
-$orMask =  0x0000 ^ (pow(2, $bitNumber) * $bitValue ) ;
+$andMask = 0xFFFF ^ pow(2, $bitNumber);
+$orMask = 0x0000 ^ (pow(2, $bitNumber) * $bitValue);

 try {
-    // FC22
-    $modbus->maskWriteRegister(0, 12288, $andMask, $orMask);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC22
+	$modbus->maskWriteRegister(0, 12288, $andMask, $orMask);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
 echo $modbus;
-
-?>
@@ -1,6 +1,6 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");
@@ -10,14 +10,13 @@ $data = array(10, -1000, 2000, 3.0);
 $dataTypes = array("WORD", "INT", "DINT", "REAL");

 try {
-    // FC23
-    $recData = $modbus->readWriteRegisters(0, 12288, 6, 12288, $data, $dataTypes);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC23
+	$recData = $modbus->readWriteRegisters(0, 12288, 6, 12288, $data, $dataTypes);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
@@ -27,5 +26,3 @@ echo "</br>Status:</br>" . $modbus;
 echo "</br>Data:</br>";
 print_r($recData);
 echo "</br>";
-
-?>
@@ -1,19 +1,18 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");

 try {
-    // FC 3
-    $recData = $modbus->readMultipleRegisters(0, 12288, 6);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC 3
+	$recData = $modbus->readMultipleRegisters(0, 12288, 6);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
@@ -21,6 +20,5 @@ echo "</br>Status:</br>" . $modbus;

 // Print read data
 echo "</br>Data:</br>";
-print_r($recData); 
+print_r($recData);
 echo "</br>";
-?>
@@ -1,19 +1,18 @@
 <?php

-require_once dirname(__FILE__) . '/../../Phpmodbus/ModbusMasterUdp.php';
+use PHPModbus\ModbusMasterUdp;

 // Create Modbus object
 $modbus = new ModbusMasterUdp("192.192.15.51");

 try {
-    // Read input discretes - FC 4
-    $recData = $modbus->readMultipleInputRegisters(0, 0, 2);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// Read input discretes - FC 4
+	$recData = $modbus->readMultipleInputRegisters(0, 0, 2);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

-var_dump($recData);
+var_dump($recData);
@@ -1,24 +1,23 @@
 <?php

-require_once dirname(__FILE__) . '/../../Phpmodbus/ModbusMasterUdp.php';
+use PHPModbus\ModbusMasterUdp;

 // Create Modbus object
 $modbus = new ModbusMasterUdp("192.192.15.51");

 // Data to be writen - TRUE, FALSE
-$data_true = array(TRUE);
-$data_false = array(FALSE);
+$data_true = array(true);
+$data_false = array(false);

 try {
-    // Write single coil - FC5
-    $modbus->writeSingleCoil(0, 12288, $data_true);
-    $modbus->writeSingleCoil(0, 12289, $data_false);
-    $modbus->writeSingleCoil(0, 12290, $data_true);
-    $modbus->writeSingleCoil(0, 12291, $data_false);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// Write single coil - FC5
+	$modbus->writeSingleCoil(0, 12288, $data_true);
+	$modbus->writeSingleCoil(0, 12289, $data_false);
+	$modbus->writeSingleCoil(0, 12290, $data_true);
+	$modbus->writeSingleCoil(0, 12291, $data_false);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }
@@ -1,26 +1,22 @@
 <?php

-require_once dirname(__FILE__) . '/../Phpmodbus/ModbusMaster.php';
+use PHPModbus\ModbusMaster;

 // Create Modbus object
 $modbus = new ModbusMaster("192.192.15.51", "UDP");

 // Data to be writen
 $data = array(-1000);
-$dataTypes = array("INT");

 try {
-    // FC6
-    $modbus->writeSingleRegister(0, 12288, $data, $dataTypes);
-}
-catch (Exception $e) {
-    // Print error information if any
-    echo $modbus;
-    echo $e;
-    exit;
+	// FC6
+	$modbus->writeSingleRegister(0, 12288, $data);
+} catch (Exception $e) {
+	// Print error information if any
+	echo $modbus;
+	echo $e;
+	exit;
 }

 // Print status information
 echo $modbus;
-
-?>
@@ -8,12 +8,12 @@ namespace PHPModbus;
 * This source file is subject to the "PhpModbus license" that is bundled
 * with this package in the file license.txt.
 *
- * @author Jan Krakora
+ * @author    Jan Krakora
 * @copyright Copyright (c) 2004, 2013 Jan Krakora
- * @license PhpModbus license
- * @category Phpmodbus
- * @package Phpmodbus
- * @version $id$
+ * @license   PhpModbus license
+ * @category  Phpmodbus
+ * @package   Phpmodbus
+ * @version   $id$
 */

 /**
@@ -22,115 +22,120 @@ namespace PHPModbus;
 * The class includes set of IEC-1131 data type functions that converts a PHP
 * data types to a IEC data type.
 *
- * @author Jan Krakora
+ * @author     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
-     *
-     * Converts a value to IEC-1131 BYTE data type
-     *
-     * @param value value from 0 to 255
-     * @return value IEC BYTE data type
-     *
-     */
-    public static function iecBYTE($value) {
-        return chr($value & 0xFF);
-    }
+	/**
+	 * iecINT
+	 *
+	 * Converts a value to IEC-1131 INT data type
+	 *
+	 * @param int $value to be converted
+	 * @return int IEC-1131 INT data type
+	 *
+	 */
+	public static function iecINT($value)
+	{
+		return self::iecBYTE(($value >> 8) & 0x00FF) .
+		self::iecBYTE(($value & 0x00FF));
+	}

-    /**
-     * iecINT
-     *
-     * Converts a value to IEC-1131 INT data type
-     *
-     * @param value value to be converted
-     * @return value IEC-1131 INT data type
-     *
-     */
-    public static function iecINT($value) {
-        return self::iecBYTE(($value >> 8) & 0x00FF) .
-                self::iecBYTE(($value & 0x00FF));
-    }
+	/**
+	 * iecDINT
+	 *
+	 * Converts a value to IEC-1131 DINT data type
+	 *
+	 * @param int $value     to be converted
+	 * @param int $bigEndian defines endian codding (little endian == 0, big endian == 1)
+	 * @return int IEC-1131 INT data type
+	 *
+	 */
+	public static function iecDINT($value, $bigEndian = 0)
+	{
+		// result with right endianness
+		return self::endianness($value, $bigEndian);
+	}

-    /**
-     * iecDINT
-     *
-     * Converts a value to IEC-1131 DINT data type
-     *
-     * @param value value to be converted
-     * @param value endianness defines endian codding (little endian == 0, big endian == 1)
-     * @return value IEC-1131 INT data type
-     *
-     */
-    public static function iecDINT($value, $endianness = 0) {
-        // result with right endianness
-        return self::endianness($value, $endianness);
-    }
+	/**
+	 * iecREAL
+	 *
+	 * Converts a value to IEC-1131 REAL data type. The function uses function  @use float2iecReal.
+	 *
+	 * @param int  $value     to be converted
+	 * @param bool $bigEndian defines endian codding (little endian == 0, big endian == 1)
+	 * @return int IEC-1131 REAL data type
+	 */
+	public static function iecREAL($value, $bigEndian = 0)
+	{
+		// iecREAL representation
+		$real = self::float2iecReal($value);
+		// result with right endianness
+		return self::endianness($real, $bigEndian);
+	}

-    /**
-     * iecREAL
-     *
-     * Converts a value to IEC-1131 REAL data type. The function uses function  @use float2iecReal.
-     *
-     * @param value value to be converted
-     * @param value endianness defines endian codding (little endian == 0, big endian == 1)
-     * @return value IEC-1131 REAL data type
-     */
-    public static function iecREAL($value, $endianness = 0) {
-        // iecREAL representation
-        $real = self::float2iecReal($value);
-        // result with right endianness
-        return self::endianness($real, $endianness);
-    }
-
-    /**
-     * float2iecReal
-     *
-     * This function converts float value to IEC-1131 REAL single precision form.
-     *
-     * 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));
-    }
+	/**
+	 * float2iecReal
+	 *
+	 * This function converts float value to IEC-1131 REAL single precision form.
+	 *
+	 * 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 int 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 $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));
+		}
+	}
 }
-
-?>
@@ -4,47 +4,48 @@ namespace PHPModbus;

 /**
 * Phpmodbus Copyright (c) 2004, 2012 Jan Krakora
- *  
+ *
 * This source file is subject to the "PhpModbus license" that is bundled
 * with this package in the file license.txt.
- *   
+ *
 *
 * @copyright  Copyright (c) 2004, 2012 Jan Krakora
- * @license PhpModbus license 
- * @category Phpmodbus
- * @tutorial Phpmodbus.pkg 
- * @package Phpmodbus 
- * @version $id$
- *  
+ * @license    PhpModbus license
+ * @category   Phpmodbus
+ * @tutorial   Phpmodbus.pkg
+ * @package    Phpmodbus
+ * @version    $id$
+ *
 */

 /**
 * ModbusMasterTcp
 *
 * This class deals with the MODBUS master using TCP. Extends ModbusMaster class.
- *  
+ *
 * Implemented MODBUS functions:
 *   - FC  1: read coils
 *   - FC  3: read multiple registers
- *   - FC 15: write multiple coils 
+ *   - FC 15: write multiple coils
 *   - FC 16: write multiple registers
 *   - FC 23: read write registers
- *   
- * @author Jan Krakora
+ *
+ * @author     Jan Krakora
 * @copyright  Copyright (c) 2004, 2012 Jan Krakora
- * @package Phpmodbus  
+ * @package    Phpmodbus
 *
 */
-class ModbusMasterTcp extends ModbusMaster {
-  /**
-   * ModbusMasterTcp
-   *
-   * 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".
-   */         
-  function ModbusMasterTcp($host){
-    $this->host = $host;
-    $this->socket_protocol = "TCP";
-  }
+class ModbusMasterTcp extends ModbusMaster
+{
+	/**
+	 * ModbusMasterTcp
+	 *
+	 * 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".
+	 */
+	public function __construct($host)
+	{
+		parent::__construct($host, "TCP");
+	}
 }
@@ -4,48 +4,48 @@ namespace PHPModbus;

 /**
 * Phpmodbus Copyright (c) 2004, 2012 Jan Krakora
- *  
+ *
 * This source file is subject to the "PhpModbus license" that is bundled
 * with this package in the file license.txt.
- *   
+ *
 *
 * @copyright  Copyright (c) 2004, 2012 Jan Krakora
- * @license PhpModbus license 
- * @category Phpmodbus
- * @tutorial Phpmodbus.pkg 
- * @package Phpmodbus 
- * @version $id$
- *  
+ * @license    PhpModbus license
+ * @category   Phpmodbus
+ * @tutorial   Phpmodbus.pkg
+ * @package    Phpmodbus
+ * @version    $id$
+ *
 */

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

 namespace PHPModbus;
+use Exception;

 /**
 * 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
 * with this package in the file license.txt.
 *
- * @author Jan Krakora
+ * @author    Jan Krakora
 * @copyright Copyright (c) 2004, 2012 Jan Krakora
- * @license PhpModbus license
- * @category Phpmodbus
- * @package Phpmodbus
- * @version $id$
+ * @license   PhpModbus license
+ * @category  Phpmodbus
+ * @package   Phpmodbus
+ * @version   $id$
 *
 */

@@ -23,230 +24,243 @@ namespace PHPModbus;
 * 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.
 *
- * @author Jan Krakora
+ * @author     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
-     *
-     * 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 $endianness
-     * @return float
-     */
-    public static function bytes2float($values, $endianness = 0) {
-        $data = array();
-        $real = 0;
+	/**
+	 * bytes2signedInt
+	 *
+	 * The function converts array of 2 or 4 bytes to signed integer.
+	 * The return value depends on order of the input bytes (endianning).
+	 *
+	 * @param array $values
+	 * @param bool  $bigEndian
+	 * @return int
+	 */
+	public static function bytes2signedInt($values, $bigEndian = 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);
-        // Combine bytes
-        $real = self::combineBytes($data, $endianness);
-        // Convert the real value to float
-        return (float) self::real2float($real);
-    }
+	/**
+	 * bytes2unsignedInt
+	 *
+	 * The function converts array of 2 or 4 bytes to unsigned integer.
+	 * The return value depends on order of the input bytes (endianning).
+	 *
+	 * @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
-     *
-     * The function converts array of 2 or 4 bytes to signed integer.
-     * The return value depends on order of the input bytes (endianning).
-     *
-     * @param array $values
-     * @param bool $endianness
-     * @return int
-     */
-    public static function bytes2signedInt($values, $endianness = 0) {
-        $data = array();
-        $int = 0;
-        // Set the array to correct form
-        $data = self::checkData($values);
-        // Combine bytes
-        $int = self::combineBytes($data, $endianness);
-        // 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);
-    }
+	/**
+	 * 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  $bigEndian
+	 * @return string
+	 */
+	public static function bytes2string($values, $bigEndian = 0)
+	{
+		// Prepare string variable
+		$str = "";
+		// Parse the received data word array
+		for ($i = 0; $i < count($values); $i += 2) {
+			if ($bigEndian) {
+				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;
+	}

-    /**
-     * bytes2unsignedInt
-     *
-     * The function converts array of 2 or 4 bytes to unsigned integer.
-     * The return value depends on order of the input bytes (endianning).
-     *
-     * @param array $values
-     * @param bool $endianness
-     * @return int|float
-     */
-    public static function bytes2unsignedInt($values, $endianness = 0) {
-        $data = array();
-        $int = 0;
-        // Set the array to correct form
-        $data = self::checkData($values);
-        // Combine bytes
-        $int = self::combineBytes($data, $endianness);
-        // Convert the value
-        return self::dword2unsignedInt($int);
-    }
+	/**
+	 * real2float
+	 *
+	 * 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
+	 * [{@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 int $value in IEC REAL data type to be converted
+	 * @return float float value
+	 */
+	private static function real2float($value)
+	{
+		// get unsigned long
+		$ulong = pack("L", $value);
+		// set float
+		$float = unpack("f", $ulong);

-    /**
-     * 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;
-    }
+		return $float[1];
+	}

-    /**
-     * real2float
-     *
-     * 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
-     * [{@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 value value in IEC REAL data type to be converted
-     * @return float float value
-     */
-    private static function real2float($value) {
-        // get unsigned long
-        $ulong = pack("L", $value);
-        // set float
-        $float = unpack("f", $ulong);
-        
-        return $float[1];
-    }
+	/**
+	 * dword2signedInt
+	 *
+	 * Switch double word to signed integer
+	 *
+	 * @param int $value
+	 * @return int
+	 */
+	private static function dword2signedInt($value)
+	{
+		if ((0x80000000 & $value) != 0) {
+			return -(0x7FFFFFFF & ~$value) - 1;
+		} else {
+			return (0x7FFFFFFF & $value);
+		}
+	}

-    /**
-     * dword2signedInt
-     *
-     * Switch double word to signed integer
-     *
-     * @param int $value
-     * @return int
-     */
-    private static function dword2signedInt($value) {
-        if ((0x80000000 & $value) != 0) {
-            return -(0x7FFFFFFF & ~$value)-1;
-        } else {
-            return (0x7FFFFFFF & $value);
-        }
-    }
+	/**
+	 * dword2signedInt
+	 *
+	 * Switch double word to unsigned integer
+	 *
+	 * @param int $value
+	 * @return int|float
+	 */
+	private static function dword2unsignedInt($value)
+	{
+		if ((0x80000000 & $value) != 0) {
+			return ((float)(0x7FFFFFFF & $value)) + 2147483648;
+		} else {
+			return (int)(0x7FFFFFFF & $value);
+		}
+	}

-    /**
-     * dword2signedInt
-     *
-     * Switch double word to unsigned integer
-     *
-     * @param int $value
-     * @return int|float
-     */
-    private static function dword2unsignedInt($value) {
-        if ((0x80000000 & $value) != 0) {
-            return ((float) (0x7FFFFFFF & $value)) + 2147483648;
-        } else {
-            return (int) (0x7FFFFFFF & $value);
-        }
-    }
+	/**
+	 * checkData
+	 *
+	 * Check if the data variable is array, and check if the values are numeric
+	 *
+	 * @param int[] $data
+	 * @return int
+	 * @throws Exception
+	 */
+	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');
+		}

-    /**
-     * 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;
+	}

-        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));
+		}

-    /**
-     * 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;
-    }
+		return $value;
+	}
 }
-?>
Author	SHA1	Message	Date
MightyPork	4256b6cef7	fixed the examples	2016-11-20 11:29:09 +01:00
MightyPork	61e7a690eb	Minor cleanup, removed duplicate timeout vars & replaced with float [sec], added socket Tout setter	2016-11-18 16:06:15 +01:00
toimtoimtoim	7365700b72	cleanup	2016-11-05 18:00:41 +02:00
toimtoimtoim	cff8493205	refactor timeout_usec to millisecond precision and add setter for ms.	2016-11-05 17:57:19 +02:00
toimtoimtoim	e10bb250d8	Use microsecond precision instead of second for timeout when reading from sockets. Expose variables to configure socket read and write timeouts in sec and usec (microseconds) precision	2016-11-04 22:02:04 +02:00
MightyPork	c18696a718	added myself to composer json	2016-03-11 23:11:21 +01:00
MightyPork	dd5a892fb6	Cleaned up the code, fixed broken phpdoc tags, formatting	2016-03-11 23:08:00 +01:00
MightyPork	7d058ee526	changed name for packagist because it doesnt like uppercase	2016-03-11 22:33:11 +01:00