Pill

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

• Pill.GetConfig to obtain the component's configuration
• Pill.SetConfig to update the component's configuration
• Pill.GetStatus to obtain the component's status

Methods

Pill.SetConfig

Parameters:

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

Pill.GetConfig

Find the Pill.GetConfig response properties in config section

Pill.GetStatus

Find more about the status response properties in status section

Configuration

The configuration of the Pill component changes peripheral modes.

Parameters:

Property	Type	Description
mode	string	Device mode. Range of values onewire, dht22, analog_in, ssr, digital_io, js_uart, mb_client
pin0_mode	string	Pin 0 mode. Range of values none, reserved, digital_in, digital_out
pin1_mode	string	Pin 1 mode. Range of values none, reserved, digital_in, digital_out
pin2_mode	string	Pin 2 mode. Range of values none, reserved, digital_in, digital_out

mode property selects one of the following peripheral modes:

mode	description
onewire	Temperature sensor: OneWire (DS18B20)
dht22	Temperature & Humidity: DHT22
analog_in	Analog sensor (Range: 0-2.5V without additional addons)
ssr	Solid State Relay Addon (2x channels; IO3 is available)
digital_io	Digital IO: Inputs/Outputs are configurable via the pinX_mode
js_uart	Raw UART for scripts. Creates a Serial component instance in jsuart mode.
mb_client	Modbus RTU client. Creates a Serial component instance in mb_client mode plus an MbRtuClient component.

note

The js_uart and mb_client modes are available for firmware version 2.0.1 and above.

pinX_mode (pin0_mode, pin1_mode, pin2_mode respectively for each pin) selects individual I/O pin mode.

pinX_mode	description
none	I/O not used (default)
digital_in	Digital input (NOTE: Active LOW state)
digital_out	Digital output
reserved	Reserved for Device Peripheral function

note

Modes affect the current set of device components. Switching a mode may cause new components to emerge, and/or components that were created under the previous mode to disappear.

note

Some device modes use specific pins for their functionality. When such a mode is enabled, the corresponding pin mode appears as reserved and any changes to it will have no effect until the device switches to a mode that does not use the pin.

Obtaining Supported Pill Modes

The supported modes for the running firmware can be obtained using the shelly.getcomponents RPC method with the pill key:

GET /rpc/shelly.getcomponents?keys=["pill"]

The response will include the modes attribute containing the list of supported modes for the current device and firmware version.

Status

The status of the Pill component is empty.

Pill.SetConfig example

Pill.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Pill.SetConfig?config={"mode":"onewire","pin0_mode":"none"}

Pill.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Pill.SetConfig","params":{"config":{"mode":"onewire","pin0_mode":"none"}}}' http://${SHELLY}/rpc

Pill.SetConfig Mos Request

mos --port ${PORT} call Pill.SetConfig '{"config":{"mode":"onewire","pin0_mode":"none"}}'

Response

Pill.SetConfig HTTP GET Response

{
  "restart_required": false
}

Pill.SetConfig Curl Response

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

Pill.SetConfig Mos Response

{
  "restart_required": false
}

Pill.GetConfig example

Pill.GetConfig HTTP GET Request

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

Pill.GetConfig Curl Request

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

Pill.GetConfig Mos Request

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

Response

Pill.GetConfig HTTP GET Response

{
  "mode": "digital_io",
  "pin0_mode": "digital_in",
  "pin1_mode": "digital_out",
  "pin2_mode": "none"
}

Pill.GetConfig Curl Response

{
  "id": 1,
  "params": {
    "mode": "digital_io",
    "pin0_mode": "digital_in",
    "pin1_mode": "digital_out",
    "pin2_mode": "none"
  }
}

Pill.GetConfig Mos Response

{
  "mode": "digital_io",
  "pin0_mode": "digital_in",
  "pin1_mode": "digital_out",
  "pin2_mode": "none"
}

Pill.GetStatus example

Pill.GetStatus HTTP GET Request

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

Pill.GetStatus Curl Request

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

Pill.GetStatus Mos Request

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

Response

Pill.GetStatus HTTP GET Response

{}

Pill.GetStatus Curl Response

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

Pill.GetStatus Mos Response

{}