Breathe Effect

post

https://api.lifx.com/v1/lights/{selector}/effects/breathe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Performs a breathe effect by slowly fading between the given colors. Use the parameters to tweak the effect. (Note: the effect targets the whole light, specific-zone selectors are ignored).

Path Params

selector

string

required

The selector to limit which lights will run the effect.

Body Params

color

string

required

The color to use for the breathe effect.

from_color

string

Defaults to current bulb color

The color to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.

period

double

Defaults to 1

The time in seconds for one cycle of the effect.

cycles

double

Defaults to 1

The number of times to repeat the effect.

persist

boolean

Defaults to false

If false set the light back to its previous value when effect ends, if true leave the last effect color.

power_on

boolean

Defaults to true

If true, turn the bulb on if it is not already on.

peak

double

Defaults to 0.5

Defines where in a period the target color is at its maximum. Minimum 0.0, maximum 1.0.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

2XX2XX