The Shelly plugin controls and monitors one Shelly device of the Plus (Gen2), Pro, Gen3 or Gen4 lineups from a Q-SYS Core. It talks to the device over its RPC WebSocket (API Gen2+): commands go out immediately and every change made on the device, from its inputs, its app or another system, comes back at once as a notification.
The plugin is built from the components of the device: switches, inputs, covers, lights (dimmer, RGB, RGBW, CCT, RGBCCT bulbs), power and energy meters, sensors (including presence zones and battery), the thermostat of the Wall Display and the virtual components. Pick the model and its components are filled in, or pick <Custom> and set how many of each the device has.
The device must run a Gen2+ firmware and be reachable from the Core on TCP port 80. Battery-powered devices (H&T, Smoke…) sleep and can only be reached when powered by USB.
Key Features
Every Gen2+ device — 80 models with their profiles, plus a <Custom> model for any other device
Real-time two-way control — WebSocket connection, notifications of every status change and input event
25 component types — Switch, Input, Cover, Light, RGB, RGBW, CCT, RGBCCT, Power Meter, Energy Meter, 3-Phase Meter, Temperature, Humidity, Illuminance, Voltmeter, Presence Zone, Device Power, Thermostat, virtual Boolean, Number, Text, Enum and Button, BTHome Device and Sensor
Virtual components — Booleans, numbers, texts, enums and buttons created on the Shelly (Virtual license feature)
Bluetooth devices — Shelly BLU sensors and buttons relayed by a Shelly gateway (BTHome license feature)
Sensor Add-on — Inputs, temperature, humidity and voltmeter peripherals of the add-on
Power monitoring — Power, energy, voltage, current and temperature of every channel that measures them, with an energy counter reset
Hold-to-dim — Dim Up / Dim Down buttons on every light, dimming while held
Protected password — Digest authentication, the password is kept out of the plugin's controls
Model check — A component the device does not have is reported in Status, the unsupported fields are disabled
Release Notes
2.0.0.0
Breaking Change
Changed the plugin to a completely new plugin, built on the Shelly WebSocket API: pages, controls, pins and properties are all new, designs made with 1.x must be rebuilt
Changed the licensing: licenses from before 2.0 must be reactivated to use version 2.0 and later
Improvement
Added support for nearly every Shelly Gen2, Gen3, Gen4 and Pro device: pick a preset model to fill its components automatically, or <Custom> to set how many of each component the device has
Added support for Virtual components and BTHome components, each with its own feature of the license
1.5.0.8
Improvement
Added the Shelly Power Strip 4 Gen4
1.5.0.5
Fixes
Fixed the brightness sent with Light.Set not being applied
1.5.0.0
Improvement
Added the Shelly Plus Plug S (PlusPlugS)
1.4.0.0
Improvement
Added the Shelly Plug S Gen3 (PlugSG3)
Added the Shelly Pro Dimmer 1PM and 2PM (ProDimmerx), tested with firmware 1.4.4
Added the Pro Dimmer Model property to select the Pro Dimmer sub-model
1.3.0.0
Improvement
Added the Shelly 1PM Mini Gen3 and the Shelly 1 Mini Gen3
1.2.0.0
Improvement
Added the Shelly Plus 0-10V Dimmer (Plus10V)
1.1.0.0
Improvement
Added the Rate property to set the poll rate
1.0.0.0
Improvement
Added the first release of the plugin
Properties
License
Type:string Default Value:(empty) Description: License key of the primary Core. A license of a version before 2.0 must be reactivated to work with 2.0 and later.
License Backup
Type:string Default Value:(empty) Description: License key of the backup Core.
Model
Type:enum Default Value:<Custom> Description: Model of the device. Every model fills the component counts of the plugin; a model with several profiles has one entry per profile, the profile must match the one set on the device. <Custom> shows one count property per component type.
Models
Shelly Plus 1
Shelly Plus 1PM
Shelly Plus 1 Mini
Shelly Plus 1PM Mini
Shelly Plus PM Mini
Shelly Plus 2PM (Switch)
Shelly Plus 2PM (Cover)
Shelly Plus i4
Shelly Plus i4 DC
Shelly Plus Plug (S, IT, UK, US)
Shelly Plus 0-10V Dimmer
Shelly Plus Wall Dimmer
Shelly Plus RGBW PM (Light)
Shelly Plus RGBW PM (RGB)
Shelly Plus RGBW PM (RGBW)
Shelly Plus Uni
Shelly Plus H&T
Shelly Pro 1
Shelly Pro 1PM
Shelly Pro 2
Shelly Pro 2PM (Switch)
Shelly Pro 2PM (Cover)
Shelly Pro 3
Shelly Pro 4PM
Shelly Pro Dual Cover PM
Shelly Pro Dimmer 1PM
Shelly Pro Dimmer 2PM
Shelly Pro Dimmer 0/1-10V PM
Shelly Pro RGBWW PM (Light)
Shelly Pro RGBWW PM (RGB + CCT)
Shelly Pro RGBWW PM (2x CCT)
Shelly Pro RGBWW PM (RGB + 2x Light)
Shelly Pro EM-50
Shelly Pro 3EM / 3EM-3CT63 (Triphase)
Shelly Pro 3EM / 3EM-3CT63 (Monophase)
Shelly 1 Gen3
Shelly 1PM Gen3
Shelly 1 Mini Gen3
Shelly 1PM Mini Gen3
Shelly PM Mini Gen3
Shelly 1L Gen3
Shelly 2L Gen3
Shelly 2PM Gen3 (Switch)
Shelly 2PM Gen3 (Cover)
Shelly i4 / i4 DC Gen3
Shelly Dimmer Gen3
Shelly Dimmer 0/1-10V PM Gen3
Shelly D Dimmer Gen3 (DALI)
Shelly Duo Bulb Gen3
Shelly RGBCCT Bulb Gen3
Shelly Shutter
Shelly Plug S Gen3
Shelly Outdoor Plug S Gen3
Shelly AZ Plug
Shelly Plug M Gen3
Shelly Plug PM Gen3
Shelly EM Gen3
Shelly 3EM Gen3 (Triphase)
Shelly 3EM Gen3 (Monophase)
Shelly 3EM-63 Gen3
Shelly BLU Gateway Gen3
Shelly H&T Gen3
Shelly Wall Display
Shelly 1 Gen4
Shelly 1PM Gen4
Shelly 1 Mini Gen4
Shelly 1PM Mini Gen4
Shelly 1L Gen4
Shelly 2L Gen4
Shelly 2PM Gen4 (Switch)
Shelly 2PM Gen4 (Cover)
Shelly i4 Gen4
Shelly Dimmer Gen4
Shelly Dimmer US Gen4
Shelly Dimmer 0/1-10V PM Gen4
Shelly EM Gen4
Shelly EM Mini Gen4
Shelly Plug US Gen4
Shelly Power Strip Gen4
Shelly Presence Gen4
Knob Debounce
Type:boolean Default Value:true Description: Sends only the value a knob settles on instead of every movement.
Switch Count … Thermostat Count
Type:integer Min:0 Default Value:1 for Switch Count, 0 for the others Description: Number of components of each type on the <Custom> model, numbered from id 0 as on the device. Only shown on the <Custom> model.
Property
Max
Switch Count
8
Input Count
8
Cover Count
4
Light Count
8
RGB Count
2
RGBW Count
2
CCT Count
2
RGBCCT Count
2
Power Meter Count
4
Energy Meter Count
4
3-Phase Meter Count
2
Temperature Count
8
Humidity Count
4
Illuminance Count
2
Voltmeter Count
4
Presence Zone Count
10 (ids from 200)
Device Power Count
1
Thermostat Count
1
Boolean Count / Number Count / Text Count / Enum Count / Button Count
Type:integer Min:0 Max:10 Default Value:0 Description: Number of virtual components of each type created on the device, numbered from id 200 as on the device (boolean:200, enum:200…). Shown on every model, under Virtual Components; they need the Virtual feature of the license; virtual components exist on the Pro and Gen3/Gen4 devices.
BTHome Device Count / BTHome Sensor Count
Type:integer Min:0 Max:10 / 20 Default Value:0 Description: Number of Bluetooth devices and sensors the Shelly relays, numbered from id 200 as on the device (bthomedevice:200, bthomesensor:200…). Shown on every model, under Bluetooth (BTHome); they need the BTHome feature of the license.
Power Metering
Type:boolean Default Value:false Description: Adds power, energy, voltage and current to the switches, covers and lights of the <Custom> model. Only shown on the <Custom> model.
Sensor Add-on
Type:boolean Default Value:false Description: Adds the peripherals of the Shelly Sensor Add-on, whose components are numbered from id 100. Only shown on <Custom> and on the models that accept the add-on.
Type:integer Min:0 Max:2 / 5 / 1 / 1 Default Value:0 Description: Number of add-on peripherals of each type. They follow the components of the same type on their page. Only shown when Sensor Add-on is enabled.
Debug Print
Type:enum Choices:None, RX, TX, RX/TX, Function Calls, All Default Value:None Description: Prints the messages exchanged with the device (RX, TX) and the function calls to the plugin's debug output.
Controls
A component page only exists when the model has components of its type. Every control of a component is disabled while the device is not connected, when the device does not have the component, and, for a value, when the device does not report it (an analog reading on a button input, the slat position of a cover without slats…).
Commands are sent in order, at most three at a time. When a control changes faster than the device answers, only its last value is sent. A command the device refuses, or does not answer within 5 seconds, puts the control back to what the device reports.
Status
Controls name:Status Type:Indicator-Status Pin Style:Output Pin Name:Status Description: Displays the plugin's operational status: OK when connected, Missing while the device is not connected, Fault when the configuration is wrong, Compromised when the device reports a problem.
OK
Compromised - switch:2 overpower
Fault - Not on the device: switch:2, switch:3, input:2, input:3
State
When
Messages
OK
Connected, the device has every component of the model and reports no error
(empty)
Missing
The device is not connected
Connecting to 192.168.10.41, Reading the device, 192.168.10.41 does not answer, Connection closed by 192.168.10.41
Fault
Wrong configuration
IP address is not set, Invalid port in …, Password refused by the device, The device requires a password, Not on the device: … (model or profile), Invalid license, Virtual Components not included in the license, Bluetooth (BTHome) not included in the license
Compromised
A component of the device reports errors (overpower, overtemp, overvoltage, undervoltage, obstruction…)
<component> <errors>, for example switch:2 overpower
Switches Page
Switch
One section per switch component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Switch controls
Controls name
Type
Pin Style
Pin Name
Description
switch_name_N
Text
Input / Output
Switch~N~Name
name of the component configuration, written with Switch.SetConfig.
switch_output_N
Button-Toggle
Input / Output
Switch~N~Output
output of the status, set with Switch.Set (on).
switch_toggle_N
Button-Trigger
Input / Output
Switch~N~Toggle
Calls Switch.Toggle.
switch_power_N
Knob
Output
Switch~N~Power
apower of the switch status. Only on models that measure power.
switch_energy_N
Knob
Output
Switch~N~Energy
aenergy.total of the switch status in kWh. Only on models that measure power.
switch_reset_energy_N
Button-Trigger
Input / Output
Switch~N~Reset Energy
Calls Switch.ResetCounters to reset the aenergy counter. Only on models that measure power.
switch_voltage_N
Knob
Output
Switch~N~Voltage
voltage of the switch status. Only on models that measure power.
switch_current_N
Knob
Output
Switch~N~Current
current of the switch status. Only on models that measure power.
switch_temperature_N
Knob
Output
Switch~N~Temperature
temperature.tC of the switch status.
switch_errors_N
Indicator-Text
Output
Switch~N~Errors
errors of the switch status.
switch_initial_state_N
Text-ComboBox
Input / Output
Switch~N~Initial State
initial_state of the component configuration, written with Switch.SetConfig.
switch_in_mode_N
Text-ComboBox
Input / Output
Switch~N~In Mode
in_mode of the component configuration, written with Switch.SetConfig.
switch_auto_on_N
Button-Toggle
Input / Output
Switch~N~Auto On
auto_on of the component configuration, written with Switch.SetConfig.
switch_auto_on_delay_N
Knob
Input / Output
Switch~N~Auto On Delay
auto_on_delay of the component configuration, written with Switch.SetConfig.
switch_auto_off_N
Button-Toggle
Input / Output
Switch~N~Auto Off
auto_off of the component configuration, written with Switch.SetConfig.
switch_auto_off_delay_N
Knob
Input / Output
Switch~N~Auto Off Delay
auto_off_delay of the component configuration, written with Switch.SetConfig.
Inputs Page
Input
One section per input component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Input controls
Controls name
Type
Pin Style
Pin Name
Description
input_name_N
Text
Input / Output
Input~N~Name
name of the component configuration, written with Input.SetConfig.
input_type_N
Text-ComboBox
Input / Output
Input~N~Type
type of the component configuration, written with Input.SetConfig.
input_invert_N
Button-Toggle
Input / Output
Input~N~Invert
invert of the component configuration, written with Input.SetConfig.
input_state_N
Indicator-LED
Output
Input~N~State
state of the input status.
input_percent_N
Knob
Output
Input~N~Percent
percent of the input status.
input_count_N
Knob
Output
Input~N~Count
counts.total of the input status.
input_event_N
Indicator-Text
Output
Input~N~Event
Last event of the input (single_push, btn_down…).
input_single_push_N
Button-Trigger
Output
Input~N~Single Push
Pulses on the single_push event.
input_double_push_N
Button-Trigger
Output
Input~N~Double Push
Pulses on the double_push event.
input_triple_push_N
Button-Trigger
Output
Input~N~Triple Push
Pulses on the triple_push event.
input_long_push_N
Button-Trigger
Output
Input~N~Long Push
Pulses on the long_push event.
Covers Page
Cover
One section per cover component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Cover controls
Controls name
Type
Pin Style
Pin Name
Description
cover_name_N
Text
Input / Output
Cover~N~Name
name of the component configuration, written with Cover.SetConfig.
cover_open_N
Button-Trigger
Input / Output
Cover~N~Open
Calls Cover.Open.
cover_stop_N
Button-Trigger
Input / Output
Cover~N~Stop
Calls Cover.Stop.
cover_close_N
Button-Trigger
Input / Output
Cover~N~Close
Calls Cover.Close.
cover_position_N
Knob
Input / Output
Cover~N~Position
current_pos of the status, set with Cover.GoToPosition (pos).
cover_slat_position_N
Knob
Input / Output
Cover~N~Slat Position
slat_pos of the status, set with Cover.GoToPosition (slat_pos).
cover_state_N
Indicator-Text
Output
Cover~N~State
state of the cover status.
cover_calibrated_N
Indicator-LED
Output
Cover~N~Calibrated
pos_control of the cover status.
cover_calibrate_N
Button-Trigger
Input / Output
Cover~N~Calibrate
Calls Cover.Calibrate.
cover_power_N
Knob
Output
Cover~N~Power
apower of the cover status. Only on models that measure power.
cover_energy_N
Knob
Output
Cover~N~Energy
aenergy.total of the cover status in kWh. Only on models that measure power.
cover_reset_energy_N
Button-Trigger
Input / Output
Cover~N~Reset Energy
Calls Cover.ResetCounters to reset the aenergy counter. Only on models that measure power.
cover_voltage_N
Knob
Output
Cover~N~Voltage
voltage of the cover status. Only on models that measure power.
cover_current_N
Knob
Output
Cover~N~Current
current of the cover status. Only on models that measure power.
cover_temperature_N
Knob
Output
Cover~N~Temperature
temperature.tC of the cover status.
cover_errors_N
Indicator-Text
Output
Cover~N~Errors
errors of the cover status.
cover_initial_state_N
Text-ComboBox
Input / Output
Cover~N~Initial State
initial_state of the component configuration, written with Cover.SetConfig.
cover_in_mode_N
Text-ComboBox
Input / Output
Cover~N~In Mode
in_mode of the component configuration, written with Cover.SetConfig.
cover_invert_directions_N
Button-Toggle
Input / Output
Cover~N~Invert Directions
invert_directions of the component configuration, written with Cover.SetConfig.
cover_swap_inputs_N
Button-Toggle
Input / Output
Cover~N~Swap Inputs
swap_inputs of the component configuration, written with Cover.SetConfig.
cover_maxtime_open_N
Knob
Input / Output
Cover~N~Maxtime Open
maxtime_open of the component configuration, written with Cover.SetConfig.
cover_maxtime_close_N
Knob
Input / Output
Cover~N~Maxtime Close
maxtime_close of the component configuration, written with Cover.SetConfig.
Lights Page
Light
One section per light component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Light controls
Controls name
Type
Pin Style
Pin Name
Description
light_name_N
Text
Input / Output
Light~N~Name
name of the component configuration, written with Light.SetConfig.
light_output_N
Button-Toggle
Input / Output
Light~N~Output
output of the status, set with Light.Set (on).
light_toggle_N
Button-Trigger
Input / Output
Light~N~Toggle
Calls Light.Toggle.
light_brightness_N
Knob
Input / Output
Light~N~Brightness
brightness of the status, set with Light.Set (brightness).
light_dim_up_N
Button-Momentary
Input / Output
Light~N~Dim Up
Calls Light.DimUp while held, Light.DimStop on release.
light_dim_down_N
Button-Momentary
Input / Output
Light~N~Dim Down
Calls Light.DimDown while held, Light.DimStop on release.
light_transition_N
Knob
Input / Output
Light~N~Transition
transition_duration of the component configuration, written with Light.SetConfig.
light_power_N
Knob
Output
Light~N~Power
apower of the light status. Only on models that measure power.
light_energy_N
Knob
Output
Light~N~Energy
aenergy.total of the light status in kWh. Only on models that measure power.
light_reset_energy_N
Button-Trigger
Input / Output
Light~N~Reset Energy
Calls Light.ResetCounters to reset the aenergy counter. Only on models that measure power.
light_voltage_N
Knob
Output
Light~N~Voltage
voltage of the light status. Only on models that measure power.
light_current_N
Knob
Output
Light~N~Current
current of the light status. Only on models that measure power.
light_temperature_N
Knob
Output
Light~N~Temperature
temperature.tC of the light status.
light_errors_N
Indicator-Text
Output
Light~N~Errors
errors of the light status.
light_initial_state_N
Text-ComboBox
Input / Output
Light~N~Initial State
initial_state of the component configuration, written with Light.SetConfig.
light_in_mode_N
Text-ComboBox
Input / Output
Light~N~In Mode
in_mode of the component configuration, written with Light.SetConfig.
RGB
One section per rgb component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
RGB controls
Controls name
Type
Pin Style
Pin Name
Description
rgb_name_N
Text
Input / Output
RGB~N~Name
name of the component configuration, written with RGB.SetConfig.
rgb_output_N
Button-Toggle
Input / Output
RGB~N~Output
output of the status, set with RGB.Set (on).
rgb_toggle_N
Button-Trigger
Input / Output
RGB~N~Toggle
Calls RGB.Toggle.
rgb_brightness_N
Knob
Input / Output
RGB~N~Brightness
brightness of the status, set with RGB.Set (brightness).
rgb_dim_up_N
Button-Momentary
Input / Output
RGB~N~Dim Up
Calls RGB.DimUp while held, RGB.DimStop on release.
rgb_dim_down_N
Button-Momentary
Input / Output
RGB~N~Dim Down
Calls RGB.DimDown while held, RGB.DimStop on release.
rgb_red_N
Knob
Input / Output
RGB~N~Red
rgb of the status, set with RGB.Set (rgb).
rgb_green_N
Knob
Input / Output
RGB~N~Green
rgb of the status, set with RGB.Set (rgb).
rgb_blue_N
Knob
Input / Output
RGB~N~Blue
rgb of the status, set with RGB.Set (rgb).
rgb_transition_N
Knob
Input / Output
RGB~N~Transition
transition_duration of the component configuration, written with RGB.SetConfig.
rgb_power_N
Knob
Output
RGB~N~Power
apower of the rgb status. Only on models that measure power.
rgb_energy_N
Knob
Output
RGB~N~Energy
aenergy.total of the rgb status in kWh. Only on models that measure power.
rgb_reset_energy_N
Button-Trigger
Input / Output
RGB~N~Reset Energy
Calls RGB.ResetCounters to reset the aenergy counter. Only on models that measure power.
rgb_voltage_N
Knob
Output
RGB~N~Voltage
voltage of the rgb status. Only on models that measure power.
rgb_current_N
Knob
Output
RGB~N~Current
current of the rgb status. Only on models that measure power.
rgb_temperature_N
Knob
Output
RGB~N~Temperature
temperature.tC of the rgb status.
rgb_errors_N
Indicator-Text
Output
RGB~N~Errors
errors of the rgb status.
rgb_initial_state_N
Text-ComboBox
Input / Output
RGB~N~Initial State
initial_state of the component configuration, written with RGB.SetConfig.
rgb_in_mode_N
Text-ComboBox
Input / Output
RGB~N~In Mode
in_mode of the component configuration, written with RGB.SetConfig.
RGBW
One section per rgbw component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
RGBW controls
Controls name
Type
Pin Style
Pin Name
Description
rgbw_name_N
Text
Input / Output
RGBW~N~Name
name of the component configuration, written with RGBW.SetConfig.
rgbw_output_N
Button-Toggle
Input / Output
RGBW~N~Output
output of the status, set with RGBW.Set (on).
rgbw_toggle_N
Button-Trigger
Input / Output
RGBW~N~Toggle
Calls RGBW.Toggle.
rgbw_brightness_N
Knob
Input / Output
RGBW~N~Brightness
brightness of the status, set with RGBW.Set (brightness).
rgbw_dim_up_N
Button-Momentary
Input / Output
RGBW~N~Dim Up
Calls RGBW.DimUp while held, RGBW.DimStop on release.
rgbw_dim_down_N
Button-Momentary
Input / Output
RGBW~N~Dim Down
Calls RGBW.DimDown while held, RGBW.DimStop on release.
rgbw_red_N
Knob
Input / Output
RGBW~N~Red
rgb of the status, set with RGBW.Set (rgb).
rgbw_green_N
Knob
Input / Output
RGBW~N~Green
rgb of the status, set with RGBW.Set (rgb).
rgbw_blue_N
Knob
Input / Output
RGBW~N~Blue
rgb of the status, set with RGBW.Set (rgb).
rgbw_white_N
Knob
Input / Output
RGBW~N~White
white of the status, set with RGBW.Set (white).
rgbw_transition_N
Knob
Input / Output
RGBW~N~Transition
transition_duration of the component configuration, written with RGBW.SetConfig.
rgbw_power_N
Knob
Output
RGBW~N~Power
apower of the rgbw status. Only on models that measure power.
rgbw_energy_N
Knob
Output
RGBW~N~Energy
aenergy.total of the rgbw status in kWh. Only on models that measure power.
rgbw_reset_energy_N
Button-Trigger
Input / Output
RGBW~N~Reset Energy
Calls RGBW.ResetCounters to reset the aenergy counter. Only on models that measure power.
rgbw_voltage_N
Knob
Output
RGBW~N~Voltage
voltage of the rgbw status. Only on models that measure power.
rgbw_current_N
Knob
Output
RGBW~N~Current
current of the rgbw status. Only on models that measure power.
rgbw_temperature_N
Knob
Output
RGBW~N~Temperature
temperature.tC of the rgbw status.
rgbw_errors_N
Indicator-Text
Output
RGBW~N~Errors
errors of the rgbw status.
rgbw_initial_state_N
Text-ComboBox
Input / Output
RGBW~N~Initial State
initial_state of the component configuration, written with RGBW.SetConfig.
rgbw_in_mode_N
Text-ComboBox
Input / Output
RGBW~N~In Mode
in_mode of the component configuration, written with RGBW.SetConfig.
CCT
One section per cct component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
CCT controls
Controls name
Type
Pin Style
Pin Name
Description
cct_name_N
Text
Input / Output
CCT~N~Name
name of the component configuration, written with CCT.SetConfig.
cct_output_N
Button-Toggle
Input / Output
CCT~N~Output
output of the status, set with CCT.Set (on).
cct_toggle_N
Button-Trigger
Input / Output
CCT~N~Toggle
Calls CCT.Toggle.
cct_brightness_N
Knob
Input / Output
CCT~N~Brightness
brightness of the status, set with CCT.Set (brightness).
cct_dim_up_N
Button-Momentary
Input / Output
CCT~N~Dim Up
Calls CCT.DimUp while held, CCT.DimStop on release.
cct_dim_down_N
Button-Momentary
Input / Output
CCT~N~Dim Down
Calls CCT.DimDown while held, CCT.DimStop on release.
cct_color_temperature_N
Knob
Input / Output
CCT~N~Color Temperature
ct of the status, set with CCT.Set (ct).
cct_transition_N
Knob
Input / Output
CCT~N~Transition
transition_duration of the component configuration, written with CCT.SetConfig.
cct_power_N
Knob
Output
CCT~N~Power
apower of the cct status. Only on models that measure power.
cct_energy_N
Knob
Output
CCT~N~Energy
aenergy.total of the cct status in kWh. Only on models that measure power.
cct_reset_energy_N
Button-Trigger
Input / Output
CCT~N~Reset Energy
Calls CCT.ResetCounters to reset the aenergy counter. Only on models that measure power.
cct_voltage_N
Knob
Output
CCT~N~Voltage
voltage of the cct status. Only on models that measure power.
cct_current_N
Knob
Output
CCT~N~Current
current of the cct status. Only on models that measure power.
cct_temperature_N
Knob
Output
CCT~N~Temperature
temperature.tC of the cct status.
cct_errors_N
Indicator-Text
Output
CCT~N~Errors
errors of the cct status.
cct_initial_state_N
Text-ComboBox
Input / Output
CCT~N~Initial State
initial_state of the component configuration, written with CCT.SetConfig.
cct_in_mode_N
Text-ComboBox
Input / Output
CCT~N~In Mode
in_mode of the component configuration, written with CCT.SetConfig.
RGBCCT
One section per rgbcct component (the RGBCCT bulb), N being its number on the page (component id N - 1). Mode switches the bulb between colour (rgb) and white (cct).
RGBCCT controls
Controls name
Type
Pin Style
Pin Name
Description
rgbcct_name_N
Text
Input / Output
RGBCCT~N~Name
name of the component configuration, written with RGBCCT.SetConfig.
rgbcct_output_N
Button-Toggle
Input / Output
RGBCCT~N~Output
output of the status, set with RGBCCT.Set (on).
rgbcct_toggle_N
Button-Trigger
Input / Output
RGBCCT~N~Toggle
Calls RGBCCT.Toggle.
rgbcct_brightness_N
Knob
Input / Output
RGBCCT~N~Brightness
brightness of the status, set with RGBCCT.Set (brightness).
rgbcct_dim_up_N
Button-Momentary
Input / Output
RGBCCT~N~Dim Up
Calls RGBCCT.DimUp while held, RGBCCT.DimStop on release.
rgbcct_dim_down_N
Button-Momentary
Input / Output
RGBCCT~N~Dim Down
Calls RGBCCT.DimDown while held, RGBCCT.DimStop on release.
rgbcct_mode_N
Text-ComboBox
Input / Output
RGBCCT~N~Mode
mode of the status, set with RGBCCT.Set (mode).
rgbcct_red_N
Knob
Input / Output
RGBCCT~N~Red
rgb of the status, set with RGBCCT.Set (rgb).
rgbcct_green_N
Knob
Input / Output
RGBCCT~N~Green
rgb of the status, set with RGBCCT.Set (rgb).
rgbcct_blue_N
Knob
Input / Output
RGBCCT~N~Blue
rgb of the status, set with RGBCCT.Set (rgb).
rgbcct_color_temperature_N
Knob
Input / Output
RGBCCT~N~Color Temperature
ct of the status, set with RGBCCT.Set (ct).
rgbcct_transition_N
Knob
Input / Output
RGBCCT~N~Transition
transition_duration of the component configuration, written with RGBCCT.SetConfig.
rgbcct_power_N
Knob
Output
RGBCCT~N~Power
apower of the rgbcct status. Only on models that measure power.
rgbcct_energy_N
Knob
Output
RGBCCT~N~Energy
aenergy.total of the rgbcct status in kWh. Only on models that measure power.
rgbcct_reset_energy_N
Button-Trigger
Input / Output
RGBCCT~N~Reset Energy
Calls RGBCCT.ResetCounters to reset the aenergy counter. Only on models that measure power.
rgbcct_errors_N
Indicator-Text
Output
RGBCCT~N~Errors
errors of the rgbcct status.
rgbcct_initial_state_N
Text-ComboBox
Input / Output
RGBCCT~N~Initial State
initial_state of the component configuration, written with RGBCCT.SetConfig.
rgbcct_in_mode_N
Text-ComboBox
Input / Output
RGBCCT~N~In Mode
in_mode of the component configuration, written with RGBCCT.SetConfig.
Meters Page
Power Meter
One section per pm1 component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Power Meter controls
Controls name
Type
Pin Style
Pin Name
Description
pm1_name_N
Text
Input / Output
Power Meter~N~Name
name of the component configuration, written with PM1.SetConfig.
pm1_power_N
Knob
Output
Power Meter~N~Power
apower of the pm1 status.
pm1_energy_N
Knob
Output
Power Meter~N~Energy
aenergy.total of the pm1 status in kWh.
pm1_reset_energy_N
Button-Trigger
Input / Output
Power Meter~N~Reset Energy
Calls PM1.ResetCounters to reset the aenergy, ret_aenergy counter.
pm1_voltage_N
Knob
Output
Power Meter~N~Voltage
voltage of the pm1 status.
pm1_current_N
Knob
Output
Power Meter~N~Current
current of the pm1 status.
pm1_frequency_N
Knob
Output
Power Meter~N~Frequency
freq of the pm1 status.
pm1_returned_energy_N
Knob
Output
Power Meter~N~Returned Energy
ret_aenergy.total of the pm1 status in kWh.
pm1_errors_N
Indicator-Text
Output
Power Meter~N~Errors
errors of the pm1 status.
Energy Meter
One section per em1 component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Energy Meter controls
Controls name
Type
Pin Style
Pin Name
Description
em1_name_N
Text
Input / Output
Energy Meter~N~Name
name of the component configuration, written with EM1.SetConfig.
em1_power_N
Knob
Output
Energy Meter~N~Power
act_power of the em1 status.
em1_apparent_power_N
Knob
Output
Energy Meter~N~Apparent Power
aprt_power of the em1 status.
em1_voltage_N
Knob
Output
Energy Meter~N~Voltage
voltage of the em1 status.
em1_current_N
Knob
Output
Energy Meter~N~Current
current of the em1 status.
em1_power_factor_N
Knob
Output
Energy Meter~N~Power Factor
pf of the em1 status.
em1_frequency_N
Knob
Output
Energy Meter~N~Frequency
freq of the em1 status.
em1_energy_N
Knob
Output
Energy Meter~N~Energy
total_act_energy of the em1data status in kWh.
em1_returned_energy_N
Knob
Output
Energy Meter~N~Returned Energy
total_act_ret_energy of the em1data status in kWh.
em1_errors_N
Indicator-Text
Output
Energy Meter~N~Errors
errors of the em1 status.
3-Phase Meter
One section per em component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
3-Phase Meter controls
Controls name
Type
Pin Style
Pin Name
Description
em_name_N
Text
Input / Output
3-Phase Meter~N~Name
name of the component configuration, written with EM.SetConfig.
em_a_voltage_N
Knob
Output
3-Phase Meter~N~A Voltage
a_voltage of the em status.
em_a_current_N
Knob
Output
3-Phase Meter~N~A Current
a_current of the em status.
em_a_power_N
Knob
Output
3-Phase Meter~N~A Power
a_act_power of the em status.
em_b_voltage_N
Knob
Output
3-Phase Meter~N~B Voltage
b_voltage of the em status.
em_b_current_N
Knob
Output
3-Phase Meter~N~B Current
b_current of the em status.
em_b_power_N
Knob
Output
3-Phase Meter~N~B Power
b_act_power of the em status.
em_c_voltage_N
Knob
Output
3-Phase Meter~N~C Voltage
c_voltage of the em status.
em_c_current_N
Knob
Output
3-Phase Meter~N~C Current
c_current of the em status.
em_c_power_N
Knob
Output
3-Phase Meter~N~C Power
c_act_power of the em status.
em_total_current_N
Knob
Output
3-Phase Meter~N~Total Current
total_current of the em status.
em_total_power_N
Knob
Output
3-Phase Meter~N~Total Power
total_act_power of the em status.
em_n_current_N
Knob
Output
3-Phase Meter~N~N Current
n_current of the em status.
em_energy_N
Knob
Output
3-Phase Meter~N~Energy
total_act of the emdata status in kWh.
em_returned_energy_N
Knob
Output
3-Phase Meter~N~Returned Energy
total_act_ret of the emdata status in kWh.
em_errors_N
Indicator-Text
Output
3-Phase Meter~N~Errors
errors of the em status.
Sensors Page
Temperature
One section per temperature component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Temperature controls
Controls name
Type
Pin Style
Pin Name
Description
temperature_name_N
Text
Input / Output
Temperature~N~Name
name of the component configuration, written with Temperature.SetConfig.
temperature_celsius_N
Knob
Output
Temperature~N~Celsius
tC of the temperature status.
temperature_fahrenheit_N
Knob
Output
Temperature~N~Fahrenheit
tF of the temperature status.
temperature_errors_N
Indicator-Text
Output
Temperature~N~Errors
errors of the temperature status.
Humidity
One section per humidity component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Humidity controls
Controls name
Type
Pin Style
Pin Name
Description
humidity_name_N
Text
Input / Output
Humidity~N~Name
name of the component configuration, written with Humidity.SetConfig.
humidity_humidity_N
Knob
Output
Humidity~N~Humidity
rh of the humidity status.
humidity_errors_N
Indicator-Text
Output
Humidity~N~Errors
errors of the humidity status.
Illuminance
One section per illuminance component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Illuminance controls
Controls name
Type
Pin Style
Pin Name
Description
illuminance_name_N
Text
Input / Output
Illuminance~N~Name
name of the component configuration, written with Illuminance.SetConfig.
illuminance_lux_N
Knob
Output
Illuminance~N~Lux
lux of the illuminance status.
illuminance_level_N
Indicator-Text
Output
Illuminance~N~Level
illumination of the illuminance status.
illuminance_errors_N
Indicator-Text
Output
Illuminance~N~Errors
errors of the illuminance status.
Voltmeter
One section per voltmeter component, N being its number on the page (component id N - 1, or 100 and up for the Sensor Add-on).
Voltmeter controls
Controls name
Type
Pin Style
Pin Name
Description
voltmeter_name_N
Text
Input / Output
Voltmeter~N~Name
name of the component configuration, written with Voltmeter.SetConfig.
voltmeter_voltage_N
Knob
Output
Voltmeter~N~Voltage
voltage of the voltmeter status.
voltmeter_transformed_N
Knob
Output
Voltmeter~N~Transformed
xvoltage of the voltmeter status.
voltmeter_errors_N
Indicator-Text
Output
Voltmeter~N~Errors
errors of the voltmeter status.
Presence Zone
One section per presence zone of the Shelly Presence, N being its number on the page (component id 199 + N, the main zone is presencezone:200).
Presence Zone controls
Controls name
Type
Pin Style
Pin Name
Description
presencezone_name_N
Text
Input / Output
Presence Zone~N~Name
name of the component configuration, written with PresenceZone.SetConfig.
presencezone_presence_N
Indicator-LED
Output
Presence Zone~N~Presence
value of the presencezone status.
presencezone_objects_N
Knob
Output
Presence Zone~N~Objects
num_objects of the presencezone status.
presencezone_enable_N
Button-Toggle
Input / Output
Presence Zone~N~Enable
enable of the component configuration, written with PresenceZone.SetConfig.
Device Power
Battery and external power of the devices that have them (H&T…), component id N - 1.
Device Power controls
Controls name
Type
Pin Style
Pin Name
Description
devicepower_battery_N
Knob
Output
Device Power~N~Battery
battery.percent of the devicepower status.
devicepower_battery_voltage_N
Knob
Output
Device Power~N~Battery Voltage
battery.V of the devicepower status.
devicepower_external_power_N
Indicator-LED
Output
Device Power~N~External Power
external.present of the devicepower status.
devicepower_errors_N
Indicator-Text
Output
Device Power~N~Errors
errors of the devicepower status.
Climate Page
Thermostat
One section per thermostat component (component id N - 1).
Thermostat controls
Controls name
Type
Pin Style
Pin Name
Description
thermostat_name_N
Text
Input / Output
Thermostat~N~Name
name of the component configuration, written with Thermostat.SetConfig.
thermostat_enable_N
Button-Toggle
Input / Output
Thermostat~N~Enable
enable of the thermostat status, written to enable with Thermostat.SetConfig.
thermostat_output_N
Indicator-LED
Output
Thermostat~N~Output
output of the thermostat status: lit while the thermostat calls for heating or cooling.
thermostat_target_N
Knob
Input / Output
Thermostat~N~Target
target_C of the thermostat status, 5 to 35 °C, written to target_C with Thermostat.SetConfig.
thermostat_current_N
Knob
Output
Thermostat~N~Current
current_C of the thermostat status.
thermostat_type_N
Text-ComboBox
Input / Output
Thermostat~N~Type
type of the component configuration (heating, cooling), written with Thermostat.SetConfig.
thermostat_errors_N
Indicator-Text
Output
Thermostat~N~Errors
errors of the thermostat status.
Virtual Page
Virtual components are created on the Shelly itself (web interface, Components › Add): booleans, numbers, texts, enums and buttons that scripts, the Shelly app and the plugin share.
The Virtual page needs the Virtual feature of the license. Without it the page stays disabled and Status is Fault - Virtual Components not included in the license.
Boolean
One section per virtual boolean component, N being its number on the page (component id 199 + N). The component must first be created on the device (web interface, Components › Add).
Boolean controls
Controls name
Type
Pin Style
Pin Name
Description
boolean_name_N
Text
Input / Output
Boolean~N~Name
name of the component configuration, written with Boolean.SetConfig.
boolean_value_N
Button-Toggle
Input / Output
Boolean~N~Value
value of the boolean status, written with Boolean.Set.
Number
One section per virtual number component, N being its number on the page (component id 199 + N).
Number controls
Controls name
Type
Pin Style
Pin Name
Description
number_name_N
Text
Input / Output
Number~N~Name
name of the component configuration, written with Number.SetConfig.
number_value_N
Knob
Input / Output
Number~N~Value
value of the number status, -1000000 to 1000000, written with Number.Set. The device refuses a value outside its own min and max.
number_min_N
Knob
Output
Number~N~Min
min of the component configuration.
number_max_N
Knob
Output
Number~N~Max
max of the component configuration.
Text
One section per virtual text component, N being its number on the page (component id 199 + N).
Text controls
Controls name
Type
Pin Style
Pin Name
Description
text_name_N
Text
Input / Output
Text~N~Name
name of the component configuration, written with Text.SetConfig.
text_value_N
Text
Input / Output
Text~N~Value
value of the text status, written with Text.Set. The device refuses a text longer than its max_len.
text_last_update_N
Indicator-Text
Output
Text~N~Last Update
Local date and time of the last change of the value.
Enum
One section per virtual enum component, N being its number on the page (component id 199 + N).
Enum controls
Controls name
Type
Pin Style
Pin Name
Description
enum_name_N
Text
Input / Output
Enum~N~Name
name of the component configuration, written with Enum.SetConfig.
enum_value_N
Text-ComboBox
Input / Output
Enum~N~Value
value of the enum status, written with Enum.Set. Its choices are the options of the enum; it is empty while no option is selected.
enum_last_update_N
Indicator-Text
Output
Enum~N~Last Update
Local date and time of the last change of the value.
Button
One section per virtual button component, N being its number on the page (component id 199 + N).
Button controls
Controls name
Type
Pin Style
Pin Name
Description
button_name_N
Text
Input / Output
Button~N~Name
name of the component configuration, written with Button.SetConfig.
button_press_single_N
Button-Trigger
Input / Output
Button~N~Press Single
Calls Button.Trigger with single_push.
button_press_double_N
Button-Trigger
Input / Output
Button~N~Press Double
Calls Button.Trigger with double_push.
button_press_triple_N
Button-Trigger
Input / Output
Button~N~Press Triple
Calls Button.Trigger with triple_push.
button_press_long_N
Button-Trigger
Input / Output
Button~N~Press Long
Calls Button.Trigger with long_push.
button_event_N
Indicator-Text
Output
Button~N~Event
Last event of the button, whoever pressed it (the plugin, the Shelly app, a script…).
button_single_push_N
Button-Trigger
Output
Button~N~Single Push
Pulses on the single_push event.
button_double_push_N
Button-Trigger
Output
Button~N~Double Push
Pulses on the double_push event.
button_triple_push_N
Button-Trigger
Output
Button~N~Triple Push
Pulses on the triple_push event.
button_long_push_N
Button-Trigger
Output
Button~N~Long Push
Pulses on the long_push event.
Bluetooth Page
Shelly BLU devices (H&T, Door/Window, Motion, Button, Remote…) cannot reach a Q-SYS Core: a Shelly with its Bluetooth gateway enabled, or a Shelly BLU Gateway Gen3, receives them and the plugin reads them from that Shelly. The devices and their sensors must first be added on the Shelly (web interface, Components › Add device).
The Bluetooth page needs the BTHome feature of the license. Without it the page stays disabled and Status is Fault - Bluetooth (BTHome) not included in the license.
BTHome Device
One section per Bluetooth device, N being its number on the page (component id 199 + N).
BTHome Device controls
Controls name
Type
Pin Style
Pin Name
Description
bthomedevice_name_N
Text
Input / Output
BTHome Device~N~Name
name of the component configuration, written with BTHomeDevice.SetConfig.
bthomedevice_battery_N
Knob
Output
BTHome Device~N~Battery
battery of the bthomedevice status.
bthomedevice_signal_N
Knob
Output
BTHome Device~N~Signal
rssi of the bthomedevice status.
bthomedevice_last_update_N
Indicator-Text
Output
BTHome Device~N~Last Update
Local date and time of the last data received from the Bluetooth device.
bthomedevice_address_N
Indicator-Text
Output
BTHome Device~N~Address
addr of the component configuration.
bthomedevice_event_N
Indicator-Text
Output
BTHome Device~N~Event
Last event of the device, with the index of the button that sent it (single_push (button 1), rotate_left…).
bthomedevice_single_push_N
Button-Trigger
Output
BTHome Device~N~Single Push
Pulses on the single_push event, from any button of the device.
bthomedevice_double_push_N
Button-Trigger
Output
BTHome Device~N~Double Push
Pulses on the double_push event, from any button of the device.
bthomedevice_triple_push_N
Button-Trigger
Output
BTHome Device~N~Triple Push
Pulses on the triple_push event, from any button of the device.
bthomedevice_long_push_N
Button-Trigger
Output
BTHome Device~N~Long Push
Pulses on the long_push event, from any button of the device.
bthomedevice_errors_N
Indicator-Text
Output
BTHome Device~N~Errors
errors of the bthomedevice status.
BTHome Sensor
One section per reading of a Bluetooth device (a BLU H&T gives one temperature and one humidity sensor), N being its number on the page (component id 199 + N).
BTHome Sensor controls
Controls name
Type
Pin Style
Pin Name
Description
bthomesensor_name_N
Text
Input / Output
BTHome Sensor~N~Name
name of the component configuration, written with BTHomeSensor.SetConfig.
bthomesensor_type_N
Indicator-Text
Output
BTHome Sensor~N~Type
Kind of reading, from the BTHome object id of the configuration (Temperature (°C), Window, Motion…, otherwise Object 0xNN).
bthomesensor_value_N
Knob
Output
BTHome Sensor~N~Value
value of the status when it is a number, disabled otherwise.
bthomesensor_state_N
Indicator-LED
Output
BTHome Sensor~N~State
value of the status when it is on / off (door, motion…), disabled otherwise.
bthomesensor_text_N
Indicator-Text
Output
BTHome Sensor~N~Text
value of the bthomesensor status.
bthomesensor_last_update_N
Indicator-Text
Output
BTHome Sensor~N~Last Update
Local date and time of the last data received from the Bluetooth device.
Setup Page
Connection
IP Address / Hostname
Controls name:connection_host Type:Text Pin Style:Input / Output Pin Name:Connection~Host Description: Address of the device, optionally followed by a port (192.168.10.41:8080); a pasted address such as http://192.168.10.41/ is accepted. The plugin connects as soon as it is set and tries again every 5 seconds when the connection is lost, Status showing the reason until the device answers. A device silent for 20 seconds is considered disconnected. A port outside 1–65535 sets Status to Fault.
Password
Controls name:connection_password Type:Text Pin Style:Input / Output Pin Name:Connection~Password Description: Password of the device when its authentication is enabled (user admin). It is moved to a hidden storage and replaced by a mask; an empty entry clears it. A refused password is never retried, not even after a reconnection, so the device does not block the Core: the plugin stays disconnected until the password, the address or Reconnect is changed.
Connected
Controls name:connection_connected Type:Indicator-LED Pin Style:Output Pin Name:Connection~Connected Description: On once the device has been read.
Reconnect
Controls name:connection_reconnect Type:Button-Trigger Pin Style:Input / Output Pin Name:Connection~Reconnect Description: Closes the connection and opens it again.
Device
Name
Controls name:device_name Type:Text Pin Style:Input / Output Pin Name:Device~Name Description: Name of the device, written to the device when changed.
Model
Controls name:device_model Type:Indicator-Text Pin Style:Output Pin Name:Device~Model Description: Application, model number and generation reported by the device (Pro2PM · SPSW-202PE16EU · Gen 2).
Firmware
Controls name:device_firmware Type:Indicator-Text Pin Style:Output Pin Name:Device~Firmware Description: Firmware version of the device.
MAC Address
Controls name:device_mac Type:Indicator-Text Pin Style:Output Pin Name:Device~MAC Address Description: MAC address of the device.
Network
Controls name:device_network Type:Indicator-Text Pin Style:Output Pin Name:Device~Network Description: Link of the device: Ethernet · 192.168.10.41 on the Pro devices wired to the network, otherwise Wi-Fi · <SSID> · <address> · <signal> dBm.
Uptime
Controls name:device_uptime Type:Indicator-Text Pin Style:Output Pin Name:Device~Uptime Description: Time since the device started, as days and hours.
Profile
Controls name:device_profile Type:Text-ComboBox Pin Style:Input / Output Pin Name:Device~Profile Description: Profile of the devices that have several (switch / cover, light / rgb / rgbw…). Choosing another one changes the components of the device and restarts it: pick the Model entry of the new profile too. Disabled on devices without profiles.
Restart Required
Controls name:device_restart_required Type:Indicator-LED Pin Style:Output Pin Name:Device~Restart Required Description: On when a setting changed on the device only applies after a restart.
Controls name:device_update_available Type:Indicator-Text Pin Style:Output Pin Name:Device~Update Available Description: Stable firmware version available for the device, or Up to date.
Update
Controls name:device_update Type:Button-Trigger Pin Style:Input / Output Pin Name:Device~Update Description: Installs the available stable firmware. The device restarts at the end of the update. Disabled when the device is up to date.
A model with more components than the device, or a profile different from the one set on the device, sets Status to Fault and lists the missing components. The plugin keeps controlling the components it found.
Controls name:about_feature_bthome Type:Indicator-Status Pin Style:Output Pin Name:About~Feature BTHome Description:Enabled when the license includes the Bluetooth (BTHome) devices, Disabled otherwise.
Feature - Virtual
Controls name:about_feature_virtual Type:Indicator-Status Pin Style:Output Pin Name:About~Feature Virtual Description:Enabled when the license includes the virtual components, Disabled otherwise.
Documentation
Controls name:about_doc_url Type:Indicator-Text Pin Style:Output Pin Name:About~Documentation Description: Address of this guide.