Analog I/O

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 analog output.
• Read Operations: Prefix register names with measure. to signify that the register is used to read the analog input signal.

See the example address map below for register naming conventions.

Required Parameters

name · string · required

A unique name for the register.

Example: measure.voltage

address · int · required

Corresponds to the number on the analog input or output module.

Example: 0

Please note that the address should start from 0, not from 1.

type · string · required

Indicates whether the register is an input or an output.

Options: input | output

Optional Parameters

scaling · int | float

The scaling factor to apply to the analog register’s return value or the value being written.

Example: 50

offset · int | float

The offset to apply to the analog register’s return value or the value being written.

Example: 100

Example

aio_address_map.json

[
  {
    "name": "measure.voltage",
    "address": 0,
    "type": "input",
    "scaling": 50,
    "offset": 100
  },
  {
    "name": "control.lights",
    "address": 0,
    "type": "output"
  }
]