ModbusEndpoint

unitId (integer)

By setting this optional parameter, the unitId defined in the Connection resource will be overwritten.

Examples: 1, 2

Additional restrictions:

  • Maximum: 255

fc (integer, enum, required)

The Function Code (fc) defines the operation of the request. This can be any of the common Modbus codes, but the exact implementation depends on the concrete device manufacturer.

This element must be one of the following enum values:

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 15

  • 16

Example: 2

address (integer, required)

Example: 0

length (integer, required)

The length describes how many registers should be read starting at the specified address. The registers of a modbus device have a length of 16 bits.

Example: 4

dataType (string, enum)

If given, convert the Modbus value to this specified type. Types are available in byte ordering Big Endian (BE), or Little Endian (LE), or with additional word swap (BEWS, LEWS).

This element must be one of the following enum values:

  • raw

  • base64

  • boolean

  • doubleBE

  • doubleLE

  • floatBE

  • floatBEWS

  • floatLE

  • floatLEWS

  • int16BE

  • int16LE

  • int32BE

  • int32LE

  • uint16BE

  • uint16LE

  • uint32BE

  • uint32LE

Example: "floatLE"

interval (integer)

Poll interval (best effort) in milliseconds

Default: 1000

Example: 2000

cronExpression (string)

The Cron expression used to poll the endpoint. (For examples, see: https://github.com/node-cron/node-cron)

Examples: "1,2,4,5 * * * *", "1-5 * * * *", "*/2 * * * *", "* * * January,September Sunday"

Last updated

Logo

© Copyright 2024, Cybus GmbH