/config/modbus/client/map/{name}/reg/{idx}/type

The type of the register value. This may be one of the following:

  • bit: One-bit value (a coil, in Modbus terminology).
  • s16: Signed 16-bit integer.
  • u16: Unsigned 16-bit integer.
  • s32: Signed 32-bit integer.
  • u32: Unsigned 32-bit integer.
  • s32l: Signed 32-bit integer, word-swapped.
  • u32l: Unsigned 32-bit integer, word-swapped.
  • s64: Signed 64-bit integer.
  • u64: Unsigned 64-bit integer.
  • float16: IEEE-754 half-precision float.
  • float16l: IEEE-754 half-precision floating point, little-endian (byte-swapped).
  • float: IEEE-754 single-precision float.
  • floatl: IEEE-754 single-precision float, word-swapped.
  • double: IEEE-754 double-precision float.

Get /config/modbus/client/map/{name}/reg/{idx}/type

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Responses
200

Normal response.

401

Unauthorized response.

get/config/modbus/client/map/{name}/reg/{idx}/type
Request samples
Response samples
application/json
{
  • "result": "u32",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/modbus/client/map/{name}/reg/{idx}/type

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Request Body schema: application/json
string (configModbusClientMapNameRegItemType)

The type of the register value. This may be one of the following:

  • bit: One-bit value (a coil, in Modbus terminology).
  • s16: Signed 16-bit integer.
  • u16: Unsigned 16-bit integer.
  • s32: Signed 32-bit integer.
  • u32: Unsigned 32-bit integer.
  • s32l: Signed 32-bit integer, word-swapped.
  • u32l: Unsigned 32-bit integer, word-swapped.
  • s64: Signed 64-bit integer.
  • u64: Unsigned 64-bit integer.
  • float16: IEEE-754 half-precision float.
  • float16l: IEEE-754 half-precision floating point, little-endian (byte-swapped).
  • float: IEEE-754 single-precision float.
  • floatl: IEEE-754 single-precision float, word-swapped.
  • double: IEEE-754 double-precision float.
Enum: "bit" "s16" "u16" "s32" "u32" "s32l" "u32l" "s64" "u64" "float16" "float16l" "float" "floatl" "double"
Responses
200

Normal response.

401

Unauthorized response.

put/config/modbus/client/map/{name}/reg/{idx}/type
Request samples
application/json
"u32"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/modbus/client/map/{name}/reg/{idx}/type

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Request Body schema: application/json
string (configModbusClientMapNameRegItemType)

The type of the register value. This may be one of the following:

  • bit: One-bit value (a coil, in Modbus terminology).
  • s16: Signed 16-bit integer.
  • u16: Unsigned 16-bit integer.
  • s32: Signed 32-bit integer.
  • u32: Unsigned 32-bit integer.
  • s32l: Signed 32-bit integer, word-swapped.
  • u32l: Unsigned 32-bit integer, word-swapped.
  • s64: Signed 64-bit integer.
  • u64: Unsigned 64-bit integer.
  • float16: IEEE-754 half-precision float.
  • float16l: IEEE-754 half-precision floating point, little-endian (byte-swapped).
  • float: IEEE-754 single-precision float.
  • floatl: IEEE-754 single-precision float, word-swapped.
  • double: IEEE-754 double-precision float.
Enum: "bit" "s16" "u16" "s32" "u32" "s32l" "u32l" "s64" "u64" "float16" "float16l" "float" "floatl" "double"
Responses
200

Normal response.

401

Unauthorized response.

post/config/modbus/client/map/{name}/reg/{idx}/type
Request samples
application/json
"u32"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/modbus/client/map/{name}/reg/{idx}/type

Reset to u16.

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Responses
200

Normal response.

401

Unauthorized response.

delete/config/modbus/client/map/{name}/reg/{idx}/type
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}