/config/bacnet/server

The BACnet server configuration.

Get /config/bacnet/server

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

Replace /config/bacnet/server

SecurityApiKey
Request
Request Body schema: application/json
object (configBacnetServerBip)

The BACnet over IPv4 configuration.

enable
Array of strings (configBacnetServerEnable)

The list of BACnet protocols that are enabled. An empty list indicates that the BACnet server is disabled. The meter is currently restricted to supporting a single protocol at a time, so this array may have at most one element.

Items Enum: "ethernet" "bip" "mstp"
epoch-relative
boolean (configBacnetServerEpochRelative)

If true, the BACnet server reports cumulative values relative to the meter epoch. If false, raw absolute values are reported relative to when the meter was manufactured.

id
integer (configBacnetServerId) [ 0 .. 4194303 ]

The object id of the BACnet server.

object (configBacnetServerMstp) [ 0 .. 127 ]

The BACnet over MS/TP configuration. This is used only if the mstp protocol is enabled.

Responses
200

Normal response.

401

Unauthorized response.

put/config/bacnet/server
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/bacnet/server

SecurityApiKey
Request
Request Body schema: application/json
object (configBacnetServerBip)

The BACnet over IPv4 configuration.

enable
Array of strings (configBacnetServerEnable)

The list of BACnet protocols that are enabled. An empty list indicates that the BACnet server is disabled. The meter is currently restricted to supporting a single protocol at a time, so this array may have at most one element.

Items Enum: "ethernet" "bip" "mstp"
epoch-relative
boolean (configBacnetServerEpochRelative)

If true, the BACnet server reports cumulative values relative to the meter epoch. If false, raw absolute values are reported relative to when the meter was manufactured.

id
integer (configBacnetServerId) [ 0 .. 4194303 ]

The object id of the BACnet server.

object (configBacnetServerMstp) [ 0 .. 127 ]

The BACnet over MS/TP configuration. This is used only if the mstp protocol is enabled.

Responses
200

Normal response.

401

Unauthorized response.

post/config/bacnet/server
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/bacnet/server

Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

delete/config/bacnet/server
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}