Struct elgato_keylight::keylight::KeyLight

pub struct KeyLight { /* fields omitted */ }

Implementations

impl KeyLight

pub async fn new_from_ip(
    name: &str,
    addr: Ipv4Addr,
    poll: Option<Duration>
) -> Result<KeyLight, ElgatoError>

Create a new Keylight from a known IP.

Arguments

• addr - IP address to the keylight
• poll - If the library should poll the light for updates

pub async fn new_from_name(
    name: &str,
    poll: Option<Duration>
) -> Result<KeyLight, ElgatoError>

Create a new Keylight from device name This uses zeroconf to discover the light on the network.

Arguments

• name - Name of the lamp like “Key Light Left” or whatever your light is named
• poll - If the library should poll the light for updates

pub async fn get(&self) -> Result<Status, ElgatoError>

pub async fn name(&self) -> String

pub async fn set_brightness(
    &mut self,
    brightness: u8
) -> Result<(), ElgatoError>

Set the brightness of the light

Arguments

• brightness - Value between 0-100

pub async fn set_relative_brightness(
    &mut self,
    brightness: f64
) -> Result<f64, ElgatoError>

Set the brightness of the light relative to the current value

Arguments

• brightness - f64 between -1.0 and 1.0

pub async fn set_temperature(
    &mut self,
    temperature: u32
) -> Result<(), ElgatoError>

Set the color temperature of the light

Arguments

• temperature - Value between 2900 - 7000 (Kelvin)

pub async fn set_power(&mut self, power: bool) -> Result<(), ElgatoError>

Turn on/off the light

Arguments

• power - true: on, false: off

Trait Implementations

impl Debug for KeyLight

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

Formats the value using the given formatter.