Breaker

Required Parameters

To add a breaker device, the following parameters are required.

id · string · required

A unique identifier for the device.

Example: breaker1

type · string · required

Indicates the type of device. For this type of device, it is always breaker.

Example: breaker

addressMap · string · required

The name of the device’s address map on the controller.

Example: breaker1_address_map

disabled · bool · required

Indicates whether the device is enabled or disabled. A value of true means the device is disabled, while false means the device is enabled.

Example

The snippet below demonstrates a breaker device, highlighting the required parameters.

{
  "id": "breaker1",
  "type": "breaker",
  "addressMap": "breaker1_address_map",
  "disabled": false
}

When configuring a breaker device, ensure that all required parameters are correctly specified to avoid configuration errors. Always verify that the paths provided for addressMap are accurate and that the files exist in the specified locations.