Boolean

The virtual Boolean component is used to store a true/false value. It uses Boolean as RPC namespace and has the following methods:

• Boolean.SetConfig to update the component's configuration
• Boolean.GetConfig to obtain the component's configuration
• Boolean.GetStatus to obtain the component's status
• Boolean.Set to update the component's value

Methods

Boolean.SetConfig

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

Find more about the config properties in config section

Boolean.GetConfig

Properties:

Property	Type	Description
id	number	Id of the component instance

Find the Boolean.GetConfig response properties in config section

Boolean.GetStatus

Properties:

Property	Type	Description
id	number	Id of the component instance

Find more about the status response properties in status section

Boolean.Set

This method updates the value of the Boolean component. It can be used to trigger webhooks. More information about the events triggering webhooks available for this component can be found below.

Request

Parameters:

Property	Type	Description
id	number	Id of the component instance. Required
value	boolean	For truthy value only true is accepted, everything else is parsed as false. Required

Configuration

The configuration of the Boolean component contains information about the default value, whether it should persist after reboot, and properties of how it will be rendered in the UI. To Get/Set the configuration of the Boolean component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the component instance
name	string or null	Name of the component instance
persisted	boolean	true for the value to be persist, default false
default_value	boolean	Value, applied on reboot if persisted is set to false
meta	object	Object for storing meta data	ui	object	Properties of how the component will be rendered in the UI Property Type Description view string Specifies the type of card used for showing the component. Supported values: "" (empty string), toggle, label. icon string or null Allows setting custom icon for the component's card by providing an external hosted image via link. titles array of strings or null Allows setting custom titles for both (Truthy/Falsy) states. Item at index 0 is is used for the title when the value is set to false, at index 1 - for true, both are of type string. Default values are ["False", "True"] for view=button and ["Off", "On"] for view=toggle. buttonIcons array of strings or null Allows setting custom titles for both (Truthy/Falsy) states. Item at index 0 is is used for the url for icon shown when the value is set to false, at index 1 - for true, both are of type string.

info

• "" (empty string): The component does not have a card;
• "toggle": Card with a toggle button (Changes its value on each hit);
• "label": Card showing the title for the value.

Status

The status of the Boolean component contains information about its current value, the timestamp for the value update, and the source of the last command. To obtain the status of the Boolean component its id must be specified.

Properties:

Property	Type	Description
source	string	Source of the last command
value	boolean	Value of the component
last_update_ts	number	Unix timestamp for the value update

Webhook Events

Currently, there is one event related to the Boolean component that can trigger webhooks:

• boolean.change - produced when the value changes.

Examples

Boolean.SetConfig example

Boolean.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Boolean.SetConfig?id=200&config={"name":"Gate status","meta":{"ui":{"titles":["Close","Open"]}}}

Boolean.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Boolean.SetConfig","params":{"id":200,"config":{"name":"Gate status","meta":{"ui":{"titles":["Close","Open"]}}}}}' http://${SHELLY}/rpc

Boolean.SetConfig Mos Request

mos --port ${PORT} call Boolean.SetConfig '{"id":200,"config":{"name":"Gate status","meta":{"ui":{"titles":["Close","Open"]}}}}'

Response

Boolean.SetConfig HTTP GET Response

{
  "restart_required": false
}

Boolean.SetConfig Curl Response

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

Boolean.SetConfig Mos Response

{
  "restart_required": false
}

Boolean.GetConfig example

Boolean.GetConfig HTTP GET Request

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

Boolean.GetConfig Curl Request

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

Boolean.GetConfig Mos Request

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

Response

Boolean.GetConfig HTTP GET Response

{
  "id": 200,
  "name": "Gate status",
  "meta": {
    "ui": {
      "view": "label",
      "titles": [
        "Close",
        "Open"
      ],
      "buttonIcons": [
        "http://192.168.25.2:7999/icon_close.png",
        "http://192.168.25.2:7999/icon_open.png"
      ],
      "icon": "http://192.168.25.2:7999/icon_gate.png"
    }
  },
  "persisted": true,
  "default_value": false
}

Boolean.GetConfig Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "id": 200,
    "name": "Gate status",
    "meta": {
      "ui": {
        "view": "label",
        "titles": [
          "Close",
          "Open"
        ],
        "buttonIcons": [
          "http://192.168.25.2:7999/icon_close.png",
          "http://192.168.25.2:7999/icon_open.png"
        ],
        "icon": "http://192.168.25.2:7999/icon_gate.png"
      }
    },
    "persisted": true,
    "default_value": false
  }
}

Boolean.GetConfig Mos Response

{
  "id": 200,
  "name": "Gate status",
  "meta": {
    "ui": {
      "view": "label",
      "titles": [
        "Close",
        "Open"
      ],
      "buttonIcons": [
        "http://192.168.25.2:7999/icon_close.png",
        "http://192.168.25.2:7999/icon_open.png"
      ],
      "icon": "http://192.168.25.2:7999/icon_gate.png"
    }
  },
  "persisted": true,
  "default_value": false
}

Boolean.GetStatus example

Boolean.GetStatus HTTP GET Request

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

Boolean.GetStatus Curl Request

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

Boolean.GetStatus Mos Request

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

Response

Boolean.GetStatus HTTP GET Response

{
  "value": true,
  "source": "rpc",
  "last_update_ts": 1700864253
}

Boolean.GetStatus Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "value": true,
    "source": "rpc",
    "last_update_ts": 1700864253
  }
}

Boolean.GetStatus Mos Response

{
  "value": true,
  "source": "rpc",
  "last_update_ts": 1700864253
}

Boolean.Set example

Boolean.Set HTTP GET Request

http://192.168.33.1/rpc/Boolean.Set?id=200&value=true

Boolean.Set Curl Request

curl -X POST -d '{"id":1,"method":"Boolean.Set","params":{"id":200,"value":true}}' http://${SHELLY}/rpc

Boolean.Set Mos Request

mos --port ${PORT} call Boolean.Set '{"id":200,"value":true}'

Response

Boolean.Set HTTP GET Response

null

Boolean.Set Curl Response

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

Boolean.Set Mos Response

null