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

​
name
string
required
A unique name for the register.Example: control.contactor.main
​
address
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.
​
type
string
required
Indicates whether the register is an input or an output.Options: input | output

​
Required Registers

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

​
Optional Registers

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

​
Example

The example below shows a complete address map for a precharge device with all required and optional registers.
precharge_address_map.json
[
  {        
    "name": "control.contactor.main",
    "address": 0,
    "type": "output"
  },
  {        
    "name": "control.contactor.auxiliary",
    "address": 1,
    "type": "output"
  },
  {        
    "name": "control.contactor.reference",
    "address": 2,
    "type": "output"
  },
  {        
    "name": "measure.contactor.main",
    "address": 8,
    "type": "input"
  },
  {        
    "name": "measure.contactor.auxiliary",
    "address": 9,
    "type": "input"
  },
  {        
    "name": "measure.contactor.reference",
    "address": 10,
    "type": "input"
  },
  {        
    "name": "measure.breaker",
    "address": 11,
    "type": "input"
  }
]