Enum kll_core::TriggerCondition

source · [−]

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

Expand description

Trigger condition definitions

XXX (HaaTa): Field order is extremely important. Rust will optimize field packing if done correctly. Static assertions are included to prevent bad mistakes. Changing the enum size is an API breaking change (requires KLL compiler updates).

Variants

`None`

`Switch`

Fields

state: Phro

Switch state

index: u16

Switch identification index

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

6 bytes

`HidLed`

Fields

state: Aodo

LED state

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

index: u8

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

5 bytes

`AnalogDistance`

Fields

reserved: u8

Needed focontiguous packing

index: u16

Switch identification index

val: i16

Analog distance, units depend on the keyboard, KLL compiler handles unit conversion

6 bytes

`AnalogVelocity`

Fields

reserved: u8

Needed for contiguous packing

index: u16

Switch identification index

val: i16

Analog velocity, units depend on the keyboard, KLL compiler handles unit conversion

6 bytes

`AnalogAcceleration`

Fields

reserved: u8

Needed for contiguous packing

index: u16

Switch identification index

val: i16

Analog acceleration, units depend on the keyboard, KLL compiler handles unit conversion

6 bytes

`AnalogJerk`

Fields

reserved: u8

Needed for contiguous packing

index: u16

Switch identification index

val: i16

Analog jerk, units depend on the keyboard, KLL compiler handles unit conversion

6 bytes

`Layer`

Fields

state: LayerState

Layer state

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

layer: u8

Layer index (layer 0 is the default state and does not have events)

5 bytes

`Animation`

Fields

state: Dro

Animation state

index: u16

Animation index

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

6 bytes

`Sleep`

Fields

state: Aodo

Sleep state

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

Sleep events are always index 0 4 bytes

`Resume`

Fields

state: Aodo

Resume state

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

Resume events are always index 0 4 bytes

`Inactive`

Fields

state: Aodo

Inactive state

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

Inactive events are always index 0 4 bytes

`Active`

Fields

state: Aodo

Active state

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

Active events are always index 0 4 bytes

`Rotation`

Fields

index: u8

Rotation index

loop_condition_index: u16

Scanning loop condition (number of scanning loops attached to state condition) Lookup index

position: i8

Rotation direction (-1,+1)

5 bytes

Implementations

source

impl TriggerCondition

source

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

Convert enum to an array of bytes

Safety

source

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

Convert array of bytes to enum

Safety

source

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

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

Safety

source

pub fn index(&self) -> u16

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

source

pub fn evaluate(
    &self,
    event: TriggerEvent,
    loop_condition_lookup: &[u32 ]
) -> Vote

Compare TriggerEvent to TriggerCondition NOTE: This is not a direct equivalent comparison each type and state can influence how the loop_condition_index is evaluated. In a way, this is similar to the voting scheme of the older C KLL implementation.