Enum kll_core::TriggerEvent

#[repr(u8)]
pub enum TriggerEvent {
    None,
    Switch {
        state: Phro,
        index: u16,
        last_state: u32,
    },
    HidLed {
        state: Aodo,
        index: u8,
        last_state: u32,
    },
    AnalogDistance {
        index: u16,
        val: i16,
    },
    AnalogVelocity {
        index: u16,
        val: i16,
    },
    AnalogAcceleration {
        index: u16,
        val: i16,
    },
    AnalogJerk {
        index: u16,
        val: i16,
    },
    Layer {
        state: LayerState,
        layer: u8,
        last_state: u32,
    },
    Animation {
        state: Dro,
        index: u16,
        last_state: u32,
    },
    Sleep {
        state: Aodo,
        last_state: u32,
    },
    Resume {
        state: Aodo,
        last_state: u32,
    },
    Inactive {
        state: Aodo,
        last_state: u32,
    },
    Active {
        state: Aodo,
        last_state: u32,
    },
    Rotation {
        index: u8,
        position: i8,
        last_state: u32,
    },
}

Trigger event definitions

last_state is an incrementing counter that increases on every scan loop while the state has not changed (e.g. holding a key).

Variants

None

Switch

Fields

state: Phro

Switch state

index: u16

Switch identification index

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

HidLed

Fields

state: Aodo

LED state

index: u8

HID LED identification (from USB HID spec, e.g. CapsLock)

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

AnalogDistance

Fields

index: u16

val: i16

AnalogVelocity

Fields

index: u16

val: i16

AnalogAcceleration

Fields

index: u16

val: i16

AnalogJerk

Fields

index: u16

val: i16

Layer

Fields

state: LayerState

layer: u8

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Animation

Fields

state: Dro

index: u16

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Sleep

Fields

state: Aodo

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Resume

Fields

state: Aodo

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Inactive

Fields

state: Aodo

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Active

Fields

state: Aodo

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Rotation

Fields

index: u8

position: i8

last_state: u32

Scanning loops since the last state change (can be 0 if the state just changed)

Implementations

impl TriggerEvent

pub const unsafe fn bytes(&self) -> &[u8]

Convert enum to an array of bytes

Safety

pub const unsafe fn from_byte_array(bytes: [u8; 8]) -> Self

Convert array of bytes to enum

Safety

pub const unsafe fn from_bytes(bytes: &[u8]) -> Self

Convert slice of bytes to enum Aggressively casts the provide u8 slice to retrieve a TriggerEvent

Safety

pub fn index(&self) -> u16

Attempts to determine the index value of the event If an index is not valid, return 0 instead (index may not have any meaning)

Trait Implementations

impl Clone for TriggerEvent

fn clone(&self) -> TriggerEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TriggerEvent

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

Formats the value using the given formatter.

impl From<TriggerCondition> for TriggerEvent

Convert TriggerCondition to TriggerEvent Used for mainly for kll validation, events are time index 0 and are assumed to be immediate with no history

fn from(cond: TriggerCondition) -> Self

Converts to this type from the input type.

impl From<TriggerEvent> for CapabilityRun

fn from(event: TriggerEvent) -> Self

Converts to this type from the input type.

impl From<TriggerEvent> for u8

Convert TriggerEvent into the u8 identifier

fn from(event: TriggerEvent) -> Self

Converts to this type from the input type.

impl Hash for TriggerEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<TriggerEvent> for TriggerEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for TriggerEvent

impl Eq for TriggerEvent

impl StructuralEq for TriggerEvent

impl StructuralPartialEq for TriggerEvent