commit 0939c32c584a73012083b1a964ad9da9ff698988 Author: Wolfgang Hottgenroth Date: Thu Dec 15 15:26:57 2022 +0100 initial diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6fd3c73 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +sketch/build/ diff --git a/libraries/ArduinoModbus/README.adoc b/libraries/ArduinoModbus/README.adoc new file mode 100644 index 0000000..7221642 --- /dev/null +++ b/libraries/ArduinoModbus/README.adoc @@ -0,0 +1,41 @@ +// Define the repository information in these attributes +:repository-owner: arduino-libraries +:repository-name: ArduinoModbus + += Modbus Library for Arduino = + +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] + +Use http://www.modbus.org/[Modbus] with your Arduino. + +Using TCP or RS485 shields, like the MKR 485 Shield. This library depends on the ArduinoRS485 library. + +This library is based on https://github.com/stephane/libmodbus[libmodbus], modifications were made to the lower level RS485 and TCP layers to use Arduino Serial/RS485 and Client API's. Then an Arduino friendly API was added on top. + +For more information about this library please visit us at +https://www.arduino.cc/en/ArduinoModbus/ArduinoModbus + +== Useful resources == + +* https://en.wikipedia.org/wiki/Modbus[Modbus - Wikipedia] +* http://www.modbus.org/faq.php[Modbus FAQ] + +== License == + +Copyright (c) 2018 Arduino SA. All rights reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/libraries/ArduinoModbus/docs/api.md b/libraries/ArduinoModbus/docs/api.md new file mode 100644 index 0000000..48e1b3c --- /dev/null +++ b/libraries/ArduinoModbus/docs/api.md @@ -0,0 +1,837 @@ +# Arduino Modbus Library + +## Modbus Client + +### `client.coilRead()` + +#### Description + +Perform a "Read Coils" operation for the specified address for a single coil. + +#### Syntax + +``` +int coilRead(int address); +int coilRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +coil value on success, -1 on failure. + +### `client.discreteInputRead()` + +#### Description + +Perform a "Read Discrete Inputs" operation for the specified address for a single discrete input. + +#### Syntax + +``` +int discreteInputRead(int address); +int discreteInputRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +discrete input value on success, -1 on failure. + +### `client.holdingRegisterRead()` + +#### Description + +Perform a "Read Holding Registers" operation for a single holding register. + +#### Syntax + +``` +long holdingRegisterRead(int address); +long holdingRegisterRead(int id, int address); +``` + +#### Parameters + +- id (slave) - id of target, defaults to 0x00 if not specified +- address start address to use for operation +- holding register value on success, -1 on failure. + +### `client.inputRegisterRead()` + +#### Description + +Perform a "Read Input Registers" operation for a single input register. + +#### Syntax + +``` +long inputRegisterRead(int address); +long inputRegisterRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +input register value on success, -1 on failure. + +### `client.coilWrite()` + +#### Description + +Perform a "Write Single Coil" operation for the specified address and value. + +#### Syntax + +``` +int coilWrite(int address, uint8_t value); +int coilWrite(int id, int address, uint8_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value coi -l value to write + + +#### Returns +1 on success, 0 on failure. + +### `client.holdingRegisterWrite()` + +#### Description + +Perform a "Write Single Holding Register" operation for the specified address and value. + +#### Syntax + +``` +int holdingRegisterWrite(int address, uint16_t value); +int holdingRegisterWrite(int id, int address, uint16_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value - holding register value to write + + +#### Returns +1 on success, 0 on failure. + +### `client.registerMaskWrite()` + +#### Description + +Perform a "Mask Write Registers" operation for the specified address, AND mask and OR mask. + +#### Syntax + +``` +int registerMaskWrite(int address, uint16_t andMask, uint16_t orMask); +int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- andMask - AND mask to use for operation +- orMask - OR mask to use for operation + + +#### Returns +1 on success, 0 on failure. + +### `client.beginTransmission()` + +#### Description + +Begin the process of a writing multiple coils or holding registers. +Use write(value) to set the values you want to send, and endTransmission() to send request on the wire. + +#### Syntax + +``` +int beginTransmission(int type, int address, int nb); +int beginTransmission(int id, int type, int address, int nb); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- type - type of write to perform, either COILS or HOLDING_REGISTERS +- address start address to use for operation +- nb - number of values to write + + +#### Returns +1 on success, 0 on failure + +### `client.write()` + +#### Description + +Set the values of a write operation started by beginTransmission(...). + +#### Syntax + +``` +int write(unsigned int value); +``` + +#### Parameters +- value - value to write + + +#### Returns +1 on success, 0 on failure + +### `client.endTransmission()` + +#### Description + +End the process of a writing multiple coils or holding registers. + +#### Syntax + +``` +int endTransmission(); +``` + +#### Parameters +none + + +#### Returns +1 on success, 0 on failure + +### `client.requestFrom()` + +#### Description + +Read multiple coils, discrete inputs, holding registers, or input register values. +Use available() and read() to process the read values. + +#### Syntax + +``` +int requestFrom(int type, int address, int nb); +int requestFrom(int id, int type, int address,int nb); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +type - type of read to perform, either COILS, DISCRETE_INPUTS, HOLDING_REGISTERS, or INPUT_REGISTERS +- address start address to use for operation +- nb - number of values to read + + +#### Returns +0 on failure, number of values read on success + +### `client.available()` + +#### Description + +Query the number of values available to read after calling requestFrom(...) + +#### Syntax + +``` +int available(); +``` + +#### Parameters +none + + +#### Returns +number of values available for reading use read() + +### `client.read()` + +#### Description + +Read a value after calling requestFrom(...) + +#### Syntax + +``` +long read(); +``` + +#### Parameters +None + + +#### Returns +-1 on failure, value on success + +### `client.lastError()` + +#### Description + +Read the last error reason as a string + +#### Syntax + +``` +const char* lastError(); +``` + +#### Parameters +none + + +#### Returns +Last error reason as a C string + +### `client.end()` + +#### Description + +Stop the client and clean up + +#### Syntax + +``` +void end(); +``` + +#### Parameters +None + + +#### Returns +nothing + +## ModbusRTUClient Class + +### `modbusRTUClient.begin()` + +#### Description + +Start the Modbus RTU client with the specified parameters. + +#### Syntax + +``` +ModbusRTUClient.begin(baudrate); +ModbusRTUClient.begin(baudrate, config); +``` + +#### Parameters +- baudrate - Baud rate to use for serial +- config - Config to use for serial (see Serial.begin(...) for more info.) defaults to SERIAL_8N1 if not provided + + +#### Returns +1 on success, 0 on failure + +## ModbusTCPClient Class + +### `ModbusTCPClient()` + +#### Description + +Creates a Modbus TCP client using the provided Client for the transport. + +#### Syntax + +``` +ModbusTCPClient(client); +``` + +#### Parameters +- Client - to use for the transport + +### `modbusTCPClient.begin()` + +#### Description + +Start the Modbus TCP client with the specified parameters. + +#### Syntax + +``` +modbusTCPClient.begin(ip, port); +``` + +#### Parameters +- ip - the IP Address the client will connect to +- port - port to the client will connect to + + +#### Returns +1 on success, 0 on failure + +### `modbusTCPClient.connected()` + +#### Description + +Returns the connection status. + +#### Syntax + +``` +modbusTCPClient.connected(); +``` + +#### Parameters +None + + +#### Returns +Returns true if the client is connected, false if not. + +### `modbusTCPClient.stop()` + +#### Description + +Disconnect from the server. + +#### Syntax + +``` +modbusTCPClient.stop(); +``` + +#### Parameters +None + + +#### Returns +Nothing + +## ModbusServer Class + +### `modbusServer.configureCoils()` + +#### Description + +Configure the servers coils. + +#### Syntax + +``` +int configureCoils(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of coils +- nb - number of coils to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.configureDiscreteInputs()` + +#### Description + +Configure the servers discrete inputs. + +#### Syntax + +``` +int configureDiscreteInputs(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of discrete inputs +- nb - number of discrete inputs to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.configureHoldingRegisters()` + +#### Description + +Configure the servers holding registers. + +#### Syntax + +``` +int configureHoldingRegisters(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of holding registers +- nb - number of holding registers to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.configureInputRegisters()` + +#### Description + +Configure the servers input registers. + +#### Syntax + +``` +int configureInputRegisters(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of input registers +- nb - number of input registers to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.coilRead()` + +#### Description + +Perform a "Read Coils" operation for the specified address for a single coil. + +#### Syntax + +``` +int coilRead(int address); +int coilRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +coil value on success, -1 on failure. + +### `modbusServer.discreteInputRead()` + +#### Description + +Perform a "Read Discrete Inputs" operation for the specified address for a single discrete input. + +#### Syntax + +``` +int discreteInputRead(int address); +int discreteInputRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +discrete input value on success, -1 on failure. + +### `modbusServer.holdingRegisterRead()` + +#### Description + +Perform a "Read Holding Registers" operation for a single holding register. + +#### Syntax + +``` +long holdingRegisterRead(int address); +long holdingRegisterRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address start address to use for operation +- holding register value on success, -1 on failure. + +### `modbusServer.inputRegisterRead()` + +#### Description + +Perform a "Read Input Registers" operation for a single input register. + +#### Syntax + +``` +long inputRegisterRead(int address); +long inputRegisterRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +input register value on success, -1 on failure. + +### `modbusServer.coilWrite()` + +#### Description + +Perform a "Write Single Coil" operation for the specified address and value. + +#### Syntax + +``` +int coilWrite(int address, uint8_t value); +int coilWrite(int id, int address, uint8_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value coi -l value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.holdingRegisterWrite()` + +#### Description + +Perform a "Write Single Holding Register" operation for the specified address and value. + +#### Syntax + +``` +int holdingRegisterWrite(int address, uint16_t value); +int holdingRegisterWrite(int id, int address, uint16_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value - holding register value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.registerMaskWrite()` + +#### Description + +Perform a "Mask Write Registers" operation for the specified address, AND mask and OR mask. + +#### Syntax +``` +int registerMaskWrite(int address, uint16_t andMask, uint16_t orMask); +int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- andMask - AND mask to use for operation +- orMask - OR mask to use for operation + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.discreteInputWrite()` + +#### Description + +Write the value of the server's Discrete Input for the specified address and value. + +#### Syntax + +``` +int discreteInputWrite(int address, uint8_t value); +``` + +#### Parameters +- address address to use for operation +- value - discrete input value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.writeDiscreteInputs()` + +#### Description + +Write values to the server's Discrete Inputs for the specified address and values. + +#### Syntax + +``` +int writeDiscreteInputs(int address, uint8_t values[], int nb); +``` + +#### Parameters +- address address to use for operation +- values - array of discrete inputs values to write +- nb - number of discrete inputs to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.inputRegisterWrite()` + +#### Description + +Write the value of the server's Input Register for the specified address and value. + +#### Syntax + +``` +int inputRegisterWrite(int address, uint16_t value); +``` + +#### Parameters +- address address to use for operation +- value - input register value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.writeInputRegisters()` + +#### Description + +Write values to the server's Input Registers for the specified address and values. + +#### Syntax + +``` +int writeInputRegisters(int address, uint16_t values[], int nb); +``` + +#### Parameters +- address address to use for operation +- values - array of input registers values to write +- nb - number of input registers to write + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.poll()` + +#### Description + +Poll for requests + +#### Syntax + +``` +virtual void poll() = 0; +``` + +#### Parameters +None + +#### Returns +nothing + +### `modbusServer.end()` + +#### Description + +Stop the server + +#### Syntax + +``` +void end(); +``` + +#### Parameters +None + +#### Return +nothing + +## ModbusRTUServer Class + +### `modbusRTUServer.begin()` + +#### Description + +Start the Modbus RTU server with the specified parameters. + +#### Syntax + +``` +ModbusRTUServer.begin(id, baudrate); +ModbusRTUServer.begin(id, baudrate, config); +``` + +#### Parameters +- id - (slave) id of the server baudrate - Baud rate to use for serial +- config - Config to use for serial (see Serial.begin(...) for more info.) defaults to SERIAL_8N1 if not provided + + +#### Returns +1 on success, 0 on failure + +## ModbusTCPServer + +### `ModbusTCPServer()` + +#### Description + +Creates a Modbus TCP server. + +#### Syntax + +``` +ModbusTCPServer(); +``` + +#### Parameters +None + +### `modbusTCPServer.begin()` + +#### Description + +Start the Modbus TCP server. + +#### Syntax + +``` +modbusTCPserver.begin(); +modbusTCPserver.begin(id); +``` + +#### Parameters +- id - the (slave) id of the server, defaults to 0xff (TCP); + + +#### Returns +1 on success, 0 on failure + +### `modbusTCPServer.accept()` + +#### Description + +Accept a client connection. + +#### Syntax + +``` +modbusTCPserver.accept(client); +``` + +#### Parameters +- client - the Client to accept a connection from; + + +#### Returns +Nothing diff --git a/libraries/ArduinoModbus/docs/readme.md b/libraries/ArduinoModbus/docs/readme.md new file mode 100644 index 0000000..c1ae8bd --- /dev/null +++ b/libraries/ArduinoModbus/docs/readme.md @@ -0,0 +1,20 @@ +# Arduino Modbus Library + +This library implements the [Modbus protocol](https://en.wikipedia.org/wiki/Modbus) over two different types of transport: serial communication over RS485 with RTU (Remote Terminal Unit) or Ethernet and WiFi communication with TCP protocol. There are a few differences in the APIs depending on the transport, but the majority of the functions are the same for both. +Modbus is also a client server protocol where Client = master and Server = slave in Modbus terminilogy; we suggest to read some papers about this protocol if you don't have any former experience because it is based heavily on some formal conventions. + +We have organized this reference so that you find the common functions of both transports together and only the transport related functions are given individually. As a rule of thumb, RTU communication is multipoint and therefore the ID of the unit involved in the communication needs to be specified. TCP is point to point using the IP address and therefore there is no need for an ID in the parameters. + +The library is available in our Library Manager; it is compatible with our [MKR RS485 Shield](https://store.arduino.cc/products/arduino-mkr-485-shield) and with our network enabled products like the [Ethernet shield](https://store-usa.arduino.cc/products/arduino-ethernet-shield-2), the MKR family of boards and the [Arduino UNO WiFi Rev 2](https://store.arduino.cc/products/arduino-uno-wifi-rev2) just to name a few. + +To use this library: + +``` +#include +``` + +## Further readings + +- [Modbus Tutorial from Control Solutions](https://www.csimn.com/CSI_pages/Modbus101.html) +- [Modbus Application Protocol (PDF)](http://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b3.pdf) +- [Modbus FAQ](https://modbus.org/faq.php) \ No newline at end of file diff --git a/libraries/ArduinoModbus/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino b/libraries/ArduinoModbus/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino new file mode 100644 index 0000000..397a382 --- /dev/null +++ b/libraries/ArduinoModbus/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino @@ -0,0 +1,183 @@ +/* + Modbus RTU Client Kitchen Sink + + This sketch creates a Modbus RTU Client and demonstrates + how to use various Modbus Client APIs. + + Circuit: + - MKR board + - MKR 485 shield + - ISO GND connected to GND of the Modbus RTU server + - Y connected to A/Y of the Modbus RTU server + - Z connected to B/Z of the Modbus RTU server + - Jumper positions + - FULL set to OFF + - Z \/\/ Y set to ON + + created 18 July 2018 + by Sandeep Mistry +*/ + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +int counter = 0; + +void setup() { + Serial.begin(9600); + while (!Serial); + + Serial.println("Modbus RTU Client Kitchen Sink"); + + // start the Modbus RTU client + if (!ModbusRTUClient.begin(9600)) { + Serial.println("Failed to start Modbus RTU Client!"); + while (1); + } +} + +void loop() { + writeCoilValues(); + + readCoilValues(); + + readDiscreteInputValues(); + + writeHoldingRegisterValues(); + + readHoldingRegisterValues(); + + readInputRegisterValues(); + + counter++; + + delay(5000); + Serial.println(); +} + +void writeCoilValues() { + // set the coils to 1 when counter is odd + byte coilValue = ((counter % 2) == 0) ? 0x00 : 0x01; + + Serial.print("Writing Coil values ... "); + + // write 10 Coil values to (slave) id 42, address 0x00 + ModbusRTUClient.beginTransmission(42, COILS, 0x00, 10); + for (int i = 0; i < 10; i++) { + ModbusRTUClient.write(coilValue); + } + if (!ModbusRTUClient.endTransmission()) { + Serial.print("failed! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.println("success"); + } + + // Alternatively, to write a single Coil value use: + // ModbusRTUClient.coilWrite(...) +} + +void readCoilValues() { + Serial.print("Reading Coil values ... "); + + // read 10 Coil values from (slave) id 42, address 0x00 + if (!ModbusRTUClient.requestFrom(42, COILS, 0x00, 10)) { + Serial.print("failed! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.println("success"); + + while (ModbusRTUClient.available()) { + Serial.print(ModbusRTUClient.read()); + Serial.print(' '); + } + Serial.println(); + } + + // Alternatively, to read a single Coil value use: + // ModbusRTUClient.coilRead(...) +} + +void readDiscreteInputValues() { + Serial.print("Reading Discrete Input values ... "); + + // read 10 Discrete Input values from (slave) id 42, address 0x00 + if (!ModbusRTUClient.requestFrom(42, DISCRETE_INPUTS, 0x00, 10)) { + Serial.print("failed! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.println("success"); + + while (ModbusRTUClient.available()) { + Serial.print(ModbusRTUClient.read()); + Serial.print(' '); + } + Serial.println(); + } + + // Alternatively, to read a single Discrete Input value use: + // ModbusRTUClient.discreteInputRead(...) +} + +void writeHoldingRegisterValues() { + // set the Holding Register values to counter + + Serial.print("Writing Holding Registers values ... "); + + // write 10 coil values to (slave) id 42, address 0x00 + ModbusRTUClient.beginTransmission(42, HOLDING_REGISTERS, 0x00, 10); + for (int i = 0; i < 10; i++) { + ModbusRTUClient.write(counter); + } + if (!ModbusRTUClient.endTransmission()) { + Serial.print("failed! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.println("success"); + } + + // Alternatively, to write a single Holding Register value use: + // ModbusRTUClient.holdingRegisterWrite(...) +} + +void readHoldingRegisterValues() { + Serial.print("Reading Input Register values ... "); + + // read 10 Input Register values from (slave) id 42, address 0x00 + if (!ModbusRTUClient.requestFrom(42, HOLDING_REGISTERS, 0x00, 10)) { + Serial.print("failed! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.println("success"); + + while (ModbusRTUClient.available()) { + Serial.print(ModbusRTUClient.read()); + Serial.print(' '); + } + Serial.println(); + } + + // Alternatively, to read a single Holding Register value use: + // ModbusRTUClient.holdingRegisterRead(...) +} + +void readInputRegisterValues() { + Serial.print("Reading input register values ... "); + + // read 10 discrete input values from (slave) id 42, + if (!ModbusRTUClient.requestFrom(42, INPUT_REGISTERS, 0x00, 10)) { + Serial.print("failed! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.println("success"); + + while (ModbusRTUClient.available()) { + Serial.print(ModbusRTUClient.read()); + Serial.print(' '); + } + Serial.println(); + } + + // Alternatively, to read a single Input Register value use: + // ModbusRTUClient.inputRegisterRead(...) +} diff --git a/libraries/ArduinoModbus/examples/RTU/ModbusRTUClientToggle/ModbusRTUClientToggle.ino b/libraries/ArduinoModbus/examples/RTU/ModbusRTUClientToggle/ModbusRTUClientToggle.ino new file mode 100644 index 0000000..266bd16 --- /dev/null +++ b/libraries/ArduinoModbus/examples/RTU/ModbusRTUClientToggle/ModbusRTUClientToggle.ino @@ -0,0 +1,55 @@ +/* + Modbus RTU Client Toggle + + This sketch toggles the coil of a Modbus RTU server connected via RS485 + on and off every second. + + Circuit: + - MKR board + - MKR 485 shield + - ISO GND connected to GND of the Modbus RTU server + - Y connected to A/Y of the Modbus RTU server + - Z connected to B/Z of the Modbus RTU server + - Jumper positions + - FULL set to OFF + - Z \/\/ Y set to ON + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +void setup() { + Serial.begin(9600); + while (!Serial); + + Serial.println("Modbus RTU Client Toggle"); + + // start the Modbus RTU client + if (!ModbusRTUClient.begin(9600)) { + Serial.println("Failed to start Modbus RTU Client!"); + while (1); + } +} + +void loop() { + // for (slave) id 1: write the value of 0x01, to the coil at address 0x00 + if (!ModbusRTUClient.coilWrite(1, 0x00, 0x01)) { + Serial.print("Failed to write coil! "); + Serial.println(ModbusRTUClient.lastError()); + } + + // wait for 1 second + delay(1000); + + // for (slave) id 1: write the value of 0x00, to the coil at address 0x00 + if (!ModbusRTUClient.coilWrite(1, 0x00, 0x00)) { + Serial.print("Failed to write coil! "); + Serial.println(ModbusRTUClient.lastError()); + } + + // wait for 1 second + delay(1000); +} diff --git a/libraries/ArduinoModbus/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino b/libraries/ArduinoModbus/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino new file mode 100644 index 0000000..832f05b --- /dev/null +++ b/libraries/ArduinoModbus/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino @@ -0,0 +1,71 @@ +/* + Modbus RTU Server Kitchen Sink + + This sketch creates a Modbus RTU Server and demonstrates + how to use various Modbus Server APIs. + + Circuit: + - MKR board + - MKR 485 shield + - ISO GND connected to GND of the Modbus RTU server + - Y connected to A/Y of the Modbus RTU client + - Z connected to B/Z of the Modbus RTU client + - Jumper positions + - FULL set to OFF + - Z \/\/ Y set to OFF + + created 18 July 2018 + by Sandeep Mistry +*/ + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +const int numCoils = 10; +const int numDiscreteInputs = 10; +const int numHoldingRegisters = 10; +const int numInputRegisters = 10; + +void setup() { + Serial.begin(9600); + while (!Serial); + + Serial.println("Modbus RTU Server Kitchen Sink"); + + // start the Modbus RTU server, with (slave) id 42 + if (!ModbusRTUServer.begin(42, 9600)) { + Serial.println("Failed to start Modbus RTU Server!"); + while (1); + } + + // configure coils at address 0x00 + ModbusRTUServer.configureCoils(0x00, numCoils); + + // configure discrete inputs at address 0x00 + ModbusRTUServer.configureDiscreteInputs(0x00, numDiscreteInputs); + + // configure holding registers at address 0x00 + ModbusRTUServer.configureHoldingRegisters(0x00, numHoldingRegisters); + + // configure input registers at address 0x00 + ModbusRTUServer.configureInputRegisters(0x00, numInputRegisters); +} + +void loop() { + // poll for Modbus RTU requests + ModbusRTUServer.poll(); + + // map the coil values to the discrete input values + for (int i = 0; i < numCoils; i++) { + int coilValue = ModbusRTUServer.coilRead(i); + + ModbusRTUServer.discreteInputWrite(i, coilValue); + } + + // map the holding register values to the input register values + for (int i = 0; i < numHoldingRegisters; i++) { + long holdingRegisterValue = ModbusRTUServer.holdingRegisterRead(i); + + ModbusRTUServer.inputRegisterWrite(i, holdingRegisterValue); + } +} diff --git a/libraries/ArduinoModbus/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino b/libraries/ArduinoModbus/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino new file mode 100644 index 0000000..07a059b --- /dev/null +++ b/libraries/ArduinoModbus/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino @@ -0,0 +1,61 @@ +/* + Modbus RTU Server LED + + This sketch creates a Modbus RTU Server with a simulated coil. + The value of the simulated coil is set on the LED + + Circuit: + - MKR board + - MKR 485 shield + - ISO GND connected to GND of the Modbus RTU server + - Y connected to A/Y of the Modbus RTU client + - Z connected to B/Z of the Modbus RTU client + - Jumper positions + - FULL set to OFF + - Z \/\/ Y set to OFF + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +const int ledPin = LED_BUILTIN; + +void setup() { + Serial.begin(9600); + + Serial.println("Modbus RTU Server LED"); + + // start the Modbus RTU server, with (slave) id 1 + if (!ModbusRTUServer.begin(1, 9600)) { + Serial.println("Failed to start Modbus RTU Server!"); + while (1); + } + + // configure the LED + pinMode(ledPin, OUTPUT); + digitalWrite(ledPin, LOW); + + // configure a single coil at address 0x00 + ModbusRTUServer.configureCoils(0x00, 1); +} + +void loop() { + // poll for Modbus RTU requests + int packetReceived = ModbusRTUServer.poll(); + + if(packetReceived) { + // read the current value of the coil + int coilValue = ModbusRTUServer.coilRead(0x00); + + if (coilValue) { + // coil value set, turn LED on + digitalWrite(ledPin, HIGH); + } else { + // coil value clear, turn LED off + digitalWrite(ledPin, LOW); + } + } +} diff --git a/libraries/ArduinoModbus/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino b/libraries/ArduinoModbus/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino new file mode 100644 index 0000000..323e55a --- /dev/null +++ b/libraries/ArduinoModbus/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino @@ -0,0 +1,65 @@ +/* + Modbus RTU Temperature Sensor + + This sketch shows you how to interact with a Modbus RTU temperature and humidity sensor. + It reads the temperature and humidity values every 5 seconds and outputs them to the + serial monitor. + + Circuit: + - MKR board + - Winners® Modbus RS485 Temperature and Humidity: + https://www.banggood.com/Modbus-RS485-Temperature-and-Humidity-Transmitter-Sensor-High-Precision-Monitoring-p-1159961.html?cur_warehouse=CN + - External 9-36 V power Supply + - MKR 485 shield + - ISO GND connected to GND of the Modbus RTU sensor and the Power supply V- + - Power supply V+ connected to V+ sensor + - Y connected to A/Y of the Modbus RTU sensor + - Z connected to B/Z of the Modbus RTU sensor + - Jumper positions + - FULL set to OFF + - Z \/\/ Y set to ON + + created 8 August 2018 + by Riccardo Rizzo +*/ + +#include + +float temperature; +float humidity; + +void setup() { + Serial.begin(9600); + while (!Serial); + + Serial.println("Modbus Temperature Humidity Sensor"); + // start the Modbus RTU client + if (!ModbusRTUClient.begin(9600)) { + Serial.println("Failed to start Modbus RTU Client!"); + while (1); + } +} + +void loop() { + + // send a Holding registers read request to (slave) id 1, for 2 registers + if (!ModbusRTUClient.requestFrom(1, HOLDING_REGISTERS, 0x00, 2)) { + Serial.print("failed to read registers! "); + Serial.println(ModbusRTUClient.lastError()); + } else { + // If the request succeeds, the sensor sends the readings, that are + // stored in the holding registers. The read() method can be used to + // get the raw temperature and the humidity values. + short rawtemperature = ModbusRTUClient.read(); + short rawhumidity = ModbusRTUClient.read(); + + // To get the temperature in Celsius and the humidity reading as + // a percentage, divide the raw value by 10.0. + temperature = rawtemperature / 10.0; + humidity = rawhumidity / 10.0; + Serial.println(temperature); + Serial.println(humidity); + } + + delay(5000); +} diff --git a/libraries/ArduinoModbus/examples/TCP/EthernetModbusClientToggle/EthernetModbusClientToggle.ino b/libraries/ArduinoModbus/examples/TCP/EthernetModbusClientToggle/EthernetModbusClientToggle.ino new file mode 100644 index 0000000..a15ae11 --- /dev/null +++ b/libraries/ArduinoModbus/examples/TCP/EthernetModbusClientToggle/EthernetModbusClientToggle.ino @@ -0,0 +1,87 @@ +/* + Ethernet Modbus TCP Client Toggle + + This sketch toggles the coil of a Modbus TCP server connected + on and off every second. + + Circuit: + - Any Arduino MKR Board + - MKR ETH Shield + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include +#include + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +// Enter a MAC address for your controller below. +// Newer Ethernet shields have a MAC address printed on a sticker on the shield +// The IP address will be dependent on your local network: +byte mac[] = { + 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED +}; +IPAddress ip(192, 168, 1, 177); + +EthernetClient ethClient; +ModbusTCPClient modbusTCPClient(ethClient); + +IPAddress server(192, 168, 1, 10); // update with the IP Address of your Modbus server + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // start the Ethernet connection and the server: + Ethernet.begin(mac, ip); + + // Check for Ethernet hardware present + if (Ethernet.hardwareStatus() == EthernetNoHardware) { + Serial.println("Ethernet shield was not found. Sorry, can't run without hardware. :("); + while (true) { + delay(1); // do nothing, no point running without Ethernet hardware + } + } + if (Ethernet.linkStatus() == LinkOFF) { + Serial.println("Ethernet cable is not connected."); + } +} + +void loop() { + if (!modbusTCPClient.connected()) { + // client not connected, start the Modbus TCP client + Serial.println("Attempting to connect to Modbus TCP server"); + + if (!modbusTCPClient.begin(server, 502)) { + Serial.println("Modbus TCP Client failed to connect!"); + } else { + Serial.println("Modbus TCP Client connected"); + } + } else { + // client connected + + // write the value of 0x01, to the coil at address 0x00 + if (!modbusTCPClient.coilWrite(0x00, 0x01)) { + Serial.print("Failed to write coil! "); + Serial.println(modbusTCPClient.lastError()); + } + + // wait for 1 second + delay(1000); + + // write the value of 0x00, to the coil at address 0x00 + if (!modbusTCPClient.coilWrite(0x00, 0x00)) { + Serial.print("Failed to write coil! "); + Serial.println(modbusTCPClient.lastError()); + } + + // wait for 1 second + delay(1000); + } +} diff --git a/libraries/ArduinoModbus/examples/TCP/EthernetModbusServerLED/EthernetModbusServerLED.ino b/libraries/ArduinoModbus/examples/TCP/EthernetModbusServerLED/EthernetModbusServerLED.ino new file mode 100644 index 0000000..bedc2b7 --- /dev/null +++ b/libraries/ArduinoModbus/examples/TCP/EthernetModbusServerLED/EthernetModbusServerLED.ino @@ -0,0 +1,116 @@ +/* + Ethernet Modbus TCP Server LED + + This sketch creates a Modbus TCP Server with a simulated coil. + The value of the simulated coil is set on the LED + + Circuit: + - Any Arduino MKR Board + - MKR ETH Shield + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include +#include + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +// Enter a MAC address for your controller below. +// Newer Ethernet shields have a MAC address printed on a sticker on the shield +// The IP address will be dependent on your local network: +byte mac[] = { + 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED +}; +IPAddress ip(192, 168, 1, 177); + +EthernetServer ethServer(502); + +ModbusTCPServer modbusTCPServer; + +const int ledPin = LED_BUILTIN; + +void setup() { + // You can use Ethernet.init(pin) to configure the CS pin + //Ethernet.init(10); // Most Arduino shields + //Ethernet.init(5); // MKR ETH shield + //Ethernet.init(0); // Teensy 2.0 + //Ethernet.init(20); // Teensy++ 2.0 + //Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet + //Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet + + // Open serial communications and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + Serial.println("Ethernet Modbus TCP Example"); + + // start the Ethernet connection and the server: + Ethernet.begin(mac, ip); + + // Check for Ethernet hardware present + if (Ethernet.hardwareStatus() == EthernetNoHardware) { + Serial.println("Ethernet shield was not found. Sorry, can't run without hardware. :("); + while (true) { + delay(1); // do nothing, no point running without Ethernet hardware + } + } + if (Ethernet.linkStatus() == LinkOFF) { + Serial.println("Ethernet cable is not connected."); + } + + // start the server + ethServer.begin(); + + // start the Modbus TCP server + if (!modbusTCPServer.begin()) { + Serial.println("Failed to start Modbus TCP Server!"); + while (1); + } + + // configure the LED + pinMode(ledPin, OUTPUT); + digitalWrite(ledPin, LOW); + + // configure a single coil at address 0x00 + modbusTCPServer.configureCoils(0x00, 1); +} + +void loop() { + // listen for incoming clients + EthernetClient client = ethServer.available(); + + if (client) { + // a new client connected + Serial.println("new client"); + + // let the Modbus TCP accept the connection + modbusTCPServer.accept(client); + + while (client.connected()) { + // poll for Modbus TCP requests, while client connected + modbusTCPServer.poll(); + + // update the LED + updateLED(); + } + + Serial.println("client disconnected"); + } +} + +void updateLED() { + // read the current value of the coil + int coilValue = modbusTCPServer.coilRead(0x00); + + if (coilValue) { + // coil value set, turn LED on + digitalWrite(ledPin, HIGH); + } else { + // coild value clear, turn LED off + digitalWrite(ledPin, LOW); + } +} diff --git a/libraries/ArduinoModbus/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino b/libraries/ArduinoModbus/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino new file mode 100644 index 0000000..0322c89 --- /dev/null +++ b/libraries/ArduinoModbus/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino @@ -0,0 +1,106 @@ +/* + WiFi Modbus TCP Client Toggle + + This sketch toggles the coil of a Modbus TCP server connected + on and off every second. + + Circuit: + - MKR1000 or MKR WiFi 1010 board + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include +#include // for MKR WiFi 1010 +// #include // for MKR1000 + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) +int keyIndex = 0; // your network key Index number (needed only for WEP) + +int status = WL_IDLE_STATUS; + +WiFiClient wifiClient; +ModbusTCPClient modbusTCPClient(wifiClient); + +IPAddress server(192, 168, 1, 10); // update with the IP Address of your Modbus server + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + Serial.println("Modbus TCP Client Toggle"); + + // attempt to connect to WiFi network: + while (status != WL_CONNECTED) { + Serial.print("Attempting to connect to SSID: "); + Serial.println(ssid); + // Connect to WPA/WPA2 network. Change this line if using open or WEP network: + status = WiFi.begin(ssid, pass); + + // wait 10 seconds for connection: + delay(10000); + } + + // you're connected now, so print out the status: + printWifiStatus(); +} + +void loop() { + if (!modbusTCPClient.connected()) { + // client not connected, start the Modbus TCP client + Serial.println("Attempting to connect to Modbus TCP server"); + + if (!modbusTCPClient.begin(server)) { + Serial.println("Modbus TCP Client failed to connect!"); + } else { + Serial.println("Modbus TCP Client connected"); + } + } else { + // client connected + + // write the value of 0x01, to the coil at address 0x00 + if (!modbusTCPClient.coilWrite(0x00, 0x01)) { + Serial.print("Failed to write coil! "); + Serial.println(modbusTCPClient.lastError()); + } + + // wait for 1 second + delay(1000); + + // write the value of 0x00, to the coil at address 0x00 + if (!modbusTCPClient.coilWrite(0x00, 0x00)) { + Serial.print("Failed to write coil! "); + Serial.println(modbusTCPClient.lastError()); + } + + // wait for 1 second + delay(1000); + } +} + +void printWifiStatus() { + // print the SSID of the network you're attached to: + Serial.print("SSID: "); + Serial.println(WiFi.SSID()); + + // print your WiFi shield's IP address: + IPAddress ip = WiFi.localIP(); + Serial.print("IP Address: "); + Serial.println(ip); + + // print the received signal strength: + long rssi = WiFi.RSSI(); + Serial.print("signal strength (RSSI):"); + Serial.print(rssi); + Serial.println(" dBm"); +} diff --git a/libraries/ArduinoModbus/examples/TCP/WiFiModbusClientToggle/arduino_secrets.h b/libraries/ArduinoModbus/examples/TCP/WiFiModbusClientToggle/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/libraries/ArduinoModbus/examples/TCP/WiFiModbusClientToggle/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/libraries/ArduinoModbus/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino b/libraries/ArduinoModbus/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino new file mode 100644 index 0000000..60276c0 --- /dev/null +++ b/libraries/ArduinoModbus/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino @@ -0,0 +1,126 @@ +/* + WiFi Modbus TCP Server LED + + This sketch creates a Modbus TCP Server with a simulated coil. + The value of the simulated coil is set on the LED + + Circuit: + - MKR1000 or MKR WiFi 1010 board + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include +#include // for MKR WiFi 1010 +// #include // for MKR1000 + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +#include "arduino_secrets.h" +///////please enter your sensitive data in the Secret tab/arduino_secrets.h +char ssid[] = SECRET_SSID; // your network SSID (name) +char pass[] = SECRET_PASS; // your network password (use for WPA, or use as key for WEP) +int keyIndex = 0; // your network key Index number (needed only for WEP) + +const int ledPin = LED_BUILTIN; + +int status = WL_IDLE_STATUS; + +WiFiServer wifiServer(502); + +ModbusTCPServer modbusTCPServer; + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + Serial.println("Modbus TCP Server LED"); + + // attempt to connect to WiFi network: + while (status != WL_CONNECTED) { + Serial.print("Attempting to connect to SSID: "); + Serial.println(ssid); + // Connect to WPA/WPA2 network. Change this line if using open or WEP network: + status = WiFi.begin(ssid, pass); + + // wait 10 seconds for connection: + delay(10000); + } + + // you're connected now, so print out the status: + printWifiStatus(); + + // start the server + wifiServer.begin(); + + // start the Modbus TCP server + if (!modbusTCPServer.begin()) { + Serial.println("Failed to start Modbus TCP Server!"); + while (1); + } + + // configure the LED + pinMode(ledPin, OUTPUT); + digitalWrite(ledPin, LOW); + + // configure a single coil at address 0x00 + modbusTCPServer.configureCoils(0x00, 1); +} + +void loop() { + // listen for incoming clients + WiFiClient client = wifiServer.available(); + + if (client) { + // a new client connected + Serial.println("new client"); + + // let the Modbus TCP accept the connection + modbusTCPServer.accept(client); + + while (client.connected()) { + // poll for Modbus TCP requests, while client connected + modbusTCPServer.poll(); + + // update the LED + updateLED(); + } + + Serial.println("client disconnected"); + } +} + +void updateLED() { + // read the current value of the coil + int coilValue = modbusTCPServer.coilRead(0x00); + + if (coilValue) { + // coil value set, turn LED on + digitalWrite(ledPin, HIGH); + } else { + // coild value clear, turn LED off + digitalWrite(ledPin, LOW); + } +} + +void printWifiStatus() { + // print the SSID of the network you're attached to: + Serial.print("SSID: "); + Serial.println(WiFi.SSID()); + + // print your WiFi shield's IP address: + IPAddress ip = WiFi.localIP(); + Serial.print("IP Address: "); + Serial.println(ip); + + // print the received signal strength: + long rssi = WiFi.RSSI(); + Serial.print("signal strength (RSSI):"); + Serial.print(rssi); + Serial.println(" dBm"); +} diff --git a/libraries/ArduinoModbus/examples/TCP/WiFiModbusServerLED/arduino_secrets.h b/libraries/ArduinoModbus/examples/TCP/WiFiModbusServerLED/arduino_secrets.h new file mode 100644 index 0000000..0c9fdd5 --- /dev/null +++ b/libraries/ArduinoModbus/examples/TCP/WiFiModbusServerLED/arduino_secrets.h @@ -0,0 +1,2 @@ +#define SECRET_SSID "" +#define SECRET_PASS "" diff --git a/libraries/ArduinoModbus/keywords.txt b/libraries/ArduinoModbus/keywords.txt new file mode 100644 index 0000000..845bdb3 --- /dev/null +++ b/libraries/ArduinoModbus/keywords.txt @@ -0,0 +1,54 @@ +####################################### +# Syntax Coloring Map For ArduinoModbus +####################################### + +####################################### +# Datatypes (KEYWORD1) +####################################### + +ArduinoModbus KEYWORD1 +ModbusRTUClient KEYWORD1 +ModbusRTUServer KEYWORD1 +ModbusRTUClient KEYWORD1 +ModbusTCPServer KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +begin KEYWORD2 +poll KEYWORD2 +end KEYWORD2 +setTimeout KEYWORD2 + +beginTransmission KEYWORD2 +write KEYWORD2 +endTransmission KEYWORD2 +requestFrom KEYWORD2 +available KEYWORD2 +read KEYWORD2 + +coilRead KEYWORD2 +discreteInputRead KEYWORD2 +holdingRegisterRead KEYWORD2 +inputRegisterRead KEYWORD2 +coilWrite KEYWORD2 +holdingRegisterWrite KEYWORD2 +registerMaskWrite KEYWORD2 +lastError KEYWORD2 + +configureCoils KEYWORD2 +configureDiscreteInputs KEYWORD2 +configureHoldingRegisters KEYWORD2 +configureInputRegisters KEYWORD2 +discreteInputWrite KEYWORD2 +inputRegisterWrite KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### + +COILS LITERAL1 +DISCRETE_INPUTS LITERAL1 +HOLDING_REGISTERS LITERAL1 +INPUT_REGISTERS LITERAL1 diff --git a/libraries/ArduinoModbus/library.properties b/libraries/ArduinoModbus/library.properties new file mode 100644 index 0000000..02761ad --- /dev/null +++ b/libraries/ArduinoModbus/library.properties @@ -0,0 +1,11 @@ +name=ArduinoModbus +version=1.0.7 +author=Arduino +maintainer=Arduino +sentence=Use Modbus equipment with your Arduino. +paragraph=Using TCP or RS485 shields, like the MKR 485 Shield. This library depends on the ArduinoRS485 library. +category=Communication +url=https://www.arduino.cc/en/ArduinoModbus/ArduinoModbus +architectures=* +includes=ArduinoModbus.h +depends=ArduinoRS485 diff --git a/libraries/ArduinoModbus/src/ArduinoModbus.h b/libraries/ArduinoModbus/src/ArduinoModbus.h new file mode 100644 index 0000000..41f1615 --- /dev/null +++ b/libraries/ArduinoModbus/src/ArduinoModbus.h @@ -0,0 +1,29 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _ARDUINO_MODBUS_H_INCLUDED +#define _ARDUINO_MODBUS_H_INCLUDED + +#include "ModbusRTUClient.h" +#include "ModbusRTUServer.h" + +#include "ModbusTCPClient.h" +#include "ModbusTCPServer.h" + +#endif diff --git a/libraries/ArduinoModbus/src/ModbusClient.cpp b/libraries/ArduinoModbus/src/ModbusClient.cpp new file mode 100644 index 0000000..bf4b329 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusClient.cpp @@ -0,0 +1,424 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include + +#include "ModbusClient.h" + +ModbusClient::ModbusClient(unsigned long defaultTimeout) : + _mb(NULL), + _timeout(defaultTimeout), + _defaultId(0x00), + _transmissionBegun(false), + _values(NULL), + _available(0), + _read(0), + _availableForWrite(0), + _written(0) +{ +} + +ModbusClient::~ModbusClient() +{ + if (_values != NULL) { + free(_values); + } + + if (_mb != NULL) { + modbus_free(_mb); + } +} + +int ModbusClient::begin(modbus_t* mb, int defaultId) +{ + end(); + + _mb = mb; + _defaultId = defaultId; + if (_mb == NULL) { + return 0; + } + + if (modbus_connect(_mb) != 0) { + modbus_free(_mb); + + _mb = NULL; + return 0; + } + + _transmissionBegun = false; + _available = 0; + _read = 0; + _availableForWrite = 0; + _written = 0; + + modbus_set_error_recovery(_mb, MODBUS_ERROR_RECOVERY_PROTOCOL); + + setTimeout(_timeout); + + return 1; +} + +void ModbusClient::end() +{ + if (_values != NULL) { + free(_values); + + _values = NULL; + } + + if (_mb != NULL) { + modbus_close(_mb); + modbus_free(_mb); + + _mb = NULL; + } +} + +int ModbusClient::coilRead(int address) +{ + return coilRead(_defaultId, address); +} + +int ModbusClient::coilRead(int id, int address) +{ + uint8_t value; + + modbus_set_slave(_mb, id); + + if (modbus_read_bits(_mb, address, 1, &value) < 0) { + return -1; + } + + return value; +} + +int ModbusClient::discreteInputRead(int address) +{ + return discreteInputRead(_defaultId, address); +} + +int ModbusClient::discreteInputRead(int id, int address) +{ + uint8_t value; + + modbus_set_slave(_mb, id); + + if (modbus_read_input_bits(_mb, address, 1, &value) < 0) { + return -1; + } + + return value; +} + +long ModbusClient::holdingRegisterRead(int address) +{ + return holdingRegisterRead(_defaultId, address); +} + +long ModbusClient::holdingRegisterRead(int id, int address) +{ + uint16_t value; + + modbus_set_slave(_mb, id); + + if (modbus_read_registers(_mb, address, 1, &value) < 0) { + return -1; + } + + return value; +} + +long ModbusClient::inputRegisterRead(int address) +{ + return inputRegisterRead(_defaultId, address); +} + +long ModbusClient::inputRegisterRead(int id, int address) +{ + uint16_t value; + + modbus_set_slave(_mb, id); + + if (modbus_read_input_registers(_mb, address, 1, &value) < 0) { + return -1; + } + + return value; +} + +int ModbusClient::coilWrite(int address, uint8_t value) +{ + return coilWrite(_defaultId, address, value); +} + +int ModbusClient::coilWrite(int id, int address, uint8_t value) +{ + modbus_set_slave(_mb, id); + + if (modbus_write_bit(_mb, address, value) < 0) { + return 0; + } + + return 1; +} + +int ModbusClient::holdingRegisterWrite(int address, uint16_t value) +{ + return holdingRegisterWrite(_defaultId, address, value); +} + +int ModbusClient::holdingRegisterWrite(int id, int address, uint16_t value) +{ + modbus_set_slave(_mb, id); + + if (modbus_write_register(_mb, address, value) < 0) { + return 0; + } + + return 1; +} + +int ModbusClient::registerMaskWrite(int address, uint16_t andMask, uint16_t orMask) +{ + return registerMaskWrite(_defaultId, address, andMask, orMask); +} + +int ModbusClient::registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask) +{ + modbus_set_slave(_mb, id); + + if (modbus_mask_write_register(_mb, address, andMask, orMask) < 0) { + return 0; + } + + return 1; +} + +int ModbusClient::beginTransmission(int type, int address, int nb) +{ + return beginTransmission(_defaultId, type, address, nb); +} + +int ModbusClient::beginTransmission(int id, int type, int address, int nb) +{ + if ((type != COILS && type != HOLDING_REGISTERS) || nb < 1) { + errno = EINVAL; + + return 0; + } + + int valueSize = (type == COILS) ? sizeof(uint8_t) : sizeof(uint16_t); + + _values = realloc(_values, nb * valueSize); + + if (_values == NULL) { + errno = ENOMEM; + + return 0; + } + + memset(_values, 0x00, nb * valueSize); + + _transmissionBegun = true; + _id = id; + _type = type; + _address = address; + _nb = nb; + + _available = 0; + _read = 0; + _availableForWrite = nb; + _written = 0; + + return 1; +} + +int ModbusClient::write(unsigned int value) +{ + if (!_transmissionBegun || _availableForWrite <= 0) { + return 0; + } + + switch (_type) { + case COILS: + ((uint8_t*)_values)[_written++] = value; + _availableForWrite--; + return 1; + + case HOLDING_REGISTERS: + ((uint16_t*)_values)[_written++] = value; + _availableForWrite--; + return 1; + + default: + return 0; + } + + return 1; +} + +int ModbusClient::endTransmission() +{ + if (!_transmissionBegun) { + return 0; + } + + int result = -1; + + modbus_set_slave(_mb, _id); + + switch (_type) { + case COILS: + result = modbus_write_bits(_mb, _address, _nb, (const uint8_t*)_values); + break; + + case HOLDING_REGISTERS: + result = modbus_write_registers(_mb, _address, _nb, (const uint16_t*)_values); + break; + + default: + return 0; + } + + _transmissionBegun = false; + _available = 0; + _read = 0; + _availableForWrite = 0; + _written = 0; + + return (result < 0) ? 0 : 1; +} + +int ModbusClient::requestFrom(int type, int address, int nb) +{ + return requestFrom(_defaultId, type, address, nb); +} + +int ModbusClient::requestFrom(int id, int type, int address, int nb) +{ + if ((type != COILS && type != DISCRETE_INPUTS && type != HOLDING_REGISTERS && type != INPUT_REGISTERS) + || (nb < 1)) { + errno = EINVAL; + + return 0; + } + + int valueSize = (type == COILS || type == DISCRETE_INPUTS) ? sizeof(uint8_t) : sizeof(uint16_t); + + _values = realloc(_values, nb * valueSize); + + if (_values == NULL) { + errno = ENOMEM; + + return 0; + } + + int result = -1; + + modbus_set_slave(_mb, id); + + switch (type) { + case COILS: + result = modbus_read_bits(_mb, address, nb, (uint8_t*)_values); + break; + + case DISCRETE_INPUTS: + result = modbus_read_input_bits(_mb, address, nb, (uint8_t*)_values); + break; + + case HOLDING_REGISTERS: + result = modbus_read_registers(_mb, address, nb, (uint16_t*)_values); + break; + + case INPUT_REGISTERS: + result = modbus_read_input_registers(_mb, address, nb, (uint16_t*)_values); + break; + + default: + break; + } + + if (result == -1) { + return 0; + } + + _transmissionBegun = false; + _type = type; + _available = nb; + _read = 0; + _availableForWrite = 0; + _written = 0; + + return nb; +} + +int ModbusClient::available() +{ + return _available; +} + +long ModbusClient::read() +{ + if (_available <= 0) { + return -1; + } + + long result = -1; + + switch (_type) { + case COILS: + case DISCRETE_INPUTS: + result = ((uint8_t*)_values)[_read]; + break; + + case HOLDING_REGISTERS: + case INPUT_REGISTERS: + result = ((uint16_t*)_values)[_read]; + break; + + default: + break; + } + + if (result != -1) { + _available--; + _read++; + } + + return result; +} + +const char* ModbusClient::lastError() +{ + if (errno == 0) { + return NULL; + } + + return modbus_strerror(errno); +} + +void ModbusClient::setTimeout(unsigned long ms) +{ + _timeout = ms; + + if (_mb) { + modbus_set_response_timeout(_mb, _timeout / 1000, (_timeout % 1000) * 1000); + } +} diff --git a/libraries/ArduinoModbus/src/ModbusClient.h b/libraries/ArduinoModbus/src/ModbusClient.h new file mode 100644 index 0000000..468e07a --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusClient.h @@ -0,0 +1,230 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MODBUS_CLIENT_H_INCLUDED +#define _MODBUS_CLIENT_H_INCLUDED + +extern "C" { + #include "libmodbus/modbus.h" +} + +#include + +#define COILS 0 +#define DISCRETE_INPUTS 1 +#define HOLDING_REGISTERS 2 +#define INPUT_REGISTERS 3 + +class ModbusClient { + +public: + /** + * Perform a "Read Coils" operation for the specified address for a single + * coil. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address address to use for operation + * + * @return coil value on success, -1 on failure. + */ + int coilRead(int address); + int coilRead(int id, int address); + + /** + * Perform a "Read Discrete Inputs" operation for the specified address for a + * single discrete input. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address address to use for operation + * + * @return discrete input value on success, -1 on failure. + */ + int discreteInputRead(int address); + int discreteInputRead(int id, int address); + + /** + * Perform a "Read Holding Registers" operation for a single holding + * register. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address start address to use for operation + * + * @return holding register value on success, -1 on failure. + */ + long holdingRegisterRead(int address); + long holdingRegisterRead(int id, int address); + + /** + * Perform a "Read Input Registers" operation for a single input + * register. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address address to use for operation + * + * @return input register value on success, -1 on failure. + */ + long inputRegisterRead(int address); + long inputRegisterRead(int id, int address); + + /** + * Perform a "Write Single Coil" operation for the specified address and + * value. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address address to use for operation + * @param value coil value to write + * + * @return 1 on success, 0 on failure. + */ + int coilWrite(int address, uint8_t value); + int coilWrite(int id, int address, uint8_t value); + + /** + * Perform a "Write Single Holding Register" operation for the specified + * address and value. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address address to use for operation + * @param value holding register value to write + * + * @return 1 on success, 0 on failure. + */ + int holdingRegisterWrite(int address, uint16_t value); + int holdingRegisterWrite(int id, int address, uint16_t value); + + /** + * Perform a "Mask Write Registers" operation for the specified + * address, AND mask and OR mask. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param address address to use for operation + * @param andMask AND mask to use for operation + * @param orMask OR mask to use for operation + * + * @return 1 on success, 0 on failure. + */ + int registerMaskWrite(int address, uint16_t andMask, uint16_t orMask); + int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask); + + /** + * Begin the process of a writing multiple coils or holding registers. + * + * Use write(value) to set the values you want to send, and endTransmission() + * to send request on the wire. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param type type of write to perform, either COILS or HOLDING_REGISTERS + * @param address start address to use for operation + * @param nb number of values to write + * + * @return 1 on success, 0 on failure + */ + int beginTransmission(int type, int address, int nb); + int beginTransmission(int id, int type, int address, int nb); + + /** + * Set the values of a write operation started by beginTransmission(...). + * + * @param value value to write + * + * @return 1 on success, 0 on failure + */ + int write(unsigned int value); + + /** + * End the process of a writing multiple coils or holding registers. + * + * @return 1 on success, 0 on failure + */ + int endTransmission(); + + /** + * Read multiple coils, discrete inputs, holding registers, or input + * register values. + * + * Use available() and read() to process the read values. + * + * @param id (slave) id of target, defaults to 0x00 if not specified + * @param type type of read to perform, either COILS, DISCRETE_INPUTS, + * HOLDING_REGISTERS, or INPUT_REGISTERS + * @param address start address to use for operation + * @param nb number of values to read + * + * @return 0 on failure, number of values read on success + */ + int requestFrom(int type, int address, int nb); + int requestFrom(int id, int type, int address,int nb); + + /** + * Query the number of values available to read after calling + * requestFrom(...) + * + * @return number of values available for reading use read() + */ + int available(); + + /** + * Read a value after calling requestFrom(...) + * + * @return -1 on failure, value on success + */ + long read(); + + /** + * Read the last error reason as a string + * + * @return Last error reason as a C string + */ + const char* lastError(); + + /** + * Stop the client and clean up + */ + void end(); + + /** + * Set response timeout (in milliseconds) + */ + void setTimeout(unsigned long ms); + +protected: + ModbusClient(unsigned long defaultTimeout); + virtual ~ModbusClient(); + + int begin(modbus_t* _mb, int defaultId); + +private: + modbus_t* _mb; + unsigned long _timeout; + int _defaultId; + + bool _transmissionBegun; + int _id; + int _type; + int _address; + int _nb; + + void* _values; + int _available; + int _read; + int _availableForWrite; + int _written; +}; + +#endif diff --git a/libraries/ArduinoModbus/src/ModbusRTUClient.cpp b/libraries/ArduinoModbus/src/ModbusRTUClient.cpp new file mode 100644 index 0000000..2b35227 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusRTUClient.cpp @@ -0,0 +1,60 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include + +extern "C" { +#include "libmodbus/modbus.h" +#include "libmodbus/modbus-rtu.h" +} + +#include "ModbusRTUClient.h" + +ModbusRTUClientClass::ModbusRTUClientClass() : + ModbusClient(1000) +{ +} + +ModbusRTUClientClass::ModbusRTUClientClass(RS485Class& rs485) : + ModbusClient(1000), _rs485(&rs485) +{ +} + +ModbusRTUClientClass::~ModbusRTUClientClass() +{ +} + +int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config) +{ + modbus_t* mb = modbus_new_rtu(_rs485, baudrate, config); + + if (!ModbusClient::begin(mb, 0x00)) { + return 0; + } + + return 1; +} + +int ModbusRTUClientClass::begin(RS485Class& rs485, unsigned long baudrate, uint16_t config) +{ + _rs485 = &rs485; + return begin(baudrate, config); +} + +ModbusRTUClientClass ModbusRTUClient; diff --git a/libraries/ArduinoModbus/src/ModbusRTUClient.h b/libraries/ArduinoModbus/src/ModbusRTUClient.h new file mode 100644 index 0000000..3fe6714 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusRTUClient.h @@ -0,0 +1,49 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MODBUS_RTU_CLIENT_H_INCLUDED +#define _MODBUS_RTU_CLIENT_H_INCLUDED + +#include "ModbusClient.h" +#include + +class ModbusRTUClientClass : public ModbusClient { +public: + ModbusRTUClientClass(); + ModbusRTUClientClass(RS485Class& rs485); + virtual ~ModbusRTUClientClass(); + + /** + * Start the Modbus RTU client with the specified parameters + * + * @param baudrate Baud rate to use + * @param config serial config. to use defaults to SERIAL_8N1 + * + * Return 1 on success, 0 on failure + */ + int begin(unsigned long baudrate, uint16_t config = SERIAL_8N1); + int begin(RS485Class& rs485, unsigned long baudrate, uint16_t config = SERIAL_8N1); + +private: + RS485Class* _rs485; // = &RS485; +}; + +extern ModbusRTUClientClass ModbusRTUClient; + +#endif diff --git a/libraries/ArduinoModbus/src/ModbusRTUServer.cpp b/libraries/ArduinoModbus/src/ModbusRTUServer.cpp new file mode 100644 index 0000000..95cc0b8 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusRTUServer.cpp @@ -0,0 +1,73 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include + +extern "C" { +#include "libmodbus/modbus.h" +#include "libmodbus/modbus-rtu.h" +} + +#include "ModbusRTUServer.h" + +ModbusRTUServerClass::ModbusRTUServerClass() +{ +} + +ModbusRTUServerClass::ModbusRTUServerClass(RS485Class& rs485) : _rs485(&rs485) +{ +} + +ModbusRTUServerClass::~ModbusRTUServerClass() +{ +} + +int ModbusRTUServerClass::begin(int id, unsigned long baudrate, uint16_t config) +{ + modbus_t* mb = modbus_new_rtu(_rs485, baudrate, config); + + if (!ModbusServer::begin(mb, id)) { + return 0; + } + + modbus_connect(mb); + + return 1; +} + +int ModbusRTUServerClass::begin(RS485Class& rs485, int id, unsigned long baudrate, uint16_t config) +{ + _rs485 = &rs485; + return begin(id, baudrate, config); +} + +int ModbusRTUServerClass::poll() +{ + uint8_t request[MODBUS_RTU_MAX_ADU_LENGTH]; + + int requestLength = modbus_receive(_mb, request); + + if (requestLength > 0) { + modbus_reply(_mb, request, requestLength, &_mbMapping); + return 1; + } + return 0; +} + +ModbusRTUServerClass ModbusRTUServer; diff --git a/libraries/ArduinoModbus/src/ModbusRTUServer.h b/libraries/ArduinoModbus/src/ModbusRTUServer.h new file mode 100644 index 0000000..426caa3 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusRTUServer.h @@ -0,0 +1,55 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MODBUS_RTU_SERVER_H_INCLUDED +#define _MODBUS_RTU_SERVER_H_INCLUDED + +#include "ModbusServer.h" +#include + +class ModbusRTUServerClass : public ModbusServer { +public: + ModbusRTUServerClass(); + ModbusRTUServerClass(RS485Class& rs485); + virtual ~ModbusRTUServerClass(); + + /** + * Start the Modbus RTU server with the specified parameters + * + * @param id (slave) id of the server + * @param baudrate Baud rate to use + * @param config serial config. to use defaults to SERIAL_8N1 + * + * Return 1 on success, 0 on failure + */ + int begin(int id, unsigned long baudrate, uint16_t config = SERIAL_8N1); + int begin(RS485Class& rs485, int id, unsigned long baudrate, uint16_t config = SERIAL_8N1); + + /** + * Poll interface for requests + */ + virtual int poll(); + +private: + RS485Class* _rs485;// = &RS485; +}; + +extern ModbusRTUServerClass ModbusRTUServer; + +#endif diff --git a/libraries/ArduinoModbus/src/ModbusServer.cpp b/libraries/ArduinoModbus/src/ModbusServer.cpp new file mode 100644 index 0000000..883f746 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusServer.cpp @@ -0,0 +1,329 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include + +#include "ModbusServer.h" + +ModbusServer::ModbusServer() : + _mb(NULL) +{ + memset(&_mbMapping, 0x00, sizeof(_mbMapping)); +} + +ModbusServer::~ModbusServer() +{ + if (_mbMapping.tab_bits != NULL) { + free(_mbMapping.tab_bits); + } + + if (_mbMapping.tab_input_bits != NULL) { + free(_mbMapping.tab_input_bits); + } + + if (_mbMapping.tab_input_registers != NULL) { + free(_mbMapping.tab_input_registers); + } + + if (_mbMapping.tab_registers != NULL) { + free(_mbMapping.tab_registers); + } + + if (_mb != NULL) { + modbus_free(_mb); + } +} + +int ModbusServer::configureCoils(int startAddress, int nb) +{ + if (startAddress < 0 || nb < 1) { + errno = EINVAL; + + return -1; + } + + size_t s = sizeof(_mbMapping.tab_bits[0]) * nb; + + _mbMapping.tab_bits = (uint8_t*)realloc(_mbMapping.tab_bits, s); + + if (_mbMapping.tab_bits == NULL) { + _mbMapping.start_bits = 0; + _mbMapping.nb_bits = 0; + + return 0; + } + + memset(_mbMapping.tab_bits, 0x00, s); + _mbMapping.start_bits = startAddress; + _mbMapping.nb_bits = nb; + + return 1; +} + +int ModbusServer::configureDiscreteInputs(int startAddress, int nb) +{ + if (startAddress < 0 || nb < 1) { + errno = EINVAL; + + return -1; + } + + size_t s = sizeof(_mbMapping.tab_input_bits[0]) * nb; + + _mbMapping.tab_input_bits = (uint8_t*)realloc(_mbMapping.tab_input_bits, s); + + if (_mbMapping.tab_input_bits == NULL) { + _mbMapping.start_input_bits = 0; + _mbMapping.nb_input_bits = 0; + + return 0; + } + + memset(_mbMapping.tab_input_bits, 0x00, s); + _mbMapping.start_input_bits = startAddress; + _mbMapping.nb_input_bits = nb; + + return 1; +} + +int ModbusServer::configureHoldingRegisters(int startAddress, int nb) +{ + if (startAddress < 0 || nb < 1) { + errno = EINVAL; + + return -1; + } + + size_t s = sizeof(_mbMapping.tab_registers[0]) * nb; + + _mbMapping.tab_registers = (uint16_t*)realloc(_mbMapping.tab_registers, s); + + if (_mbMapping.tab_registers == NULL) { + _mbMapping.start_registers = 0; + _mbMapping.nb_registers = 0; + + return 0; + } + + memset(_mbMapping.tab_registers, 0x00, s); + _mbMapping.start_registers = startAddress; + _mbMapping.nb_registers = nb; + + return 1; +} + +int ModbusServer::configureInputRegisters(int startAddress, int nb) +{ + if (startAddress < 0 || nb < 1) { + errno = EINVAL; + + return -1; + } + + size_t s = sizeof(_mbMapping.tab_input_registers[0]) * nb; + + _mbMapping.tab_input_registers = (uint16_t*)realloc(_mbMapping.tab_input_registers, s); + + if (_mbMapping.tab_input_registers == NULL) { + _mbMapping.start_input_registers = 0; + _mbMapping.nb_input_registers = 0; + + return 0; + } + + memset(_mbMapping.tab_input_registers, 0x00, s); + _mbMapping.start_input_registers = startAddress; + _mbMapping.nb_input_registers = nb; + + return 1; +} + +int ModbusServer::coilRead(int address) +{ + if (_mbMapping.start_bits > address || + (_mbMapping.start_bits + _mbMapping.nb_bits) < (address + 1)) { + errno = EMBXILADD; + + return -1; + } + + return _mbMapping.tab_bits[address - _mbMapping.start_bits]; +} + +int ModbusServer::discreteInputRead(int address) +{ + if (_mbMapping.start_input_bits > address || + (_mbMapping.start_input_bits + _mbMapping.nb_input_bits) < (address + 1)) { + errno = EMBXILADD; + + return -1; + } + + return _mbMapping.tab_input_bits[address - _mbMapping.start_input_bits]; +} + +long ModbusServer::holdingRegisterRead(int address) +{ + if (_mbMapping.start_registers > address || + (_mbMapping.start_registers + _mbMapping.nb_registers) < (address + 1)) { + errno = EMBXILADD; + + return -1; + } + + return _mbMapping.tab_registers[address - _mbMapping.start_registers]; +} + +long ModbusServer::inputRegisterRead(int address) +{ + if (_mbMapping.start_input_registers > address || + (_mbMapping.start_input_registers + _mbMapping.nb_input_registers) < (address + 1)) { + errno = EMBXILADD; + + return -1; + } + + return _mbMapping.tab_input_registers[address - _mbMapping.start_input_registers]; +} + +int ModbusServer::coilWrite(int address, uint8_t value) +{ + if (_mbMapping.start_bits > address || + (_mbMapping.start_bits + _mbMapping.nb_bits) < (address + 1)) { + errno = EMBXILADD; + + return 0; + } + + _mbMapping.tab_bits[address - _mbMapping.start_bits] = value; + + return 1; +} + +int ModbusServer::holdingRegisterWrite(int address, uint16_t value) +{ + if (_mbMapping.start_registers > address || + (_mbMapping.start_registers + _mbMapping.nb_registers) < (address + 1)) { + errno = EMBXILADD; + + return 0; + } + + _mbMapping.tab_registers[address - _mbMapping.start_registers] = value; + + return 1; +} + +int ModbusServer::registerMaskWrite(int address, uint16_t andMask, uint16_t orMask) +{ + long value = holdingRegisterRead(address); + + if (value < 0) { + return 0; + } + + value &= andMask; + value |= orMask; + + if (!holdingRegisterWrite(address, value)) { + return 0; + } + + return 1; +} + +int ModbusServer::discreteInputWrite(int address, uint8_t value) +{ + return writeDiscreteInputs(address, &value, 1); +} + +int ModbusServer::writeDiscreteInputs(int address, uint8_t values[], int nb) +{ + if (_mbMapping.start_input_bits > address || + (_mbMapping.start_input_bits + _mbMapping.nb_input_bits) < (address + nb)) { + errno = EMBXILADD; + + return 0; + } + + memcpy(&_mbMapping.tab_input_bits[address - _mbMapping.start_input_bits], values, sizeof(values[0]) * nb); + + return 1; +} + +int ModbusServer::inputRegisterWrite(int address, uint16_t value) +{ + return writeInputRegisters(address, &value, 1); +} + +int ModbusServer::writeInputRegisters(int address, uint16_t values[], int nb) +{ + if (_mbMapping.start_input_registers > address || + (_mbMapping.start_input_registers + _mbMapping.nb_input_registers) < (address + nb)) { + errno = EMBXILADD; + + return 0; + } + + memcpy(&_mbMapping.tab_input_registers[address - _mbMapping.start_input_registers], values, sizeof(values[0]) * nb); + + return 1; +} + +int ModbusServer::begin(modbus_t* mb, int id) +{ + end(); + + _mb = mb; + if (_mb == NULL) { + return 0; + } + + modbus_set_slave(_mb, id); + + return 1; +} + +void ModbusServer::end() +{ + if (_mbMapping.tab_bits != NULL) { + free(_mbMapping.tab_bits); + } + + if (_mbMapping.tab_input_bits != NULL) { + free(_mbMapping.tab_input_bits); + } + + if (_mbMapping.tab_input_registers != NULL) { + free(_mbMapping.tab_input_registers); + } + + if (_mbMapping.tab_registers != NULL) { + free(_mbMapping.tab_registers); + } + + memset(&_mbMapping, 0x00, sizeof(_mbMapping)); + + if (_mb != NULL) { + modbus_close(_mb); + modbus_free(_mb); + + _mb = NULL; + } +} diff --git a/libraries/ArduinoModbus/src/ModbusServer.h b/libraries/ArduinoModbus/src/ModbusServer.h new file mode 100644 index 0000000..cb1d67b --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusServer.h @@ -0,0 +1,150 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MODBUS_SERVER_H_INCLUDED +#define _MODBUS_SERVER_H_INCLUDED + +#include + +extern "C" { + #include "libmodbus/modbus.h" +} + +class ModbusServer { + +public: + /** + * Configure the servers coils. + * + * @param startAddress start address of coils + * @param nb number of coils to configure + * + * @return 0 on success, 1 on failure + */ + int configureCoils(int startAddress, int nb); + + /** + * Configure the servers discrete inputs. + * + * @param startAddress start address of discrete inputs + * @param nb number of discrete inputs to configure + * + * @return 0 on success, 1 on failure + */ + int configureDiscreteInputs(int startAddress, int nb); + + /** + * Configure the servers holding registers. + * + * @param startAddress start address of holding registers + * @param nb number of holding registers to configure + * + * @return 0 on success, 1 on failure + */ + int configureHoldingRegisters(int startAddress, int nb); + + /** + * Configure the servers input registers. + * + * @param startAddress start address of input registers + * @param nb number of input registers to configure + * + * @return 0 on success, 1 on failure + */ + int configureInputRegisters(int startAddress, int nb); + + // same as ModbusClient.h + int coilRead(int address); + int discreteInputRead(int address); + long holdingRegisterRead(int address); + long inputRegisterRead(int address); + int coilWrite(int address, uint8_t value); + int holdingRegisterWrite(int address, uint16_t value); + int registerMaskWrite(int address, uint16_t andMask, uint16_t orMask); + + /** + * Write the value of the server's Discrete Input for the specified address + * and value. + * + * @param address address to use for operation + * @param value discrete input value to write + * + * @return 1 on success, 0 on failure. + */ + int discreteInputWrite(int address, uint8_t value); + + /** + * Write values to the server's Discrete Inputs for the specified address + * and values. + * + * @param address address to use for operation + * @param values array of discrete inputs values to write + * @param nb number of discrete inputs to write + * + * @return 1 on success, 0 on failure. + */ + int writeDiscreteInputs(int address, uint8_t values[], int nb); + + /** + * Write the value of the server's Input Register for the specified address + * and value. + * + * @param address address to use for operation + * @param value input register value to write + * + * @return 1 on success, 0 on failure. + */ + int inputRegisterWrite(int address, uint16_t value); + + /** + * Write values to the server's Input Registers for the specified address + * and values. + * + * @param address address to use for operation + * @param values array of input registers values to write + * @param nb number of input registers to write + * + * @return 1 on success, 0 on failure. + */ + int writeInputRegisters(int address, uint16_t values[], int nb); + + /** + * Poll for requests + * + * @return 1 on request, 0 on no request. + */ + virtual int poll() = 0; + + /** + * Stop the server + */ + void end(); + +protected: + ModbusServer(); + virtual ~ModbusServer(); + + int begin(modbus_t* _mb, int id); + +protected: + modbus_t* _mb; + modbus_mapping_t _mbMapping; +}; + +#endif diff --git a/libraries/ArduinoModbus/src/ModbusTCPClient.cpp b/libraries/ArduinoModbus/src/ModbusTCPClient.cpp new file mode 100644 index 0000000..1571103 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusTCPClient.cpp @@ -0,0 +1,54 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include + +extern "C" { +#include "libmodbus/modbus.h" +#include "libmodbus/modbus-tcp.h" +} + +#include "ModbusTCPClient.h" + +ModbusTCPClient::ModbusTCPClient(Client& client) : + ModbusClient(30 * 1000), + _client(&client) +{ +} + +ModbusTCPClient::~ModbusTCPClient() +{ +} + +int ModbusTCPClient::begin(IPAddress ip, uint16_t port) +{ + modbus_t* mb = modbus_new_tcp(_client, ip, port); + + return ModbusClient::begin(mb, MODBUS_TCP_SLAVE); +} + +int ModbusTCPClient::connected() +{ + return _client->connected(); +} + +void ModbusTCPClient::stop() +{ + end(); +} diff --git a/libraries/ArduinoModbus/src/ModbusTCPClient.h b/libraries/ArduinoModbus/src/ModbusTCPClient.h new file mode 100644 index 0000000..365116d --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusTCPClient.h @@ -0,0 +1,64 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MODBUS_TCP_CLIENT_H_INCLUDED +#define _MODBUS_TCP_CLIENT_H_INCLUDED + +#include +#include + +#include "ModbusClient.h" + +class ModbusTCPClient : public ModbusClient { +public: + /** + * ModbusTCPClient constructor + * + * @param client Client to use for TCP connection + */ + ModbusTCPClient(Client& client); + virtual ~ModbusTCPClient(); + + /** + * Start the Modbus TCP client with the specified parameters + * + * @param ip IP Address of the Modbus server + * @param port TCP port number of Modbus server, defaults to 502 + * + * @return 1 on success, 0 on failure + */ + int begin(IPAddress ip, uint16_t port = 502); + + /** + * Query connection status. + * + * @return 1 if connected, 0 if not connected + */ + int connected(); + + /** + * Disconnect the client. + */ + void stop(); + +private: + Client* _client; +}; + +#endif diff --git a/libraries/ArduinoModbus/src/ModbusTCPServer.cpp b/libraries/ArduinoModbus/src/ModbusTCPServer.cpp new file mode 100644 index 0000000..16e3a1e --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusTCPServer.cpp @@ -0,0 +1,73 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include + +extern "C" { +#include "libmodbus/modbus.h" +#include "libmodbus/modbus-tcp.h" +} + +#include "ModbusTCPServer.h" + +ModbusTCPServer::ModbusTCPServer() : + _client(NULL) +{ +} + +ModbusTCPServer::~ModbusTCPServer() +{ +} + +int ModbusTCPServer::begin(int id) +{ + modbus_t* mb = modbus_new_tcp(NULL, IPAddress(0, 0, 0, 0), 0); + + if (!ModbusServer::begin(mb, id)) { + return 0; + } + + if (modbus_tcp_listen(mb) != 0) { + return 0; + } + + return 1; +} + +void ModbusTCPServer::accept(Client& client) +{ + if (modbus_tcp_accept(_mb, &client) == 0) { + _client = &client; + } +} + +int ModbusTCPServer::poll() +{ + if (_client != NULL) { + uint8_t request[MODBUS_TCP_MAX_ADU_LENGTH]; + + int requestLength = modbus_receive(_mb, request); + + if (requestLength > 0) { + modbus_reply(_mb, request, requestLength, &_mbMapping); + return 1; + } + } + return 0; +} diff --git a/libraries/ArduinoModbus/src/ModbusTCPServer.h b/libraries/ArduinoModbus/src/ModbusTCPServer.h new file mode 100644 index 0000000..cbf6e65 --- /dev/null +++ b/libraries/ArduinoModbus/src/ModbusTCPServer.h @@ -0,0 +1,57 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _MODBUS_TCP_SERVER_H_INCLUDED +#define _MODBUS_TCP_SERVER_H_INCLUDED + +#include + +#include "ModbusServer.h" + +class ModbusTCPServer : public ModbusServer { +public: + ModbusTCPServer(); + virtual ~ModbusTCPServer(); + + /** + * Start the Modbus TCP server with the specified parameters + * + * @param id (slave) id of the server, defaults to 0xff (TCP) + * + * Return 1 on success, 0 on failure + */ + int begin(int id = 0xff); + + /** + * Accept client connection + * + * @param client client to accept + */ + void accept(Client& client); + + /** + * Poll accepted client for requests + */ + virtual int poll(); + +private: + Client* _client; +}; + +#endif diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-data.c b/libraries/ArduinoModbus/src/libmodbus/modbus-data.c new file mode 100644 index 0000000..2007257 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-data.c @@ -0,0 +1,252 @@ +/* + * Copyright © 2010-2014 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#include + +#ifndef _MSC_VER +# include +#else +# include "stdint.h" +#endif + +#include +#include + +#if defined(_WIN32) +# include +#elif defined(ARDUINO) +#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ +#define htonl(x) bswap_32(x) +#define htons(x) bswap_16(x) +#define ntohl(x) bswap_32(x) +#define ntohs(x) bswap_16(x) +#else +#define htonl(x) (x) +#define htons(x) (x) +#define ntohl(x) (x) +#define ntohs(x) (x) +#endif +#else +# include +#endif + +#ifndef ARDUINO +#include +#endif + +#include "modbus.h" + +#if defined(HAVE_BYTESWAP_H) +# include +#endif + +#if defined(__APPLE__) +# include +# define bswap_16 OSSwapInt16 +# define bswap_32 OSSwapInt32 +# define bswap_64 OSSwapInt64 +#endif + +#if defined(__GNUC__) +# define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__ * 10) +# if GCC_VERSION >= 430 +// Since GCC >= 4.30, GCC provides __builtin_bswapXX() alternatives so we switch to them +# undef bswap_32 +# define bswap_32 __builtin_bswap32 +# endif +#endif + +#if defined(_MSC_VER) && (_MSC_VER >= 1400) +# define bswap_32 _byteswap_ulong +# define bswap_16 _byteswap_ushort +#endif + +#if !defined(__CYGWIN__) && !defined(bswap_16) +#ifndef ARDUINO +# warning "Fallback on C functions for bswap_16" +#endif +static inline uint16_t bswap_16(uint16_t x) +{ + return (x >> 8) | (x << 8); +} +#endif + +#if !defined(bswap_32) +#ifndef ARDUINO +# warning "Fallback on C functions for bswap_32" +#endif +static inline uint32_t bswap_32(uint32_t x) +{ + return (bswap_16(x & 0xffff) << 16) | (bswap_16(x >> 16)); +} +#endif + +/* Sets many bits from a single byte value (all 8 bits of the byte value are + set) */ +void modbus_set_bits_from_byte(uint8_t *dest, int idx, const uint8_t value) +{ + int i; + + for (i=0; i < 8; i++) { + dest[idx+i] = (value & (1 << i)) ? 1 : 0; + } +} + +/* Sets many bits from a table of bytes (only the bits between idx and + idx + nb_bits are set) */ +void modbus_set_bits_from_bytes(uint8_t *dest, int idx, unsigned int nb_bits, + const uint8_t *tab_byte) +{ + unsigned int i; + int shift = 0; + + for (i = idx; i < idx + nb_bits; i++) { + dest[i] = tab_byte[(i - idx) / 8] & (1 << shift) ? 1 : 0; + /* gcc doesn't like: shift = (++shift) % 8; */ + shift++; + shift %= 8; + } +} + +/* Gets the byte value from many bits. + To obtain a full byte, set nb_bits to 8. */ +uint8_t modbus_get_byte_from_bits(const uint8_t *src, int idx, + unsigned int nb_bits) +{ + unsigned int i; + uint8_t value = 0; + + if (nb_bits > 8) { + /* Assert is ignored if NDEBUG is set */ + assert(nb_bits < 8); + nb_bits = 8; + } + + for (i=0; i < nb_bits; i++) { + value |= (src[idx+i] << i); + } + + return value; +} + +/* Get a float from 4 bytes (Modbus) without any conversion (ABCD) */ +float modbus_get_float_abcd(const uint16_t *src) +{ + float f; + uint32_t i; + + i = ntohl(((uint32_t)src[0] << 16) + src[1]); + memcpy(&f, &i, sizeof(float)); + + return f; +} + +/* Get a float from 4 bytes (Modbus) in inversed format (DCBA) */ +float modbus_get_float_dcba(const uint16_t *src) +{ + float f; + uint32_t i; + + i = ntohl(bswap_32((((uint32_t)src[0]) << 16) + src[1])); + memcpy(&f, &i, sizeof(float)); + + return f; +} + +/* Get a float from 4 bytes (Modbus) with swapped bytes (BADC) */ +float modbus_get_float_badc(const uint16_t *src) +{ + float f; + uint32_t i; + +#if defined(ARDUINO) && defined(__AVR__) + i = ntohl((uint32_t)((uint32_t)bswap_16(src[0]) << 16) + bswap_16(src[1])); +#else + i = ntohl((uint32_t)(bswap_16(src[0]) << 16) + bswap_16(src[1])); +#endif + memcpy(&f, &i, sizeof(float)); + + return f; +} + +/* Get a float from 4 bytes (Modbus) with swapped words (CDAB) */ +float modbus_get_float_cdab(const uint16_t *src) +{ + float f; + uint32_t i; + + i = ntohl((((uint32_t)src[1]) << 16) + src[0]); + memcpy(&f, &i, sizeof(float)); + + return f; +} + +/* DEPRECATED - Get a float from 4 bytes in sort of Modbus format */ +float modbus_get_float(const uint16_t *src) +{ + float f; + uint32_t i; + + i = (((uint32_t)src[1]) << 16) + src[0]; + memcpy(&f, &i, sizeof(float)); + + return f; +} + +/* Set a float to 4 bytes for Modbus w/o any conversion (ABCD) */ +void modbus_set_float_abcd(float f, uint16_t *dest) +{ + uint32_t i; + + memcpy(&i, &f, sizeof(uint32_t)); + i = htonl(i); + dest[0] = (uint16_t)(i >> 16); + dest[1] = (uint16_t)i; +} + +/* Set a float to 4 bytes for Modbus with byte and word swap conversion (DCBA) */ +void modbus_set_float_dcba(float f, uint16_t *dest) +{ + uint32_t i; + + memcpy(&i, &f, sizeof(uint32_t)); + i = bswap_32(htonl(i)); + dest[0] = (uint16_t)(i >> 16); + dest[1] = (uint16_t)i; +} + +/* Set a float to 4 bytes for Modbus with byte swap conversion (BADC) */ +void modbus_set_float_badc(float f, uint16_t *dest) +{ + uint32_t i; + + memcpy(&i, &f, sizeof(uint32_t)); + i = htonl(i); + dest[0] = (uint16_t)bswap_16(i >> 16); + dest[1] = (uint16_t)bswap_16(i & 0xFFFF); +} + +/* Set a float to 4 bytes for Modbus with word swap conversion (CDAB) */ +void modbus_set_float_cdab(float f, uint16_t *dest) +{ + uint32_t i; + + memcpy(&i, &f, sizeof(uint32_t)); + i = htonl(i); + dest[0] = (uint16_t)i; + dest[1] = (uint16_t)(i >> 16); +} + +/* DEPRECATED - Set a float to 4 bytes in a sort of Modbus format! */ +void modbus_set_float(float f, uint16_t *dest) +{ + uint32_t i; + + memcpy(&i, &f, sizeof(uint32_t)); + dest[0] = (uint16_t)i; + dest[1] = (uint16_t)(i >> 16); +} diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-private.h b/libraries/ArduinoModbus/src/libmodbus/modbus-private.h new file mode 100644 index 0000000..79e7b93 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-private.h @@ -0,0 +1,129 @@ +/* + * Copyright © 2010-2012 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifndef MODBUS_PRIVATE_H +#define MODBUS_PRIVATE_H + +#ifndef _MSC_VER +# include +#if defined(ARDUINO) && defined(__AVR__) +#define ssize_t unsigned long + +#define fd_set void* + +struct timeval { + uint32_t tv_sec; + uint32_t tv_usec; +}; +#else +# include +#endif +#else +# include "stdint.h" +# include +typedef int ssize_t; +#endif +#include +#ifndef ARDUINO +#include +#endif + +#include "modbus.h" + +MODBUS_BEGIN_DECLS + +/* It's not really the minimal length (the real one is report slave ID + * in RTU (4 bytes)) but it's a convenient size to use in RTU or TCP + * communications to read many values or write a single one. + * Maximum between : + * - HEADER_LENGTH_TCP (7) + function (1) + address (2) + number (2) + * - HEADER_LENGTH_RTU (1) + function (1) + address (2) + number (2) + CRC (2) + */ +#define _MIN_REQ_LENGTH 12 + +#define _REPORT_SLAVE_ID 180 + +#define _MODBUS_EXCEPTION_RSP_LENGTH 5 + +/* Timeouts in microsecond (0.5 s) */ +#define _RESPONSE_TIMEOUT 500000 +#define _BYTE_TIMEOUT 500000 + +typedef enum { + _MODBUS_BACKEND_TYPE_RTU=0, + _MODBUS_BACKEND_TYPE_TCP +} modbus_backend_type_t; + +/* + * ---------- Request Indication ---------- + * | Client | ---------------------->| Server | + * ---------- Confirmation Response ---------- + */ +typedef enum { + /* Request message on the server side */ + MSG_INDICATION, + /* Request message on the client side */ + MSG_CONFIRMATION +} msg_type_t; + +/* This structure reduces the number of params in functions and so + * optimizes the speed of execution (~ 37%). */ +typedef struct _sft { + int slave; + int function; + int t_id; +} sft_t; + +typedef struct _modbus_backend { + unsigned int backend_type; + unsigned int header_length; + unsigned int checksum_length; + unsigned int max_adu_length; + int (*set_slave) (modbus_t *ctx, int slave); + int (*build_request_basis) (modbus_t *ctx, int function, int addr, + int nb, uint8_t *req); + int (*build_response_basis) (sft_t *sft, uint8_t *rsp); + int (*prepare_response_tid) (const uint8_t *req, int *req_length); + int (*send_msg_pre) (uint8_t *req, int req_length); + ssize_t (*send) (modbus_t *ctx, const uint8_t *req, int req_length); + int (*receive) (modbus_t *ctx, uint8_t *req); + ssize_t (*recv) (modbus_t *ctx, uint8_t *rsp, int rsp_length); + int (*check_integrity) (modbus_t *ctx, uint8_t *msg, + const int msg_length); + int (*pre_check_confirmation) (modbus_t *ctx, const uint8_t *req, + const uint8_t *rsp, int rsp_length); + int (*connect) (modbus_t *ctx); + void (*close) (modbus_t *ctx); + int (*flush) (modbus_t *ctx); + int (*select) (modbus_t *ctx, fd_set *rset, struct timeval *tv, int msg_length); + void (*free) (modbus_t *ctx); +} modbus_backend_t; + +struct _modbus { + /* Slave address */ + int slave; + /* Socket or file descriptor */ + int s; + int debug; + int error_recovery; + struct timeval response_timeout; + struct timeval byte_timeout; + const modbus_backend_t *backend; + void *backend_data; +}; + +void _modbus_init_common(modbus_t *ctx); +void _error_print(modbus_t *ctx, const char *context); +int _modbus_receive_msg(modbus_t *ctx, uint8_t *msg, msg_type_t msg_type); + +#ifndef HAVE_STRLCPY +size_t strlcpy(char *dest, const char *src, size_t dest_size); +#endif + +MODBUS_END_DECLS + +#endif /* MODBUS_PRIVATE_H */ diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-rtu-private.h b/libraries/ArduinoModbus/src/libmodbus/modbus-rtu-private.h new file mode 100644 index 0000000..5cd6a8b --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-rtu-private.h @@ -0,0 +1,85 @@ +/* + * Copyright © 2001-2011 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifndef MODBUS_RTU_PRIVATE_H +#define MODBUS_RTU_PRIVATE_H + +#ifndef _MSC_VER +#include +#else +#include "stdint.h" +#endif + +#if defined(_WIN32) +#include +#elif defined(ARDUINO) +#include +#else +#include +#endif + +#define _MODBUS_RTU_HEADER_LENGTH 1 +#define _MODBUS_RTU_PRESET_REQ_LENGTH 6 +#define _MODBUS_RTU_PRESET_RSP_LENGTH 2 + +#define _MODBUS_RTU_CHECKSUM_LENGTH 2 + +#if defined(_WIN32) +#if !defined(ENOTSUP) +#define ENOTSUP WSAEOPNOTSUPP +#endif + +/* WIN32: struct containing serial handle and a receive buffer */ +#define PY_BUF_SIZE 512 +struct win32_ser { + /* File handle */ + HANDLE fd; + /* Receive buffer */ + uint8_t buf[PY_BUF_SIZE]; + /* Received chars */ + DWORD n_bytes; +}; +#endif /* _WIN32 */ + +typedef struct _modbus_rtu { +#if defined(ARDUINO) + unsigned long baud; + uint16_t config; + RS485Class* rs485; +#else + /* Device: "/dev/ttyS0", "/dev/ttyUSB0" or "/dev/tty.USA19*" on Mac OS X. */ + char *device; + /* Bauds: 9600, 19200, 57600, 115200, etc */ + int baud; + /* Data bit */ + uint8_t data_bit; + /* Stop bit */ + uint8_t stop_bit; + /* Parity: 'N', 'O', 'E' */ + char parity; +#if defined(_WIN32) + struct win32_ser w_ser; + DCB old_dcb; +#else + /* Save old termios settings */ + struct termios old_tios; +#endif +#if HAVE_DECL_TIOCSRS485 + int serial_mode; +#endif +#if HAVE_DECL_TIOCM_RTS + int rts; + int rts_delay; + int onebyte_time; + void (*set_rts) (modbus_t *ctx, int on); +#endif +#endif + /* To handle many slaves on the same link */ + int confirmation_to_ignore; +} modbus_rtu_t; + +#endif /* MODBUS_RTU_PRIVATE_H */ diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-rtu.cpp b/libraries/ArduinoModbus/src/libmodbus/modbus-rtu.cpp new file mode 100644 index 0000000..c5a8302 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-rtu.cpp @@ -0,0 +1,1409 @@ +/* + * Copyright © 2001-2011 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifdef ARDUINO +#include + +#ifndef DEBUG +#define printf(...) {} +#define fprintf(...) {} +#endif +#endif + +#include +#include +#include +#include +#include +#if !defined(_MSC_VER) && !defined(ARDUINO) +#include +#endif +#include + +#include "modbus-private.h" + +#include "modbus-rtu.h" +#include "modbus-rtu-private.h" + +#if HAVE_DECL_TIOCSRS485 || HAVE_DECL_TIOCM_RTS +#include +#endif + +#if HAVE_DECL_TIOCSRS485 +#include +#endif + +#if defined(ARDUINO) && defined(__AVR__) +#include + +#undef EIO +#define EIO 5 + +#undef EINVAL +#define EINVAL 22 + +#undef ENOPROTOOPT +#define ENOPROTOOPT 109 + +#undef ECONNREFUSED +#define ECONNREFUSED 111 + +#undef ETIMEDOUT +#define ETIMEDOUT 116 + +#undef ENOTSUP +#define ENOTSUP 134 +#endif + +/* Table of CRC values for high-order byte */ +#if defined(ARDUINO) && defined(__AVR__) +static PROGMEM const uint8_t table_crc_hi[] = { +#else +static const uint8_t table_crc_hi[] = { +#endif + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, + 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, + 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, + 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, + 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, + 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, + 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, + 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, + 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, + 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, + 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, + 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, + 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, + 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, + 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +}; + +/* Table of CRC values for low-order byte */ +#if defined(ARDUINO) && defined(__AVR__) +#include +static PROGMEM const uint8_t table_crc_lo[] = { +#else +static const uint8_t table_crc_lo[] = { +#endif + 0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2, 0xC6, 0x06, + 0x07, 0xC7, 0x05, 0xC5, 0xC4, 0x04, 0xCC, 0x0C, 0x0D, 0xCD, + 0x0F, 0xCF, 0xCE, 0x0E, 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09, + 0x08, 0xC8, 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A, + 0x1E, 0xDE, 0xDF, 0x1F, 0xDD, 0x1D, 0x1C, 0xDC, 0x14, 0xD4, + 0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6, 0xD2, 0x12, 0x13, 0xD3, + 0x11, 0xD1, 0xD0, 0x10, 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3, + 0xF2, 0x32, 0x36, 0xF6, 0xF7, 0x37, 0xF5, 0x35, 0x34, 0xF4, + 0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE, 0xFA, 0x3A, + 0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38, 0x28, 0xE8, 0xE9, 0x29, + 0xEB, 0x2B, 0x2A, 0xEA, 0xEE, 0x2E, 0x2F, 0xEF, 0x2D, 0xED, + 0xEC, 0x2C, 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26, + 0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0, 0xA0, 0x60, + 0x61, 0xA1, 0x63, 0xA3, 0xA2, 0x62, 0x66, 0xA6, 0xA7, 0x67, + 0xA5, 0x65, 0x64, 0xA4, 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F, + 0x6E, 0xAE, 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68, + 0x78, 0xB8, 0xB9, 0x79, 0xBB, 0x7B, 0x7A, 0xBA, 0xBE, 0x7E, + 0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C, 0xB4, 0x74, 0x75, 0xB5, + 0x77, 0xB7, 0xB6, 0x76, 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71, + 0x70, 0xB0, 0x50, 0x90, 0x91, 0x51, 0x93, 0x53, 0x52, 0x92, + 0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54, 0x9C, 0x5C, + 0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E, 0x5A, 0x9A, 0x9B, 0x5B, + 0x99, 0x59, 0x58, 0x98, 0x88, 0x48, 0x49, 0x89, 0x4B, 0x8B, + 0x8A, 0x4A, 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C, + 0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86, 0x82, 0x42, + 0x43, 0x83, 0x41, 0x81, 0x80, 0x40 +}; + +/* Define the slave ID of the remote device to talk in master mode or set the + * internal slave ID in slave mode */ +static int _modbus_set_slave(modbus_t *ctx, int slave) +{ + /* Broadcast address is 0 (MODBUS_BROADCAST_ADDRESS) */ + if (slave >= 0 && slave <= 247) { + ctx->slave = slave; + } else { + errno = EINVAL; + return -1; + } + + return 0; +} + +/* Builds a RTU request header */ +static int _modbus_rtu_build_request_basis(modbus_t *ctx, int function, + int addr, int nb, + uint8_t *req) +{ + assert(ctx->slave != -1); + req[0] = ctx->slave; + req[1] = function; + req[2] = addr >> 8; + req[3] = addr & 0x00ff; + req[4] = nb >> 8; + req[5] = nb & 0x00ff; + + return _MODBUS_RTU_PRESET_REQ_LENGTH; +} + +/* Builds a RTU response header */ +static int _modbus_rtu_build_response_basis(sft_t *sft, uint8_t *rsp) +{ + /* In this case, the slave is certainly valid because a check is already + * done in _modbus_rtu_listen */ + rsp[0] = sft->slave; + rsp[1] = sft->function; + + return _MODBUS_RTU_PRESET_RSP_LENGTH; +} + +static uint16_t crc16(uint8_t *buffer, uint16_t buffer_length) +{ + uint8_t crc_hi = 0xFF; /* high CRC byte initialized */ + uint8_t crc_lo = 0xFF; /* low CRC byte initialized */ + unsigned int i; /* will index into CRC lookup */ + + /* pass through message buffer */ + while (buffer_length--) { + i = crc_hi ^ *buffer++; /* calculate the CRC */ +#if defined(ARDUINO) && defined(__AVR__) + crc_hi = crc_lo ^ pgm_read_byte_near(table_crc_hi + i); + crc_lo = pgm_read_byte_near(table_crc_lo + i); +#else + crc_hi = crc_lo ^ table_crc_hi[i]; + crc_lo = table_crc_lo[i]; +#endif + } + + return (crc_hi << 8 | crc_lo); +} + +static int _modbus_rtu_prepare_response_tid(const uint8_t *req, int *req_length) +{ +#ifdef ARDUINO + (void)req; +#endif + (*req_length) -= _MODBUS_RTU_CHECKSUM_LENGTH; + /* No TID */ + return 0; +} + +static int _modbus_rtu_send_msg_pre(uint8_t *req, int req_length) +{ + uint16_t crc = crc16(req, req_length); + req[req_length++] = crc >> 8; + req[req_length++] = crc & 0x00FF; + + return req_length; +} + +#if defined(_WIN32) + +/* This simple implementation is sort of a substitute of the select() call, + * working this way: the win32_ser_select() call tries to read some data from + * the serial port, setting the timeout as the select() call would. Data read is + * stored into the receive buffer, that is then consumed by the win32_ser_read() + * call. So win32_ser_select() does both the event waiting and the reading, + * while win32_ser_read() only consumes the receive buffer. + */ + +static void win32_ser_init(struct win32_ser *ws) +{ + /* Clear everything */ + memset(ws, 0x00, sizeof(struct win32_ser)); + + /* Set file handle to invalid */ + ws->fd = INVALID_HANDLE_VALUE; +} + +/* FIXME Try to remove length_to_read -> max_len argument, only used by win32 */ +static int win32_ser_select(struct win32_ser *ws, int max_len, + const struct timeval *tv) +{ + COMMTIMEOUTS comm_to; + unsigned int msec = 0; + + /* Check if some data still in the buffer to be consumed */ + if (ws->n_bytes > 0) { + return 1; + } + + /* Setup timeouts like select() would do. + FIXME Please someone on Windows can look at this? + Does it possible to use WaitCommEvent? + When tv is NULL, MAXDWORD isn't infinite! + */ + if (tv == NULL) { + msec = MAXDWORD; + } else { + msec = tv->tv_sec * 1000 + tv->tv_usec / 1000; + if (msec < 1) + msec = 1; + } + + comm_to.ReadIntervalTimeout = msec; + comm_to.ReadTotalTimeoutMultiplier = 0; + comm_to.ReadTotalTimeoutConstant = msec; + comm_to.WriteTotalTimeoutMultiplier = 0; + comm_to.WriteTotalTimeoutConstant = 1000; + SetCommTimeouts(ws->fd, &comm_to); + + /* Read some bytes */ + if ((max_len > PY_BUF_SIZE) || (max_len < 0)) { + max_len = PY_BUF_SIZE; + } + + if (ReadFile(ws->fd, &ws->buf, max_len, &ws->n_bytes, NULL)) { + /* Check if some bytes available */ + if (ws->n_bytes > 0) { + /* Some bytes read */ + return 1; + } else { + /* Just timed out */ + return 0; + } + } else { + /* Some kind of error */ + return -1; + } +} + +static int win32_ser_read(struct win32_ser *ws, uint8_t *p_msg, + unsigned int max_len) +{ + unsigned int n = ws->n_bytes; + + if (max_len < n) { + n = max_len; + } + + if (n > 0) { + memcpy(p_msg, ws->buf, n); + } + + ws->n_bytes -= n; + + return n; +} +#endif + +#if HAVE_DECL_TIOCM_RTS +static void _modbus_rtu_ioctl_rts(modbus_t *ctx, int on) +{ + int fd = ctx->s; + int flags; + + ioctl(fd, TIOCMGET, &flags); + if (on) { + flags |= TIOCM_RTS; + } else { + flags &= ~TIOCM_RTS; + } + ioctl(fd, TIOCMSET, &flags); +} +#endif + +static ssize_t _modbus_rtu_send(modbus_t *ctx, const uint8_t *req, int req_length) +{ +#if defined(_WIN32) + modbus_rtu_t *ctx_rtu = ctx->backend_data; + DWORD n_bytes = 0; + return (WriteFile(ctx_rtu->w_ser.fd, req, req_length, &n_bytes, NULL)) ? (ssize_t)n_bytes : -1; +#elif defined(ARDUINO) + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; + + ssize_t size; + + ctx_rtu->rs485->noReceive(); + ctx_rtu->rs485->beginTransmission(); + size = ctx_rtu->rs485->write(req, req_length); + ctx_rtu->rs485->endTransmission(); + ctx_rtu->rs485->receive(); + + return size; +#else +#if HAVE_DECL_TIOCM_RTS + modbus_rtu_t *ctx_rtu = ctx->backend_data; + if (ctx_rtu->rts != MODBUS_RTU_RTS_NONE) { + ssize_t size; + + if (ctx->debug) { + fprintf(stderr, "Sending request using RTS signal\n"); + } + + ctx_rtu->set_rts(ctx, ctx_rtu->rts == MODBUS_RTU_RTS_UP); + usleep(ctx_rtu->rts_delay); + + size = write(ctx->s, req, req_length); + + usleep(ctx_rtu->onebyte_time * req_length + ctx_rtu->rts_delay); + ctx_rtu->set_rts(ctx, ctx_rtu->rts != MODBUS_RTU_RTS_UP); + + return size; + } else { +#endif + return write(ctx->s, req, req_length); +#if HAVE_DECL_TIOCM_RTS + } +#endif +#endif +} + +static int _modbus_rtu_receive(modbus_t *ctx, uint8_t *req) +{ + int rc; +#ifdef ARDUINO + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; +#else + modbus_rtu_t *ctx_rtu = ctx->backend_data; +#endif + + if (ctx_rtu->confirmation_to_ignore) { + _modbus_receive_msg(ctx, req, MSG_CONFIRMATION); + /* Ignore errors and reset the flag */ + ctx_rtu->confirmation_to_ignore = FALSE; + rc = 0; + if (ctx->debug) { + printf("Confirmation to ignore\n"); + } + } else { + rc = _modbus_receive_msg(ctx, req, MSG_INDICATION); + if (rc == 0) { + /* The next expected message is a confirmation to ignore */ + ctx_rtu->confirmation_to_ignore = TRUE; + } + } + return rc; +} + +static ssize_t _modbus_rtu_recv(modbus_t *ctx, uint8_t *rsp, int rsp_length) +{ +#if defined(_WIN32) + return win32_ser_read(&((modbus_rtu_t *)ctx->backend_data)->w_ser, rsp, rsp_length); +#elif defined(ARDUINO) + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; + + return ctx_rtu->rs485->readBytes(rsp, rsp_length); +#else + return read(ctx->s, rsp, rsp_length); +#endif +} + +static int _modbus_rtu_flush(modbus_t *); + +static int _modbus_rtu_pre_check_confirmation(modbus_t *ctx, const uint8_t *req, + const uint8_t *rsp, int rsp_length) +{ +#ifdef ARDUINO + (void)rsp_length; +#endif + /* Check responding slave is the slave we requested (except for broacast + * request) */ + if (req[0] != rsp[0] && req[0] != MODBUS_BROADCAST_ADDRESS) { + if (ctx->debug) { + fprintf(stderr, + "The responding slave %d isn't the requested slave %d\n", + rsp[0], req[0]); + } + errno = EMBBADSLAVE; + return -1; + } else { + return 0; + } +} + +/* The check_crc16 function shall return 0 is the message is ignored and the + message length if the CRC is valid. Otherwise it shall return -1 and set + errno to EMBADCRC. */ +static int _modbus_rtu_check_integrity(modbus_t *ctx, uint8_t *msg, + const int msg_length) +{ + uint16_t crc_calculated; + uint16_t crc_received; + int slave = msg[0]; + + /* Filter on the Modbus unit identifier (slave) in RTU mode to avoid useless + * CRC computing. */ + if (slave != ctx->slave && slave != MODBUS_BROADCAST_ADDRESS) { + if (ctx->debug) { + printf("Request for slave %d ignored (not %d)\n", slave, ctx->slave); + } + /* Following call to check_confirmation handles this error */ + return 0; + } + + crc_calculated = crc16(msg, msg_length - 2); + crc_received = (msg[msg_length - 2] << 8) | msg[msg_length - 1]; + + /* Check CRC of msg */ + if (crc_calculated == crc_received) { + return msg_length; + } else { + if (ctx->debug) { + fprintf(stderr, "ERROR CRC received 0x%0X != CRC calculated 0x%0X\n", + crc_received, crc_calculated); + } + + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { + _modbus_rtu_flush(ctx); + } + errno = EMBBADCRC; + return -1; + } +} + +/* Sets up a serial port for RTU communications */ +static int _modbus_rtu_connect(modbus_t *ctx) +{ +#if defined(_WIN32) + DCB dcb; +#elif defined(ARDUINO) + // nothing extra needed +#else + struct termios tios; + speed_t speed; + int flags; +#endif +#ifdef ARDUINO + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; +#else + modbus_rtu_t *ctx_rtu = ctx->backend_data; + + if (ctx->debug) { + printf("Opening %s at %d bauds (%c, %d, %d)\n", + ctx_rtu->device, ctx_rtu->baud, ctx_rtu->parity, + ctx_rtu->data_bit, ctx_rtu->stop_bit); + } +#endif + +#if defined(_WIN32) + /* Some references here: + * http://msdn.microsoft.com/en-us/library/aa450602.aspx + */ + win32_ser_init(&ctx_rtu->w_ser); + + /* ctx_rtu->device should contain a string like "COMxx:" xx being a decimal + * number */ + ctx_rtu->w_ser.fd = CreateFileA(ctx_rtu->device, + GENERIC_READ | GENERIC_WRITE, + 0, + NULL, + OPEN_EXISTING, + 0, + NULL); + + /* Error checking */ + if (ctx_rtu->w_ser.fd == INVALID_HANDLE_VALUE) { + if (ctx->debug) { + fprintf(stderr, "ERROR Can't open the device %s (LastError %d)\n", + ctx_rtu->device, (int)GetLastError()); + } + return -1; + } + + /* Save params */ + ctx_rtu->old_dcb.DCBlength = sizeof(DCB); + if (!GetCommState(ctx_rtu->w_ser.fd, &ctx_rtu->old_dcb)) { + if (ctx->debug) { + fprintf(stderr, "ERROR Error getting configuration (LastError %d)\n", + (int)GetLastError()); + } + CloseHandle(ctx_rtu->w_ser.fd); + ctx_rtu->w_ser.fd = INVALID_HANDLE_VALUE; + return -1; + } + + /* Build new configuration (starting from current settings) */ + dcb = ctx_rtu->old_dcb; + + /* Speed setting */ + switch (ctx_rtu->baud) { + case 110: + dcb.BaudRate = CBR_110; + break; + case 300: + dcb.BaudRate = CBR_300; + break; + case 600: + dcb.BaudRate = CBR_600; + break; + case 1200: + dcb.BaudRate = CBR_1200; + break; + case 2400: + dcb.BaudRate = CBR_2400; + break; + case 4800: + dcb.BaudRate = CBR_4800; + break; + case 9600: + dcb.BaudRate = CBR_9600; + break; + case 14400: + dcb.BaudRate = CBR_14400; + break; + case 19200: + dcb.BaudRate = CBR_19200; + break; + case 38400: + dcb.BaudRate = CBR_38400; + break; + case 57600: + dcb.BaudRate = CBR_57600; + break; + case 115200: + dcb.BaudRate = CBR_115200; + break; + case 230400: + /* CBR_230400 - not defined */ + dcb.BaudRate = 230400; + break; + case 250000: + dcb.BaudRate = 250000; + break; + case 460800: + dcb.BaudRate = 460800; + break; + case 500000: + dcb.BaudRate = 500000; + break; + case 921600: + dcb.BaudRate = 921600; + break; + case 1000000: + dcb.BaudRate = 1000000; + break; + default: + dcb.BaudRate = CBR_9600; + if (ctx->debug) { + fprintf(stderr, "WARNING Unknown baud rate %d for %s (B9600 used)\n", + ctx_rtu->baud, ctx_rtu->device); + } + } + + /* Data bits */ + switch (ctx_rtu->data_bit) { + case 5: + dcb.ByteSize = 5; + break; + case 6: + dcb.ByteSize = 6; + break; + case 7: + dcb.ByteSize = 7; + break; + case 8: + default: + dcb.ByteSize = 8; + break; + } + + /* Stop bits */ + if (ctx_rtu->stop_bit == 1) + dcb.StopBits = ONESTOPBIT; + else /* 2 */ + dcb.StopBits = TWOSTOPBITS; + + /* Parity */ + if (ctx_rtu->parity == 'N') { + dcb.Parity = NOPARITY; + dcb.fParity = FALSE; + } else if (ctx_rtu->parity == 'E') { + dcb.Parity = EVENPARITY; + dcb.fParity = TRUE; + } else { + /* odd */ + dcb.Parity = ODDPARITY; + dcb.fParity = TRUE; + } + + /* Hardware handshaking left as default settings retrieved */ + + /* No software handshaking */ + dcb.fTXContinueOnXoff = TRUE; + dcb.fOutX = FALSE; + dcb.fInX = FALSE; + + /* Binary mode (it's the only supported on Windows anyway) */ + dcb.fBinary = TRUE; + + /* Don't want errors to be blocking */ + dcb.fAbortOnError = FALSE; + + /* Setup port */ + if (!SetCommState(ctx_rtu->w_ser.fd, &dcb)) { + if (ctx->debug) { + fprintf(stderr, "ERROR Error setting new configuration (LastError %d)\n", + (int)GetLastError()); + } + CloseHandle(ctx_rtu->w_ser.fd); + ctx_rtu->w_ser.fd = INVALID_HANDLE_VALUE; + return -1; + } +#elif defined(ARDUINO) + ctx_rtu->rs485->begin(ctx_rtu->baud, ctx_rtu->config); + ctx_rtu->rs485->receive(); +#else + /* The O_NOCTTY flag tells UNIX that this program doesn't want + to be the "controlling terminal" for that port. If you + don't specify this then any input (such as keyboard abort + signals and so forth) will affect your process + + Timeouts are ignored in canonical input mode or when the + NDELAY option is set on the file via open or fcntl */ + flags = O_RDWR | O_NOCTTY | O_NDELAY | O_EXCL; +#ifdef O_CLOEXEC + flags |= O_CLOEXEC; +#endif + + ctx->s = open(ctx_rtu->device, flags); + if (ctx->s == -1) { + if (ctx->debug) { + fprintf(stderr, "ERROR Can't open the device %s (%s)\n", + ctx_rtu->device, strerror(errno)); + } + return -1; + } + + /* Save */ + tcgetattr(ctx->s, &ctx_rtu->old_tios); + + memset(&tios, 0, sizeof(struct termios)); + + /* C_ISPEED Input baud (new interface) + C_OSPEED Output baud (new interface) + */ + switch (ctx_rtu->baud) { + case 110: + speed = B110; + break; + case 300: + speed = B300; + break; + case 600: + speed = B600; + break; + case 1200: + speed = B1200; + break; + case 2400: + speed = B2400; + break; + case 4800: + speed = B4800; + break; + case 9600: + speed = B9600; + break; + case 19200: + speed = B19200; + break; + case 38400: + speed = B38400; + break; +#ifdef B57600 + case 57600: + speed = B57600; + break; +#endif +#ifdef B115200 + case 115200: + speed = B115200; + break; +#endif +#ifdef B230400 + case 230400: + speed = B230400; + break; +#endif +#ifdef B460800 + case 460800: + speed = B460800; + break; +#endif +#ifdef B500000 + case 500000: + speed = B500000; + break; +#endif +#ifdef B576000 + case 576000: + speed = B576000; + break; +#endif +#ifdef B921600 + case 921600: + speed = B921600; + break; +#endif +#ifdef B1000000 + case 1000000: + speed = B1000000; + break; +#endif +#ifdef B1152000 + case 1152000: + speed = B1152000; + break; +#endif +#ifdef B1500000 + case 1500000: + speed = B1500000; + break; +#endif +#ifdef B2500000 + case 2500000: + speed = B2500000; + break; +#endif +#ifdef B3000000 + case 3000000: + speed = B3000000; + break; +#endif +#ifdef B3500000 + case 3500000: + speed = B3500000; + break; +#endif +#ifdef B4000000 + case 4000000: + speed = B4000000; + break; +#endif + default: + speed = B9600; + if (ctx->debug) { + fprintf(stderr, + "WARNING Unknown baud rate %d for %s (B9600 used)\n", + ctx_rtu->baud, ctx_rtu->device); + } + } + + /* Set the baud rate */ + if ((cfsetispeed(&tios, speed) < 0) || + (cfsetospeed(&tios, speed) < 0)) { + close(ctx->s); + ctx->s = -1; + return -1; + } + + /* C_CFLAG Control options + CLOCAL Local line - do not change "owner" of port + CREAD Enable receiver + */ + tios.c_cflag |= (CREAD | CLOCAL); + /* CSIZE, HUPCL, CRTSCTS (hardware flow control) */ + + /* Set data bits (5, 6, 7, 8 bits) + CSIZE Bit mask for data bits + */ + tios.c_cflag &= ~CSIZE; + switch (ctx_rtu->data_bit) { + case 5: + tios.c_cflag |= CS5; + break; + case 6: + tios.c_cflag |= CS6; + break; + case 7: + tios.c_cflag |= CS7; + break; + case 8: + default: + tios.c_cflag |= CS8; + break; + } + + /* Stop bit (1 or 2) */ + if (ctx_rtu->stop_bit == 1) + tios.c_cflag &=~ CSTOPB; + else /* 2 */ + tios.c_cflag |= CSTOPB; + + /* PARENB Enable parity bit + PARODD Use odd parity instead of even */ + if (ctx_rtu->parity == 'N') { + /* None */ + tios.c_cflag &=~ PARENB; + } else if (ctx_rtu->parity == 'E') { + /* Even */ + tios.c_cflag |= PARENB; + tios.c_cflag &=~ PARODD; + } else { + /* Odd */ + tios.c_cflag |= PARENB; + tios.c_cflag |= PARODD; + } + + /* Read the man page of termios if you need more information. */ + + /* This field isn't used on POSIX systems + tios.c_line = 0; + */ + + /* C_LFLAG Line options + + ISIG Enable SIGINTR, SIGSUSP, SIGDSUSP, and SIGQUIT signals + ICANON Enable canonical input (else raw) + XCASE Map uppercase \lowercase (obsolete) + ECHO Enable echoing of input characters + ECHOE Echo erase character as BS-SP-BS + ECHOK Echo NL after kill character + ECHONL Echo NL + NOFLSH Disable flushing of input buffers after + interrupt or quit characters + IEXTEN Enable extended functions + ECHOCTL Echo control characters as ^char and delete as ~? + ECHOPRT Echo erased character as character erased + ECHOKE BS-SP-BS entire line on line kill + FLUSHO Output being flushed + PENDIN Retype pending input at next read or input char + TOSTOP Send SIGTTOU for background output + + Canonical input is line-oriented. Input characters are put + into a buffer which can be edited interactively by the user + until a CR (carriage return) or LF (line feed) character is + received. + + Raw input is unprocessed. Input characters are passed + through exactly as they are received, when they are + received. Generally you'll deselect the ICANON, ECHO, + ECHOE, and ISIG options when using raw input + */ + + /* Raw input */ + tios.c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG); + + /* C_IFLAG Input options + + Constant Description + INPCK Enable parity check + IGNPAR Ignore parity errors + PARMRK Mark parity errors + ISTRIP Strip parity bits + IXON Enable software flow control (outgoing) + IXOFF Enable software flow control (incoming) + IXANY Allow any character to start flow again + IGNBRK Ignore break condition + BRKINT Send a SIGINT when a break condition is detected + INLCR Map NL to CR + IGNCR Ignore CR + ICRNL Map CR to NL + IUCLC Map uppercase to lowercase + IMAXBEL Echo BEL on input line too long + */ + if (ctx_rtu->parity == 'N') { + /* None */ + tios.c_iflag &= ~INPCK; + } else { + tios.c_iflag |= INPCK; + } + + /* Software flow control is disabled */ + tios.c_iflag &= ~(IXON | IXOFF | IXANY); + + /* C_OFLAG Output options + OPOST Postprocess output (not set = raw output) + ONLCR Map NL to CR-NL + + ONCLR ant others needs OPOST to be enabled + */ + + /* Raw ouput */ + tios.c_oflag &=~ OPOST; + + /* C_CC Control characters + VMIN Minimum number of characters to read + VTIME Time to wait for data (tenths of seconds) + + UNIX serial interface drivers provide the ability to + specify character and packet timeouts. Two elements of the + c_cc array are used for timeouts: VMIN and VTIME. Timeouts + are ignored in canonical input mode or when the NDELAY + option is set on the file via open or fcntl. + + VMIN specifies the minimum number of characters to read. If + it is set to 0, then the VTIME value specifies the time to + wait for every character read. Note that this does not mean + that a read call for N bytes will wait for N characters to + come in. Rather, the timeout will apply to the first + character and the read call will return the number of + characters immediately available (up to the number you + request). + + If VMIN is non-zero, VTIME specifies the time to wait for + the first character read. If a character is read within the + time given, any read will block (wait) until all VMIN + characters are read. That is, once the first character is + read, the serial interface driver expects to receive an + entire packet of characters (VMIN bytes total). If no + character is read within the time allowed, then the call to + read returns 0. This method allows you to tell the serial + driver you need exactly N bytes and any read call will + return 0 or N bytes. However, the timeout only applies to + the first character read, so if for some reason the driver + misses one character inside the N byte packet then the read + call could block forever waiting for additional input + characters. + + VTIME specifies the amount of time to wait for incoming + characters in tenths of seconds. If VTIME is set to 0 (the + default), reads will block (wait) indefinitely unless the + NDELAY option is set on the port with open or fcntl. + */ + /* Unused because we use open with the NDELAY option */ + tios.c_cc[VMIN] = 0; + tios.c_cc[VTIME] = 0; + + if (tcsetattr(ctx->s, TCSANOW, &tios) < 0) { + close(ctx->s); + ctx->s = -1; + return -1; + } +#endif + + return 0; +} + +#ifndef ARDUINO +int modbus_rtu_set_serial_mode(modbus_t *ctx, int mode) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCSRS485 + modbus_rtu_t *ctx_rtu = ctx->backend_data; + struct serial_rs485 rs485conf; + memset(&rs485conf, 0x0, sizeof(struct serial_rs485)); + + if (mode == MODBUS_RTU_RS485) { + rs485conf.flags = SER_RS485_ENABLED; + if (ioctl(ctx->s, TIOCSRS485, &rs485conf) < 0) { + return -1; + } + + ctx_rtu->serial_mode = MODBUS_RTU_RS485; + return 0; + } else if (mode == MODBUS_RTU_RS232) { + /* Turn off RS485 mode only if required */ + if (ctx_rtu->serial_mode == MODBUS_RTU_RS485) { + /* The ioctl call is avoided because it can fail on some RS232 ports */ + if (ioctl(ctx->s, TIOCSRS485, &rs485conf) < 0) { + return -1; + } + } + ctx_rtu->serial_mode = MODBUS_RTU_RS232; + return 0; + } +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } + + /* Wrong backend and invalid mode specified */ + errno = EINVAL; + return -1; +} + +int modbus_rtu_get_serial_mode(modbus_t *ctx) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCSRS485 + modbus_rtu_t *ctx_rtu = ctx->backend_data; + return ctx_rtu->serial_mode; +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } else { + errno = EINVAL; + return -1; + } +} + +int modbus_rtu_get_rts(modbus_t *ctx) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCM_RTS + modbus_rtu_t *ctx_rtu = ctx->backend_data; + return ctx_rtu->rts; +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } else { + errno = EINVAL; + return -1; + } +} + +int modbus_rtu_set_rts(modbus_t *ctx, int mode) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCM_RTS + modbus_rtu_t *ctx_rtu = ctx->backend_data; + + if (mode == MODBUS_RTU_RTS_NONE || mode == MODBUS_RTU_RTS_UP || + mode == MODBUS_RTU_RTS_DOWN) { + ctx_rtu->rts = mode; + + /* Set the RTS bit in order to not reserve the RS485 bus */ + ctx_rtu->set_rts(ctx, ctx_rtu->rts != MODBUS_RTU_RTS_UP); + + return 0; + } else { + errno = EINVAL; + return -1; + } +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } + /* Wrong backend or invalid mode specified */ + errno = EINVAL; + return -1; +} + +int modbus_rtu_set_custom_rts(modbus_t *ctx, void (*set_rts) (modbus_t *ctx, int on)) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCM_RTS + modbus_rtu_t *ctx_rtu = ctx->backend_data; + ctx_rtu->set_rts = set_rts; + return 0; +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } else { + errno = EINVAL; + return -1; + } +} + +int modbus_rtu_get_rts_delay(modbus_t *ctx) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCM_RTS + modbus_rtu_t *ctx_rtu; + ctx_rtu = (modbus_rtu_t *)ctx->backend_data; + return ctx_rtu->rts_delay; +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } else { + errno = EINVAL; + return -1; + } +} + +int modbus_rtu_set_rts_delay(modbus_t *ctx, int us) +{ + if (ctx == NULL || us < 0) { + errno = EINVAL; + return -1; + } + + if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { +#if HAVE_DECL_TIOCM_RTS + modbus_rtu_t *ctx_rtu; + ctx_rtu = (modbus_rtu_t *)ctx->backend_data; + ctx_rtu->rts_delay = us; + return 0; +#else + if (ctx->debug) { + fprintf(stderr, "This function isn't supported on your platform\n"); + } + errno = ENOTSUP; + return -1; +#endif + } else { + errno = EINVAL; + return -1; + } +} +#endif + +static void _modbus_rtu_close(modbus_t *ctx) +{ + /* Restore line settings and close file descriptor in RTU mode */ +#ifdef ARDUINO + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; +#else + modbus_rtu_t *ctx_rtu = ctx->backend_data; +#endif + +#if defined(_WIN32) + /* Revert settings */ + if (!SetCommState(ctx_rtu->w_ser.fd, &ctx_rtu->old_dcb) && ctx->debug) { + fprintf(stderr, "ERROR Couldn't revert to configuration (LastError %d)\n", + (int)GetLastError()); + } + + if (!CloseHandle(ctx_rtu->w_ser.fd) && ctx->debug) { + fprintf(stderr, "ERROR Error while closing handle (LastError %d)\n", + (int)GetLastError()); + } +#elif defined(ARDUINO) + (void)ctx_rtu; + + ctx_rtu->rs485->noReceive(); + ctx_rtu->rs485->end(); +#else + if (ctx->s != -1) { + tcsetattr(ctx->s, TCSANOW, &ctx_rtu->old_tios); + close(ctx->s); + ctx->s = -1; + } +#endif +} + +static int _modbus_rtu_flush(modbus_t *ctx) +{ +#if defined(_WIN32) + modbus_rtu_t *ctx_rtu = ctx->backend_data; + ctx_rtu->w_ser.n_bytes = 0; + return (PurgeComm(ctx_rtu->w_ser.fd, PURGE_RXCLEAR) == FALSE); +#elif defined(ARDUINO) + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; + + while (ctx_rtu->rs485->available()) { + ctx_rtu->rs485->read(); + } + + return 0; +#else + return tcflush(ctx->s, TCIOFLUSH); +#endif +} + +static int _modbus_rtu_select(modbus_t *ctx, fd_set *rset, + struct timeval *tv, int length_to_read) +{ + int s_rc; +#if defined(_WIN32) + s_rc = win32_ser_select(&((modbus_rtu_t *)ctx->backend_data)->w_ser, + length_to_read, tv); + if (s_rc == 0) { + errno = ETIMEDOUT; + return -1; + } + + if (s_rc < 0) { + return -1; + } +#elif defined(ARDUINO) + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; + (void)rset; + + unsigned long wait_time_millis = (tv == NULL) ? 0 : (tv->tv_sec * 1000) + (tv->tv_usec / 1000); + unsigned long start = millis(); + + do { + s_rc = ctx_rtu->rs485->available(); + + if (s_rc >= length_to_read) { + break; + } + } while ((millis() - start) < wait_time_millis); + + if (s_rc == 0) { + /* Timeout */ + errno = ETIMEDOUT; + return -1; + } +#else + while ((s_rc = select(ctx->s+1, rset, NULL, NULL, tv)) == -1) { + if (errno == EINTR) { + if (ctx->debug) { + fprintf(stderr, "A non blocked signal was caught\n"); + } + /* Necessary after an error */ + FD_ZERO(rset); + FD_SET(ctx->s, rset); + } else { + return -1; + } + } + + if (s_rc == 0) { + /* Timeout */ + errno = ETIMEDOUT; + return -1; + } +#endif + + return s_rc; +} + +static void _modbus_rtu_free(modbus_t *ctx) { +#ifndef ARDUINO + free(((modbus_rtu_t*)ctx->backend_data)->device); +#endif + free(ctx->backend_data); + free(ctx); +} + +const modbus_backend_t _modbus_rtu_backend = { + _MODBUS_BACKEND_TYPE_RTU, + _MODBUS_RTU_HEADER_LENGTH, + _MODBUS_RTU_CHECKSUM_LENGTH, + MODBUS_RTU_MAX_ADU_LENGTH, + _modbus_set_slave, + _modbus_rtu_build_request_basis, + _modbus_rtu_build_response_basis, + _modbus_rtu_prepare_response_tid, + _modbus_rtu_send_msg_pre, + _modbus_rtu_send, + _modbus_rtu_receive, + _modbus_rtu_recv, + _modbus_rtu_check_integrity, + _modbus_rtu_pre_check_confirmation, + _modbus_rtu_connect, + _modbus_rtu_close, + _modbus_rtu_flush, + _modbus_rtu_select, + _modbus_rtu_free +}; + +#ifdef ARDUINO +modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, uint16_t config) +#else +modbus_t* modbus_new_rtu(const char *device, + int baud, char parity, int data_bit, + int stop_bit) +#endif +{ + modbus_t *ctx; + modbus_rtu_t *ctx_rtu; + +#ifndef ARDUINO + /* Check device argument */ + if (device == NULL || *device == 0) { + fprintf(stderr, "The device string is empty\n"); + errno = EINVAL; + return NULL; + } + + /* Check baud argument */ + if (baud == 0) { + fprintf(stderr, "The baud rate value must not be zero\n"); + errno = EINVAL; + return NULL; + } +#endif + + ctx = (modbus_t *)malloc(sizeof(modbus_t)); + _modbus_init_common(ctx); + ctx->backend = &_modbus_rtu_backend; + ctx->backend_data = (modbus_rtu_t *)malloc(sizeof(modbus_rtu_t)); + ctx_rtu = (modbus_rtu_t *)ctx->backend_data; +#ifdef ARDUINO + ctx_rtu->rs485 = rs485; + ctx_rtu->baud = baud; + ctx_rtu->config = config; +#else + ctx_rtu->device = NULL; + + /* Device name and \0 */ + ctx_rtu->device = (char *)malloc((strlen(device) + 1) * sizeof(char)); + strcpy(ctx_rtu->device, device); + + ctx_rtu->baud = baud; + if (parity == 'N' || parity == 'E' || parity == 'O') { + ctx_rtu->parity = parity; + } else { + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + ctx_rtu->data_bit = data_bit; + ctx_rtu->stop_bit = stop_bit; + +#if HAVE_DECL_TIOCSRS485 + /* The RS232 mode has been set by default */ + ctx_rtu->serial_mode = MODBUS_RTU_RS232; +#endif + +#if HAVE_DECL_TIOCM_RTS + /* The RTS use has been set by default */ + ctx_rtu->rts = MODBUS_RTU_RTS_NONE; + + /* Calculate estimated time in micro second to send one byte */ + ctx_rtu->onebyte_time = 1000000 * (1 + data_bit + (parity == 'N' ? 0 : 1) + stop_bit) / baud; + + /* The internal function is used by default to set RTS */ + ctx_rtu->set_rts = _modbus_rtu_ioctl_rts; + + /* The delay before and after transmission when toggling the RTS pin */ + ctx_rtu->rts_delay = ctx_rtu->onebyte_time; +#endif +#endif + + ctx_rtu->confirmation_to_ignore = FALSE; + + return ctx; +} diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-rtu.h b/libraries/ArduinoModbus/src/libmodbus/modbus-rtu.h new file mode 100644 index 0000000..9521114 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-rtu.h @@ -0,0 +1,48 @@ +/* + * Copyright © 2001-2011 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifndef MODBUS_RTU_H +#define MODBUS_RTU_H + +#include "modbus.h" + +MODBUS_BEGIN_DECLS + +/* Modbus_Application_Protocol_V1_1b.pdf Chapter 4 Section 1 Page 5 + * RS232 / RS485 ADU = 253 bytes + slave (1 byte) + CRC (2 bytes) = 256 bytes + */ +#define MODBUS_RTU_MAX_ADU_LENGTH 256 + +#ifdef ARDUINO +class RS485Class; +MODBUS_API modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, uint16_t config); +#else +MODBUS_API modbus_t* modbus_new_rtu(const char *device, int baud, char parity, + int data_bit, int stop_bit); + +#define MODBUS_RTU_RS232 0 +#define MODBUS_RTU_RS485 1 + +MODBUS_API int modbus_rtu_set_serial_mode(modbus_t *ctx, int mode); +MODBUS_API int modbus_rtu_get_serial_mode(modbus_t *ctx); + +#define MODBUS_RTU_RTS_NONE 0 +#define MODBUS_RTU_RTS_UP 1 +#define MODBUS_RTU_RTS_DOWN 2 + +MODBUS_API int modbus_rtu_set_rts(modbus_t *ctx, int mode); +MODBUS_API int modbus_rtu_get_rts(modbus_t *ctx); + +MODBUS_API int modbus_rtu_set_custom_rts(modbus_t *ctx, void (*set_rts) (modbus_t *ctx, int on)); + +MODBUS_API int modbus_rtu_set_rts_delay(modbus_t *ctx, int us); +MODBUS_API int modbus_rtu_get_rts_delay(modbus_t *ctx); +#endif + +MODBUS_END_DECLS + +#endif /* MODBUS_RTU_H */ diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-tcp-private.h b/libraries/ArduinoModbus/src/libmodbus/modbus-tcp-private.h new file mode 100644 index 0000000..c87c33f --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-tcp-private.h @@ -0,0 +1,56 @@ +/* + * Copyright © 2001-2011 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifndef MODBUS_TCP_PRIVATE_H +#define MODBUS_TCP_PRIVATE_H + +#ifdef ARDUINO +#include +#include +#include +#endif + +#define _MODBUS_TCP_HEADER_LENGTH 7 +#define _MODBUS_TCP_PRESET_REQ_LENGTH 12 +#define _MODBUS_TCP_PRESET_RSP_LENGTH 8 + +#define _MODBUS_TCP_CHECKSUM_LENGTH 0 + +/* In both structures, the transaction ID must be placed on first position + to have a quick access not dependant of the TCP backend */ +typedef struct _modbus_tcp { + /* Extract from MODBUS Messaging on TCP/IP Implementation Guide V1.0b + (page 23/46): + The transaction identifier is used to associate the future response + with the request. This identifier is unique on each TCP connection. */ + uint16_t t_id; + /* TCP port */ + int port; +#ifdef ARDUINO + IPAddress ip; + Client* client; +#else + /* IP address */ + char ip[16]; +#endif +} modbus_tcp_t; + +#define _MODBUS_TCP_PI_NODE_LENGTH 1025 +#define _MODBUS_TCP_PI_SERVICE_LENGTH 32 + +typedef struct _modbus_tcp_pi { + /* Transaction ID */ + uint16_t t_id; + /* TCP port */ + int port; + /* Node */ + char node[_MODBUS_TCP_PI_NODE_LENGTH]; + /* Service */ + char service[_MODBUS_TCP_PI_SERVICE_LENGTH]; +} modbus_tcp_pi_t; + +#endif /* MODBUS_TCP_PRIVATE_H */ diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-tcp.cpp b/libraries/ArduinoModbus/src/libmodbus/modbus-tcp.cpp new file mode 100644 index 0000000..2d69cc0 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-tcp.cpp @@ -0,0 +1,1061 @@ +/* + * Copyright © 2001-2013 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#include +#include +#include +#include +#if !defined(_MSC_VER) && !defined(ARDUINO) +#include +#endif +#include +#include + +#if defined(_WIN32) +# define OS_WIN32 +/* ws2_32.dll has getaddrinfo and freeaddrinfo on Windows XP and later. + * minwg32 headers check WINVER before allowing the use of these */ +# ifndef WINVER +# define WINVER 0x0501 +# endif +/* Already set in modbus-tcp.h but it seems order matters in VS2005 */ +# include +# include +# define SHUT_RDWR 2 +# define close closesocket +#elif defined(ARDUINO) +#include "Arduino.h" +#ifndef DEBUG +#define printf(...) {} +#define fprintf(...) {} +#endif +#else +# include +# include + +#if defined(__OpenBSD__) || (defined(__FreeBSD__) && __FreeBSD__ < 5) +# define OS_BSD +# include +#endif + +# include +# include +# include +# include +# include +#endif + +#if !defined(MSG_NOSIGNAL) +#define MSG_NOSIGNAL 0 +#endif + +#if defined(_AIX) && !defined(MSG_DONTWAIT) +#define MSG_DONTWAIT MSG_NONBLOCK +#endif + +#if defined(ARDUINO) && defined(__AVR__) +#undef EIO +#define EIO 5 + +#undef EINVAL +#define EINVAL 22 + +#undef ENOPROTOOPT +#define ENOPROTOOPT 109 + +#undef ECONNREFUSED +#define ECONNREFUSED 111 + +#undef ETIMEDOUT +#define ETIMEDOUT 116 + +#undef ENOTSUP +#define ENOTSUP 134 +#endif + +#include "modbus-private.h" + +#include "modbus-tcp.h" +#include "modbus-tcp-private.h" + +#ifdef OS_WIN32 +static int _modbus_tcp_init_win32(void) +{ + /* Initialise Windows Socket API */ + WSADATA wsaData; + + if (WSAStartup(MAKEWORD(2, 2), &wsaData) != 0) { + fprintf(stderr, "WSAStartup() returned error code %d\n", + (unsigned int)GetLastError()); + errno = EIO; + return -1; + } + return 0; +} +#endif + +static int _modbus_set_slave(modbus_t *ctx, int slave) +{ + /* Broadcast address is 0 (MODBUS_BROADCAST_ADDRESS) */ + if (slave >= 0 && slave <= 247) { + ctx->slave = slave; + } else if (slave == MODBUS_TCP_SLAVE) { + /* The special value MODBUS_TCP_SLAVE (0xFF) can be used in TCP mode to + * restore the default value. */ + ctx->slave = slave; + } else { + errno = EINVAL; + return -1; + } + + return 0; +} + +/* Builds a TCP request header */ +static int _modbus_tcp_build_request_basis(modbus_t *ctx, int function, + int addr, int nb, + uint8_t *req) +{ +#ifdef ARDUINO + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; +#else + modbus_tcp_t *ctx_tcp = ctx->backend_data; +#endif + + /* Increase transaction ID */ + if (ctx_tcp->t_id < UINT16_MAX) + ctx_tcp->t_id++; + else + ctx_tcp->t_id = 0; + req[0] = ctx_tcp->t_id >> 8; + req[1] = ctx_tcp->t_id & 0x00ff; + + /* Protocol Modbus */ + req[2] = 0; + req[3] = 0; + + /* Length will be defined later by set_req_length_tcp at offsets 4 + and 5 */ + + req[6] = ctx->slave; + req[7] = function; + req[8] = addr >> 8; + req[9] = addr & 0x00ff; + req[10] = nb >> 8; + req[11] = nb & 0x00ff; + + return _MODBUS_TCP_PRESET_REQ_LENGTH; +} + +/* Builds a TCP response header */ +static int _modbus_tcp_build_response_basis(sft_t *sft, uint8_t *rsp) +{ + /* Extract from MODBUS Messaging on TCP/IP Implementation + Guide V1.0b (page 23/46): + The transaction identifier is used to associate the future + response with the request. */ + rsp[0] = sft->t_id >> 8; + rsp[1] = sft->t_id & 0x00ff; + + /* Protocol Modbus */ + rsp[2] = 0; + rsp[3] = 0; + + /* Length will be set later by send_msg (4 and 5) */ + + /* The slave ID is copied from the indication */ + rsp[6] = sft->slave; + rsp[7] = sft->function; + + return _MODBUS_TCP_PRESET_RSP_LENGTH; +} + + +static int _modbus_tcp_prepare_response_tid(const uint8_t *req, int *req_length) +{ +#ifdef ARDUINO + (void)req_length; +#endif + return (req[0] << 8) + req[1]; +} + +static int _modbus_tcp_send_msg_pre(uint8_t *req, int req_length) +{ + /* Substract the header length to the message length */ + int mbap_length = req_length - 6; + + req[4] = mbap_length >> 8; + req[5] = mbap_length & 0x00FF; + + return req_length; +} + +static ssize_t _modbus_tcp_send(modbus_t *ctx, const uint8_t *req, int req_length) +{ +#ifdef ARDUINO + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; + + return ctx_tcp->client->write(req, req_length); +#else + /* MSG_NOSIGNAL + Requests not to send SIGPIPE on errors on stream oriented + sockets when the other end breaks the connection. The EPIPE + error is still returned. */ + return send(ctx->s, (const char *)req, req_length, MSG_NOSIGNAL); +#endif +} + +static int _modbus_tcp_receive(modbus_t *ctx, uint8_t *req) { + return _modbus_receive_msg(ctx, req, MSG_INDICATION); +} + +static ssize_t _modbus_tcp_recv(modbus_t *ctx, uint8_t *rsp, int rsp_length) { +#ifdef ARDUINO + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; + + return ctx_tcp->client->read(rsp, rsp_length); +#else + return recv(ctx->s, (char *)rsp, rsp_length, 0); +#endif +} + +static int _modbus_tcp_check_integrity(modbus_t *ctx, uint8_t *msg, const int msg_length) +{ +#ifdef ARDUINO + (void)ctx; + (void)msg; +#endif + return msg_length; +} + +static int _modbus_tcp_pre_check_confirmation(modbus_t *ctx, const uint8_t *req, + const uint8_t *rsp, int rsp_length) +{ +#ifdef ARDUINO + (void)rsp_length; +#endif + /* Check transaction ID */ + if (req[0] != rsp[0] || req[1] != rsp[1]) { + if (ctx->debug) { + fprintf(stderr, "Invalid transaction ID received 0x%X (not 0x%X)\n", + (rsp[0] << 8) + rsp[1], (req[0] << 8) + req[1]); + } + errno = EMBBADDATA; + return -1; + } + + /* Check protocol ID */ + if (rsp[2] != 0x0 && rsp[3] != 0x0) { + if (ctx->debug) { + fprintf(stderr, "Invalid protocol ID received 0x%X (not 0x0)\n", + (rsp[2] << 8) + rsp[3]); + } + errno = EMBBADDATA; + return -1; + } + + return 0; +} + +#ifndef ARDUINO +static int _modbus_tcp_set_ipv4_options(int s) +{ + int rc; + int option; + + /* Set the TCP no delay flag */ + /* SOL_TCP = IPPROTO_TCP */ + option = 1; + rc = setsockopt(s, IPPROTO_TCP, TCP_NODELAY, + (const void *)&option, sizeof(int)); + if (rc == -1) { + return -1; + } + + /* If the OS does not offer SOCK_NONBLOCK, fall back to setting FIONBIO to + * make sockets non-blocking */ + /* Do not care about the return value, this is optional */ +#if !defined(SOCK_NONBLOCK) && defined(FIONBIO) +#ifdef OS_WIN32 + { + /* Setting FIONBIO expects an unsigned long according to MSDN */ + u_long loption = 1; + ioctlsocket(s, FIONBIO, &loption); + } +#else + option = 1; + ioctl(s, FIONBIO, &option); +#endif +#endif + +#ifndef OS_WIN32 + /** + * Cygwin defines IPTOS_LOWDELAY but can't handle that flag so it's + * necessary to workaround that problem. + **/ + /* Set the IP low delay option */ + option = IPTOS_LOWDELAY; + rc = setsockopt(s, IPPROTO_IP, IP_TOS, + (const void *)&option, sizeof(int)); + if (rc == -1) { + return -1; + } +#endif + + return 0; +} + +static int _connect(int sockfd, const struct sockaddr *addr, socklen_t addrlen, + const struct timeval *ro_tv) +{ + int rc = connect(sockfd, addr, addrlen); + +#ifdef OS_WIN32 + int wsaError = 0; + if (rc == -1) { + wsaError = WSAGetLastError(); + } + + if (wsaError == WSAEWOULDBLOCK || wsaError == WSAEINPROGRESS) { +#else + if (rc == -1 && errno == EINPROGRESS) { +#endif + fd_set wset; + int optval; + socklen_t optlen = sizeof(optval); + struct timeval tv = *ro_tv; + + /* Wait to be available in writing */ + FD_ZERO(&wset); + FD_SET(sockfd, &wset); + rc = select(sockfd + 1, NULL, &wset, NULL, &tv); + if (rc <= 0) { + /* Timeout or fail */ + return -1; + } + + /* The connection is established if SO_ERROR and optval are set to 0 */ + rc = getsockopt(sockfd, SOL_SOCKET, SO_ERROR, (void *)&optval, &optlen); + if (rc == 0 && optval == 0) { + return 0; + } else { + errno = ECONNREFUSED; + return -1; + } + } + return rc; +} +#endif + +/* Establishes a modbus TCP connection with a Modbus server. */ +static int _modbus_tcp_connect(modbus_t *ctx) +{ +#ifdef ARDUINO + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; +#else + int rc; + /* Specialized version of sockaddr for Internet socket address (same size) */ + struct sockaddr_in addr; + modbus_tcp_t *ctx_tcp = ctx->backend_data; + int flags = SOCK_STREAM; +#endif + +#ifdef OS_WIN32 + if (_modbus_tcp_init_win32() == -1) { + return -1; + } +#endif + +#ifdef ARDUINO + if (!ctx_tcp->client->connect(ctx_tcp->ip, ctx_tcp->port)) { + return -1; + } +#else +#ifdef SOCK_CLOEXEC + flags |= SOCK_CLOEXEC; +#endif + +#ifdef SOCK_NONBLOCK + flags |= SOCK_NONBLOCK; +#endif + + ctx->s = socket(PF_INET, flags, 0); + if (ctx->s == -1) { + return -1; + } + + rc = _modbus_tcp_set_ipv4_options(ctx->s); + if (rc == -1) { + close(ctx->s); + ctx->s = -1; + return -1; + } + + if (ctx->debug) { + printf("Connecting to %s:%d\n", ctx_tcp->ip, ctx_tcp->port); + } + + addr.sin_family = AF_INET; + addr.sin_port = htons(ctx_tcp->port); + addr.sin_addr.s_addr = inet_addr(ctx_tcp->ip); + rc = _connect(ctx->s, (struct sockaddr *)&addr, sizeof(addr), &ctx->response_timeout); + if (rc == -1) { + close(ctx->s); + ctx->s = -1; + return -1; + } +#endif + + return 0; +} + +#ifndef ARDUINO +/* Establishes a modbus TCP PI connection with a Modbus server. */ +static int _modbus_tcp_pi_connect(modbus_t *ctx) +{ + int rc; + struct addrinfo *ai_list; + struct addrinfo *ai_ptr; + struct addrinfo ai_hints; + modbus_tcp_pi_t *ctx_tcp_pi = ctx->backend_data; + +#ifdef OS_WIN32 + if (_modbus_tcp_init_win32() == -1) { + return -1; + } +#endif + + memset(&ai_hints, 0, sizeof(ai_hints)); +#ifdef AI_ADDRCONFIG + ai_hints.ai_flags |= AI_ADDRCONFIG; +#endif + ai_hints.ai_family = AF_UNSPEC; + ai_hints.ai_socktype = SOCK_STREAM; + ai_hints.ai_addr = NULL; + ai_hints.ai_canonname = NULL; + ai_hints.ai_next = NULL; + + ai_list = NULL; + rc = getaddrinfo(ctx_tcp_pi->node, ctx_tcp_pi->service, + &ai_hints, &ai_list); + if (rc != 0) { + if (ctx->debug) { + fprintf(stderr, "Error returned by getaddrinfo: %s\n", gai_strerror(rc)); + } + errno = ECONNREFUSED; + return -1; + } + + for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) { + int flags = ai_ptr->ai_socktype; + int s; + +#ifdef SOCK_CLOEXEC + flags |= SOCK_CLOEXEC; +#endif + +#ifdef SOCK_NONBLOCK + flags |= SOCK_NONBLOCK; +#endif + + s = socket(ai_ptr->ai_family, flags, ai_ptr->ai_protocol); + if (s < 0) + continue; + + if (ai_ptr->ai_family == AF_INET) + _modbus_tcp_set_ipv4_options(s); + + if (ctx->debug) { + printf("Connecting to [%s]:%s\n", ctx_tcp_pi->node, ctx_tcp_pi->service); + } + + rc = _connect(s, ai_ptr->ai_addr, ai_ptr->ai_addrlen, &ctx->response_timeout); + if (rc == -1) { + close(s); + continue; + } + + ctx->s = s; + break; + } + + freeaddrinfo(ai_list); + + if (ctx->s < 0) { + return -1; + } + + return 0; +} +#endif + +/* Closes the network connection and socket in TCP mode */ +static void _modbus_tcp_close(modbus_t *ctx) +{ +#ifdef ARDUINO + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; + + if(ctx_tcp && ctx_tcp->client) { + ctx_tcp->client->stop(); + } + +#else + if (ctx->s != -1) { + shutdown(ctx->s, SHUT_RDWR); + close(ctx->s); + ctx->s = -1; + } +#endif +} + +static int _modbus_tcp_flush(modbus_t *ctx) +{ +#ifdef ARDUINO + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; + + while (ctx_tcp->client->available()) { + ctx_tcp->client->read(); + } + + return 0; +#else + int rc; + int rc_sum = 0; + + do { + /* Extract the garbage from the socket */ + char devnull[MODBUS_TCP_MAX_ADU_LENGTH]; +#ifndef OS_WIN32 + rc = recv(ctx->s, devnull, MODBUS_TCP_MAX_ADU_LENGTH, MSG_DONTWAIT); +#else + /* On Win32, it's a bit more complicated to not wait */ + fd_set rset; + struct timeval tv; + + tv.tv_sec = 0; + tv.tv_usec = 0; + FD_ZERO(&rset); + FD_SET(ctx->s, &rset); + rc = select(ctx->s+1, &rset, NULL, NULL, &tv); + if (rc == -1) { + return -1; + } + + if (rc == 1) { + /* There is data to flush */ + rc = recv(ctx->s, devnull, MODBUS_TCP_MAX_ADU_LENGTH, 0); + } +#endif + if (rc > 0) { + rc_sum += rc; + } + } while (rc == MODBUS_TCP_MAX_ADU_LENGTH); + + return rc_sum; +#endif +} + +/* Listens for any request from one or many modbus masters in TCP */ +#ifdef ARDUINO +int modbus_tcp_listen(modbus_t *ctx) +#else +int modbus_tcp_listen(modbus_t *ctx, int nb_connection) +#endif +{ +#ifndef ARDUINO + int new_s; + int enable; + struct sockaddr_in addr; + modbus_tcp_t *ctx_tcp; +#endif + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + +#ifdef ARDUINO + return 0; +#else + ctx_tcp = ctx->backend_data; + +#ifdef OS_WIN32 + if (_modbus_tcp_init_win32() == -1) { + return -1; + } +#endif + + new_s = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP); + if (new_s == -1) { + return -1; + } + + enable = 1; + if (setsockopt(new_s, SOL_SOCKET, SO_REUSEADDR, + (char *)&enable, sizeof(enable)) == -1) { + close(new_s); + return -1; + } + + memset(&addr, 0, sizeof(addr)); + addr.sin_family = AF_INET; + /* If the modbus port is < to 1024, we need the setuid root. */ + addr.sin_port = htons(ctx_tcp->port); + if (ctx_tcp->ip[0] == '0') { + /* Listen any addresses */ + addr.sin_addr.s_addr = htonl(INADDR_ANY); + } else { + /* Listen only specified IP address */ + addr.sin_addr.s_addr = inet_addr(ctx_tcp->ip); + } + if (bind(new_s, (struct sockaddr *)&addr, sizeof(addr)) == -1) { + close(new_s); + return -1; + } + + if (listen(new_s, nb_connection) == -1) { + close(new_s); + return -1; + } + + return new_s; +#endif +} + +#ifndef ARDUINO +int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection) +{ + int rc; + struct addrinfo *ai_list; + struct addrinfo *ai_ptr; + struct addrinfo ai_hints; + const char *node; + const char *service; + int new_s; + modbus_tcp_pi_t *ctx_tcp_pi; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + ctx_tcp_pi = ctx->backend_data; + +#ifdef OS_WIN32 + if (_modbus_tcp_init_win32() == -1) { + return -1; + } +#endif + + if (ctx_tcp_pi->node[0] == 0) { + node = NULL; /* == any */ + } else { + node = ctx_tcp_pi->node; + } + + if (ctx_tcp_pi->service[0] == 0) { + service = "502"; + } else { + service = ctx_tcp_pi->service; + } + + memset(&ai_hints, 0, sizeof (ai_hints)); + /* If node is not NULL, than the AI_PASSIVE flag is ignored. */ + ai_hints.ai_flags |= AI_PASSIVE; +#ifdef AI_ADDRCONFIG + ai_hints.ai_flags |= AI_ADDRCONFIG; +#endif + ai_hints.ai_family = AF_UNSPEC; + ai_hints.ai_socktype = SOCK_STREAM; + ai_hints.ai_addr = NULL; + ai_hints.ai_canonname = NULL; + ai_hints.ai_next = NULL; + + ai_list = NULL; + rc = getaddrinfo(node, service, &ai_hints, &ai_list); + if (rc != 0) { + if (ctx->debug) { + fprintf(stderr, "Error returned by getaddrinfo: %s\n", gai_strerror(rc)); + } + errno = ECONNREFUSED; + return -1; + } + + new_s = -1; + for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) { + int s; + + s = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, + ai_ptr->ai_protocol); + if (s < 0) { + if (ctx->debug) { + perror("socket"); + } + continue; + } else { + int enable = 1; + rc = setsockopt(s, SOL_SOCKET, SO_REUSEADDR, + (void *)&enable, sizeof (enable)); + if (rc != 0) { + close(s); + if (ctx->debug) { + perror("setsockopt"); + } + continue; + } + } + + rc = bind(s, ai_ptr->ai_addr, ai_ptr->ai_addrlen); + if (rc != 0) { + close(s); + if (ctx->debug) { + perror("bind"); + } + continue; + } + + rc = listen(s, nb_connection); + if (rc != 0) { + close(s); + if (ctx->debug) { + perror("listen"); + } + continue; + } + + new_s = s; + break; + } + freeaddrinfo(ai_list); + + if (new_s < 0) { + return -1; + } + + return new_s; +} +#endif + + +#ifdef ARDUINO +#ifdef __NEED_NAMESPACE__ +int modbus_tcp_accept(modbus_t *ctx, arduino::Client* client) +#else +int modbus_tcp_accept(modbus_t *ctx, Client* client) +#endif +#else +int modbus_tcp_accept(modbus_t *ctx, int *s) +#endif +{ +#ifndef ARDUINO + struct sockaddr_in addr; + socklen_t addrlen; +#endif + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + +#ifdef ARDUINO + if (client == NULL) { + errno = EINVAL; + return -1; + } + + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; + + ctx_tcp->client = client; + + return 0; +#else + addrlen = sizeof(addr); +#ifdef HAVE_ACCEPT4 + /* Inherit socket flags and use accept4 call */ + ctx->s = accept4(*s, (struct sockaddr *)&addr, &addrlen, SOCK_CLOEXEC); +#else + ctx->s = accept(*s, (struct sockaddr *)&addr, &addrlen); +#endif + + if (ctx->s == -1) { + close(*s); + *s = -1; + return -1; + } + + if (ctx->debug) { + printf("The client connection from %s is accepted\n", + inet_ntoa(addr.sin_addr)); + } + + return ctx->s; +#endif +} + +#ifndef ARDUINO +int modbus_tcp_pi_accept(modbus_t *ctx, int *s) +{ + struct sockaddr_storage addr; + socklen_t addrlen; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + addrlen = sizeof(addr); +#ifdef HAVE_ACCEPT4 + /* Inherit socket flags and use accept4 call */ + ctx->s = accept4(*s, (struct sockaddr *)&addr, &addrlen, SOCK_CLOEXEC); +#else + ctx->s = accept(*s, (struct sockaddr *)&addr, &addrlen); +#endif + if (ctx->s == -1) { + close(*s); + *s = -1; + } + + if (ctx->debug) { + printf("The client connection is accepted.\n"); + } + + return ctx->s; +} +#endif + +static int _modbus_tcp_select(modbus_t *ctx, fd_set *rset, struct timeval *tv, int length_to_read) +{ + int s_rc; +#ifdef ARDUINO + (void)rset; + + modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; + + unsigned long wait_time_millis = (tv == NULL) ? 0 : (tv->tv_sec * 1000) + (tv->tv_usec / 1000); + unsigned long start = millis(); + + do { + s_rc = ctx_tcp->client->available(); + + if (s_rc >= length_to_read) { + break; + } + } while ((millis() - start) < wait_time_millis && ctx_tcp->client->connected()); +#else + while ((s_rc = select(ctx->s+1, rset, NULL, NULL, tv)) == -1) { + if (errno == EINTR) { + if (ctx->debug) { + fprintf(stderr, "A non blocked signal was caught\n"); + } + /* Necessary after an error */ + FD_ZERO(rset); + FD_SET(ctx->s, rset); + } else { + return -1; + } + } +#endif + + if (s_rc == 0) { + errno = ETIMEDOUT; + return -1; + } + + return s_rc; +} + +static void _modbus_tcp_free(modbus_t *ctx) { + free(ctx->backend_data); + free(ctx); +} + +const modbus_backend_t _modbus_tcp_backend = { + _MODBUS_BACKEND_TYPE_TCP, + _MODBUS_TCP_HEADER_LENGTH, + _MODBUS_TCP_CHECKSUM_LENGTH, + MODBUS_TCP_MAX_ADU_LENGTH, + _modbus_set_slave, + _modbus_tcp_build_request_basis, + _modbus_tcp_build_response_basis, + _modbus_tcp_prepare_response_tid, + _modbus_tcp_send_msg_pre, + _modbus_tcp_send, + _modbus_tcp_receive, + _modbus_tcp_recv, + _modbus_tcp_check_integrity, + _modbus_tcp_pre_check_confirmation, + _modbus_tcp_connect, + _modbus_tcp_close, + _modbus_tcp_flush, + _modbus_tcp_select, + _modbus_tcp_free +}; + + +#ifndef ARDUINO +const modbus_backend_t _modbus_tcp_pi_backend = { + _MODBUS_BACKEND_TYPE_TCP, + _MODBUS_TCP_HEADER_LENGTH, + _MODBUS_TCP_CHECKSUM_LENGTH, + MODBUS_TCP_MAX_ADU_LENGTH, + _modbus_set_slave, + _modbus_tcp_build_request_basis, + _modbus_tcp_build_response_basis, + _modbus_tcp_prepare_response_tid, + _modbus_tcp_send_msg_pre, + _modbus_tcp_send, + _modbus_tcp_receive, + _modbus_tcp_recv, + _modbus_tcp_check_integrity, + _modbus_tcp_pre_check_confirmation, + _modbus_tcp_pi_connect, + _modbus_tcp_close, + _modbus_tcp_flush, + _modbus_tcp_select, + _modbus_tcp_free +}; +#endif + +#ifdef ARDUINO +#ifdef __NEED_NAMESPACE__ +modbus_t* modbus_new_tcp(arduino::Client* client, arduino::IPAddress ip_address, int port) +#else +modbus_t* modbus_new_tcp(Client* client, IPAddress ip_address, int port) +#endif +#else +modbus_t* modbus_new_tcp(const char *ip, int port) +#endif +{ + modbus_t *ctx; + modbus_tcp_t *ctx_tcp; +#ifndef ARDUINO + size_t dest_size; + size_t ret_size; +#endif + +#if defined(OS_BSD) + /* MSG_NOSIGNAL is unsupported on *BSD so we install an ignore + handler for SIGPIPE. */ + struct sigaction sa; + + sa.sa_handler = SIG_IGN; + if (sigaction(SIGPIPE, &sa, NULL) < 0) { + /* The debug flag can't be set here... */ + fprintf(stderr, "Coud not install SIGPIPE handler.\n"); + return NULL; + } +#endif + + ctx = (modbus_t *)malloc(sizeof(modbus_t)); + _modbus_init_common(ctx); + + /* Could be changed after to reach a remote serial Modbus device */ + ctx->slave = MODBUS_TCP_SLAVE; + + ctx->backend = &_modbus_tcp_backend; + + ctx->backend_data = (modbus_tcp_t *)malloc(sizeof(modbus_tcp_t)); + ctx_tcp = (modbus_tcp_t *)ctx->backend_data; + +#ifdef ARDUINO + ctx_tcp->client = client; + ctx_tcp->ip = ip_address; +#else + if (ip != NULL) { + dest_size = sizeof(char) * 16; + ret_size = strlcpy(ctx_tcp->ip, ip, dest_size); + if (ret_size == 0) { + fprintf(stderr, "The IP string is empty\n"); + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + + if (ret_size >= dest_size) { + fprintf(stderr, "The IP string has been truncated\n"); + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + } else { + ctx_tcp->ip[0] = '0'; + } +#endif + ctx_tcp->port = port; + ctx_tcp->t_id = 0; + + return ctx; +} + + +#ifndef ARDUINO +modbus_t* modbus_new_tcp_pi(const char *node, const char *service) +{ + modbus_t *ctx; + modbus_tcp_pi_t *ctx_tcp_pi; + size_t dest_size; + size_t ret_size; + + ctx = (modbus_t *)malloc(sizeof(modbus_t)); + _modbus_init_common(ctx); + + /* Could be changed after to reach a remote serial Modbus device */ + ctx->slave = MODBUS_TCP_SLAVE; + + ctx->backend = &_modbus_tcp_pi_backend; + + ctx->backend_data = (modbus_tcp_pi_t *)malloc(sizeof(modbus_tcp_pi_t)); + ctx_tcp_pi = (modbus_tcp_pi_t *)ctx->backend_data; + + if (node == NULL) { + /* The node argument can be empty to indicate any hosts */ + ctx_tcp_pi->node[0] = 0; + } else { + dest_size = sizeof(char) * _MODBUS_TCP_PI_NODE_LENGTH; + ret_size = strlcpy(ctx_tcp_pi->node, node, dest_size); + if (ret_size == 0) { + fprintf(stderr, "The node string is empty\n"); + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + + if (ret_size >= dest_size) { + fprintf(stderr, "The node string has been truncated\n"); + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + } + + if (service != NULL) { + dest_size = sizeof(char) * _MODBUS_TCP_PI_SERVICE_LENGTH; + ret_size = strlcpy(ctx_tcp_pi->service, service, dest_size); + } else { + /* Empty service is not allowed, error catched below. */ + ret_size = 0; + } + + if (ret_size == 0) { + fprintf(stderr, "The service string is empty\n"); + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + + if (ret_size >= dest_size) { + fprintf(stderr, "The service string has been truncated\n"); + modbus_free(ctx); + errno = EINVAL; + return NULL; + } + + ctx_tcp_pi->t_id = 0; + + return ctx; +} +#endif diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-tcp.h b/libraries/ArduinoModbus/src/libmodbus/modbus-tcp.h new file mode 100644 index 0000000..1adf4fd --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-tcp.h @@ -0,0 +1,79 @@ +/* + * Copyright © 2001-2010 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifndef MODBUS_TCP_H +#define MODBUS_TCP_H + +#ifdef ARDUINO +// check if __has_include ArduinoAPI +#if defined __has_include +# if __has_include("api/ArduinoAPI.h") +#define __NEED_NAMESPACE__ +namespace arduino { +# endif +#endif +class Client; +class IPAddress; +#endif +#ifdef __NEED_NAMESPACE__ +} +#endif + +#include "modbus.h" + +MODBUS_BEGIN_DECLS + +#if defined(_WIN32) && !defined(__CYGWIN__) +/* Win32 with MinGW, supplement to */ +#include +#if !defined(ECONNRESET) +#define ECONNRESET WSAECONNRESET +#endif +#if !defined(ECONNREFUSED) +#define ECONNREFUSED WSAECONNREFUSED +#endif +#if !defined(ETIMEDOUT) +#define ETIMEDOUT WSAETIMEDOUT +#endif +#if !defined(ENOPROTOOPT) +#define ENOPROTOOPT WSAENOPROTOOPT +#endif +#if !defined(EINPROGRESS) +#define EINPROGRESS WSAEINPROGRESS +#endif +#endif + +#define MODBUS_TCP_DEFAULT_PORT 502 +#define MODBUS_TCP_SLAVE 0xFF + +/* Modbus_Application_Protocol_V1_1b.pdf Chapter 4 Section 1 Page 5 + * TCP MODBUS ADU = 253 bytes + MBAP (7 bytes) = 260 bytes + */ +#define MODBUS_TCP_MAX_ADU_LENGTH 260 + +#ifdef ARDUINO +#ifdef __NEED_NAMESPACE__ +MODBUS_API modbus_t* modbus_new_tcp(arduino::Client* client, arduino::IPAddress ip_address, int port); +MODBUS_API int modbus_tcp_accept(modbus_t *ctx, arduino::Client* client); +#else +MODBUS_API modbus_t* modbus_new_tcp(Client* client, IPAddress ip_address, int port); +MODBUS_API int modbus_tcp_accept(modbus_t *ctx, Client* client); +#endif +MODBUS_API int modbus_tcp_listen(modbus_t *ctx); +#else +MODBUS_API modbus_t* modbus_new_tcp(const char *ip_address, int port); +MODBUS_API int modbus_tcp_listen(modbus_t *ctx, int nb_connection); +MODBUS_API int modbus_tcp_accept(modbus_t *ctx, int *s); + +MODBUS_API modbus_t* modbus_new_tcp_pi(const char *node, const char *service); +MODBUS_API int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection); +MODBUS_API int modbus_tcp_pi_accept(modbus_t *ctx, int *s); +#endif + +MODBUS_END_DECLS + +#endif /* MODBUS_TCP_H */ diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus-version.h b/libraries/ArduinoModbus/src/libmodbus/modbus-version.h new file mode 100644 index 0000000..743efff --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus-version.h @@ -0,0 +1,53 @@ +/* + * Copyright © 2010-2014 Stéphane Raimbault + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef MODBUS_VERSION_H +#define MODBUS_VERSION_H + +/* The major version, (1, if %LIBMODBUS_VERSION is 1.2.3) */ +#define LIBMODBUS_VERSION_MAJOR (3) + +/* The minor version (2, if %LIBMODBUS_VERSION is 1.2.3) */ +#define LIBMODBUS_VERSION_MINOR (1) + +/* The micro version (3, if %LIBMODBUS_VERSION is 1.2.3) */ +#define LIBMODBUS_VERSION_MICRO (4) + +/* The full version, like 1.2.3 */ +#define LIBMODBUS_VERSION 3.1.4 + +/* The full version, in string form (suited for string concatenation) + */ +#define LIBMODBUS_VERSION_STRING "3.1.4" + +/* Numerically encoded version, eg. v1.2.3 is 0x010203 */ +#define LIBMODBUS_VERSION_HEX ((LIBMODBUS_VERSION_MAJOR << 16) | \ + (LIBMODBUS_VERSION_MINOR << 8) | \ + (LIBMODBUS_VERSION_MICRO << 0)) + +/* Evaluates to True if the version is greater than @major, @minor and @micro + */ +#define LIBMODBUS_VERSION_CHECK(major,minor,micro) \ + (LIBMODBUS_VERSION_MAJOR > (major) || \ + (LIBMODBUS_VERSION_MAJOR == (major) && \ + LIBMODBUS_VERSION_MINOR > (minor)) || \ + (LIBMODBUS_VERSION_MAJOR == (major) && \ + LIBMODBUS_VERSION_MINOR == (minor) && \ + LIBMODBUS_VERSION_MICRO >= (micro))) + +#endif /* MODBUS_VERSION_H */ diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus.c b/libraries/ArduinoModbus/src/libmodbus/modbus.c new file mode 100644 index 0000000..17e36e1 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus.c @@ -0,0 +1,1927 @@ +/* + * Copyright © 2001-2011 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + * + * This library implements the Modbus protocol. + * http://libmodbus.org/ + */ + +#include +#include +#include +#include +#include +#include +#include +#ifndef _MSC_VER +#include +#endif +#ifdef ARDUINO +#include +#include + +#ifndef DEBUG +#define printf(...) {} +#define fprintf(...) {} +#endif +#endif + +#ifndef ARDUINO +#include +#endif + +#if defined(ARDUINO) && defined(__AVR__) +#undef EIO +#define EIO 5 + +#undef EINVAL +#define EINVAL 22 + +#undef ENOPROTOOPT +#define ENOPROTOOPT 109 + +#undef ECONNREFUSED +#define ECONNREFUSED 111 + +#undef ETIMEDOUT +#define ETIMEDOUT 116 + +#undef ENOTSUP +#define ENOTSUP 134 +#endif + +#include "modbus.h" +#include "modbus-private.h" + +/* Internal use */ +#define MSG_LENGTH_UNDEFINED -1 + +/* Exported version */ +const unsigned int libmodbus_version_major = LIBMODBUS_VERSION_MAJOR; +const unsigned int libmodbus_version_minor = LIBMODBUS_VERSION_MINOR; +const unsigned int libmodbus_version_micro = LIBMODBUS_VERSION_MICRO; + +/* Max between RTU and TCP max adu length (so TCP) */ +#define MAX_MESSAGE_LENGTH 260 + +/* 3 steps are used to parse the query */ +typedef enum { + _STEP_FUNCTION, + _STEP_META, + _STEP_DATA +} _step_t; + +#if defined(ARDUINO) && defined(__AVR__) + +char *strerror(int errnum) +{ + switch (errnum) { + case 0: + return "Success"; + case EIO: + return "I/O error"; + case EINVAL: + return "Invalid argument"; + case ENOPROTOOPT: + return "Protocol not available"; + case ECONNREFUSED: + return "Connection refused"; + case ETIMEDOUT: + return "Connection timed out"; + case ENOTSUP: + return "Not supported"; + default: + return "Unknown"; + } +} +#endif + +const char *modbus_strerror(int errnum) { + switch (errnum) { + case EMBXILFUN: + return "Illegal function"; + case EMBXILADD: + return "Illegal data address"; + case EMBXILVAL: + return "Illegal data value"; + case EMBXSFAIL: + return "Slave device or server failure"; + case EMBXACK: + return "Acknowledge"; + case EMBXSBUSY: + return "Slave device or server is busy"; + case EMBXNACK: + return "Negative acknowledge"; + case EMBXMEMPAR: + return "Memory parity error"; + case EMBXGPATH: + return "Gateway path unavailable"; + case EMBXGTAR: + return "Target device failed to respond"; + case EMBBADCRC: + return "Invalid CRC"; + case EMBBADDATA: + return "Invalid data"; + case EMBBADEXC: + return "Invalid exception code"; + case EMBMDATA: + return "Too many data"; + case EMBBADSLAVE: + return "Response not from requested slave"; + default: + return strerror(errnum); + } +} + +void _error_print(modbus_t *ctx, const char *context) +{ + if (ctx->debug) { + fprintf(stderr, "ERROR %s", modbus_strerror(errno)); + if (context != NULL) { + fprintf(stderr, ": %s\n", context); + } else { + fprintf(stderr, "\n"); + } + } +} + +static void _sleep_response_timeout(modbus_t *ctx) +{ + /* Response timeout is always positive */ +#ifdef _WIN32 + /* usleep doesn't exist on Windows */ + Sleep((ctx->response_timeout.tv_sec * 1000) + + (ctx->response_timeout.tv_usec / 1000)); +#elif defined(ARDUINO) + delay(ctx->response_timeout.tv_sec * 1000); + delayMicroseconds(ctx->response_timeout.tv_usec); +#else + /* usleep source code */ + struct timespec request, remaining; + request.tv_sec = ctx->response_timeout.tv_sec; + request.tv_nsec = ((long int)ctx->response_timeout.tv_usec) * 1000; + while (nanosleep(&request, &remaining) == -1 && errno == EINTR) { + request = remaining; + } +#endif +} + +int modbus_flush(modbus_t *ctx) +{ + int rc; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + rc = ctx->backend->flush(ctx); + if (rc != -1 && ctx->debug) { + /* Not all backends are able to return the number of bytes flushed */ + printf("Bytes flushed (%d)\n", rc); + } + return rc; +} + +/* Computes the length of the expected response */ +static unsigned int compute_response_length_from_request(modbus_t *ctx, uint8_t *req) +{ + int length; + const int offset = ctx->backend->header_length; + + switch (req[offset]) { + case MODBUS_FC_READ_COILS: + case MODBUS_FC_READ_DISCRETE_INPUTS: { + /* Header + nb values (code from write_bits) */ + int nb = (req[offset + 3] << 8) | req[offset + 4]; + length = 2 + (nb / 8) + ((nb % 8) ? 1 : 0); + } + break; + case MODBUS_FC_WRITE_AND_READ_REGISTERS: + case MODBUS_FC_READ_HOLDING_REGISTERS: + case MODBUS_FC_READ_INPUT_REGISTERS: + /* Header + 2 * nb values */ + length = 2 + 2 * (req[offset + 3] << 8 | req[offset + 4]); + break; + case MODBUS_FC_READ_EXCEPTION_STATUS: + length = 3; + break; + case MODBUS_FC_REPORT_SLAVE_ID: + /* The response is device specific (the header provides the + length) */ + return MSG_LENGTH_UNDEFINED; + case MODBUS_FC_MASK_WRITE_REGISTER: + length = 7; + break; + default: + length = 5; + } + + return offset + length + ctx->backend->checksum_length; +} + +/* Sends a request/response */ +static int send_msg(modbus_t *ctx, uint8_t *msg, int msg_length) +{ + int rc; + int i; + + msg_length = ctx->backend->send_msg_pre(msg, msg_length); + + if (ctx->debug) { + for (i = 0; i < msg_length; i++) + printf("[%.2X]", msg[i]); + printf("\n"); + } + + /* In recovery mode, the write command will be issued until to be + successful! Disabled by default. */ + do { + rc = ctx->backend->send(ctx, msg, msg_length); + if (rc == -1) { + _error_print(ctx, NULL); + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) { + int saved_errno = errno; + + if ((errno == EBADF || errno == ECONNRESET || errno == EPIPE)) { + modbus_close(ctx); + _sleep_response_timeout(ctx); + modbus_connect(ctx); + } else { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } + errno = saved_errno; + } + } + } while ((ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) && + rc == -1); + + if (rc > 0 && rc != msg_length) { + errno = EMBBADDATA; + return -1; + } + + return rc; +} + +int modbus_send_raw_request(modbus_t *ctx, uint8_t *raw_req, int raw_req_length) +{ + sft_t sft; + uint8_t req[MAX_MESSAGE_LENGTH]; + int req_length; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (raw_req_length < 2 || raw_req_length > (MODBUS_MAX_PDU_LENGTH + 1)) { + /* The raw request must contain function and slave at least and + must not be longer than the maximum pdu length plus the slave + address. */ + errno = EINVAL; + return -1; + } + + sft.slave = raw_req[0]; + sft.function = raw_req[1]; + /* The t_id is left to zero */ + sft.t_id = 0; + /* This response function only set the header so it's convenient here */ + req_length = ctx->backend->build_response_basis(&sft, req); + + if (raw_req_length > 2) { + /* Copy data after function code */ + memcpy(req + req_length, raw_req + 2, raw_req_length - 2); + req_length += raw_req_length - 2; + } + + return send_msg(ctx, req, req_length); +} + +/* + * ---------- Request Indication ---------- + * | Client | ---------------------->| Server | + * ---------- Confirmation Response ---------- + */ + +/* Computes the length to read after the function received */ +static uint8_t compute_meta_length_after_function(int function, + msg_type_t msg_type) +{ + int length; + + if (msg_type == MSG_INDICATION) { + if (function <= MODBUS_FC_WRITE_SINGLE_REGISTER) { + length = 4; + } else if (function == MODBUS_FC_WRITE_MULTIPLE_COILS || + function == MODBUS_FC_WRITE_MULTIPLE_REGISTERS) { + length = 5; + } else if (function == MODBUS_FC_MASK_WRITE_REGISTER) { + length = 6; + } else if (function == MODBUS_FC_WRITE_AND_READ_REGISTERS) { + length = 9; + } else { + /* MODBUS_FC_READ_EXCEPTION_STATUS, MODBUS_FC_REPORT_SLAVE_ID */ + length = 0; + } + } else { + /* MSG_CONFIRMATION */ + switch (function) { + case MODBUS_FC_WRITE_SINGLE_COIL: + case MODBUS_FC_WRITE_SINGLE_REGISTER: + case MODBUS_FC_WRITE_MULTIPLE_COILS: + case MODBUS_FC_WRITE_MULTIPLE_REGISTERS: + length = 4; + break; + case MODBUS_FC_MASK_WRITE_REGISTER: + length = 6; + break; + default: + length = 1; + } + } + + return length; +} + +/* Computes the length to read after the meta information (address, count, etc) */ +static int compute_data_length_after_meta(modbus_t *ctx, uint8_t *msg, + msg_type_t msg_type) +{ + int function = msg[ctx->backend->header_length]; + int length; + + if (msg_type == MSG_INDICATION) { + switch (function) { + case MODBUS_FC_WRITE_MULTIPLE_COILS: + case MODBUS_FC_WRITE_MULTIPLE_REGISTERS: + length = msg[ctx->backend->header_length + 5]; + break; + case MODBUS_FC_WRITE_AND_READ_REGISTERS: + length = msg[ctx->backend->header_length + 9]; + break; + default: + length = 0; + } + } else { + /* MSG_CONFIRMATION */ + if (function <= MODBUS_FC_READ_INPUT_REGISTERS || + function == MODBUS_FC_REPORT_SLAVE_ID || + function == MODBUS_FC_WRITE_AND_READ_REGISTERS) { + length = msg[ctx->backend->header_length + 1]; + } else { + length = 0; + } + } + + length += ctx->backend->checksum_length; + + return length; +} + + +/* Waits a response from a modbus server or a request from a modbus client. + This function blocks if there is no replies (3 timeouts). + + The function shall return the number of received characters and the received + message in an array of uint8_t if successful. Otherwise it shall return -1 + and errno is set to one of the values defined below: + - ECONNRESET + - EMBBADDATA + - EMBUNKEXC + - ETIMEDOUT + - read() or recv() error codes +*/ + +int _modbus_receive_msg(modbus_t *ctx, uint8_t *msg, msg_type_t msg_type) +{ + int rc; + fd_set rset; + struct timeval tv; + struct timeval *p_tv; + int length_to_read; + int msg_length = 0; + _step_t step; + + if (ctx->debug) { + if (msg_type == MSG_INDICATION) { + printf("Waiting for a indication...\n"); + } else { + printf("Waiting for a confirmation...\n"); + } + } + +#ifndef ARDUINO + /* Add a file descriptor to the set */ + FD_ZERO(&rset); + FD_SET(ctx->s, &rset); +#endif + + /* We need to analyse the message step by step. At the first step, we want + * to reach the function code because all packets contain this + * information. */ + step = _STEP_FUNCTION; + length_to_read = ctx->backend->header_length + 1; + + if (msg_type == MSG_INDICATION) { + /* Wait for a message, we don't know when the message will be + * received */ + p_tv = NULL; + } else { + tv.tv_sec = ctx->response_timeout.tv_sec; + tv.tv_usec = ctx->response_timeout.tv_usec; + p_tv = &tv; + } + + while (length_to_read != 0) { + rc = ctx->backend->select(ctx, &rset, p_tv, length_to_read); + if (rc == -1) { + _error_print(ctx, "select"); + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) { + int saved_errno = errno; + + if (errno == ETIMEDOUT) { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } else if (errno == EBADF) { + modbus_close(ctx); + modbus_connect(ctx); + } + errno = saved_errno; + } + return -1; + } + + rc = ctx->backend->recv(ctx, msg + msg_length, length_to_read); + if (rc == 0) { + errno = ECONNRESET; + rc = -1; + } + + if (rc == -1) { + _error_print(ctx, "read"); + if ((ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) && + (errno == ECONNRESET || errno == ECONNREFUSED || + errno == EBADF)) { + int saved_errno = errno; + modbus_close(ctx); + modbus_connect(ctx); + /* Could be removed by previous calls */ + errno = saved_errno; + } + return -1; + } + + /* Display the hex code of each character received */ + if (ctx->debug) { + int i; + for (i=0; i < rc; i++) + printf("<%.2X>", msg[msg_length + i]); + } + + /* Sums bytes received */ + msg_length += rc; + /* Computes remaining bytes */ + length_to_read -= rc; + + if (length_to_read == 0) { + switch (step) { + case _STEP_FUNCTION: + /* Function code position */ + length_to_read = compute_meta_length_after_function( + msg[ctx->backend->header_length], + msg_type); + if (length_to_read != 0) { + step = _STEP_META; + break; + } /*FALLTHROUGH */ /* else switches straight to the next step */ + case _STEP_META: + length_to_read = compute_data_length_after_meta( + ctx, msg, msg_type); + if ((msg_length + length_to_read) > (int)ctx->backend->max_adu_length) { + errno = EMBBADDATA; + _error_print(ctx, "too many data"); + return -1; + } + step = _STEP_DATA; + break; + default: + break; + } + } + + if (length_to_read > 0 && + (ctx->byte_timeout.tv_sec > 0 || ctx->byte_timeout.tv_usec > 0)) { + /* If there is no character in the buffer, the allowed timeout + interval between two consecutive bytes is defined by + byte_timeout */ + tv.tv_sec = ctx->byte_timeout.tv_sec; + tv.tv_usec = ctx->byte_timeout.tv_usec; + p_tv = &tv; + } + /* else timeout isn't set again, the full response must be read before + expiration of response timeout (for CONFIRMATION only) */ + } + + if (ctx->debug) + printf("\n"); + + return ctx->backend->check_integrity(ctx, msg, msg_length); +} + +/* Receive the request from a modbus master */ +int modbus_receive(modbus_t *ctx, uint8_t *req) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return ctx->backend->receive(ctx, req); +} + +/* Receives the confirmation. + + The function shall store the read response in rsp and return the number of + values (bits or words). Otherwise, its shall return -1 and errno is set. + + The function doesn't check the confirmation is the expected response to the + initial request. +*/ +int modbus_receive_confirmation(modbus_t *ctx, uint8_t *rsp) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); +} + +static int check_confirmation(modbus_t *ctx, uint8_t *req, + uint8_t *rsp, int rsp_length) +{ + int rc; + int rsp_length_computed; + const int offset = ctx->backend->header_length; + const int function = rsp[offset]; + + if (ctx->backend->pre_check_confirmation) { + rc = ctx->backend->pre_check_confirmation(ctx, req, rsp, rsp_length); + if (rc == -1) { + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } + return -1; + } + } + + rsp_length_computed = compute_response_length_from_request(ctx, req); + + /* Exception code */ + if (function >= 0x80) { + if (rsp_length == (offset + 2 + (int)ctx->backend->checksum_length) && + req[offset] == (rsp[offset] - 0x80)) { + /* Valid exception code received */ + + int exception_code = rsp[offset + 1]; + if (exception_code < MODBUS_EXCEPTION_MAX) { + errno = MODBUS_ENOBASE + exception_code; + } else { + errno = EMBBADEXC; + } + _error_print(ctx, NULL); + return -1; + } else { + errno = EMBBADEXC; + _error_print(ctx, NULL); + return -1; + } + } + + /* Check length */ + if ((rsp_length == rsp_length_computed || + rsp_length_computed == MSG_LENGTH_UNDEFINED) && + function < 0x80) { + int req_nb_value; + int rsp_nb_value; + + /* Check function code */ + if (function != req[offset]) { + if (ctx->debug) { + fprintf(stderr, + "Received function not corresponding to the request (0x%X != 0x%X)\n", + function, req[offset]); + } + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } + errno = EMBBADDATA; + return -1; + } + + /* Check the number of values is corresponding to the request */ + switch (function) { + case MODBUS_FC_READ_COILS: + case MODBUS_FC_READ_DISCRETE_INPUTS: + /* Read functions, 8 values in a byte (nb + * of values in the request and byte count in + * the response. */ + req_nb_value = (req[offset + 3] << 8) + req[offset + 4]; + req_nb_value = (req_nb_value / 8) + ((req_nb_value % 8) ? 1 : 0); + rsp_nb_value = rsp[offset + 1]; + break; + case MODBUS_FC_WRITE_AND_READ_REGISTERS: + case MODBUS_FC_READ_HOLDING_REGISTERS: + case MODBUS_FC_READ_INPUT_REGISTERS: + /* Read functions 1 value = 2 bytes */ + req_nb_value = (req[offset + 3] << 8) + req[offset + 4]; + rsp_nb_value = (rsp[offset + 1] / 2); + break; + case MODBUS_FC_WRITE_MULTIPLE_COILS: + case MODBUS_FC_WRITE_MULTIPLE_REGISTERS: + /* N Write functions */ + req_nb_value = (req[offset + 3] << 8) + req[offset + 4]; + rsp_nb_value = (rsp[offset + 3] << 8) | rsp[offset + 4]; + break; + case MODBUS_FC_REPORT_SLAVE_ID: + /* Report slave ID (bytes received) */ + req_nb_value = rsp_nb_value = rsp[offset + 1]; + break; + default: + /* 1 Write functions & others */ + req_nb_value = rsp_nb_value = 1; + } + + if (req_nb_value == rsp_nb_value) { + rc = rsp_nb_value; + } else { + if (ctx->debug) { + fprintf(stderr, + "Quantity not corresponding to the request (%d != %d)\n", + rsp_nb_value, req_nb_value); + } + + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } + + errno = EMBBADDATA; + rc = -1; + } + } else { + if (ctx->debug) { + fprintf(stderr, + "Message length not corresponding to the computed length (%d != %d)\n", + rsp_length, rsp_length_computed); + } + if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } + errno = EMBBADDATA; + rc = -1; + } + + return rc; +} + +static int response_io_status(uint8_t *tab_io_status, + int address, int nb, + uint8_t *rsp, int offset) +{ + int shift = 0; + /* Instead of byte (not allowed in Win32) */ + int one_byte = 0; + int i; + + for (i = address; i < address + nb; i++) { + one_byte |= tab_io_status[i] << shift; + if (shift == 7) { + /* Byte is full */ + rsp[offset++] = one_byte; + one_byte = shift = 0; + } else { + shift++; + } + } + + if (shift != 0) + rsp[offset++] = one_byte; + + return offset; +} + +/* Build the exception response */ +static int response_exception(modbus_t *ctx, sft_t *sft, + int exception_code, uint8_t *rsp, + unsigned int to_flush, + const char* template, ...) +{ + int rsp_length; + + /* Print debug message */ + if (ctx->debug) { + va_list ap; + + va_start(ap, template); + vfprintf(stderr, template, ap); + va_end(ap); + } + + /* Flush if required */ + if (to_flush) { + _sleep_response_timeout(ctx); + modbus_flush(ctx); + } + + /* Build exception response */ + sft->function = sft->function + 0x80; + rsp_length = ctx->backend->build_response_basis(sft, rsp); + rsp[rsp_length++] = exception_code; + + return rsp_length; +} + +/* Send a response to the received request. + Analyses the request and constructs a response. + + If an error occurs, this function construct the response + accordingly. +*/ +int modbus_reply(modbus_t *ctx, const uint8_t *req, + int req_length, modbus_mapping_t *mb_mapping) +{ + int offset; + int slave; + int function; + uint16_t address; + uint8_t rsp[MAX_MESSAGE_LENGTH]; + int rsp_length = 0; + sft_t sft; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + offset = ctx->backend->header_length; + slave = req[offset - 1]; + function = req[offset]; + address = (req[offset + 1] << 8) + req[offset + 2]; + + sft.slave = slave; + sft.function = function; + sft.t_id = ctx->backend->prepare_response_tid(req, &req_length); + + /* Data are flushed on illegal number of values errors. */ + switch (function) { + case MODBUS_FC_READ_COILS: + case MODBUS_FC_READ_DISCRETE_INPUTS: { + unsigned int is_input = (function == MODBUS_FC_READ_DISCRETE_INPUTS); + int start_bits = is_input ? mb_mapping->start_input_bits : mb_mapping->start_bits; + int nb_bits = is_input ? mb_mapping->nb_input_bits : mb_mapping->nb_bits; + uint8_t *tab_bits = is_input ? mb_mapping->tab_input_bits : mb_mapping->tab_bits; + const char * const name = is_input ? "read_input_bits" : "read_bits"; + int nb = (req[offset + 3] << 8) + req[offset + 4]; + /* The mapping can be shifted to reduce memory consumption and it + doesn't always start at address zero. */ + int mapping_address = address - start_bits; + + if (nb < 1 || MODBUS_MAX_READ_BITS < nb) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, TRUE, + "Illegal nb of values %d in %s (max %d)\n", + nb, name, MODBUS_MAX_READ_BITS); + } else if (mapping_address < 0 || (mapping_address + nb) > nb_bits) { + rsp_length = response_exception( + ctx, &sft, + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in %s\n", + mapping_address < 0 ? address : address + nb, name); + } else { + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + rsp[rsp_length++] = (nb / 8) + ((nb % 8) ? 1 : 0); + rsp_length = response_io_status(tab_bits, mapping_address, nb, + rsp, rsp_length); + } + } + break; + case MODBUS_FC_READ_HOLDING_REGISTERS: + case MODBUS_FC_READ_INPUT_REGISTERS: { + unsigned int is_input = (function == MODBUS_FC_READ_INPUT_REGISTERS); + int start_registers = is_input ? mb_mapping->start_input_registers : mb_mapping->start_registers; + int nb_registers = is_input ? mb_mapping->nb_input_registers : mb_mapping->nb_registers; + uint16_t *tab_registers = is_input ? mb_mapping->tab_input_registers : mb_mapping->tab_registers; + const char * const name = is_input ? "read_input_registers" : "read_registers"; + int nb = (req[offset + 3] << 8) + req[offset + 4]; + /* The mapping can be shifted to reduce memory consumption and it + doesn't always start at address zero. */ + int mapping_address = address - start_registers; + + if (nb < 1 || MODBUS_MAX_READ_REGISTERS < nb) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, TRUE, + "Illegal nb of values %d in %s (max %d)\n", + nb, name, MODBUS_MAX_READ_REGISTERS); + } else if (mapping_address < 0 || (mapping_address + nb) > nb_registers) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in %s\n", + mapping_address < 0 ? address : address + nb, name); + } else { + int i; + + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + rsp[rsp_length++] = nb << 1; + for (i = mapping_address; i < mapping_address + nb; i++) { + rsp[rsp_length++] = tab_registers[i] >> 8; + rsp[rsp_length++] = tab_registers[i] & 0xFF; + } + } + } + break; + case MODBUS_FC_WRITE_SINGLE_COIL: { + int mapping_address = address - mb_mapping->start_bits; + + if (mapping_address < 0 || mapping_address >= mb_mapping->nb_bits) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in write_bit\n", + address); + } else { + int data = (req[offset + 3] << 8) + req[offset + 4]; + +#if defined(ARDUINO) && defined(__AVR__) + if (data == (int)0xFF00 || data == 0x0) { +#else + if (data == 0xFF00 || data == 0x0) { +#endif + mb_mapping->tab_bits[mapping_address] = data ? 1 : 0; + memcpy(rsp, req, req_length); + rsp_length = req_length; + } else { + rsp_length = response_exception( + ctx, &sft, + MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, FALSE, + "Illegal data value 0x%0X in write_bit request at address %0X\n", + data, address); + } + } + } + break; + case MODBUS_FC_WRITE_SINGLE_REGISTER: { + int mapping_address = address - mb_mapping->start_registers; + + if (mapping_address < 0 || mapping_address >= mb_mapping->nb_registers) { + rsp_length = response_exception( + ctx, &sft, + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in write_register\n", + address); + } else { + int data = (req[offset + 3] << 8) + req[offset + 4]; + + mb_mapping->tab_registers[mapping_address] = data; + memcpy(rsp, req, req_length); + rsp_length = req_length; + } + } + break; + case MODBUS_FC_WRITE_MULTIPLE_COILS: { + int nb = (req[offset + 3] << 8) + req[offset + 4]; + int mapping_address = address - mb_mapping->start_bits; + + if (nb < 1 || MODBUS_MAX_WRITE_BITS < nb) { + /* May be the indication has been truncated on reading because of + * invalid address (eg. nb is 0 but the request contains values to + * write) so it's necessary to flush. */ + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, TRUE, + "Illegal number of values %d in write_bits (max %d)\n", + nb, MODBUS_MAX_WRITE_BITS); + } else if (mapping_address < 0 || + (mapping_address + nb) > mb_mapping->nb_bits) { + rsp_length = response_exception( + ctx, &sft, + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in write_bits\n", + mapping_address < 0 ? address : address + nb); + } else { + /* 6 = byte count */ + modbus_set_bits_from_bytes(mb_mapping->tab_bits, mapping_address, nb, + &req[offset + 6]); + + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + /* 4 to copy the bit address (2) and the quantity of bits */ + memcpy(rsp + rsp_length, req + rsp_length, 4); + rsp_length += 4; + } + } + break; + case MODBUS_FC_WRITE_MULTIPLE_REGISTERS: { + int nb = (req[offset + 3] << 8) + req[offset + 4]; + int mapping_address = address - mb_mapping->start_registers; + + if (nb < 1 || MODBUS_MAX_WRITE_REGISTERS < nb) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, TRUE, + "Illegal number of values %d in write_registers (max %d)\n", + nb, MODBUS_MAX_WRITE_REGISTERS); + } else if (mapping_address < 0 || + (mapping_address + nb) > mb_mapping->nb_registers) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in write_registers\n", + mapping_address < 0 ? address : address + nb); + } else { + int i, j; + for (i = mapping_address, j = 6; i < mapping_address + nb; i++, j += 2) { + /* 6 and 7 = first value */ + mb_mapping->tab_registers[i] = + (req[offset + j] << 8) + req[offset + j + 1]; + } + + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + /* 4 to copy the address (2) and the no. of registers */ + memcpy(rsp + rsp_length, req + rsp_length, 4); + rsp_length += 4; + } + } + break; + case MODBUS_FC_REPORT_SLAVE_ID: { + int str_len; + int byte_count_pos; + + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + /* Skip byte count for now */ + byte_count_pos = rsp_length++; + rsp[rsp_length++] = _REPORT_SLAVE_ID; + /* Run indicator status to ON */ + rsp[rsp_length++] = 0xFF; + /* LMB + length of LIBMODBUS_VERSION_STRING */ + str_len = 3 + strlen(LIBMODBUS_VERSION_STRING); + memcpy(rsp + rsp_length, "LMB" LIBMODBUS_VERSION_STRING, str_len); + rsp_length += str_len; + rsp[byte_count_pos] = rsp_length - byte_count_pos - 1; + } + break; + case MODBUS_FC_READ_EXCEPTION_STATUS: + if (ctx->debug) { + fprintf(stderr, "FIXME Not implemented\n"); + } + errno = ENOPROTOOPT; + return -1; + break; + case MODBUS_FC_MASK_WRITE_REGISTER: { + int mapping_address = address - mb_mapping->start_registers; + + if (mapping_address < 0 || mapping_address >= mb_mapping->nb_registers) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data address 0x%0X in write_register\n", + address); + } else { + uint16_t data = mb_mapping->tab_registers[mapping_address]; + uint16_t and = (req[offset + 3] << 8) + req[offset + 4]; + uint16_t or = (req[offset + 5] << 8) + req[offset + 6]; + + data = (data & and) | (or & (~and)); + mb_mapping->tab_registers[mapping_address] = data; + memcpy(rsp, req, req_length); + rsp_length = req_length; + } + } + break; + case MODBUS_FC_WRITE_AND_READ_REGISTERS: { + int nb = (req[offset + 3] << 8) + req[offset + 4]; + uint16_t address_write = (req[offset + 5] << 8) + req[offset + 6]; + int nb_write = (req[offset + 7] << 8) + req[offset + 8]; + int nb_write_bytes = req[offset + 9]; + int mapping_address = address - mb_mapping->start_registers; + int mapping_address_write = address_write - mb_mapping->start_registers; + + if (nb_write < 1 || MODBUS_MAX_WR_WRITE_REGISTERS < nb_write || + nb < 1 || MODBUS_MAX_WR_READ_REGISTERS < nb || + nb_write_bytes != nb_write * 2) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, TRUE, + "Illegal nb of values (W%d, R%d) in write_and_read_registers (max W%d, R%d)\n", + nb_write, nb, MODBUS_MAX_WR_WRITE_REGISTERS, MODBUS_MAX_WR_READ_REGISTERS); + } else if (mapping_address < 0 || + (mapping_address + nb) > mb_mapping->nb_registers || + mapping_address < 0 || + (mapping_address_write + nb_write) > mb_mapping->nb_registers) { + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, + "Illegal data read address 0x%0X or write address 0x%0X write_and_read_registers\n", + mapping_address < 0 ? address : address + nb, + mapping_address_write < 0 ? address_write : address_write + nb_write); + } else { + int i, j; + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + rsp[rsp_length++] = nb << 1; + + /* Write first. + 10 and 11 are the offset of the first values to write */ + for (i = mapping_address_write, j = 10; + i < mapping_address_write + nb_write; i++, j += 2) { + mb_mapping->tab_registers[i] = + (req[offset + j] << 8) + req[offset + j + 1]; + } + + /* and read the data for the response */ + for (i = mapping_address; i < mapping_address + nb; i++) { + rsp[rsp_length++] = mb_mapping->tab_registers[i] >> 8; + rsp[rsp_length++] = mb_mapping->tab_registers[i] & 0xFF; + } + } + } + break; + + default: + rsp_length = response_exception( + ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_FUNCTION, rsp, TRUE, + "Unknown Modbus function code: 0x%0X\n", function); + break; + } + + /* Suppress any responses when the request was a broadcast */ + return (slave == MODBUS_BROADCAST_ADDRESS) ? 0 : send_msg(ctx, rsp, rsp_length); +} + +int modbus_reply_exception(modbus_t *ctx, const uint8_t *req, + unsigned int exception_code) +{ + int offset; + int slave; + int function; + uint8_t rsp[MAX_MESSAGE_LENGTH]; + int rsp_length; + int dummy_length = 99; + sft_t sft; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + offset = ctx->backend->header_length; + slave = req[offset - 1]; + function = req[offset]; + + sft.slave = slave; + sft.function = function + 0x80;; + sft.t_id = ctx->backend->prepare_response_tid(req, &dummy_length); + rsp_length = ctx->backend->build_response_basis(&sft, rsp); + + /* Positive exception code */ + if (exception_code < MODBUS_EXCEPTION_MAX) { + rsp[rsp_length++] = exception_code; + return send_msg(ctx, rsp, rsp_length); + } else { + errno = EINVAL; + return -1; + } +} + +/* Reads IO status */ +static int read_io_status(modbus_t *ctx, int function, + int addr, int nb, uint8_t *dest) +{ + int rc; + int req_length; + + uint8_t req[_MIN_REQ_LENGTH]; + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + req_length = ctx->backend->build_request_basis(ctx, function, addr, nb, req); + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + int i, temp, bit; + int pos = 0; + int offset; + int offset_end; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + if (rc == -1) + return -1; + + offset = ctx->backend->header_length + 2; + offset_end = offset + rc; + for (i = offset; i < offset_end; i++) { + /* Shift reg hi_byte to temp */ + temp = rsp[i]; + + for (bit = 0x01; (bit & 0xff) && (pos < nb);) { + dest[pos++] = (temp & bit) ? TRUE : FALSE; + bit = bit << 1; + } + + } + } + + return rc; +} + +/* Reads the boolean status of bits and sets the array elements + in the destination to TRUE or FALSE (single bits). */ +int modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest) +{ + int rc; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (nb > MODBUS_MAX_READ_BITS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Too many bits requested (%d > %d)\n", + nb, MODBUS_MAX_READ_BITS); + } + errno = EMBMDATA; + return -1; + } + + rc = read_io_status(ctx, MODBUS_FC_READ_COILS, addr, nb, dest); + + if (rc == -1) + return -1; + else + return nb; +} + + +/* Same as modbus_read_bits but reads the remote device input table */ +int modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest) +{ + int rc; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (nb > MODBUS_MAX_READ_BITS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Too many discrete inputs requested (%d > %d)\n", + nb, MODBUS_MAX_READ_BITS); + } + errno = EMBMDATA; + return -1; + } + + rc = read_io_status(ctx, MODBUS_FC_READ_DISCRETE_INPUTS, addr, nb, dest); + + if (rc == -1) + return -1; + else + return nb; +} + +/* Reads the data from a remove device and put that data into an array */ +static int read_registers(modbus_t *ctx, int function, int addr, int nb, + uint16_t *dest) +{ + int rc; + int req_length; + uint8_t req[_MIN_REQ_LENGTH]; + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + if (nb > MODBUS_MAX_READ_REGISTERS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Too many registers requested (%d > %d)\n", + nb, MODBUS_MAX_READ_REGISTERS); + } + errno = EMBMDATA; + return -1; + } + + req_length = ctx->backend->build_request_basis(ctx, function, addr, nb, req); + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + int offset; + int i; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + if (rc == -1) + return -1; + + offset = ctx->backend->header_length; + + for (i = 0; i < rc; i++) { + /* shift reg hi_byte to temp OR with lo_byte */ + dest[i] = (rsp[offset + 2 + (i << 1)] << 8) | + rsp[offset + 3 + (i << 1)]; + } + } + + return rc; +} + +/* Reads the holding registers of remote device and put the data into an + array */ +int modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest) +{ + int status; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (nb > MODBUS_MAX_READ_REGISTERS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Too many registers requested (%d > %d)\n", + nb, MODBUS_MAX_READ_REGISTERS); + } + errno = EMBMDATA; + return -1; + } + + status = read_registers(ctx, MODBUS_FC_READ_HOLDING_REGISTERS, + addr, nb, dest); + return status; +} + +/* Reads the input registers of remote device and put the data into an array */ +int modbus_read_input_registers(modbus_t *ctx, int addr, int nb, + uint16_t *dest) +{ + int status; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (nb > MODBUS_MAX_READ_REGISTERS) { + fprintf(stderr, + "ERROR Too many input registers requested (%d > %d)\n", + nb, MODBUS_MAX_READ_REGISTERS); + errno = EMBMDATA; + return -1; + } + + status = read_registers(ctx, MODBUS_FC_READ_INPUT_REGISTERS, + addr, nb, dest); + + return status; +} + +/* Write a value to the specified register of the remote device. + Used by write_bit and write_register */ +static int write_single(modbus_t *ctx, int function, int addr, int value) +{ + int rc; + int req_length; + uint8_t req[_MIN_REQ_LENGTH]; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + req_length = ctx->backend->build_request_basis(ctx, function, addr, value, req); + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + /* Used by write_bit and write_register */ + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + } + + return rc; +} + +/* Turns ON or OFF a single bit of the remote device */ +int modbus_write_bit(modbus_t *ctx, int addr, int status) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return write_single(ctx, MODBUS_FC_WRITE_SINGLE_COIL, addr, + status ? 0xFF00 : 0); +} + +/* Writes a value in one register of the remote device */ +int modbus_write_register(modbus_t *ctx, int addr, int value) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return write_single(ctx, MODBUS_FC_WRITE_SINGLE_REGISTER, addr, value); +} + +/* Write the bits of the array in the remote device */ +int modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *src) +{ + int rc; + int i; + int byte_count; + int req_length; + int bit_check = 0; + int pos = 0; + uint8_t req[MAX_MESSAGE_LENGTH]; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (nb > MODBUS_MAX_WRITE_BITS) { + if (ctx->debug) { + fprintf(stderr, "ERROR Writing too many bits (%d > %d)\n", + nb, MODBUS_MAX_WRITE_BITS); + } + errno = EMBMDATA; + return -1; + } + + req_length = ctx->backend->build_request_basis(ctx, + MODBUS_FC_WRITE_MULTIPLE_COILS, + addr, nb, req); + byte_count = (nb / 8) + ((nb % 8) ? 1 : 0); + req[req_length++] = byte_count; + + for (i = 0; i < byte_count; i++) { + int bit; + + bit = 0x01; + req[req_length] = 0; + + while ((bit & 0xFF) && (bit_check++ < nb)) { + if (src[pos++]) + req[req_length] |= bit; + else + req[req_length] &=~ bit; + + bit = bit << 1; + } + req_length++; + } + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + } + + + return rc; +} + +/* Write the values from the array to the registers of the remote device */ +int modbus_write_registers(modbus_t *ctx, int addr, int nb, const uint16_t *src) +{ + int rc; + int i; + int req_length; + int byte_count; + uint8_t req[MAX_MESSAGE_LENGTH]; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (nb > MODBUS_MAX_WRITE_REGISTERS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Trying to write to too many registers (%d > %d)\n", + nb, MODBUS_MAX_WRITE_REGISTERS); + } + errno = EMBMDATA; + return -1; + } + + req_length = ctx->backend->build_request_basis(ctx, + MODBUS_FC_WRITE_MULTIPLE_REGISTERS, + addr, nb, req); + byte_count = nb * 2; + req[req_length++] = byte_count; + + for (i = 0; i < nb; i++) { + req[req_length++] = src[i] >> 8; + req[req_length++] = src[i] & 0x00FF; + } + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + } + + return rc; +} + +int modbus_mask_write_register(modbus_t *ctx, int addr, uint16_t and_mask, uint16_t or_mask) +{ + int rc; + int req_length; + /* The request length can not exceed _MIN_REQ_LENGTH - 2 and 4 bytes to + * store the masks. The ugly substraction is there to remove the 'nb' value + * (2 bytes) which is not used. */ + uint8_t req[_MIN_REQ_LENGTH + 2]; + + req_length = ctx->backend->build_request_basis(ctx, + MODBUS_FC_MASK_WRITE_REGISTER, + addr, 0, req); + + /* HACKISH, count is not used */ + req_length -= 2; + + req[req_length++] = and_mask >> 8; + req[req_length++] = and_mask & 0x00ff; + req[req_length++] = or_mask >> 8; + req[req_length++] = or_mask & 0x00ff; + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + /* Used by write_bit and write_register */ + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + } + + return rc; +} + +/* Write multiple registers from src array to remote device and read multiple + registers from remote device to dest array. */ +int modbus_write_and_read_registers(modbus_t *ctx, + int write_addr, int write_nb, + const uint16_t *src, + int read_addr, int read_nb, + uint16_t *dest) + +{ + int rc; + int req_length; + int i; + int byte_count; + uint8_t req[MAX_MESSAGE_LENGTH]; + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + if (write_nb > MODBUS_MAX_WR_WRITE_REGISTERS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Too many registers to write (%d > %d)\n", + write_nb, MODBUS_MAX_WR_WRITE_REGISTERS); + } + errno = EMBMDATA; + return -1; + } + + if (read_nb > MODBUS_MAX_WR_READ_REGISTERS) { + if (ctx->debug) { + fprintf(stderr, + "ERROR Too many registers requested (%d > %d)\n", + read_nb, MODBUS_MAX_WR_READ_REGISTERS); + } + errno = EMBMDATA; + return -1; + } + req_length = ctx->backend->build_request_basis(ctx, + MODBUS_FC_WRITE_AND_READ_REGISTERS, + read_addr, read_nb, req); + + req[req_length++] = write_addr >> 8; + req[req_length++] = write_addr & 0x00ff; + req[req_length++] = write_nb >> 8; + req[req_length++] = write_nb & 0x00ff; + byte_count = write_nb * 2; + req[req_length++] = byte_count; + + for (i = 0; i < write_nb; i++) { + req[req_length++] = src[i] >> 8; + req[req_length++] = src[i] & 0x00FF; + } + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + int offset; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + if (rc == -1) + return -1; + + offset = ctx->backend->header_length; + for (i = 0; i < rc; i++) { + /* shift reg hi_byte to temp OR with lo_byte */ + dest[i] = (rsp[offset + 2 + (i << 1)] << 8) | + rsp[offset + 3 + (i << 1)]; + } + } + + return rc; +} + +/* Send a request to get the slave ID of the device (only available in serial + communication). */ +int modbus_report_slave_id(modbus_t *ctx, int max_dest, uint8_t *dest) +{ + int rc; + int req_length; + uint8_t req[_MIN_REQ_LENGTH]; + + if (ctx == NULL || max_dest <= 0) { + errno = EINVAL; + return -1; + } + + req_length = ctx->backend->build_request_basis(ctx, MODBUS_FC_REPORT_SLAVE_ID, + 0, 0, req); + + /* HACKISH, addr and count are not used */ + req_length -= 4; + + rc = send_msg(ctx, req, req_length); + if (rc > 0) { + int i; + int offset; + uint8_t rsp[MAX_MESSAGE_LENGTH]; + + rc = _modbus_receive_msg(ctx, rsp, MSG_CONFIRMATION); + if (rc == -1) + return -1; + + rc = check_confirmation(ctx, req, rsp, rc); + if (rc == -1) + return -1; + + offset = ctx->backend->header_length + 2; + + /* Byte count, slave id, run indicator status and + additional data. Truncate copy to max_dest. */ + for (i=0; i < rc && i < max_dest; i++) { + dest[i] = rsp[offset + i]; + } + } + + return rc; +} + +void _modbus_init_common(modbus_t *ctx) +{ + /* Slave and socket are initialized to -1 */ + ctx->slave = -1; + ctx->s = -1; + + ctx->debug = FALSE; + ctx->error_recovery = MODBUS_ERROR_RECOVERY_NONE; + + ctx->response_timeout.tv_sec = 0; + ctx->response_timeout.tv_usec = _RESPONSE_TIMEOUT; + + ctx->byte_timeout.tv_sec = 0; + ctx->byte_timeout.tv_usec = _BYTE_TIMEOUT; +} + +/* Define the slave number */ +int modbus_set_slave(modbus_t *ctx, int slave) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return ctx->backend->set_slave(ctx, slave); +} + +int modbus_set_error_recovery(modbus_t *ctx, + modbus_error_recovery_mode error_recovery) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + /* The type of modbus_error_recovery_mode is unsigned enum */ + ctx->error_recovery = (uint8_t) error_recovery; + return 0; +} + +int modbus_set_socket(modbus_t *ctx, int s) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + ctx->s = s; + return 0; +} + +int modbus_get_socket(modbus_t *ctx) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return ctx->s; +} + +/* Get the timeout interval used to wait for a response */ +int modbus_get_response_timeout(modbus_t *ctx, uint32_t *to_sec, uint32_t *to_usec) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + *to_sec = ctx->response_timeout.tv_sec; + *to_usec = ctx->response_timeout.tv_usec; + return 0; +} + +int modbus_set_response_timeout(modbus_t *ctx, uint32_t to_sec, uint32_t to_usec) +{ + if (ctx == NULL || + (to_sec == 0 && to_usec == 0) || to_usec > 999999) { + errno = EINVAL; + return -1; + } + + ctx->response_timeout.tv_sec = to_sec; + ctx->response_timeout.tv_usec = to_usec; + return 0; +} + +/* Get the timeout interval between two consecutive bytes of a message */ +int modbus_get_byte_timeout(modbus_t *ctx, uint32_t *to_sec, uint32_t *to_usec) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + *to_sec = ctx->byte_timeout.tv_sec; + *to_usec = ctx->byte_timeout.tv_usec; + return 0; +} + +int modbus_set_byte_timeout(modbus_t *ctx, uint32_t to_sec, uint32_t to_usec) +{ + /* Byte timeout can be disabled when both values are zero */ + if (ctx == NULL || to_usec > 999999) { + errno = EINVAL; + return -1; + } + + ctx->byte_timeout.tv_sec = to_sec; + ctx->byte_timeout.tv_usec = to_usec; + return 0; +} + +int modbus_get_header_length(modbus_t *ctx) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return ctx->backend->header_length; +} + +int modbus_connect(modbus_t *ctx) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + return ctx->backend->connect(ctx); +} + +void modbus_close(modbus_t *ctx) +{ + if (ctx == NULL) + return; + + ctx->backend->close(ctx); +} + +void modbus_free(modbus_t *ctx) +{ + if (ctx == NULL) + return; + + ctx->backend->free(ctx); +} + +int modbus_set_debug(modbus_t *ctx, int flag) +{ + if (ctx == NULL) { + errno = EINVAL; + return -1; + } + + ctx->debug = flag; + return 0; +} + +/* Allocates 4 arrays to store bits, input bits, registers and inputs + registers. The pointers are stored in modbus_mapping structure. + + The modbus_mapping_new_ranges() function shall return the new allocated + structure if successful. Otherwise it shall return NULL and set errno to + ENOMEM. */ +modbus_mapping_t* modbus_mapping_new_start_address( + unsigned int start_bits, unsigned int nb_bits, + unsigned int start_input_bits, unsigned int nb_input_bits, + unsigned int start_registers, unsigned int nb_registers, + unsigned int start_input_registers, unsigned int nb_input_registers) +{ + modbus_mapping_t *mb_mapping; + + mb_mapping = (modbus_mapping_t *)malloc(sizeof(modbus_mapping_t)); + if (mb_mapping == NULL) { + return NULL; + } + + /* 0X */ + mb_mapping->nb_bits = nb_bits; + mb_mapping->start_bits = start_bits; + if (nb_bits == 0) { + mb_mapping->tab_bits = NULL; + } else { + /* Negative number raises a POSIX error */ + mb_mapping->tab_bits = + (uint8_t *) malloc(nb_bits * sizeof(uint8_t)); + if (mb_mapping->tab_bits == NULL) { + free(mb_mapping); + return NULL; + } + memset(mb_mapping->tab_bits, 0, nb_bits * sizeof(uint8_t)); + } + + /* 1X */ + mb_mapping->nb_input_bits = nb_input_bits; + mb_mapping->start_input_bits = start_input_bits; + if (nb_input_bits == 0) { + mb_mapping->tab_input_bits = NULL; + } else { + mb_mapping->tab_input_bits = + (uint8_t *) malloc(nb_input_bits * sizeof(uint8_t)); + if (mb_mapping->tab_input_bits == NULL) { + free(mb_mapping->tab_bits); + free(mb_mapping); + return NULL; + } + memset(mb_mapping->tab_input_bits, 0, nb_input_bits * sizeof(uint8_t)); + } + + /* 4X */ + mb_mapping->nb_registers = nb_registers; + mb_mapping->start_registers = start_registers; + if (nb_registers == 0) { + mb_mapping->tab_registers = NULL; + } else { + mb_mapping->tab_registers = + (uint16_t *) malloc(nb_registers * sizeof(uint16_t)); + if (mb_mapping->tab_registers == NULL) { + free(mb_mapping->tab_input_bits); + free(mb_mapping->tab_bits); + free(mb_mapping); + return NULL; + } + memset(mb_mapping->tab_registers, 0, nb_registers * sizeof(uint16_t)); + } + + /* 3X */ + mb_mapping->nb_input_registers = nb_input_registers; + mb_mapping->start_input_registers = start_input_registers; + if (nb_input_registers == 0) { + mb_mapping->tab_input_registers = NULL; + } else { + mb_mapping->tab_input_registers = + (uint16_t *) malloc(nb_input_registers * sizeof(uint16_t)); + if (mb_mapping->tab_input_registers == NULL) { + free(mb_mapping->tab_registers); + free(mb_mapping->tab_input_bits); + free(mb_mapping->tab_bits); + free(mb_mapping); + return NULL; + } + memset(mb_mapping->tab_input_registers, 0, + nb_input_registers * sizeof(uint16_t)); + } + + return mb_mapping; +} + +modbus_mapping_t* modbus_mapping_new(int nb_bits, int nb_input_bits, + int nb_registers, int nb_input_registers) +{ + return modbus_mapping_new_start_address( + 0, nb_bits, 0, nb_input_bits, 0, nb_registers, 0, nb_input_registers); +} + +/* Frees the 4 arrays */ +void modbus_mapping_free(modbus_mapping_t *mb_mapping) +{ + if (mb_mapping == NULL) { + return; + } + + free(mb_mapping->tab_input_registers); + free(mb_mapping->tab_registers); + free(mb_mapping->tab_input_bits); + free(mb_mapping->tab_bits); + free(mb_mapping); +} + +#ifndef HAVE_STRLCPY +/* + * Function strlcpy was originally developed by + * Todd C. Miller to simplify writing secure code. + * See ftp://ftp.openbsd.org/pub/OpenBSD/src/lib/libc/string/strlcpy.3 + * for more information. + * + * Thank you Ulrich Drepper... not! + * + * Copy src to string dest of size dest_size. At most dest_size-1 characters + * will be copied. Always NUL terminates (unless dest_size == 0). Returns + * strlen(src); if retval >= dest_size, truncation occurred. + */ +size_t strlcpy(char *dest, const char *src, size_t dest_size) +{ + register char *d = dest; + register const char *s = src; + register size_t n = dest_size; + + /* Copy as many bytes as will fit */ + if (n != 0 && --n != 0) { + do { + if ((*d++ = *s++) == 0) + break; + } while (--n != 0); + } + + /* Not enough room in dest, add NUL and traverse rest of src */ + if (n == 0) { + if (dest_size != 0) + *d = '\0'; /* NUL-terminate dest */ + while (*s++) + ; + } + + return (s - src - 1); /* count does not include NUL */ +} +#endif diff --git a/libraries/ArduinoModbus/src/libmodbus/modbus.h b/libraries/ArduinoModbus/src/libmodbus/modbus.h new file mode 100644 index 0000000..85f7630 --- /dev/null +++ b/libraries/ArduinoModbus/src/libmodbus/modbus.h @@ -0,0 +1,289 @@ +/* + * Copyright © 2001-2013 Stéphane Raimbault + * Copyright © 2018 Arduino SA. All rights reserved. + * + * SPDX-License-Identifier: LGPL-2.1+ + */ + +#ifndef MODBUS_H +#define MODBUS_H + +/* Add this for macros that defined unix flavor */ +#if (defined(__unix__) || defined(unix)) && !defined(USG) +#include +#endif + +#ifndef _MSC_VER +#include +#else +#include "stdint.h" +#endif + +#include "modbus-version.h" + +#if defined(_MSC_VER) +# if defined(DLLBUILD) +/* define DLLBUILD when building the DLL */ +# define MODBUS_API __declspec(dllexport) +# else +# define MODBUS_API __declspec(dllimport) +# endif +#else +# define MODBUS_API +#endif + +#ifdef __cplusplus +# define MODBUS_BEGIN_DECLS extern "C" { +# define MODBUS_END_DECLS } +#else +# define MODBUS_BEGIN_DECLS +# define MODBUS_END_DECLS +#endif + +MODBUS_BEGIN_DECLS + +#ifndef FALSE +#define FALSE 0 +#endif + +#ifndef TRUE +#define TRUE 1 +#endif + + +/* Modbus function codes */ +#define MODBUS_FC_READ_COILS 0x01 +#define MODBUS_FC_READ_DISCRETE_INPUTS 0x02 +#define MODBUS_FC_READ_HOLDING_REGISTERS 0x03 +#define MODBUS_FC_READ_INPUT_REGISTERS 0x04 +#define MODBUS_FC_WRITE_SINGLE_COIL 0x05 +#define MODBUS_FC_WRITE_SINGLE_REGISTER 0x06 +#define MODBUS_FC_READ_EXCEPTION_STATUS 0x07 +#define MODBUS_FC_WRITE_MULTIPLE_COILS 0x0F +#define MODBUS_FC_WRITE_MULTIPLE_REGISTERS 0x10 +#define MODBUS_FC_REPORT_SLAVE_ID 0x11 +#define MODBUS_FC_MASK_WRITE_REGISTER 0x16 +#define MODBUS_FC_WRITE_AND_READ_REGISTERS 0x17 + +#define MODBUS_BROADCAST_ADDRESS 0 + +/* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 1 page 12) + * Quantity of Coils to read (2 bytes): 1 to 2000 (0x7D0) + * (chapter 6 section 11 page 29) + * Quantity of Coils to write (2 bytes): 1 to 1968 (0x7B0) + */ +#define MODBUS_MAX_READ_BITS 2000 +#define MODBUS_MAX_WRITE_BITS 1968 + +/* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 3 page 15) + * Quantity of Registers to read (2 bytes): 1 to 125 (0x7D) + * (chapter 6 section 12 page 31) + * Quantity of Registers to write (2 bytes) 1 to 123 (0x7B) + * (chapter 6 section 17 page 38) + * Quantity of Registers to write in R/W registers (2 bytes) 1 to 121 (0x79) + */ +#define MODBUS_MAX_READ_REGISTERS 125 +#define MODBUS_MAX_WRITE_REGISTERS 123 +#define MODBUS_MAX_WR_WRITE_REGISTERS 121 +#define MODBUS_MAX_WR_READ_REGISTERS 125 + +/* The size of the MODBUS PDU is limited by the size constraint inherited from + * the first MODBUS implementation on Serial Line network (max. RS485 ADU = 256 + * bytes). Therefore, MODBUS PDU for serial line communication = 256 - Server + * address (1 byte) - CRC (2 bytes) = 253 bytes. + */ +#define MODBUS_MAX_PDU_LENGTH 253 + +/* Consequently: + * - RTU MODBUS ADU = 253 bytes + Server address (1 byte) + CRC (2 bytes) = 256 + * bytes. + * - TCP MODBUS ADU = 253 bytes + MBAP (7 bytes) = 260 bytes. + * so the maximum of both backend in 260 bytes. This size can used to allocate + * an array of bytes to store responses and it will be compatible with the two + * backends. + */ +#define MODBUS_MAX_ADU_LENGTH 260 + +/* Random number to avoid errno conflicts */ +#if defined(ARDUINO) && defined(__AVR__) +#define MODBUS_ENOBASE 11234 +#else +#define MODBUS_ENOBASE 112345678 +#endif + +/* Protocol exceptions */ +enum { + MODBUS_EXCEPTION_ILLEGAL_FUNCTION = 0x01, + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, + MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, + MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE, + MODBUS_EXCEPTION_ACKNOWLEDGE, + MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY, + MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE, + MODBUS_EXCEPTION_MEMORY_PARITY, + MODBUS_EXCEPTION_NOT_DEFINED, + MODBUS_EXCEPTION_GATEWAY_PATH, + MODBUS_EXCEPTION_GATEWAY_TARGET, + MODBUS_EXCEPTION_MAX +}; + +#define EMBXILFUN (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_FUNCTION) +#define EMBXILADD (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS) +#define EMBXILVAL (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE) +#define EMBXSFAIL (MODBUS_ENOBASE + MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE) +#define EMBXACK (MODBUS_ENOBASE + MODBUS_EXCEPTION_ACKNOWLEDGE) +#define EMBXSBUSY (MODBUS_ENOBASE + MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY) +#define EMBXNACK (MODBUS_ENOBASE + MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE) +#define EMBXMEMPAR (MODBUS_ENOBASE + MODBUS_EXCEPTION_MEMORY_PARITY) +#define EMBXGPATH (MODBUS_ENOBASE + MODBUS_EXCEPTION_GATEWAY_PATH) +#define EMBXGTAR (MODBUS_ENOBASE + MODBUS_EXCEPTION_GATEWAY_TARGET) + +/* Native libmodbus error codes */ +#define EMBBADCRC (EMBXGTAR + 1) +#define EMBBADDATA (EMBXGTAR + 2) +#define EMBBADEXC (EMBXGTAR + 3) +#define EMBUNKEXC (EMBXGTAR + 4) +#define EMBMDATA (EMBXGTAR + 5) +#define EMBBADSLAVE (EMBXGTAR + 6) + +extern const unsigned int libmodbus_version_major; +extern const unsigned int libmodbus_version_minor; +extern const unsigned int libmodbus_version_micro; + +typedef struct _modbus modbus_t; + +typedef struct { + int nb_bits; + int start_bits; + int nb_input_bits; + int start_input_bits; + int nb_input_registers; + int start_input_registers; + int nb_registers; + int start_registers; + uint8_t *tab_bits; + uint8_t *tab_input_bits; + uint16_t *tab_input_registers; + uint16_t *tab_registers; +} modbus_mapping_t; + +typedef enum +{ + MODBUS_ERROR_RECOVERY_NONE = 0, + MODBUS_ERROR_RECOVERY_LINK = (1<<1), + MODBUS_ERROR_RECOVERY_PROTOCOL = (1<<2) +} modbus_error_recovery_mode; + +MODBUS_API int modbus_set_slave(modbus_t* ctx, int slave); +MODBUS_API int modbus_set_error_recovery(modbus_t *ctx, modbus_error_recovery_mode error_recovery); +MODBUS_API int modbus_set_socket(modbus_t *ctx, int s); +MODBUS_API int modbus_get_socket(modbus_t *ctx); + +MODBUS_API int modbus_get_response_timeout(modbus_t *ctx, uint32_t *to_sec, uint32_t *to_usec); +MODBUS_API int modbus_set_response_timeout(modbus_t *ctx, uint32_t to_sec, uint32_t to_usec); + +MODBUS_API int modbus_get_byte_timeout(modbus_t *ctx, uint32_t *to_sec, uint32_t *to_usec); +MODBUS_API int modbus_set_byte_timeout(modbus_t *ctx, uint32_t to_sec, uint32_t to_usec); + +MODBUS_API int modbus_get_header_length(modbus_t *ctx); + +MODBUS_API int modbus_connect(modbus_t *ctx); +MODBUS_API void modbus_close(modbus_t *ctx); + +MODBUS_API void modbus_free(modbus_t *ctx); + +MODBUS_API int modbus_flush(modbus_t *ctx); +MODBUS_API int modbus_set_debug(modbus_t *ctx, int flag); + +MODBUS_API const char *modbus_strerror(int errnum); + +MODBUS_API int modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest); +MODBUS_API int modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest); +MODBUS_API int modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest); +MODBUS_API int modbus_read_input_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest); +MODBUS_API int modbus_write_bit(modbus_t *ctx, int coil_addr, int status); +MODBUS_API int modbus_write_register(modbus_t *ctx, int reg_addr, int value); +MODBUS_API int modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *data); +MODBUS_API int modbus_write_registers(modbus_t *ctx, int addr, int nb, const uint16_t *data); +MODBUS_API int modbus_mask_write_register(modbus_t *ctx, int addr, uint16_t and_mask, uint16_t or_mask); +MODBUS_API int modbus_write_and_read_registers(modbus_t *ctx, int write_addr, int write_nb, + const uint16_t *src, int read_addr, int read_nb, + uint16_t *dest); +MODBUS_API int modbus_report_slave_id(modbus_t *ctx, int max_dest, uint8_t *dest); + +MODBUS_API modbus_mapping_t* modbus_mapping_new_start_address( + unsigned int start_bits, unsigned int nb_bits, + unsigned int start_input_bits, unsigned int nb_input_bits, + unsigned int start_registers, unsigned int nb_registers, + unsigned int start_input_registers, unsigned int nb_input_registers); + +MODBUS_API modbus_mapping_t* modbus_mapping_new(int nb_bits, int nb_input_bits, + int nb_registers, int nb_input_registers); +MODBUS_API void modbus_mapping_free(modbus_mapping_t *mb_mapping); + +MODBUS_API int modbus_send_raw_request(modbus_t *ctx, uint8_t *raw_req, int raw_req_length); + +MODBUS_API int modbus_receive(modbus_t *ctx, uint8_t *req); + +MODBUS_API int modbus_receive_confirmation(modbus_t *ctx, uint8_t *rsp); + +MODBUS_API int modbus_reply(modbus_t *ctx, const uint8_t *req, + int req_length, modbus_mapping_t *mb_mapping); +MODBUS_API int modbus_reply_exception(modbus_t *ctx, const uint8_t *req, + unsigned int exception_code); + +/** + * UTILS FUNCTIONS + **/ + +#define MODBUS_GET_HIGH_BYTE(data) (((data) >> 8) & 0xFF) +#define MODBUS_GET_LOW_BYTE(data) ((data) & 0xFF) +#define MODBUS_GET_INT64_FROM_INT16(tab_int16, index) \ + (((int64_t)tab_int16[(index) ] << 48) + \ + ((int64_t)tab_int16[(index) + 1] << 32) + \ + ((int64_t)tab_int16[(index) + 2] << 16) + \ + (int64_t)tab_int16[(index) + 3]) +#define MODBUS_GET_INT32_FROM_INT16(tab_int16, index) ((tab_int16[(index)] << 16) + tab_int16[(index) + 1]) +#define MODBUS_GET_INT16_FROM_INT8(tab_int8, index) ((tab_int8[(index)] << 8) + tab_int8[(index) + 1]) +#define MODBUS_SET_INT16_TO_INT8(tab_int8, index, value) \ + do { \ + tab_int8[(index)] = (value) >> 8; \ + tab_int8[(index) + 1] = (value) & 0xFF; \ + } while (0) +#define MODBUS_SET_INT32_TO_INT16(tab_int16, index, value) \ + do { \ + tab_int16[(index) ] = (value) >> 16; \ + tab_int16[(index) + 1] = (value); \ + } while (0) +#define MODBUS_SET_INT64_TO_INT16(tab_int16, index, value) \ + do { \ + tab_int16[(index) ] = (value) >> 48; \ + tab_int16[(index) + 1] = (value) >> 32; \ + tab_int16[(index) + 2] = (value) >> 16; \ + tab_int16[(index) + 3] = (value); \ + } while (0) + +MODBUS_API void modbus_set_bits_from_byte(uint8_t *dest, int idx, const uint8_t value); +MODBUS_API void modbus_set_bits_from_bytes(uint8_t *dest, int idx, unsigned int nb_bits, + const uint8_t *tab_byte); +MODBUS_API uint8_t modbus_get_byte_from_bits(const uint8_t *src, int idx, unsigned int nb_bits); +MODBUS_API float modbus_get_float(const uint16_t *src); +MODBUS_API float modbus_get_float_abcd(const uint16_t *src); +MODBUS_API float modbus_get_float_dcba(const uint16_t *src); +MODBUS_API float modbus_get_float_badc(const uint16_t *src); +MODBUS_API float modbus_get_float_cdab(const uint16_t *src); + +MODBUS_API void modbus_set_float(float f, uint16_t *dest); +MODBUS_API void modbus_set_float_abcd(float f, uint16_t *dest); +MODBUS_API void modbus_set_float_dcba(float f, uint16_t *dest); +MODBUS_API void modbus_set_float_badc(float f, uint16_t *dest); +MODBUS_API void modbus_set_float_cdab(float f, uint16_t *dest); + +#ifndef ARDUINO +#include "modbus-tcp.h" +#include "modbus-rtu.h" +#endif + +MODBUS_END_DECLS + +#endif /* MODBUS_H */ diff --git a/libraries/ArduinoRS485/LICENSE.txt b/libraries/ArduinoRS485/LICENSE.txt new file mode 100644 index 0000000..8000a6f --- /dev/null +++ b/libraries/ArduinoRS485/LICENSE.txt @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/libraries/ArduinoRS485/README.adoc b/libraries/ArduinoRS485/README.adoc new file mode 100644 index 0000000..b1be50e --- /dev/null +++ b/libraries/ArduinoRS485/README.adoc @@ -0,0 +1,15 @@ +:repository-owner: arduino-libraries +:repository-name: ArduinoRS485 + += {repository-name} Library for Arduino = + +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] + +Enables sending and receiving data using the RS-485 standard with RS-485 shields, like the MKR 485 Shield. + +This library supports the Maxim Integrated MAX3157 and equivalent chipsets. + +For more information about this library please visit us at +http://www.arduino.cc/en/Reference/{repository-name} diff --git a/libraries/ArduinoRS485/docs/api.md b/libraries/ArduinoRS485/docs/api.md new file mode 100644 index 0000000..71b6989 --- /dev/null +++ b/libraries/ArduinoRS485/docs/api.md @@ -0,0 +1,583 @@ +# Arduino RS485 library + +## Methods + +### `begin()` + +Initializes the RS485 object communication speed. + +#### Syntax + +``` +RS485.begin(baudrate) +``` + +#### Parameters + +* _baudrate_: communication speed in bits per second (baud). + +#### Returns + +None. + +#### See also + +* [end()](#end) +* [available()](#available) +* [peek()](#peek) +* [read()](#read) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `end()` + +Disables RS485 communication. + +#### Syntax + +``` +RS485.end() +``` + +#### Parameters + +None. + +#### Returns + +None. + +#### See also + +* [begin()](#begin) +* [available()](#available) +* [peek()](#peek) +* [read()](#read) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `available()` + +Get the number of bytes (characters) available for reading from the RS485 port. This is data that already arrived and is stored in the serial receive buffer. + +#### Syntax + +``` +RS485.available() +``` + +#### Parameters + +None. + +#### Returns + +The number of bytes available to read. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [peek()](#peek) +* [read()](#read) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `available()` + +Get the number of bytes (characters) available for reading from the RS485 port. This is data that already arrived and is stored in the serial receive buffer. + +#### Syntax + +``` +RS485.available() +``` + +#### Parameters + +None. + +#### Returns + +The number of bytes available to read. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [peek()](#peek) +* [read()](#read) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `peek()` + +Returns the next byte (character) of the incoming serial data without removing it from the internal serial buffer. That is, successive calls to peek() will return the same character, as will the next call to read(). + +#### Syntax + +``` +RS485.peek() +``` + +#### Parameters + +None. + +#### Returns + +The first byte of incoming serial data available or -1 if no data is available. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [read()](#read) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `read()` + +Reads incoming serial data. + +#### Syntax + +``` +RS485.read() +``` + +#### Parameters + +None. + +#### Returns + +The first byte of incoming serial data available or -1 if no data is available. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `write()` + +Writes binary data to the serial port. This data is sent as a byte or series of bytes. + +#### Syntax + +``` +RS485.write(uint8_t b) +``` + +#### Parameters + +* _b_: unsigned char. + +#### Returns + +The number of bytes written. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `flush()` + +Waits for the transmission of outgoing serial data to complete. + +#### Syntax + +``` +RS485.flush() +``` + +#### Parameters + +None. + +#### Returns + +None. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `beginTransmission()` + +Enables RS-485 transmission. + +#### Syntax + +``` +RS485.beginTransmission() +``` + +#### Parameters + +None. + +#### Returns + +None. + +#### Example + +``` +#include + +int counter = 0; + +void setup() { + RS485.begin(9600); +} + +void loop() { + RS485.beginTransmission(); + RS485.print("Counter: "); + RS485.println(counter); + RS485.endTransmission(); + + counter++; + + delay(1000); +} +``` + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `endTransmission()` + +Disables RS-485 transmission. + +#### Syntax + +``` +RS485.endTransmission() +``` + +#### Parameters + +None. + +#### Returns + +None. + +#### Example + +``` +#include + +int counter = 0; + +void setup() { + RS485.begin(9600); +} + +void loop() { + RS485.beginTransmission(); + RS485.print("Counter: "); + RS485.println(counter); + RS485.endTransmission(); + + counter++; + + delay(1000); +} +``` + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `receive()` + +Enables reception. + +#### Syntax + +``` +RS485.receive() +``` + +#### Parameters + +None. + +#### Returns + +None. + +#### Example + +``` +#include + +void setup() { + Serial.begin(9600); + while (!Serial); + + RS485.begin(9600); + + // Enable data reception + RS485.receive(); +} + +void loop() { + if (RS485.available()) { + Serial.write(RS485.read()); + } +} +``` + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `noReceive()` + +Disables reception. + +#### Syntax + +``` +RS485.noReceive() +``` + +#### Parameters + +None. + +#### Returns + +None. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `sendBreak()` + +Sends a serial break signal for the specified duration in milliseconds. + +#### Syntax + +``` +RS485.sendBreak(unsigned int duration) +``` + +#### Parameters + +* _duration_: Duration of the break signal in milliseconds. + +#### Returns + +None. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) +* [setPins()](#setpins) + +### `sendBreakMicroseconds()` + +Sends a serial break signal for the specified duration in microseconds. + +#### Syntax + +``` +RS485.sendBreak(unsigned int duration) +``` + +#### Parameters + +* _duration_: Duration of the break signal in microseconds. + +#### Returns + +None. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [setPins()](#setpins) + +### `setPins()` + +Modify the pins used to communicate with the MAX3157 chipset. By default the library uses pin 14 for TX, pin A6 for drive output enable, and pin A5 for receiver output enable. + +#### Syntax + +``` +RS485.setPins(int txPin, int dePin, int rePin) +``` + +#### Parameters + +* _txPin_: transmission pin (used to send break signals). +* _dePin_: drive output enable pin. +* _rePin_: receiver output enable pin. + +#### Returns + +None. + +#### See also + +* [begin()](#begin) +* [end()](#end) +* [available()](#available) +* [peak()](#peak) +* [read()](#write) +* [write()](#write) +* [flush()](#flush) +* [beginTransmission()](#begintransmission) +* [endTransmission()](#endtransmission) +* [receive()](#receive) +* [noReceive()](#noreceive) +* [sendBreak()](#sendbreak) +* [sendBreakMicroseconds()](#sendbreakmicroseconds) \ No newline at end of file diff --git a/libraries/ArduinoRS485/docs/readme.md b/libraries/ArduinoRS485/docs/readme.md new file mode 100644 index 0000000..2a2608a --- /dev/null +++ b/libraries/ArduinoRS485/docs/readme.md @@ -0,0 +1,12 @@ +# Arduino RS485 library + + +The Arduino RS485 library enables you to send and receive data using the RS-485 standard with Arduino® RS485 Shields, like the MKR 485 Shield. Please refer to the MKR RS485 Shield documentation for the specific settings about half, full duplex, and termination. + +This library supports the MAX3157 and equivalent chipsets. + +To use this library: + +``` +#include +``` \ No newline at end of file diff --git a/libraries/ArduinoRS485/examples/RS485Passthrough/RS485Passthrough.ino b/libraries/ArduinoRS485/examples/RS485Passthrough/RS485Passthrough.ino new file mode 100644 index 0000000..f86249f --- /dev/null +++ b/libraries/ArduinoRS485/examples/RS485Passthrough/RS485Passthrough.ino @@ -0,0 +1,44 @@ +/* + RS-485 Passthrough + + This sketch relays data sent and received between the Serial port and the RS-485 interface + + Circuit: + - MKR board + - MKR 485 Shield + - ISO GND connected to GND of the RS-485 device + - Y connected to A of the RS-485 device + - Z connected to B of the RS-485 device + - A connected to Y of the RS-485 device + - B connected to Z of the RS-485 device + - Jumper positions + - FULL set to ON + - Z \/\/ Y set to ON, if the RS-485 device doesn't provide termination + - B \/\/ A set to ON, if the RS-485 device doesn't provide termination + + created 4 July 2018 + by Sandeep Mistry +*/ + +#include + +void setup() { + Serial.begin(9600); + RS485.begin(9600); + + // enable transmission, can be disabled with: RS485.endTransmission(); + RS485.beginTransmission(); + + // enable reception, can be disabled with: RS485.noReceive(); + RS485.receive(); +} + +void loop() { + if (Serial.available()) { + RS485.write(Serial.read()); + } + + if (RS485.available()) { + Serial.write(RS485.read()); + } +} diff --git a/libraries/ArduinoRS485/examples/RS485Receiver/RS485Receiver.ino b/libraries/ArduinoRS485/examples/RS485Receiver/RS485Receiver.ino new file mode 100644 index 0000000..0373496 --- /dev/null +++ b/libraries/ArduinoRS485/examples/RS485Receiver/RS485Receiver.ino @@ -0,0 +1,37 @@ +/* + RS-485 Receiver + + This sketch receives data over RS-485 interface and outputs the data to the Serial interface + + Circuit: + - MKR board + - MKR 485 shield + - ISO GND connected to GND of the RS-485 device + - A connected to A/Y of the RS-485 device + - B connected to B/Z of the RS-485 device + - Jumper positions + - FULL set to ON + - A \/\/ B set to OFF + + created 4 July 2018 + by Sandeep Mistry +*/ + +#include + +void setup() { + Serial.begin(9600); + while (!Serial); + + RS485.begin(9600); + + // enable reception, can be disabled with: RS485.noReceive(); + RS485.receive(); +} + +void loop() { + if (RS485.available()) { + Serial.write(RS485.read()); + } +} + diff --git a/libraries/ArduinoRS485/examples/RS485Sender/RS485Sender.ino b/libraries/ArduinoRS485/examples/RS485Sender/RS485Sender.ino new file mode 100644 index 0000000..c40f016 --- /dev/null +++ b/libraries/ArduinoRS485/examples/RS485Sender/RS485Sender.ino @@ -0,0 +1,37 @@ +/* + RS-485 Sender + + This sketch periodically sends a string over the RS-485 interface + + Circuit: + - MKR board + - MKR 485 shield + - ISO GND connected to GND of the RS-485 device + - Y connected to A of the RS-485 device + - Z connected to B of the RS-485 device + - Jumper positions + - FULL set to ON + - Z \/\/ Y set to ON + + created 4 July 2018 + by Sandeep Mistry +*/ + +#include + +int counter = 0; + +void setup() { + RS485.begin(9600); +} + +void loop() { + RS485.beginTransmission(); + RS485.print("hello "); + RS485.println(counter); + RS485.endTransmission(); + + counter++; + + delay(1000); +} diff --git a/libraries/ArduinoRS485/keywords.txt b/libraries/ArduinoRS485/keywords.txt new file mode 100644 index 0000000..2d28341 --- /dev/null +++ b/libraries/ArduinoRS485/keywords.txt @@ -0,0 +1,33 @@ +####################################### +# Syntax Coloring Map For ArduinoRS485 +####################################### + +####################################### +# Datatypes (KEYWORD1) +####################################### + +ArduinoRS485 KEYWORD1 +RS485 KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +begin KEYWORD2 +end KEYWORD2 +peek KEYWORD2 +read KEYWORD2 +flush KEYWORD2 +write KEYWORD2 + +beginTransmission KEYWORD2 +endTransmission KEYWORD2 +receive KEYWORD2 +noReceive KEYWORD2 +sendBreak KEYWORD2 +sendBreakMicroseconds KEYWORD2 +setPins KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### diff --git a/libraries/ArduinoRS485/library.properties b/libraries/ArduinoRS485/library.properties new file mode 100644 index 0000000..ffd6dfe --- /dev/null +++ b/libraries/ArduinoRS485/library.properties @@ -0,0 +1,10 @@ +name=ArduinoRS485 +version=1.0.2 +author=Arduino +maintainer=Arduino +sentence=Enables sending and receiving data using the RS-485 standard with RS-485 shields, like the MKR 485 Shield. +paragraph=This library supports the Maxim Integrated MAX3157 and equivalent chipsets. +category=Communication +url=http://www.arduino.cc/en/Reference/ArduinoRS485 +architectures=* +includes=ArduinoRS485.h diff --git a/libraries/ArduinoRS485/src/ArduinoRS485.h b/libraries/ArduinoRS485/src/ArduinoRS485.h new file mode 100644 index 0000000..d24771f --- /dev/null +++ b/libraries/ArduinoRS485/src/ArduinoRS485.h @@ -0,0 +1,25 @@ +/* + This file is part of the ArduinoRS485 library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _ARDUINO_RS485_H_INCLUDED +#define _ARDUINO_RS485_H_INCLUDED + +#include "RS485.h" + +#endif diff --git a/libraries/ArduinoRS485/src/RS485.cpp b/libraries/ArduinoRS485/src/RS485.cpp new file mode 100644 index 0000000..07ca70d --- /dev/null +++ b/libraries/ArduinoRS485/src/RS485.cpp @@ -0,0 +1,191 @@ +/* + This file is part of the ArduinoRS485 library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include "RS485.h" + +RS485Class::RS485Class(HardwareSerial& hwSerial, int txPin, int dePin, int rePin) : + _serial(&hwSerial), + _txPin(txPin), + _dePin(dePin), + _rePin(rePin), + _transmisionBegun(false) +{ +} + +void RS485Class::begin(unsigned long baudrate) +{ + begin(baudrate, SERIAL_8N1, RS485_DEFAULT_PRE_DELAY, RS485_DEFAULT_POST_DELAY); +} + +void RS485Class::begin(unsigned long baudrate, int predelay, int postdelay) +{ + begin(baudrate, SERIAL_8N1, predelay, postdelay); +} + +void RS485Class::begin(unsigned long baudrate, uint16_t config) +{ + begin(baudrate, config, RS485_DEFAULT_PRE_DELAY, RS485_DEFAULT_POST_DELAY); +} + +void RS485Class::begin(unsigned long baudrate, uint16_t config, int predelay, int postdelay) +{ + _baudrate = baudrate; + _config = config; + + // Set only if not already initialized with ::setDelays + _predelay = _predelay == 0 ? predelay : _predelay; + _postdelay = _postdelay == 0 ? postdelay : _postdelay; + + if (_dePin > -1) { + pinMode(_dePin, OUTPUT); + digitalWrite(_dePin, LOW); + } + + if (_rePin > -1) { + pinMode(_rePin, OUTPUT); + digitalWrite(_rePin, HIGH); + } + + _transmisionBegun = false; + + _serial->begin(baudrate, config); +} + +void RS485Class::end() +{ + _serial->end(); + + if (_rePin > -1) { + digitalWrite(_rePin, LOW); + pinMode(_dePin, INPUT); + } + + if (_dePin > -1) { + digitalWrite(_dePin, LOW); + pinMode(_rePin, INPUT); + } +} + +int RS485Class::available() +{ + return _serial->available(); +} + +int RS485Class::peek() +{ + return _serial->peek(); +} + +int RS485Class::read(void) +{ + return _serial->read(); +} + +void RS485Class::flush() +{ + return _serial->flush(); +} + +size_t RS485Class::write(uint8_t b) +{ + if (!_transmisionBegun) { + setWriteError(); + return 0; + } + + return _serial->write(b); +} + +RS485Class::operator bool() +{ + return true; +} + +void RS485Class::beginTransmission() +{ + if (_dePin > -1) { + digitalWrite(_dePin, HIGH); + if (_predelay) delayMicroseconds(_predelay); + } + + _transmisionBegun = true; +} + +void RS485Class::endTransmission() +{ + _serial->flush(); + + if (_dePin > -1) { + if (_postdelay) delayMicroseconds(_postdelay); + digitalWrite(_dePin, LOW); + } + + _transmisionBegun = false; +} + +void RS485Class::receive() +{ + if (_rePin > -1) { + digitalWrite(_rePin, LOW); + } +} + +void RS485Class::noReceive() +{ + if (_rePin > -1) { + digitalWrite(_rePin, HIGH); + } +} + +void RS485Class::sendBreak(unsigned int duration) +{ + _serial->flush(); + _serial->end(); + pinMode(_txPin, OUTPUT); + digitalWrite(_txPin, LOW); + delay(duration); + _serial->begin(_baudrate, _config); +} + +void RS485Class::sendBreakMicroseconds(unsigned int duration) +{ + _serial->flush(); + _serial->end(); + pinMode(_txPin, OUTPUT); + digitalWrite(_txPin, LOW); + delayMicroseconds(duration); + _serial->begin(_baudrate, _config); +} + +void RS485Class::setPins(int txPin, int dePin, int rePin) +{ + _txPin = txPin; + _dePin = dePin; + _rePin = rePin; +} + +void RS485Class::setDelays(int predelay, int postdelay) +{ + _predelay = predelay; + _postdelay = postdelay; +} + +/* +RS485Class RS485(SERIAL_PORT_HARDWARE, RS485_DEFAULT_TX_PIN, RS485_DEFAULT_DE_PIN, RS485_DEFAULT_RE_PIN); +*/ \ No newline at end of file diff --git a/libraries/ArduinoRS485/src/RS485.h b/libraries/ArduinoRS485/src/RS485.h new file mode 100644 index 0000000..f76c006 --- /dev/null +++ b/libraries/ArduinoRS485/src/RS485.h @@ -0,0 +1,89 @@ +/* + This file is part of the ArduinoRS485 library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _RS485_H_INCLUDED +#define _RS485_H_INCLUDED + +#include + +#ifdef PIN_SERIAL1_TX +#define RS485_DEFAULT_TX_PIN PIN_SERIAL1_TX +#else +#define RS485_DEFAULT_TX_PIN 1 +#endif + +#ifdef __AVR__ +#define RS485_DEFAULT_DE_PIN 2 +#define RS485_DEFAULT_RE_PIN -1 +#else +#define RS485_DEFAULT_DE_PIN A6 +#define RS485_DEFAULT_RE_PIN A5 +#endif + + +#define RS485_DEFAULT_PRE_DELAY 50 +#define RS485_DEFAULT_POST_DELAY 50 + +class RS485Class : public Stream { + public: + RS485Class(HardwareSerial& hwSerial, int txPin, int dePin, int rePin); + + virtual void begin(unsigned long baudrate); + virtual void begin(unsigned long baudrate, uint16_t config); + virtual void begin(unsigned long baudrate, int predelay, int postdelay); + virtual void begin(unsigned long baudrate, uint16_t config, int predelay, int postdelay); + virtual void end(); + virtual int available(); + virtual int peek(); + virtual int read(void); + virtual void flush(); + virtual size_t write(uint8_t b); + using Print::write; // pull in write(str) and write(buf, size) from Print + virtual operator bool(); + + void beginTransmission(); + void endTransmission(); + void receive(); + void noReceive(); + + void sendBreak(unsigned int duration); + void sendBreakMicroseconds(unsigned int duration); + + void setPins(int txPin, int dePin, int rePin); + + void setDelays(int predelay, int postdelay); + + private: + HardwareSerial* _serial; + int _txPin; + int _dePin; + int _rePin; + int _predelay = 0; + int _postdelay = 0; + + bool _transmisionBegun; + unsigned long _baudrate; + uint16_t _config; +}; + + +extern RS485Class RS485; + + +#endif diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..f0a9d4a --- /dev/null +++ b/readme.md @@ -0,0 +1,20 @@ +* start dev environment using `startDevEnv.sh` +* build application in container in directory `~/project` using `arduino-cli compile --fqbn=Heltec-esp32:esp32:WIFI_LoRa_32_V3 --export-binaries /home/arduino/project/sketch/` +* flash device using `esptool.py --port /dev/tty.usbserial-0001 --baud 921600 --chip esp32s3 write_flash --flash_mode dio --flash_size 8MB 0x0 sketch.ino.bootloader.bin 0x8000 sketch.ino.partitions.bin 0x10000 sketch.ino.bin` + + +/Users/wn/Library/Arduino15/packages/Heltec-esp32/tools/esptool_py/3.3.0/esptool + --chip esp32s3 + --port /dev/cu.usbserial-0001 + --baud 921600 + --before default_reset + --after hard_reset + write_flash + -z + --flash_mode dio + --flash_freq 80m + --flash_size 8MB + 0x0 /var/folders/vy/d60s0tzx3mn8bfy6ssd27hl00000gn/T/arduino_build_190148/LoRaWan.ino.bootloader.bin + 0x8000 /var/folders/vy/d60s0tzx3mn8bfy6ssd27hl00000gn/T/arduino_build_190148/LoRaWan.ino.partitions.bin + 0xe000 /Users/wn/Library/Arduino15/packages/Heltec-esp32/hardware/esp32/0.0.7/tools/partitions/boot_app0.bin + 0x10000 /var/folders/vy/d60s0tzx3mn8bfy6ssd27hl00000gn/T/arduino_build_190148/LoRaWan.ino.bin diff --git a/sketch/sketch.ino b/sketch/sketch.ino new file mode 100644 index 0000000..177849c --- /dev/null +++ b/sketch/sketch.ino @@ -0,0 +1,168 @@ + +#include "LoRaWan_APP.h" +// #include +#include + + + +/* OTAA para*/ +uint8_t devEui[] = { 0x22, 0x32, 0x33, 0x00, 0x00, 0x88, 0x88, 0x02 }; +uint8_t appEui[] = { 0xa0, 0x57, 0x81, 0x00, 0x01, 0x12, 0xaa, 0xf3 }; +uint8_t appKey[] = { 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88, 0x88 }; + + +/* ABP para*/ +uint8_t nwkSKey[] = { 0x15, 0xb1, 0xd0, 0xef, 0xa4, 0x63, 0xdf, 0xbe, 0x3d, 0x11, 0x18, 0x1e, 0x1e, 0xc7, 0xda,0x85 }; +uint8_t appSKey[] = { 0xd7, 0x2c, 0x78, 0x75, 0x8c, 0xdc, 0xca, 0xbf, 0x55, 0xee, 0x4a, 0x77, 0x8d, 0x16, 0xef,0x67 }; +uint32_t devAddr = ( uint32_t )0x007e6ae1; + +/*LoraWan channelsmask, default channels 0-7*/ +uint16_t userChannelsMask[6]={ 0x00FF,0x0000,0x0000,0x0000,0x0000,0x0000 }; + +/*LoraWan region, select in arduino IDE tools*/ +LoRaMacRegion_t loraWanRegion = ACTIVE_REGION; + +/*LoraWan Class, Class A and Class C are supported*/ +DeviceClass_t loraWanClass = CLASS_A; + +/*the application data transmission duty cycle. value in [ms].*/ +uint32_t appTxDutyCycle = 15000; + +/*OTAA or ABP*/ +bool overTheAirActivation = true; + +/*ADR enable*/ +bool loraWanAdr = true; + +/* Indicates if the node is sending confirmed or unconfirmed messages */ +bool isTxConfirmed = true; + +/* Application port */ +uint8_t appPort = 2; +/*! +* Number of trials to transmit the frame, if the LoRaMAC layer did not +* receive an acknowledgment. The MAC performs a datarate adaptation, +* according to the LoRaWAN Specification V1.0.2, chapter 18.4, according +* to the following table: +* +* Transmission nb | Data Rate +* ----------------|----------- +* 1 (first) | DR +* 2 | DR +* 3 | max(DR-1,0) +* 4 | max(DR-1,0) +* 5 | max(DR-2,0) +* 6 | max(DR-2,0) +* 7 | max(DR-3,0) +* 8 | max(DR-3,0) +* +* Note, that if NbTrials is set to 1 or 2, the MAC will not decrease +* the datarate, in case the LoRaMAC layer did not receive an acknowledgment +*/ +uint8_t confirmedNbTrials = 4; + +RS485Class* pRS485_1; + +/* Prepares the payload of the frame */ +static void prepareTxFrame( uint8_t port ) +{ + /*appData size is LORAWAN_APP_DATA_MAX_SIZE which is defined in "commissioning.h". + *appDataSize max value is LORAWAN_APP_DATA_MAX_SIZE. + *if enabled AT, don't modify LORAWAN_APP_DATA_MAX_SIZE, it may cause system hanging or failure. + *if disabled AT, LORAWAN_APP_DATA_MAX_SIZE can be modified, the max value is reference to lorawan region and SF. + *for example, if use REGION_CN470, + *the max value for different DR can be found in MaxPayloadOfDatarateCN470 refer to DataratesCN470 and BandwidthsCN470 in "RegionCN470.h". + */ + appDataSize = 4; + appData[0] = 0x10; + appData[1] = 0x21; + appData[2] = 0x32; + appData[3] = 0x43; +} + +//if true, next uplink will add MOTE_MAC_DEVICE_TIME_REQ + + +void setup() { + Serial.begin(115200); + Serial1.begin(9600, SERIAL_8N1, 7, 6); + pRS485_1 = new RS485Class(Serial1, 6, 5, 4); + ModbusRTUClient.begin(*pRS485_1, 9600, SERIAL_8N1); + + Mcu.begin(); + deviceState = DEVICE_STATE_INIT; +} + +void loop() +{ +#if 1 + + switch( deviceState ) + { + case DEVICE_STATE_INIT: + { +#if(LORAWAN_DEVEUI_AUTO) + LoRaWAN.generateDeveuiByChipID(); +#endif + LoRaWAN.init(loraWanClass,loraWanRegion); + break; + } + case DEVICE_STATE_JOIN: + { + LoRaWAN.join(); + break; + } + case DEVICE_STATE_SEND: + { + Serial.println("rs485 writing"); + pRS485_1->beginTransmission(); + pRS485_1->write(0xaa); + pRS485_1->endTransmission(); + + Serial.println("sending"); + prepareTxFrame( appPort ); + LoRaWAN.send(); + deviceState = DEVICE_STATE_CYCLE; + break; + } + case DEVICE_STATE_CYCLE: + { + // Schedule next packet transmission + txDutyCycleTime = appTxDutyCycle + randr( -APP_TX_DUTYCYCLE_RND, APP_TX_DUTYCYCLE_RND ); + LoRaWAN.cycle(txDutyCycleTime); + deviceState = DEVICE_STATE_SLEEP; + break; + } + case DEVICE_STATE_SLEEP: + { + LoRaWAN.sleep(loraWanClass); + break; + } + default: + { + deviceState = DEVICE_STATE_INIT; + break; + } + } +#endif + +#if 0 + // for (slave) id 1: write the value of 0x01, to the coil at address 0x00 + if (!ModbusRTUClient.coilWrite(1, 0x00, 0x01)) { + Serial.print("Failed to write coil! "); + Serial.println(ModbusRTUClient.lastError()); + } + + // wait for 1 second + delay(1000); + + // for (slave) id 1: write the value of 0x00, to the coil at address 0x00 + if (!ModbusRTUClient.coilWrite(1, 0x00, 0x00)) { + Serial.print("Failed to write coil! "); + Serial.println(ModbusRTUClient.lastError()); + } + + // wait for 1 second + delay(1000); +#endif +} diff --git a/startDevEnv.sh b/startDevEnv.sh new file mode 100755 index 0000000..a62c92f --- /dev/null +++ b/startDevEnv.sh @@ -0,0 +1,9 @@ +#!/usr/local/bin/bash + +docker run \ + -it \ + --rm \ + -v $PWD:/home/arduino/project \ + registry.hottis.de/dockerized/build-env-arduino:0.29.0-9 \ + bash +