Struct ColorLedEffectsFeature 

pub struct ColorLedEffectsFeature { /* private fields */ }

Implements the ColorLedEffects / 0x8070 feature.

Implementations

impl ColorLedEffectsFeature

pub async fn get_info(&self) -> Result<ColorLedInfo, Hidpp20Error>

Retrieves the zone count and capability bitmasks.

pub async fn get_zone_info( &self, zone_index: u8, ) -> Result<ZoneInfo, Hidpp20Error>

Retrieves information about zone_index.

pub async fn get_zone_effect_info( &self, zone_index: u8, zone_effect_index: u8, ) -> Result<ZoneEffectInfo, Hidpp20Error>

Retrieves information about effect zone_effect_index of zone_index.

pub async fn set_zone_effect( &self, zone_index: u8, zone_effect_index: u8, params: [u8; 10], persistence: Persistence, ) -> Result<(), Hidpp20Error>

Applies effect zone_effect_index to zone_index with effect-specific params.

The meaning of each parameter byte depends on the effect’s EffectId (discoverable with Self::get_zone_effect_info). For example, the EffectId::FixedColor effect uses the first three parameters as red, green and blue.

pub async fn get_nv_config( &self, capability: NvCapabilities, ) -> Result<NvConfig, Hidpp20Error>

Reads one non-volatile configuration capability.

Exactly one NvCapabilities bit must be set.

pub async fn set_nv_config( &self, capability: NvCapabilities, state: NvCapabilityState, param1: u8, param2: u8, ) -> Result<(), Hidpp20Error>

Writes one non-volatile configuration entry (to EEPROM, so use sparingly).

pub async fn get_led_bin_info( &self, zone_index: u8, led_bin_index: LedBinIndex, ) -> Result<LedBinInfo, Hidpp20Error>

Reads manufacturing LED bin information.

pub async fn get_sw_control(&self) -> Result<SwControlState, Hidpp20Error>

Retrieves whether firmware or software owns the LEDs.

pub async fn set_sw_control( &self, control: SwControl, sync_events: bool, ) -> Result<(), Hidpp20Error>

Takes or releases software control of the LEDs.

sync_events enables the ColorLedEffectsEvent::SyncEffect event. This is not stored in EEPROM.

pub async fn get_effect_settings( &self, zone_index: u8, source: PersistenceSource, ) -> Result<EffectSettings, Hidpp20Error>

Reads the effect settings of zone_index.

Not supported when ExtCapabilities::NO_GET_EFFECT_SETTINGS is set.

pub async fn clear_effect_settings( &self, zone_index: u8, ) -> Result<(), Hidpp20Error>

Clears the effect settings of zone_index, reverting it to the default mode.

pub async fn set_cycling_direction( &self, direction: CyclingDirection, ) -> Result<(), Hidpp20Error>

Sets the color-cycling direction.

pub async fn get_current_color( &self, zone_index: u8, ) -> Result<Rgb, Hidpp20Error>

Retrieves the color currently displayed by zone_index.

pub async fn synchronize_effect( &self, zone_index: u8, drift_value: i16, ) -> Result<(), Hidpp20Error>

Synchronizes effect timing across devices by applying a drift_value correction (milliseconds).

Valid only while sync events are enabled. A zone_index of 0xff targets all zones.

pub async fn get_zone_effect( &self, zone_index: u8, source: PersistenceSource, ) -> Result<ZoneEffect, Hidpp20Error>

Retrieves the currently configured effect of zone_index.

Requires ExtCapabilities::GET_ZONE_EFFECT.

pub async fn set_led_bin_info( &self, info: &LedBinInfo, ) -> Result<LedBinInfo, Hidpp20Error>

Stores manufacturing LED bin information and returns the device’s echo.

Requires ExtCapabilities::SET_LED_BIN_INFO.

Trait Implementations

impl CreatableFeature for ColorLedEffectsFeature

const ID: u16 = 0x8070

The protocol ID of the implemented feature.

const STARTING_VERSION: u8 = 0

The version of the feature the implementation starts to support.

fn new(chan: Arc<HidppChannel>, device_index: u8, feature_index: u8) -> Self

Creates a new instance of the feature implementation.

impl EmittingFeature<ColorLedEffectsEvent> for ColorLedEffectsFeature

fn listen(&self) -> Receiver<ColorLedEffectsEvent>

Creates a receiver that is being notified whenever a new event of type T is emitted by the feature.

impl Feature for ColorLedEffectsFeature