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

The kind of the register. Possible values are:

  • analog: The value is continuous (the average of two values is meaningful).

  • enum: The value is discrete (the average of two values is not meaningful). An example for this would be a numeric error code.

  • bitset: Each bit in the value is a discrete on/off value. An example for this would be a set of error flags.

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

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

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

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 (configModbusClientMapNameRegItemKind)

The kind of the register. Possible values are:

  • analog: The value is continuous (the average of two values is meaningful).

  • enum: The value is discrete (the average of two values is not meaningful). An example for this would be a numeric error code.

  • bitset: Each bit in the value is a discrete on/off value. An example for this would be a set of error flags.

Enum: "analog" "enum" "bitset"
Responses
200

Normal response.

401

Unauthorized response.

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

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

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 (configModbusClientMapNameRegItemKind)

The kind of the register. Possible values are:

  • analog: The value is continuous (the average of two values is meaningful).

  • enum: The value is discrete (the average of two values is not meaningful). An example for this would be a numeric error code.

  • bitset: Each bit in the value is a discrete on/off value. An example for this would be a set of error flags.

Enum: "analog" "enum" "bitset"
Responses
200

Normal response.

401

Unauthorized response.

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

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

Reset to analog.

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