Struct PulseEffect

pub struct PulseEffect {
    pub color: Option<String>,
    pub from_color: Option<String>,
    pub period: Option<f64>,
    pub cycles: Option<f64>,
    pub persist: Option<bool>,
    pub power_on: Option<bool>,
}

Used to set the params when posting a PulseEffect event

Fields

color: Option<String>

The color to use for the breathe effect.

from_color: Option<String>

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: Option<f64>

The time in seconds for one cycle of the effect.

cycles: Option<f64>

The number of times to repeat the effect.

persist: Option<bool>

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

power_on: Option<bool>

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

Implementations

impl PulseEffect

pub fn new() -> Self

Returns a new PulseEffect object

Examples

extern crate lifx_rs as lifx;
 
fn main() {
 
    let key = "xxx".to_string();
    let mut api_endpoints: Vec<String> = Vec::new();

    api_endpoints.push(format!("https://api.lifx.com"));
    api_endpoints.push(format!("http://localhost:8089"));

    let config = lifx::LifxConfig{
       access_token: key.clone(),
       api_endpoints: api_endpoints
    };
 
    let mut pulse = lifx::PulseEffect::new();
    pulse.color = Some(format!("red"));
    pulse.from_color = Some(format!("green"));
    pulse.period = Some(10);
    pulse.persist = Some(true);
    pulse.power_on = Some(true);
}

Trait Implementations

impl Clone for PulseEffect

fn clone(&self) -> PulseEffect

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PulseEffect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PulseEffect

fn default() -> PulseEffect

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PulseEffect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PulseEffect

fn eq(&self, other: &PulseEffect) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PulseEffect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PulseEffect