Skip to main content
Version: 1.0

Shelly Plug S

Shelly Plug S Gen3 is a one-channel device with a wide range of functionalities. The channel supports the use of automatic timers, webhooks, and schedules. The device has a built-in power meter to instantaneously measure the power consumed by the channel. In addition, the device features built-in LEDs indicating the power consumption and the status of the network connectivity.

The following components are available in Shelly Plug S Gen3:

PLUGS_UI

The PLUGS_UI component handles the settings of a Plug S Gen3 device's LEDs.

Methods

PLUGS_UI.SetConfig

Properties:

PropertyTypeDescription

config

object

Configuration that the method takes

Find more about the config properties in config section

PLUGS_UI.GetConfig

Find the PLUGS_UI.GetConfig response properties in config section

PLUGS_UI.GetStatus

Find more about the status response properties in status section

Configuration

The configuration of the PLUGS_UI component allows you to set the color mode of the LEDs (power/switch/off).



PropertyTypeDescription

leds

object

PLUGS_UI LED configuration

mode

string

LED indication mode

ValueDescription

power

LED indication according to the power consumption

switch

LED indication according to the user-defined values for output state on/off

off

disabled LED indication

colors

object

LED colors and brightness in RGB format


PropertyTypeDescription

switch:0

object

Switch component instance

on

object

LED colors for output state on

PropertyTypeDescription

rgb

array of numbers or null

Value for red, green and blue [0-100]

brightness

number

Value for brightness [0-100]

off

object

LED colors for output state off

PropertyTypeDescription

rgb

array of numbers or null

Value for red, green and blue [0-100]

brightness

number

Value for brightness [0-100]

power

object

LED brightness for LED indication mode power

PropertyTypeDescription

brightness

number

Value for brightness [0-100]


night_mode

object

LED brightness in night mode

PropertyTypeDescription

enable

boolean

Enable or disable night mode

brightness

number

Value for brightness [0-100]

active_between

array of 2 elements of type string for start of the period and end of the period in format HH:MM

Value for strings [00:00-23:59]


controls

object

PLUGS_UI control configuration


PropertyTypeDescription

switch:0

object

Switch component instance

in_mode

string

Button mode

ValueDescription

momentary

Button switches on/off the relay

detached

Button is detached from the relay

Status

The PLUGS_UI component does not own any status properties.

Examples

PLUGS_UI.GetStatus example

http://192.168.33.1/rpc/PLUGS_UI.GetStatus

Response

{}

PLUGS_UI.GetConfig example

http://192.168.33.1/rpc/PLUGS_UI.GetConfig

Response

{
"leds": {
"mode": "power",
"colors": {
"switch:0": {
"on": {
"rgb": [
0,
100,
0
],
"brightness": 100
},
"off": {
"rgb": [
100,
0,
0
],
"brightness": 100
}
},
"power": {
"brightness": 100
}
},
"night_mode": {
"enable": false,
"brightness": 10,
"active_between": [
"22:00",
"06:00"
]
}
},
"controls": {
"switch:0": {
"in_mode": "momentary"
}
}
}

PLUGS_UI.SetConfig example

http://192.168.33.1/rpc/PLUGS_UI.SetConfig?config={"leds":{"mode":"switch","colors":{"switch:0":{"on":{"rgb":[100,100,0],"brightness":100},"off":{"rgb":[100,100,100],"brightness":100}},"power":{"brightness":100}},"night_mode":{"enable":true,"brightness":10,"active_between":["22:00","06:00"]}},"controls":{"switch:0":{"in_mode":"detached"}}}

Response

{
"restart_required": false
}