Matter

The Matter component provides Matter standard connectivity for supported Shelly devices.

The Matter component uses Matter as RPC namespace and implements the following methods:

• Matter.GetConfig to obtain the component's configuration
• Matter.SetConfig to update the component's configuration
• Matter.GetStatus to obtain the component's status
• Matter.GetSetupCode to obtain the component's setup code

Methods

Matter.SetConfig

Properties:

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

Matter.GetConfig

Find the Matter.GetConfig response properties in config section

Matter.GetStatus

Find more about the status response properties in status section

Matter.GetSetupCode

Request

This method takes no parameters.

Response

Property	Type	Description
qr_code	string	Textual representation of the QR code that is normally used to join the device.
manual_code	string	Manual pairing code, which can be used in certain situations next to or instead of the QR code.

Notes:

• These codes can be obtained from the Shelly Cloud Application or the device's web interface. On some devices, there is standard Matter sticker attached with both codes.
• The QR and the manual pairing codes are both used for commissioning (joining, pairing) the device into a Matter network. Most Matter network controllers allow to scan or enter the code manually.
• The device can be paired only when the component is enabled and the commissionable property is true. See the the status and config sections for details.

Configuration

The configuration of the Matter component enables or disables the server.

Properties:

Property	Type	Description
enable	boolean	Set true to enable.

Status

The status of the Matter component shows its current commissioning state.

Property	Type	Description
num_fabrics	number	The number of Matter fabrics that the device has joined.
commissionable	boolean	true if the device can be joined to an existing Matter fabric. false means that the device is either already joined, or the commissioning window is closed due to timeout. In the latter case, the device should be restarted before adding to a fabric.

Matter.SetConfig example

Matter.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Matter.SetConfig?config={"enable":true}

Matter.SetConfig Curl Request

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

Matter.SetConfig Mos Request

mos --port ${PORT} call Matter.SetConfig '{"config":{"enable":true}}'

Response

Matter.SetConfig HTTP GET Response

{
  "restart_required": false
}

Matter.SetConfig Curl Response

{
  "id": 1,
  "params": {
    "restart_required": false
  }
}

Matter.SetConfig Mos Response

{
  "restart_required": false
}

Matter.GetConfig example

Matter.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Matter.GetConfig?

Matter.GetConfig Curl Request

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

Matter.GetConfig Mos Request

mos --port ${PORT} call Matter.GetConfig '{}'

Response

Matter.GetConfig HTTP GET Response

{
  "enable": true
}

Matter.GetConfig Curl Response

{
  "id": 1,
  "params": {
    "enable": true
  }
}

Matter.GetConfig Mos Response

{
  "enable": true
}

Matter.GetStatus example

Matter.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Matter.GetStatus?

Matter.GetStatus Curl Request

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

Matter.GetStatus Mos Request

mos --port ${PORT} call Matter.GetStatus '{}'

Response

Matter.GetStatus HTTP GET Response

{
  "num_fabrics": 0,
  "commissionable": true
}

Matter.GetStatus Curl Response

{
  "id": 1,
  "params": {
    "num_fabrics": 0,
    "commissionable": true
  }
}

Matter.GetStatus Mos Response

{
  "num_fabrics": 0,
  "commissionable": true
}

Matter.GetSetupCode example

Matter.GetSetupCode HTTP GET Request

http://192.168.33.1/rpc/Matter.GetSetupCode?

Matter.GetSetupCode Curl Request

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

Matter.GetSetupCode Mos Request

mos --port ${PORT} call Matter.GetSetupCode '{}'

Response

Matter.GetSetupCode HTTP GET Response

{
  "qr_code": "MT:00000O-O03.3QG5.000",
  "manual_code": "00576700759"
}

Matter.GetSetupCode Curl Response

{
  "id": 1,
  "params": {
    "qr_code": "MT:00000O-O03.3QG5.000",
    "manual_code": "00576700759"
  }
}

Matter.GetSetupCode Mos Response

{
  "qr_code": "MT:00000O-O03.3QG5.000",
  "manual_code": "00576700759"
}