Enum kll_core::Capability

source ·

#[repr(u8)]
pub enum Capability {
Show 22 variants    NoOp {
        state: CapabilityState,
        loop_condition_index: u16,
    },
    Rotate {
        state: CapabilityState,
        loop_condition_index: u16,
        index: u8,
        increment: i8,
    },
    LayerClear {
        state: CapabilityState,
        loop_condition_index: u16,
    },
    LayerState {
        state: CapabilityState,
        loop_condition_index: u16,
        layer: u8,
        layer_state: State,
    },
    LayerRotate {
        state: CapabilityState,
        loop_condition_index: u16,
        direction: Direction,
    },
    HidProtocol {
        state: CapabilityState,
        loop_condition_index: u16,
        mode: Protocol,
    },
    HidKeyboard {
        state: CapabilityState,
        loop_condition_index: u16,
        id: Keyboard,
    },
    HidKeyboardState {
        state: CapabilityState,
        loop_condition_index: u16,
        id: Keyboard,
        key_state: State,
    },
    HidConsumerControl {
        state: CapabilityState,
        loop_condition_index: u16,
        id: ConsumerControl,
    },
    HidSystemControl {
        state: CapabilityState,
        loop_condition_index: u16,
        id: SystemControl,
    },
    McuFlashMode {
        state: CapabilityState,
        loop_condition_index: u16,
    },
    PixelAnimationControl {
        state: CapabilityState,
        loop_condition_index: u16,
        mode: AnimationControl,
    },
    PixelAnimationIndex {
        state: CapabilityState,
        loop_condition_index: u16,
        index: u16,
    },
    PixelFadeControl {
        state: CapabilityState,
        loop_condition_index: u16,
        profile: u8,
        command: FadeCommand,
        arg: u8,
    },
    PixelFadeLayer {
        state: CapabilityState,
        loop_condition_index: u16,
        layer: u8,
    },
    PixelFadeSet {
        state: CapabilityState,
        loop_condition_index: u16,
        profile: u8,
        config: u8,
        period: u8,
    },
    PixelGammaControl {
        state: CapabilityState,
        loop_condition_index: u16,
        mode: GammaControl,
    },
    PixelLedControl {
        state: CapabilityState,
        loop_condition_index: u16,
        mode: LedControl,
        amount: u8,
    },
    PixelTest {
        state: CapabilityState,
        loop_condition_index: u16,
        test: PixelTest,
        index: u16,
    },
    HidioOpenUrl {
        state: CapabilityState,
        loop_condition_index: u16,
        index: u16,
    },
    HidioUnicodeString {
        state: CapabilityState,
        loop_condition_index: u16,
        index: u16,
    },
    HidioUnicodeState {
        state: CapabilityState,
        loop_condition_index: u16,
        unicode: char,
    },
}

Expand description

Global capability list for KLL NOTE: Changing parameters and removing entries will require a firmware reflash. At worst, KLL file and compiler definitions may also need to be updated. Please avoid these kinds of changes if possible. Adding new entries is safe.

Variants

`NoOp`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

No-op / None action 4 bytes

`Rotate`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

index: u8

increment: i8

Rotation event trigger 6 bytes

`LayerClear`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

Clears all layer states NOTE: Does not send trigger events 4 bytes

`LayerState`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

layer: u8

layer_state: State

Updates layer to the specified state 6 bytes

`LayerRotate`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

direction: Direction

Rotates through possible layers given the direction Uses internal state to keep track of the current layer 5 bytes

`HidProtocol`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

mode: Protocol

HID Protocol Mode 5 bytes

`HidKeyboard`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

id: Keyboard

USB HID keyboard event Handles press/released based on incoming state 5 bytes

`HidKeyboardState`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

id: Keyboard

key_state: State

USB HID keyboard event Force state event 6 bytes

`HidConsumerControl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

id: ConsumerControl

USB HID Consumer Control Event Handles press/released based on incoming state 6 bytes

`HidSystemControl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

id: SystemControl

USB HID System Control Event Handles press/released based on incoming state 5 bytes

`McuFlashMode`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

Enter Flash Mode Usually jumps to the bootloader 4 bytes

`PixelAnimationControl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

mode: AnimationControl

Overall animation control 5 bytes

`PixelAnimationIndex`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

index: u16

Activates the given indexed Animation 6 bytes

`PixelFadeControl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

profile: u8

command: FadeCommand

arg: u8

Fade control 7 bytes

`PixelFadeLayer`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

layer: u8

Layer fade 5 bytes

`PixelFadeSet`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

profile: u8

config: u8

period: u8

Fade set profile 7 bytes

`PixelGammaControl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

mode: GammaControl

Enable/Disable/Toggle gamma correction 5 bytes

`PixelLedControl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

mode: LedControl

amount: u8

LED Control 6 bytes

`PixelTest`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

test: PixelTest

index: u16

Pixel test 7 bytes

`HidioOpenUrl`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

index: u16

Sends URL (using index stored unicode string) to host computer web browser 6 bytes

`HidioUnicodeString`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

index: u16

Sends Unicode string (using index stored unicode string) to host computer 6 bytes

`HidioUnicodeState`

Fields

state: CapabilityState

Capability state

loop_condition_index: u16

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

unicode: char

Sends Unicode character with state (Press or Release) 8 bytes

Implementations

source

impl Capability

source

pub fn generate(
    &self,
    event: TriggerEvent,
    _loop_condition_lookup: &[u32]
) -> CapabilityRun

Generate a CapabilityRun using a Capability + TriggerEvent The TriggerEvent is only important when CapabilityState::Passthrough is set.

source

pub fn loop_condition_index(&self) -> u16

Lookup loop_condition_index

source

impl Capability

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; 8]) -> 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 Capability

Safety

Trait Implementations

source

impl Clone for Capability

source

fn clone(&self) -> Capability

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Capability

source

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

Formats the value using the given formatter. Read more

source

impl From<Capability> for CapabilityRun

Convert Capability to CapabilityRun Used for mainly for kll validation

source

fn from(cap: Capability) -> Self

Converts to this type from the input type.

source

impl Hash for Capability

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<Capability> for Capability

source

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

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

1.0.0 · source

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. Read more

source

impl StructuralPartialEq for Capability

Auto Trait Implementations

impl RefUnwindSafe for Capability

impl Send for Capability

impl Sync for Capability

impl Unpin for Capability

impl UnwindSafe for Capability

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum kll_core::Capability

Variants

NoOp

Fields

Rotate

Fields

LayerClear

Fields

LayerState

Fields

LayerRotate

Fields

HidProtocol

Fields

HidKeyboard

Fields

HidKeyboardState

Fields

HidConsumerControl

Fields

HidSystemControl

Fields

McuFlashMode

Fields

PixelAnimationControl

Fields

PixelAnimationIndex

Fields

PixelFadeControl

Fields

PixelFadeLayer

Fields

PixelFadeSet

Fields

PixelGammaControl

Fields

PixelLedControl

Fields

PixelTest

Fields

HidioOpenUrl

Fields

HidioUnicodeString

Fields

HidioUnicodeState

Fields

Implementations

impl Capability

pub fn generate( &self, event: TriggerEvent, _loop_condition_lookup: &[u32]) -> CapabilityRun

pub fn loop_condition_index(&self) -> u16

impl Capability

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

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

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

Trait Implementations

impl Clone for Capability

fn clone(&self) -> Capability

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

impl Debug for Capability

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

impl From<Capability> for CapabilityRun

fn from(cap: Capability) -> Self

impl Hash for Capability

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

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

impl PartialEq<Capability> for Capability

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

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

impl Copy for Capability

impl Eq for Capability

impl StructuralEq for Capability

impl StructuralPartialEq for Capability

Auto Trait Implementations

impl RefUnwindSafe for Capability

impl Send for Capability

impl Sync for Capability

impl Unpin for Capability

impl UnwindSafe for Capability

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

`NoOp`

`Rotate`

`LayerClear`

`LayerState`

`LayerRotate`

`HidProtocol`

`HidKeyboard`

`HidKeyboardState`

`HidConsumerControl`

`HidSystemControl`

`McuFlashMode`

`PixelAnimationControl`

`PixelAnimationIndex`

`PixelFadeControl`

`PixelFadeLayer`

`PixelFadeSet`

`PixelGammaControl`

`PixelLedControl`

`PixelTest`

`HidioOpenUrl`

`HidioUnicodeString`

`HidioUnicodeState`

pub fn generate(
&self,
event: TriggerEvent,
_loop_condition_lookup: &[u32]
) -> CapabilityRun

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,