Button

The virtual Button component is used to simulate button events same as Input component. It uses Button as RPC namespace and has the following methods:

• Button.SetConfig to update the component's configuration
• Button.GetConfig to obtain the component's configuration
• Button.Trigger to trigger an event
• Button.GetStatus to obtain the component's status

Methods

Button.SetConfig

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

Find more about the config properties in config section

Button.GetConfig

Parameters:

Property	Type	Description
id	number	Id of the component instance Required

Find the Button.GetConfig response properties in config section

Button.Trigger

Parameters:

Property	Type	Description
id	number	Id of the component instance Required
event	string	Event name. Range of values: single_push, double_push, triple_push, long_push Required

Button.GetStatus

Parameters:

Property	Type	Description
id	number	Id of the component instance

Find more about the status response properties in status section

Configuration

The configuration of the Button component contains properties of how it will be rendered in the UI. To Get/Set the configuration of the Button component its id must be specified.

Parameters:

Property	Type	Description
id	number	Id of the component instance
name	string or null	Name of the component instance
meta	object or null	Stores the component's metadata

Status

The status of the Button component is empty.

Webhook Events

Currently, these are the events related to the Button component that can trigger webhooks:

• button.single_push
• button.double_push
• button.triple_push
• button.long_push

Examples

Button.SetConfig example

Button.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Button.SetConfig?id=200&config={"name":"Button 1"}

Button.SetConfig Curl Request

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

Button.SetConfig Mos Request

mos --port ${PORT} call Button.SetConfig '{"id":200,"config":{"name":"Button 1"}}'

Response

Button.SetConfig HTTP GET Response

{
  "restart_required": false
}

Button.SetConfig Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "restart_required": false
  }
}

Button.SetConfig Mos Response

{
  "restart_required": false
}

Button.GetConfig example

Button.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Button.GetConfig?id=200

Button.GetConfig Curl Request

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

Button.GetConfig Mos Request

mos --port ${PORT} call Button.GetConfig '{"id":200}'

Response

Button.GetConfig HTTP GET Response

{
  "id": 200,
  "name": "Button 1",
  "meta": null
}

Button.GetConfig Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "id": 200,
    "name": "Button 1",
    "meta": null
  }
}

Button.GetConfig Mos Response

{
  "id": 200,
  "name": "Button 1",
  "meta": null
}

Button.Trigger example

Button.Trigger HTTP GET Request

http://192.168.33.1/rpc/Button.Trigger?id=200&event="single_push"

Button.Trigger Curl Request

curl -X POST -d '{"id":1,"method":"Button.Trigger","params":{"id":200,"event":"single_push"}}' http://${SHELLY}/rpc

Button.Trigger Mos Request

mos --port ${PORT} call Button.Trigger '{"id":200,"event":"single_push"}'

Response

Button.Trigger HTTP GET Response

null

Button.Trigger Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": null
}

Button.Trigger Mos Response

null

Button.GetStatus example

Button.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Button.GetStatus?id=200

Button.GetStatus Curl Request

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

Button.GetStatus Mos Request

mos --port ${PORT} call Button.GetStatus '{"id":200}'

Response

Button.GetStatus HTTP GET Response

{}

Button.GetStatus Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {}
}

Button.GetStatus Mos Response

{}