Zigbee

The Zigbee component handles Zigbee connectivity services of a device. The Zigbee component uses Zigbee as RPC namespace. It handles the Zigbee services of a device and provides the minimal component interface:

• Zigbee.GetConfig to obtain the component's configuration
• Zigbee.SetConfig to update the component's configuration
• Zigbee.GetStatus to obtain the the component's status
• Zigbee.StartNetworkSteering to start network steering

note

For sending ZCL commands directly to Zigbee devices on the network, see Zigbee Through-RPC.

Methods

Zigbee.SetConfig

Parameters:

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

Zigbee.GetConfig

Find the Zigbee.GetConfig response properties in config section

Zigbee.GetStatus

Find more about the status response properties in status section

Zigbee.StartNetworkSteering

This method triggers network steering.

Request

This method takes no parameters.

Response

This method returns no attributes.

Configuration

The configuration of the Zigbee component allows enabling or disabling the Zigbee connectivity.

Properties:

Property	Type	Description
enable	boolean	True if Zigbee connectivity is enabled, false otherwise

Status

The status of the Zigbee component contains information about the state of the Zigbee connection of the device.

Properties:

Property	Type	Description
network_state	string	Status of the connection. Range of values: disabled, initializing, steering, joined, failed

Zigbee.SetConfig example

Zigbee.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Zigbee.SetConfig?config={"enable":false}

Zigbee.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Zigbee.SetConfig","params":{"config":{"enable":false}}}' http://${SHELLY}/rpc

Zigbee.SetConfig Mos Request

mos --port ${PORT} call Zigbee.SetConfig '{"config":{"enable":false}}'

Response

Zigbee.SetConfig HTTP GET Response

{
  "restart_required": true
}

Zigbee.SetConfig Curl Response

{
  "id": 1,
  "src": "shelly1g4-404cca4a9f98",
  "params": {
    "restart_required": true
  }
}

Zigbee.SetConfig Mos Response

{
  "restart_required": true
}

Zigbee.GetConfig example

Zigbee.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Zigbee.GetConfig

Zigbee.GetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Zigbee.GetConfig"}' http://${SHELLY}/rpc

Zigbee.GetConfig Mos Request

mos --port ${PORT} call Zigbee.GetConfig

Response

Zigbee.GetConfig HTTP GET Response

{
  "enable": true
}

Zigbee.GetConfig Curl Response

{
  "id": 1,
  "src": "shelly1g4-404cca4a9f98",
  "params": {
    "enable": true
  }
}

Zigbee.GetConfig Mos Response

{
  "enable": true
}

Zigbee.GetStatus example

Zigbee.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Zigbee.GetStatus

Zigbee.GetStatus Curl Request

curl -X POST -d '{"id":1,"method":"Zigbee.GetStatus"}' http://${SHELLY}/rpc

Zigbee.GetStatus Mos Request

mos --port ${PORT} call Zigbee.GetStatus

Response

Zigbee.GetStatus HTTP GET Response

{
  "network_state": "joined"
}

Zigbee.GetStatus Curl Response

{
  "id": 1,
  "src": "shelly1g4-404cca4a9f98",
  "params": {
    "network_state": "joined"
  }
}

Zigbee.GetStatus Mos Response

{
  "network_state": "joined"
}

Zigbee.StartNetworkSteering example

Zigbee.StartNetworkSteering HTTP GET Request

http://192.168.33.1/rpc/Zigbee.StartNetworkSteering

Zigbee.StartNetworkSteering Curl Request

curl -X POST -d '{"id":1,"method":"Zigbee.StartNetworkSteering"}' http://${SHELLY}/rpc

Zigbee.StartNetworkSteering Mos Request

mos --port ${PORT} call Zigbee.StartNetworkSteering

Response

Zigbee.StartNetworkSteering HTTP GET Response

null

Zigbee.StartNetworkSteering Curl Response

{
  "id": 1,
  "src": "shelly1g4-404cca4a9f98",
  "params": null
}

Zigbee.StartNetworkSteering Mos Response

null