fix setting endian before creating request will create invalid request

aldas · aldas · commit dc10ec75a4bc · 2023-06-14T16:12:05.000+03:00
diff --git a/examples/index.php b/examples/index.php
@@ -15,7 +15,11 @@
 // sudo udevadm control --reload-rules && sudo udevadm trigger
 $deviceURI = '/dev/ttyUSB0'; // do not make this changeable from WEB. This could be serious security risk.
 $isSerialDevice = false; // change to true to enable reading serial devices. this will disable ip/port logic and uses RTU
-if (getenv('MODBUS_SERIAL_ENABLED')) { // can be set from Nginx/Apache fast-cgi conf
+if (getenv('MODBUS_SERIAL_ENABLED')) {
+    // can be set from Nginx/Apache fast-cgi conf
+    // for Nginx add these lines where you PHP is configured:
+    //     fastcgi_param MODBUS_SERIAL_ENABLED true;
+    //     fastcgi_param MODBUS_SERIAL_DEVICE /dev/ttyUSB0;
     $isSerialDevice = filter_var(getenv('MODBUS_SERIAL_ENABLED'), FILTER_VALIDATE_BOOLEAN);
     if ($isSerialDevice && getenv('MODBUS_SERIAL_DEVICE')) {
         $deviceURI = getenv('MODBUS_SERIAL_DEVICE');
diff --git a/src/Packet/ModbusApplicationHeader.php b/src/Packet/ModbusApplicationHeader.php
@@ -6,6 +6,7 @@
 
 use ModbusTcpClient\Exception\InvalidArgumentException;
 use ModbusTcpClient\Exception\ModbusException;
+use ModbusTcpClient\Utils\Endian;
 use ModbusTcpClient\Utils\Types;
 
 /**
@@ -100,8 +101,8 @@ public static function parse(string $binaryString): ModbusApplicationHeader
             throw new ModbusException('Data length too short to be valid header!');
         }
 
-        $transactionId = Types::parseUInt16($binaryString[0] . $binaryString[1]);
-        $length = Types::parseUInt16($binaryString[4] . $binaryString[5]);
+        $transactionId = Types::parseUInt16($binaryString[0] . $binaryString[1], Endian::BIG_ENDIAN);
+        $length = Types::parseUInt16($binaryString[4] . $binaryString[5], Endian::BIG_ENDIAN);
         $unitId = Types::parseByte($binaryString[6]);
 
         return new ModbusApplicationHeader(
diff --git a/src/Packet/ModbusFunction/MaskWriteRegisterRequest.php b/src/Packet/ModbusFunction/MaskWriteRegisterRequest.php
@@ -93,15 +93,15 @@ public function getORMask(): int
      */
     public function getANDMaskAsWord(): Word
     {
-        return new Word(Types::toInt16($this->andMask));
+        return new Word(Types::toInt16($this->andMask, Endian::BIG_ENDIAN));
     }
 
     /**
      * @return Word
      */
     public function getORMaskAsWord(): Word
     {
-        return new Word(Types::toInt16($this->orMask));
+        return new Word(Types::toInt16($this->orMask, Endian::BIG_ENDIAN));
     }
 
     protected function getLengthInternal(): int
diff --git a/src/Packet/ModbusFunction/MaskWriteRegisterResponse.php b/src/Packet/ModbusFunction/MaskWriteRegisterResponse.php
@@ -80,14 +80,14 @@ public function getORMask(): int
      */
     public function getANDMaskAsWord(): Word
     {
-        return new Word(Types::toInt16($this->andMask));
+        return new Word(Types::toInt16($this->andMask, Endian::BIG_ENDIAN));
     }
 
     /**
      * @return Word
      */
     public function getORMaskAsWord(): Word
     {
-        return new Word(Types::toInt16($this->orMask));
+        return new Word(Types::toInt16($this->orMask, Endian::BIG_ENDIAN));
     }
 }
diff --git a/src/Packet/ProtocolDataUnitRequest.php b/src/Packet/ProtocolDataUnitRequest.php
@@ -33,7 +33,7 @@ public function __toString(): string
         return b''
             . $this->getHeader()->__toString()
             . Types::toByte($this->getFunctionCode())
-            . Types::toUint16($this->getStartAddress());
+            . Types::toUint16($this->getStartAddress(), Endian::BIG_ENDIAN);
     }
 
     public function getStartAddress(): int
diff --git a/src/Packet/ResponseFactory.php b/src/Packet/ResponseFactory.php
@@ -16,6 +16,7 @@
 use ModbusTcpClient\Packet\ModbusFunction\WriteMultipleRegistersResponse;
 use ModbusTcpClient\Packet\ModbusFunction\WriteSingleCoilResponse;
 use ModbusTcpClient\Packet\ModbusFunction\WriteSingleRegisterResponse;
+use ModbusTcpClient\Utils\Endian;
 use ModbusTcpClient\Utils\Types;
 
 class ResponseFactory
@@ -40,7 +41,7 @@ public static function parseResponse(string|null $binaryString): ModbusResponse|
             return new ErrorResponse(ModbusApplicationHeader::parse($binaryString), $functionCode, $exceptionCode);
         }
 
-        $transactionId = Types::parseUInt16($binaryString[0] . $binaryString[1]);
+        $transactionId = Types::parseUInt16($binaryString[0] . $binaryString[1], Endian::BIG_ENDIAN);
         $unitId = Types::parseByte($binaryString[6]);
 
         $rawData = substr($binaryString, 8);
diff --git a/src/Packet/StartAddressResponse.php b/src/Packet/StartAddressResponse.php
@@ -4,6 +4,7 @@
 namespace ModbusTcpClient\Packet;
 
 
+use ModbusTcpClient\Utils\Endian;
 use ModbusTcpClient\Utils\Types;
 
 abstract class StartAddressResponse extends ProtocolDataUnit implements ModbusResponse
@@ -16,7 +17,7 @@ abstract class StartAddressResponse extends ProtocolDataUnit implements ModbusRe
     public function __construct(string $rawData, int $unitId = 0, int $transactionId = null)
     {
         parent::__construct($unitId, $transactionId);
-        $this->startAddress = Types::parseUInt16(substr($rawData, 0, 2));
+        $this->startAddress = Types::parseUInt16(substr($rawData, 0, 2), Endian::BIG_ENDIAN);
     }
 
     public function __toString(): string
diff --git a/tests/unit/Packet/ModbusFunction/MaskWriteRegisterRequestTest.php b/tests/unit/Packet/ModbusFunction/MaskWriteRegisterRequestTest.php
@@ -7,11 +7,22 @@
 use ModbusTcpClient\Packet\ModbusFunction\MaskWriteRegisterRequest;
 use ModbusTcpClient\Packet\ModbusPacket;
 use ModbusTcpClient\Packet\Word;
+use ModbusTcpClient\Utils\Endian;
 use ModbusTcpClient\Utils\Types;
 use PHPUnit\Framework\TestCase;
 
 class MaskWriteRegisterRequestTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testOnPacketToString()
     {
         // Field:                    Size in packet
diff --git a/tests/unit/Packet/ModbusFunction/MaskWriteRegisterResponseTest.php b/tests/unit/Packet/ModbusFunction/MaskWriteRegisterResponseTest.php
@@ -5,10 +5,21 @@
 use ModbusTcpClient\Packet\ModbusFunction\MaskWriteRegisterResponse;
 use ModbusTcpClient\Packet\ModbusPacket;
 use ModbusTcpClient\Packet\Word;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class MaskWriteRegisterResponseTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testOnPacketToString()
     {
         // Field:                    Size in packet
diff --git a/tests/unit/Packet/ModbusFunction/ReadCoilsRequestTest.php b/tests/unit/Packet/ModbusFunction/ReadCoilsRequestTest.php
@@ -6,10 +6,21 @@
 use ModbusTcpClient\Packet\ErrorResponse;
 use ModbusTcpClient\Packet\ModbusFunction\ReadCoilsRequest;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadCoilsRequestTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadCoilsResponseTest.php b/tests/unit/Packet/ModbusFunction/ReadCoilsResponseTest.php
@@ -7,17 +7,29 @@
 use ModbusTcpClient\Exception\ParseException;
 use ModbusTcpClient\Packet\ModbusFunction\ReadCoilsResponse;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadCoilsResponseTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
             "\x81\x80\x00\x00\x00\x05\x03\x01\x02\xCD\x6B",
             (new ReadCoilsResponse("\x02\xCD\x6B", 3, 33152))->__toString()
         );
     }
+
     public function testToHex()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadHoldingRegistersRequestTest.php b/tests/unit/Packet/ModbusFunction/ReadHoldingRegistersRequestTest.php
@@ -6,6 +6,7 @@
 use ModbusTcpClient\Packet\ErrorResponse;
 use ModbusTcpClient\Packet\ModbusFunction\ReadHoldingRegistersRequest;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 /*
@@ -25,6 +26,16 @@
 
 class ReadHoldingRegistersRequestTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadHoldingRegistersResponseTest.php b/tests/unit/Packet/ModbusFunction/ReadHoldingRegistersResponseTest.php
@@ -7,10 +7,21 @@
 use ModbusTcpClient\Exception\ParseException;
 use ModbusTcpClient\Packet\ModbusFunction\ReadHoldingRegistersResponse;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadHoldingRegistersResponseTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
@@ -341,7 +352,7 @@ public function testGetAsciiString()
         $packet = (new ReadHoldingRegistersResponse("\x08\x01\x00\xF8\x53\x65\x72\x00\x6E", 3, 33152))->withStartAddress(50);
         $this->assertCount(4, $packet->getWords());
 
-        $this->assertEquals('Søren', $packet->getAsciiStringAt(51, 5));
+        $this->assertEquals('Søren', $packet->getAsciiStringAt(51, 5, Endian::BIG_ENDIAN_LOW_WORD_FIRST));
     }
 
     public function testGetAsciiStringInvalidAddressLow()
diff --git a/tests/unit/Packet/ModbusFunction/ReadInputDiscretesRequestTest.php b/tests/unit/Packet/ModbusFunction/ReadInputDiscretesRequestTest.php
@@ -5,10 +5,21 @@
 use ModbusTcpClient\Packet\ErrorResponse;
 use ModbusTcpClient\Packet\ModbusFunction\ReadInputDiscretesRequest;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadInputDiscretesRequestTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadInputDiscretesResponseTest.php b/tests/unit/Packet/ModbusFunction/ReadInputDiscretesResponseTest.php
@@ -5,10 +5,21 @@
 use ModbusTcpClient\Exception\ParseException;
 use ModbusTcpClient\Packet\ModbusFunction\ReadInputDiscretesResponse;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadInputDiscretesResponseTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadInputRegistersRequestTest.php b/tests/unit/Packet/ModbusFunction/ReadInputRegistersRequestTest.php
@@ -6,10 +6,21 @@
 use ModbusTcpClient\Packet\ErrorResponse;
 use ModbusTcpClient\Packet\ModbusFunction\ReadInputRegistersRequest;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadInputRegistersRequestTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadInputRegistersResponseTest.php b/tests/unit/Packet/ModbusFunction/ReadInputRegistersResponseTest.php
@@ -5,10 +5,21 @@
 use ModbusTcpClient\Exception\ParseException;
 use ModbusTcpClient\Packet\ModbusFunction\ReadInputRegistersResponse;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use PHPUnit\Framework\TestCase;
 
 class ReadInputRegistersResponseTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testPacketToString()
     {
         $this->assertEquals(
diff --git a/tests/unit/Packet/ModbusFunction/ReadWriteMultipleRegistersRequestTest.php b/tests/unit/Packet/ModbusFunction/ReadWriteMultipleRegistersRequestTest.php
@@ -6,11 +6,22 @@
 use ModbusTcpClient\Packet\ErrorResponse;
 use ModbusTcpClient\Packet\ModbusFunction\ReadWriteMultipleRegistersRequest;
 use ModbusTcpClient\Packet\ModbusPacket;
+use ModbusTcpClient\Utils\Endian;
 use ModbusTcpClient\Utils\Types;
 use PHPUnit\Framework\TestCase;
 
 class ReadWriteMultipleRegistersRequestTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Endian::$defaultEndian = Endian::LITTLE_ENDIAN; // packets are big endian. setting to default to little should not change output
+    }
+
+    protected function tearDown(): void
+    {
+        Endian::$defaultEndian = Endian::BIG_ENDIAN_LOW_WORD_FIRST;
+    }
+
     public function testOnPacketToString()
     {
         // Field:                    Size in packet
@@ -32,7 +43,7 @@ public function testOnPacketToString()
                 0x0410,
                 1,
                 0x0112,
-                [Types::toByte(200), Types::toInt16(130)],
+                [Types::toByte(200), Types::toInt16(130, Endian::BIG_ENDIAN_LOW_WORD_FIRST)],
                 0x11,
                 0x0138
             ))->__toString()
@@ -176,7 +187,7 @@ public function testParse()
             0x0410,
             1,
             0x0112,
-            [Types::toByte(200), Types::toInt16(130)],
+            [Types::toByte(200), Types::toInt16(130, Endian::BIG_ENDIAN_LOW_WORD_FIRST)],
             0x11,
             0x0138
         ))->__toString());
diff --git a/tests/unit/Packet/ModbusFunction/ReadWriteMultipleRegistersResponseTest.php b/tests/unit/Packet/ModbusFunction/ReadWriteMultipleRegistersResponseTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteMultipleCoilsRequestTest.php b/tests/unit/Packet/ModbusFunction/WriteMultipleCoilsRequestTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteMultipleCoilsResponseTest.php b/tests/unit/Packet/ModbusFunction/WriteMultipleCoilsResponseTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteMultipleRegistersRequestTest.php b/tests/unit/Packet/ModbusFunction/WriteMultipleRegistersRequestTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteMultipleRegistersResponseTest.php b/tests/unit/Packet/ModbusFunction/WriteMultipleRegistersResponseTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteSingleCoilRequestTest.php b/tests/unit/Packet/ModbusFunction/WriteSingleCoilRequestTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteSingleCoilResponseTest.php b/tests/unit/Packet/ModbusFunction/WriteSingleCoilResponseTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteSingleRegisterRequestTest.php b/tests/unit/Packet/ModbusFunction/WriteSingleRegisterRequestTest.php
diff --git a/tests/unit/Packet/ModbusFunction/WriteSingleRegisterResponseTest.php b/tests/unit/Packet/ModbusFunction/WriteSingleRegisterResponseTest.php

Original file line number	Diff line number	Diff line change
`@@ -93,15 +93,15 @@ public function getORMask(): int`
`93`	`93`	`*/`
`94`	`94`	`public function getANDMaskAsWord(): Word`
`95`	`95`	`{`
`96`		`- return new Word(Types::toInt16($this->andMask));`
	`96`	`+ return new Word(Types::toInt16($this->andMask, Endian::BIG_ENDIAN));`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`/**`
`100`	`100`	`* @return Word`
`101`	`101`	`*/`
`102`	`102`	`public function getORMaskAsWord(): Word`
`103`	`103`	`{`
`104`		`- return new Word(Types::toInt16($this->orMask));`
	`104`	`+ return new Word(Types::toInt16($this->orMask, Endian::BIG_ENDIAN));`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`protected function getLengthInternal(): int`
Original file line number	Diff line number	Diff line change
`@@ -80,14 +80,14 @@ public function getORMask(): int`
`80`	`80`	`*/`
`81`	`81`	`public function getANDMaskAsWord(): Word`
`82`	`82`	`{`
`83`		`- return new Word(Types::toInt16($this->andMask));`
	`83`	`+ return new Word(Types::toInt16($this->andMask, Endian::BIG_ENDIAN));`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`/**`
`87`	`87`	`* @return Word`
`88`	`88`	`*/`
`89`	`89`	`public function getORMaskAsWord(): Word`
`90`	`90`	`{`
`91`		`- return new Word(Types::toInt16($this->orMask));`
	`91`	`+ return new Word(Types::toInt16($this->orMask, Endian::BIG_ENDIAN));`
`92`	`92`	`}`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function __toString(): string`
`33`	`33`	`return b''`
`34`	`34`	`. $this->getHeader()->__toString()`
`35`	`35`	`. Types::toByte($this->getFunctionCode())`
`36`		`- . Types::toUint16($this->getStartAddress());`
	`36`	`+ . Types::toUint16($this->getStartAddress(), Endian::BIG_ENDIAN);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`public function getStartAddress(): int`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`namespace ModbusTcpClient\Packet;`
`5`	`5`
`6`	`6`
	`7`	`+use ModbusTcpClient\Utils\Endian;`
`7`	`8`	`use ModbusTcpClient\Utils\Types;`
`8`	`9`
`9`	`10`	`abstract class StartAddressResponse extends ProtocolDataUnit implements ModbusResponse`
`@@ -16,7 +17,7 @@ abstract class StartAddressResponse extends ProtocolDataUnit implements ModbusRe`
`16`	`17`	`public function __construct(string $rawData, int $unitId = 0, int $transactionId = null)`
`17`	`18`	`{`
`18`	`19`	`parent::__construct($unitId, $transactionId);`
`19`		`- $this->startAddress = Types::parseUInt16(substr($rawData, 0, 2));`
	`20`	`+ $this->startAddress = Types::parseUInt16(substr($rawData, 0, 2), Endian::BIG_ENDIAN);`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public function __toString(): string`