Enum kll_core::CapabilityRun

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

CapabilityRun Used to run capabilities rather than map them out in a result guide

Variants

NoOp

Fields

state: CapabilityEvent

No-op / None action 4 bytes

Rotate

Fields

state: CapabilityEvent

index: u8

increment: i8

Rotation event trigger 6 bytes

LayerClear

Fields

state: CapabilityEvent

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

LayerState

Fields

state: CapabilityEvent

layer: u8

layer_state: State

Updates layer to the specified state 6 bytes

LayerRotate

Fields

state: CapabilityEvent

direction: Direction

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

HidProtocol

Fields

state: CapabilityEvent

mode: Protocol

HID Protocol Mode 5 bytes

HidKeyboard

Fields

state: CapabilityEvent

id: Keyboard

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

HidKeyboardState

Fields

state: CapabilityEvent

id: Keyboard

key_state: State

USB HID keyboard event Force state event 6 bytes

HidConsumerControl

Fields

state: CapabilityEvent

id: ConsumerControl

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

HidSystemControl

Fields

state: CapabilityEvent

id: SystemControl

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

McuFlashMode

Fields

state: CapabilityEvent

Enter Flash Mode Usually jumps to the bootloader 4 bytes

HidLed

Fields

state: CapabilityEvent

id: LedIndicator

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

PixelAnimationControl

Fields

state: CapabilityEvent

mode: AnimationControl

Overall animation control 5 bytes

PixelAnimationIndex

Fields

state: CapabilityEvent

index: u16

Activates the given indexed Animation 6 bytes

PixelFadeControl

Fields

state: CapabilityEvent

profile: u8

command: FadeCommand

arg: u8

Fade control 7 bytes

PixelFadeLayer

Fields

state: CapabilityEvent

layer: u8

Layer fade 5 bytes

PixelFadeSet

Fields

state: CapabilityEvent

profile: u8

config: u8

period: u8

Fade set profile 7 bytes

PixelGammaControl

Fields

state: CapabilityEvent

mode: GammaControl

Enable/Disable/Toggle gamma correction 5 bytes

PixelLedControl

Fields

state: CapabilityEvent

mode: LedControl

amount: u8

LED Control 6 bytes

PixelTest

Fields

state: CapabilityEvent

test: PixelTest

index: u16

Pixel test 7 bytes

Analog

Fields

state: CapabilityEvent

Analog Event Always a passthrough event 4 bytes

HidioOpenUrl

Fields

state: CapabilityEvent

index: u16

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

HidioUnicodeString

Fields

state: CapabilityEvent

index: u16

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

HidioUnicodeState

Fields

state: CapabilityEvent

unicode: char

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

Implementations

impl CapabilityRun

pub fn state(&self) -> CapabilityEvent

Trait Implementations

impl Clone for CapabilityRun

fn clone(&self) -> CapabilityRun

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityRun

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

Formats the value using the given formatter.

impl From<Capability> for CapabilityRun

Convert Capability to CapabilityRun Used for mainly for kll validation

fn from(cap: Capability) -> 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 Hash for CapabilityRun

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<CapabilityRun> for CapabilityRun

fn eq(&self, other: &CapabilityRun) -> 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 CapabilityRun

impl Eq for CapabilityRun

impl StructuralEq for CapabilityRun

impl StructuralPartialEq for CapabilityRun