Skip to main content

​
Naming Conventions

While not mandatory, it is recommended to adopt the following naming conventions for clarity and usability:
  • Write Operations: Prefix register names with control. to indicate that the register is used to set the digital output.
  • Read Operations: Prefix register names with measure. to signify that the register is used to read the digital input signal.
See the example address map below for register naming conventions.

​
Required Parameters

​
string
required
A unique name for the register.Example: control.contactor.main
​
int
required
Corresponds to the number on the digital input or output module.Example: 0
Please note that the address should start from 0, not from 1. However, the physical address on the I/O module begins at 1.
​
string
required
Indicates whether the register is an input or an output.Options: input | output

​
Required Registers

​
string
required
This register is used to control the main contactor.

​
Optional Registers

Reference Contactor
​
string
This register is used to control the reference contactor. Required when referenceContactorFeedback is enabled on the device.
Contactor Feedback
​
string
This register is used to measure the main contactor. Required when mainContactorFeedback is enabled on the device.
​
string
This register is used to measure the reference contactor. Required when referenceContactorFeedback is enabled on the device.

​
Example

The example below shows a complete address map for a contactor device with all required and optional registers.
contactor_address_map.json