Smoke

The Smoke component handles the monitoring of device's smoke sensors. Smoke components are identified with smoke:<id> in objects containing multiple component payloads.

The Smoke component uses Smoke as RPC namespace and implements the minimal component interface:

• Smoke.GetConfig to obtain the component's configuration
• Smoke.SetConfig to update the component's configuration
• Smoke.GetStatus to obtain the component's status
• Smoke.Mute to mute alarm of the associated smoke sensor

Methods

Smoke.SetConfig

Property	Type	Description
id	number	Id of the Smoke component instance
config	object	Configuration that the method takes

Find more about the config properties in config section

Smoke.GetConfig

Property	Type	Description
id	number	Id of the Smoke component instance

Find the Smoke.GetConfig response properties in config section

Smoke.GetStatus

Property	Type	Description
id	number	Id of the Smoke component instance

Find more about the status response properties in status section

Smoke.Mute

This method mute alarm of the associated smoke sensor.

Property	Type	Description
id	number	Id of the Smoke component instance

Configuration

To Get/Set the configuration of the Smoke component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the Smoke component instance
name	string or null	Name of the Smoke instance. name length should not exceed 64 chars

Status

The status of the Smoke component represents the alarm and mute state of the associated smoke sensor. To obtain the status of the Smoke component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the Smoke component instance
alarm	boolean	Alarm state
mute	boolean	Mute state

Webhook Events

There are two events related to the Smoke component that can trigger webhooks:

• smoke.alarm - produced when smoke alarm is triggered
• smoke.alarm_off - produced when smoke alarm goes off
• smoke.alarm_test - produced when alarm test is invoked

Examples

Smoke.SetConfig example

Smoke.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Smoke.SetConfig?id=0&config={"name":"Smoke0"}

Smoke.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Smoke.SetConfig","params":{"id":0,"config":{"name":"Smoke0"}}}' http://${SHELLY}/rpc

Smoke.SetConfig Mos Request

mos --port ${PORT} call Smoke.SetConfig '{"id":0,"config":{"name":"Smoke0"}}'

Response

Smoke.SetConfig HTTP GET Response

{
  "restart_required": false
}

Smoke.SetConfig Curl Response

{
  "id": 1,
  "src": "shellyplussmoke-441793cc9d30",
  "params": {
    "restart_required": false
  }
}

Smoke.SetConfig Mos Response

{
  "restart_required": false
}

Smoke.GetConfig example

Smoke.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Smoke.GetConfig?id=0

Smoke.GetConfig Curl Request

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

Smoke.GetConfig Mos Request

mos --port ${PORT} call Smoke.GetConfig '{"id":0}'

Response

Smoke.GetConfig HTTP GET Response

{
  "id": 0,
  "name": null
}

Smoke.GetConfig Curl Response

{
  "id": 1,
  "src": "shellyplussmoke-441793cc9d30",
  "params": {
    "id": 0,
    "name": null
  }
}

Smoke.GetConfig Mos Response

{
  "id": 0,
  "name": null
}

Smoke.GetStatus example

Smoke.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Smoke.GetStatus?id=0

Smoke.GetStatus Curl Request

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

Smoke.GetStatus Mos Request

mos --port ${PORT} call Smoke.GetStatus '{"id":0}'

Response

Smoke.GetStatus HTTP GET Response

{
  "id": 0,
  "alarm": true,
  "mute": false
}

Smoke.GetStatus Curl Response

{
  "id": 1,
  "src": "shellyplussmoke-441793cc9d30",
  "params": {
    "id": 0,
    "alarm": true,
    "mute": false
  }
}

Smoke.GetStatus Mos Response

{
  "id": 0,
  "alarm": true,
  "mute": false
}

Smoke.Mute example

Smoke.Mute HTTP GET Request

http://192.168.33.1/rpc/Smoke.Mute?id=0

Smoke.Mute Curl Request

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

Smoke.Mute Mos Request

mos --port ${PORT} call Smoke.Mute '{"id":0}'

Response

Smoke.Mute HTTP GET Response

null

Smoke.Mute Curl Response

{
  "id": 1,
  "src": "shellyplussmoke-441793cc9d30",
  "params": null
}

Smoke.Mute Mos Response

null