RGBCCT

The RGBCCT component handles a dimmable light output with possibility to change color, brightness and adjustable hues of white (cold/warm) and on/off control. Component has additional on/off control. It has night mode capability that can reduce brightness in selected period of time. It uses RGBCCT as RPC namespace and provides the methods:

• RGBCCT.GetConfig to obtain the component's configuration
• RGBCCT.SetConfig to update the component's configuration
• RGBCCT.GetStatus to obtain the component's status
• RGBCCT.Set to control the output state, color, transition and brightness level
• RGBCCT.Toggle to toggle the output state
• RGBCCT.DimUp to dim up
• RGBCCT.DimDown to dim down
• RGBCCT.DimStop to stop dimming

RGBCCT components are identified with rgbcct:<id> in objects containing multiple component payloads.

Methods:

RGBCCT.SetConfig

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

Find more about the config properties in config section

RGBCCT.GetConfig

Properties:

Property	Type	Description
id	number	Id of the RGBCCT component instance

Find the RGBCCT.GetConfig response properties in config section

RGBCCT.GetStatus

Properties:

Property	Type	Description
id	number	Id of the RGBCCT component instance

Find more about the status response properties in status section

RGBCCT.Set

This method sets the output, color, color temperature level, mode, transition and brightness level of the RGBCCT 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 RGBCCT component instance. Required
on	boolean	True for output on, false otherwise. Optional
brightness	number	Brightness level 1%-100% Optional
rgb	array of type number	Red, Green, Blue [r,g,b] - each value represents level between 0..255 Optional
ct	number	Color temperature level (in Kelvin) Optional
mode	string	Operating mode of the light output Optional
transition_duration	number	Transition time in seconds - time between change from current brightness level and color to desired brightness level and color or current color temperature level to desired color temperature level in request Optional
toggle_after	number	Flip-back timer in seconds. Optional
offset	number	Set current brightness level with applied offset. Can not be used together with brightness. Boundaries [-100, 100] Optional
tag	string or null	Up to 20 characters used to identify the origin of a state change. Optional

info

At least one of the on and brightness parameters is required.

RGBCCT.Toggle

This method toggles the output state. 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 RGBCCT component instance. Required
tag	string or null	Up to 20 characters used to identify the origin of a state change. Optional

RGBCCT.DimUp

This method dims up the brightness and white level. Dimming stops with RGBCCT.DimStop.

Request

Parameters:

Property	Type	Description
id	number	Id of the RGBCCT component instance. Required
fade_rate	number	Fade rate of the brightness level dimming. Range [1,5] where 5 is fastest, 1 is slowest. If not provided, value is defaulted to button_fade_rate. Optional

RGBCCT.DimDown

This method dims down the brightness and white level. Dimming stops with RGBCCT.DimStop.

Request

Parameters:

Property	Type	Description
id	number	Id of the RGBCCT component instance. Required
fade_rate	number	Fade rate of the brightness level dimming. Range [1,5] where 5 is fastest, 1 is slowest. If not provided, value is defaulted to button_fade_rate. Optional

RGBCCT.DimStop

This method stops the dimming of the brightness level.

HTTP Endpoint: /rgbcct/id

Through this endpoint a light can be turned on/off with or without a timer, brightness, color and color temperature level can be changed also. This 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
turn	string	Action to be executed. Range of values: on, off, toggle. Required
timer	number	A one-shot flip-back timer in seconds.
brightness	number	Brightness, 0..100 %
red	number	Intensity of the color red, 0..255
green	number	Intensity of the color green, 0..255
blue	number	Intensity of the color blue, 0..255
temp	number	Color temperature level (in Kelvin), accepted value is device specific. Default range for RGBCCTBulbG3: [2700, 6500].
transition	number	One-shot transition, 500..10800000 [ms]

Response

Received attributes:

Property	Type	Description
ison	boolean	True if the light is turned on, false otherwise
brightness	number	Brightness, 0..100 %
red	number	Intensity of the color red, 0..255
green	number	Intensity of the color green, 0..255
blue	number	Intensity of the color blue, 0..255
temp	number	Color temperature level (in Kelvin)
transition	number	One-shot transition, 500..10800000 [ms]
has_timer	boolean	True if the light is turned on, false otherwise
timer_started_at	number	Unix timestamp, start time of the timer (in UTC)
timer_duration	number	Duration of the timer in seconds
timer_remaining	number	Time remaining (in seconds) until the request is executed
source	string	Source of the last command, for example: init, WS_in, http, ...

Configuration

The configuration of the RGBCCT component contains information about night mode settings, the timers of the chosen light instance. To Get/Set the configuration of the RGBCCT component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the RGBCCT component instance
name	string or null	Name of the RGBCCT instance
initial_state	string	Output state to set on power_on. Range of values: off, on, restore_last
auto_on	boolean	True if the "Automatic ON" function is enabled, false otherwise
auto_on_delay	number	Seconds to pass until the component is switched back on
auto_off	boolean	True if the "Automatic OFF" function is enabled, false otherwise
auto_off_delay	number	Seconds to pass until the component is switched back off
transition_duration	number	Transition time (in seconds) - time to change from 0% to 100% of brightness, RGB levels or color temperature value
min_brightness_on_toggle	number	Brightness level (in percent) applied when there is a toggle and current brightness is lower than min_brightness_on_toggle.
night_mode.enable	boolean	Enable or disable night mode
night_mode.brightness	number or null	Brightness level limit (in percent) when night mode is active. null overrides night_mode.brightness with current brightness when night mode starts. Default value 50.
night_mode.rgb	array of type number or null	Color level when night mode is active. Red, Green, Blue [r,g,b] - each value represents level between 0..255. null overrides night_mode.rgb array with current rgb array when night mode starts. Default value 255 for each color
night_mode.ct	number or null	Color temperature level limit (in Kelvin) when night mode is active. null overrides night_mode.ct value with current ct value when night mode starts. Default value: 50% of ct_range. For DuoBulbG3: 4600
night_mode.mode	string or null	Operating mode of the light output when night mode is active. Range of values: rgb, cct or null. null overrides night_mode.mode value with current mode when night mode starts. Default value: rgb
night_mode.active_between	array of type string	Containing 2 elements of type string, the first element indicates the start of the period during which the night mode will be active, the second indicates the end of that period. Both start and end are strings in the format HH:MM, where HH and MM are hours and minutes with optinal leading zeros

Status

The status of the RGBCCT component contains information about the brightness level, color, color temperature level and output state of the light instance. To obtain the status of the RGBCCT component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the RGBCCT component instance
source	string	Source of the last command, for example: init, WS_in, http, ...
tag	string or null	Tag used to identify the origin of a state change
mode	string	Current operating mode of the light output, rgb or cct
output	boolean	True if the output channel is currently on, false otherwise
rgb	array of type number	Current Red, Green, Blue [r,g,b] level 0..255
ct	number	Current color temperature level (in Kelvin)
brightness	number	Current brightness level (in percent)
timer_started_at	number	Unix timestamp, start time of the timer (in UTC) (shown if the timer is triggered)
timer_duration	number	Duration of the timer in seconds (shown if the timer is triggered)
transition	object	Information about the transition (shown if transition is triggered) Property Type Description target.output boolean True if the output channel becomes on, false otherwise target.rgb array of type number Red, Green, Blue [r,g,b] level 0..255 target.ct number Color temperature level (in Kelvin) target.brightness number Brightness level (in percent) started_at number Unix timestamp, start time of the transition (in UTC) duration number Duration of the transition in seconds
aenergy	object	Information about the active energy counter (shown if applicable) Property Type Description total number Total energy consumed in Watt-hours by_minute array of type number Energy consumption in Milliwatt-hours for the last three complete minutes. The 0-th element indicates the counts accumulated during the minute preceding minute_ts. Present only if the device clock is synced. minute_ts number Unix timestamp marking the start of the current minute (in UTC).
apower	number	Last measured instantaneous active power (in Watts) delivered to the attached load (shown if applicable)

info

• rgb: when this mode is active Red, Green, Blue [r,g,b] are valid
• cct: when this mode is active Color temperature level (in Kelvin) is valid

Webhook Events

Currently, there are two events related to the RGBCCT component that can trigger webhooks:

• rgbcct.on - produced when the output changes its state from off to on
• rgbcct.off - produced when the output changes its state from on to off

Examples

RGBCCT.SetConfig example

RGBCCT.SetConfig HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.SetConfig?id=0&config={"name":"RGBCCT0"}

RGBCCT.SetConfig Curl Request

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

RGBCCT.SetConfig Mos Request

mos --port ${PORT} call RGBCCT.SetConfig '{"id":0,"config":{"name":"RGBCCT0"}}'

Response

RGBCCT.SetConfig HTTP GET Response

null

RGBCCT.SetConfig Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": null
}

RGBCCT.SetConfig Mos Response

null

RGBCCT.GetConfig example

RGBCCT.GetConfig HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.GetConfig?id=0

RGBCCT.GetConfig Curl Request

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

RGBCCT.GetConfig Mos Request

mos --port ${PORT} call RGBCCT.GetConfig '{"id":0}'

Response

RGBCCT.GetConfig HTTP GET Response

{
  "id": 0,
  "name": null,
  "initial_state": "restore_last",
  "auto_on": true,
  "auto_on_delay": 60,
  "auto_off": true,
  "auto_off_delay": 60,
  "transition_duration": 3,
  "min_brightness_on_toggle": 3,
  "night_mode": {
    "enable": true,
    "brightness": 50,
    "rgb": [
      255,
      255,
      255
    ],
    "ct": 4600,
    "mode": "rgb",
    "active_between": [
      "21:45",
      "05:30"
    ]
  }
}

RGBCCT.GetConfig Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": {
    "id": 0,
    "name": null,
    "initial_state": "restore_last",
    "auto_on": true,
    "auto_on_delay": 60,
    "auto_off": true,
    "auto_off_delay": 60,
    "transition_duration": 3,
    "min_brightness_on_toggle": 3,
    "night_mode": {
      "enable": true,
      "brightness": 50,
      "rgb": [
        255,
        255,
        255
      ],
      "ct": 4600,
      "mode": "rgb",
      "active_between": [
        "21:45",
        "05:30"
      ]
    }
  }
}

RGBCCT.GetConfig Mos Response

{
  "id": 0,
  "name": null,
  "initial_state": "restore_last",
  "auto_on": true,
  "auto_on_delay": 60,
  "auto_off": true,
  "auto_off_delay": 60,
  "transition_duration": 3,
  "min_brightness_on_toggle": 3,
  "night_mode": {
    "enable": true,
    "brightness": 50,
    "rgb": [
      255,
      255,
      255
    ],
    "ct": 4600,
    "mode": "rgb",
    "active_between": [
      "21:45",
      "05:30"
    ]
  }
}

RGBCCT.GetStatus example

RGBCCT.GetStatus HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.GetStatus?id=0

RGBCCT.GetStatus Curl Request

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

RGBCCT.GetStatus Mos Request

mos --port ${PORT} call RGBCCT.GetStatus '{"id":0}'

Response

RGBCCT.GetStatus HTTP GET Response

{
  "id": 0,
  "source": "timer",
  "tag": null,
  "mode": "rgb",
  "output": true,
  "brightness": 50,
  "rgb": [
    0,
    0,
    127
  ],
  "ct": 4600,
  "timer_started_at": 1626942399.36,
  "timer_duration": 60,
  "transition": {
    "target": {
      "output": true,
      "brightness": 50,
      "rgb": [
        20,
        30,
        40
      ],
      "ct": 6500
    },
    "started_at": 1626942399.36,
    "duration": 20
  },
  "aenergy": {
    "total": 0.55
  },
  "apower": 2
}

RGBCCT.GetStatus Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": {
    "id": 0,
    "source": "timer",
    "tag": null,
    "mode": "rgb",
    "output": true,
    "brightness": 50,
    "rgb": [
      0,
      0,
      127
    ],
    "ct": 4600,
    "timer_started_at": 1626942399.36,
    "timer_duration": 60,
    "transition": {
      "target": {
        "output": true,
        "brightness": 50,
        "rgb": [
          20,
          30,
          40
        ],
        "ct": 6500
      },
      "started_at": 1626942399.36,
      "duration": 20
    },
    "aenergy": {
      "total": 0.55
    },
    "apower": 2
  }
}

RGBCCT.GetStatus Mos Response

{
  "id": 0,
  "source": "timer",
  "tag": null,
  "mode": "rgb",
  "output": true,
  "brightness": 50,
  "rgb": [
    0,
    0,
    127
  ],
  "ct": 4600,
  "timer_started_at": 1626942399.36,
  "timer_duration": 60,
  "transition": {
    "target": {
      "output": true,
      "brightness": 50,
      "rgb": [
        20,
        30,
        40
      ],
      "ct": 6500
    },
    "started_at": 1626942399.36,
    "duration": 20
  },
  "aenergy": {
    "total": 0.55
  },
  "apower": 2
}

RGBCCT.Set example

RGBCCT.Set HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.Set?id=0&on=true&brightness=50&rgb=[20,30,40]&ct=4000&transition_duration=20

RGBCCT.Set Curl Request

curl -X POST -d '{"id":1,"method":"RGBCCT.Set","params":{"id":0,"on":true,"brightness":50,"rgb":[20,30,40],"ct":4000,"transition_duration":20}}' http://${SHELLY}/rpc

RGBCCT.Set Mos Request

mos --port ${PORT} call RGBCCT.Set '{"id":0,"on":true,"brightness":50,"rgb":[20,30,40],"ct":4000,"transition_duration":20}'

Response

RGBCCT.Set HTTP GET Response

null

RGBCCT.Set Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": null
}

RGBCCT.Set Mos Response

null

RGBCCT.Toggle example

RGBCCT.Toggle HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.Toggle?id=0

RGBCCT.Toggle Curl Request

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

RGBCCT.Toggle Mos Request

mos --port ${PORT} call RGBCCT.Toggle '{"id":0}'

Response

RGBCCT.Toggle HTTP GET Response

null

RGBCCT.Toggle Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": null
}

RGBCCT.Toggle Mos Response

null

RGBCCT.DimUp example

RGBCCT.DimUp HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.DimUp?id=0&fade_rate=3

RGBCCT.DimUp Curl Request

curl -X POST -d '{"id":1,"method":"RGBCCT.DimUp","params":{"id":0,"fade_rate":3}}' http://${SHELLY}/rpc

RGBCCT.DimUp Mos Request

mos --port ${PORT} call RGBCCT.DimUp '{"id":0,"fade_rate":3}'

Response

RGBCCT.DimUp HTTP GET Response

null

RGBCCT.DimUp Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": null
}

RGBCCT.DimUp Mos Response

null

RGBCCT.DimDown example

RGBCCT.DimDown HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.DimDown?id=0&fade_rate=3

RGBCCT.DimDown Curl Request

curl -X POST -d '{"id":1,"method":"RGBCCT.DimDown","params":{"id":0,"fade_rate":3}}' http://${SHELLY}/rpc

RGBCCT.DimDown Mos Request

mos --port ${PORT} call RGBCCT.DimDown '{"id":0,"fade_rate":3}'

Response

RGBCCT.DimDown HTTP GET Response

null

RGBCCT.DimDown Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": null
}

RGBCCT.DimDown Mos Response

null

RGBCCT.DimStop example

RGBCCT.DimStop HTTP GET Request

http://192.168.33.1/rpc/RGBCCT.DimStop?id=0

RGBCCT.DimStop Curl Request

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

RGBCCT.DimStop Mos Request

mos --port ${PORT} call RGBCCT.DimStop '{"id":0}'

Response

RGBCCT.DimStop HTTP GET Response

null

RGBCCT.DimStop Curl Response

{
  "id": 1,
  "src": "shellyrgbcctbulbg3-b48a0a123db4",
  "params": null
}

RGBCCT.DimStop Mos Response

null

HTTP Endpoint example

Example:

curl http://${SHELLY}/rgbcct/0?turn=on

Example:

{
  "ison": true,
  "brightness": 100,
  "red": 127,
  "green": 0,
  "blue": 0,
  "temp": 4600,
  "transition": 10,
  "has_timer": true,
  "timer_started_at": 258,
  "timer_duration": 10,
  "timer_remaining": 1.98,
  "source": "http"
}