Create README.md

2013-06-14 08:01:51 -05:00
parent 5bb5dfe654
commit ad507ed46c
1 changed files with 35 additions and 0 deletions
@@ -0,0 +1,35 @@
+phpmodbus
+=========
+This project deals with an implementation of the basic functionality of the Modbus TCP and UDP based protocol using PHP.
+It's a copy of the releases from the project page over at [Google Code](https://code.google.com/p/phpmodbus/) with 
+composer support added.
+
+Features
+--------
+
+* Modbus master
+    * FC1 - Read coils
+    * FC2 - Read input discretes
+    * FC3 - Read holding registers
+    * FC6 - Write single register
+    * FC15 - Write multiple coils
+    * FC16 - Write multiple registers
+    * FC23 - Read/Write multiple registers
+
+Example
+-------
+
+    // 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);