Skip to main content

​
Required Parameters

To add a device using the Modbus TCP/IP communication protocol, the following parameters are required.
​
id
string
required
A unique identifier for the device.Example: converter1
​
type
string
required
Indicates the type of device.Options: converter, battery, other
​
protocol
string
required
The communication protocol between the controller and the device. For this type of device, it will always be Modbus TCP/IP.Example: Modbus TCP/IP
​
ipAddress
string
required
The static IP address set for the device.Example: 192.168.1.20
​
port
int
required
The port number used for communication. Please consult the device’s manual to determine the port on which it communicates.Example: 502
​
slaveId
int
required
The slave ID of the device. Please consult the device’s manual to determine the specific slave ID.Example: 1
​
controlMap
string
required
The name of the device’s control map on the controller.Example: cet_30C3_control
​
addressMap
string
required
The name of the device’s address map on the controller.Example: cet_30C3_address_map
​
disabled
bool
required
Indicates whether the device is enabled or disabled. A value of true means the device is disabled, while false means the device is enabled.

​
Optional Parameters

The parameters listed below are optional and are not required for a device with the Modbus TCP/IP protocol to work properly. However, sometimes it is desirable to add these optional parameters for device monitoring or because they are required by the manufacturer.
​
critical
bool
Marks this device as critical or not. If a device is marked as critical (value true), any fault occurring on this device will send out an alert or notification over Telegram.
​
communicationInterval
float
Indicates the delay between consecutive Modbus operations, read or write. Between each Modbus command, the controller will wait this amount of time. The value is expressed in seconds.Example: 0.2
​
forwardMap
string
Indicates the name of the device’s forward map on the controller.Example: cet_30C3_forward_map

​
Example

The snippet below demonstrates a device with id converter1 and protocol Modbus TCP/IP, including all the required parameters along with the optional parameters. 
{
  "id": "converter1",
  "type": "converter",
  "protocol": "Modbus TCP/IP",
  "ipAddress": "192.168.1.20",
  "port": 502,
  "slaveId": 240,
  "controlMap": "cet_30C3_control",
  "addressMap": "cet_30C3_address_map",
  "forwardMap": "cet_30C3_forward_map",
  "disabled": false,
  "critical": true,
  "communicationInterval": 0.2
}
When configuring a device with Modbus TCP/IP communication, ensure all required parameters are correctly specified to prevent configuration errors. Optional parameters can offer additional functionality and control but are not essential for basic operation. Always verify that the paths provided for addressMap and controlMap are accurate and that the files exist in the specified locations.
⌘I