rmk 0.9.0

Keyboard firmware written in Rust
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

//! Battery related events
//!
//! This module contains all battery-related events:
//! - Battery ADC reading events
//! - Charging state events
//! - Battery status events (computed from ADC and charging state)

use postcard::experimental::max_size::MaxSize;
use rmk_macro::event;
use rmk_types::battery::BatteryStatus;
use serde::{Deserialize, Serialize};

/// Battery adc read value
#[event(
    channel_size = crate::BATTERY_ADC_EVENT_CHANNEL_SIZE,
    pubs = crate::BATTERY_ADC_EVENT_PUB_SIZE,
    subs = crate::BATTERY_ADC_EVENT_SUB_SIZE
)]
#[derive(Serialize, Deserialize, Clone, Debug, Copy, MaxSize)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct BatteryAdcEvent(pub u16);

/// Charging state changed event
#[event(
    channel_size = crate::CHARGING_STATE_EVENT_CHANNEL_SIZE,
    pubs = crate::CHARGING_STATE_EVENT_PUB_SIZE,
    subs = crate::CHARGING_STATE_EVENT_SUB_SIZE
)]
#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, MaxSize)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct ChargingStateEvent {
    pub charging: bool,
}

/// Battery status changed event, wraps [`BatteryStatus`].
#[event(channel_size = crate::BATTERY_STATUS_EVENT_CHANNEL_SIZE, pubs = crate::BATTERY_STATUS_EVENT_PUB_SIZE, subs = crate::BATTERY_STATUS_EVENT_SUB_SIZE)]
#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, MaxSize)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct BatteryStatusEvent(pub BatteryStatus);

impl_payload_wrapper!(BatteryStatusEvent, BatteryStatus);