owner.modbus

Modbus owner

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • slaveId

Reference to the Modbus slave on which this value is read

type

string

  • address

Modbus value address on the slave

type

integer

  • modbusType

Type of Modbus table on which this value is stored

type

string

enum

COIL, DISCRETE_INPUT, HOLDING_REGISTER, INPUT_REGISTER

default

COIL

  • valueType

Number of Modbus table unit occupied by this value.

type

string

enum

BOOLEAN, INT8, INT16, INT32, INT64, FLOAT, DOUBLE, UINT8, UINT16, UINT32, TEXT

default

BOOLEAN

  • length

(must only be provided for TEXT value_type) number of characters to read

type

integer

minimum

1

  • endianness

A combination handling both bytes and word order

type

string

enum

LITTLE, BIG, LITTLE_BYTE_SWAP, BIG_BYTE_SWAP

default

BIG

  • delta

When provided, only when the content of a Value changes more than this delta will its change be published.

type

integer

  • subRange

When provided, allows to read only a sub-range of a Value.

ModbusSubRange

additionalProperties

False

allOf

if

properties

  • modbusType

enum

COIL, DISCRETE_INPUT

then

properties

  • valueType

enum

BOOLEAN

if

properties

  • valueType

enum

TEXT

else

allOf

not

if

properties

  • valueType

enum

TEXT, BOOLEAN, FLOAT, DOUBLE

then

allOf

not

ModbusSubRange

type

object

properties

  • offset

Used to discard bit(s) to read

type

integer

default

0

  • mask

Binary mask used to select the bit(s) read

type

integer

default

1

additionalProperties

False