oak-type 0.1.0-alpha

Open Analog Keyboard
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

//! Behaviors are things that the device can do, either internally in the firmware, or externally.
//!
//! Examples:
//! * Changing a layer
//! * Sending a character to a host

/// Used for outputs from the device such as sending a character to the host, making a sound,
/// sending a message to a display, or changing the state of an led
pub mod outputs
{
    pub mod hid;

    /// Marker trait indicating that the implementing struct can be used as an Output Configuration
    ///  (OC) which will output a behavior of type B
    pub trait OutputConfig<B> {}

    /// Defines (typically at the hardware level) how an output behavior is implemented
    ///
    /// For example:
    /// * For an output configuration _OC_, what does the hardware do to _do the behavior B_?
    /// * For an output configuration _HID_, what does the hardware do to _send an "a" to the host_?
    pub trait OutputConfigurator<OC, B>
        where
            OC: OutputConfig<B>,
    {
        fn configure(&self, out_conf: OC) -> fn(B) -> ();
    }
}

/// Used for actions that affect how the device is running, such as changing a layer or resetting
pub mod internal
{
    pub mod layer_switch;
}