kll-core 0.1.8

KLL state-machine implementation focused on no_std embedded/bare-metal targets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

// Copyright 2021-2022 Jacob Alexander
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

use crate::trigger::Phro;
use crate::{error, warn};
use crate::{CapabilityEvent, CapabilityRun, TriggerEvent};

/// Converts the passed `TriggerEvent` into a `CapabilityRun::HidKeyboard`
///
/// # Arguments
///
/// * `event`: The TriggerEvent to convert.  This should always be `TriggerEvent::Switch`,
/// if it is anything else a CapabilityRun::NoOp will be returned
///
/// returns: CapabilityRun::HidKeyboard
pub(super) fn convert(event: TriggerEvent) -> CapabilityRun {
    if let TriggerEvent::Switch { state, index, .. } = event {
        let key = index.into();
        match state {
            Phro::Press => CapabilityRun::HidKeyboard {
                state: CapabilityEvent::Initial,
                id: key,
            },
            Phro::Hold => CapabilityRun::HidKeyboard {
                state: CapabilityEvent::Any,
                id: key,
            },
            Phro::Release => CapabilityRun::HidKeyboard {
                state: CapabilityEvent::Last,
                id: key,
            },
            Phro::Off => CapabilityRun::HidKeyboard {
                state: CapabilityEvent::None,
                id: key,
            },
            _ => {
                warn!("Unexpected state {:?}", state);
                CapabilityRun::NoOp {
                    state: CapabilityEvent::None,
                }
            }
        }
    } else {
        error!("Unexpected event {:?}", event);
        CapabilityRun::NoOp {
            state: CapabilityEvent::None,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::converters::switch::convert;
    use crate::trigger::{Aodo, Phro};
    use crate::{CapabilityEvent, CapabilityRun, TriggerEvent};
    use kll_hid::Keyboard;

    #[test]
    fn convert_press_returns_an_initial_capability_event() {
        let a = TriggerEvent::Switch {
            state: Phro::Press,
            index: Keyboard::A.into(),
            last_state: 0,
        };
        check_switch_results(convert(a), CapabilityEvent::Initial, Keyboard::A);
    }

    #[test]
    fn convert_hold_returns_an_any_event() {
        let a = TriggerEvent::Switch {
            state: Phro::Hold,
            index: Keyboard::A.into(),
            last_state: 0,
        };
        check_switch_results(convert(a), CapabilityEvent::Any, Keyboard::A);
    }

    #[test]
    fn convert_release_returns_a_last_capability_event() {
        let a = TriggerEvent::Switch {
            state: Phro::Release,
            index: Keyboard::A.into(),
            last_state: 0,
        };
        check_switch_results(convert(a), CapabilityEvent::Last, Keyboard::A);
    }

    #[test]
    fn convert_off_returns_a_none_capability_event() {
        let a = TriggerEvent::Switch {
            state: Phro::Off,
            index: Keyboard::A.into(),
            last_state: 0,
        };
        check_switch_results(convert(a), CapabilityEvent::None, Keyboard::A);
    }

    #[test]
    fn convert_unexpected_state_type_returns_noop() {
        let a = TriggerEvent::Switch {
            state: Phro::Passthrough,
            index: Keyboard::A.into(),
            last_state: 0,
        };
        let result = convert(a);

        assert_eq!(
            result,
            CapabilityRun::NoOp {
                state: CapabilityEvent::None
            }
        )
    }

    #[test]
    fn convert_unexpected_trigger_event_type_returns_noop() {
        let a = TriggerEvent::Sleep {
            state: Aodo::Activate,
            last_state: 0,
        };
        let result = convert(a);

        assert_eq!(
            result,
            CapabilityRun::NoOp {
                state: CapabilityEvent::None
            }
        )
    }

    fn check_switch_results(
        event: CapabilityRun,
        expected_event: CapabilityEvent,
        expected_key: Keyboard,
    ) {
        if let CapabilityRun::HidKeyboard { state, id } = event {
            assert_eq!(state, expected_event);
            assert_eq!(id, expected_key);
        } else {
            panic!("process_state failed to return a HidKeyboard")
        }
    }
}