Powered by Redocly

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

The name of the register. The user can choose this name freely so long as each register within a map has a unique name.

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

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}/name
Request samples 
Response samples 
application/json
{
  • "result": "irradiance",
  • "error": "Error message (present if an error occurred)."
}
Replace /config/modbus/client/map/{name}/reg/{idx}/name
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 (configModbusClientMapNameRegItemName) 
The name of the register.  The user can choose this name freely so
long as each register within a map has a unique name.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/modbus/client/map/{name}/reg/{idx}/name
Request samples 
application/json
"irradiance"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/modbus/client/map/{name}/reg/{idx}/name
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 (configModbusClientMapNameRegItemName) 
The name of the register.  The user can choose this name freely so
long as each register within a map has a unique name.


 
Responses 
200
Normal response.


401
Unauthorized response.


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


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}/name
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/modbus/client/map/{name}/reg/{idx}/addr