Powered by Redocly

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

Modbus map consisting of a list of register definitions and a set of options.

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

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/modbus/client/map/{name}
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/modbus/client/map/{name}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user Modbus map (editable).


 
 Example:  my_modbus_map
Request Body schema: application/json
object (configModbusClientMapNameOption) 
A set of options.  The meter currently supports the following
options:


    

  • default-modbus-addr: The Modbus unit-number to use by
  default.  This must be a decimal string.  For example: 1.
    

    • 

  • default-serial-params: The default serial parameters to use
  when the remote device is connected via a serial port
  (Modbus/RTU).  This must be a string.  For example: 9600/8n1
  for 9600 baud, 8 databits, no parity, 1 stop bit.
    

    • 

  • default-tcp-port: The default TCP port number to use when
  the remote device is connected via Modbus/TCP.  This must be a
  decimal string.  For example: 6001.
    

    • 



 
Array of objects (configModbusClientMapNameReg) 
A list of Modbus register definitions.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/modbus/client/map/{name}
Request samples 
application/json
{
  • "option": {
    },
  • "reg": [
    ]
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/modbus/client/map/{name}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user Modbus map (editable).


 
 Example:  my_modbus_map
Request Body schema: application/json
object (configModbusClientMapNameOption) 
A set of options.  The meter currently supports the following
options:


    

  • default-modbus-addr: The Modbus unit-number to use by
  default.  This must be a decimal string.  For example: 1.
    

    • 

  • default-serial-params: The default serial parameters to use
  when the remote device is connected via a serial port
  (Modbus/RTU).  This must be a string.  For example: 9600/8n1
  for 9600 baud, 8 databits, no parity, 1 stop bit.
    

    • 

  • default-tcp-port: The default TCP port number to use when
  the remote device is connected via Modbus/TCP.  This must be a
  decimal string.  For example: 6001.
    

    • 



 
Array of objects (configModbusClientMapNameReg) 
A list of Modbus register definitions.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/modbus/client/map/{name}
Request samples 
application/json
{
  • "option": {
    },
  • "reg": [
    ]
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/modbus/client/map/{name}
Delete this map.


SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user Modbus map (editable).


 
 Example:  my_modbus_map
Responses 
200
Normal response.


401
Unauthorized response.


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