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

An offset value that is used to convert the Modbus register value to a value in the specified physical unit. Specifically, when the Modbus value of the register is reg, then corresponding physical value phys is calculated as:

phys = (reg + offset) * scale

where offset is the value defined here and scale is the value defined for member scale.

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

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}/offset
Request samples
Response samples
application/json
{
  • "result": 0,
  • "error": "Error message (present if an error occurred)."
}

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

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
number (configModbusClientMapNameRegItemOffset)

An offset value that is used to convert the Modbus register value to a value in the specified physical unit. Specifically, when the Modbus value of the register is reg, then corresponding physical value phys is calculated as:

phys = (reg + offset) * scale

where offset is the value defined here and scale is the value defined for member scale.

Responses
200

Normal response.

401

Unauthorized response.

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

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

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
number (configModbusClientMapNameRegItemOffset)

An offset value that is used to convert the Modbus register value to a value in the specified physical unit. Specifically, when the Modbus value of the register is reg, then corresponding physical value phys is calculated as:

phys = (reg + offset) * scale

where offset is the value defined here and scale is the value defined for member scale.

Responses
200

Normal response.

401

Unauthorized response.

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

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

Reset to 0.

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}/offset
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}