mcumgr_toolkit/
lib.rs

1#![deny(missing_docs)]
2#![deny(unreachable_pub)]
3#![forbid(unsafe_code)]
4#![doc = include_str!("../README.md")]
5#![doc(issue_tracker_base_url = "https://github.com/Finomnis/mcumgr-toolkit/issues")]
6// That's just a bad lint, in many cases I want two ifs for readability
7#![allow(clippy::collapsible_if)]
8
9/// A high-level client for Zephyr's MCUmgr SMP functionality
10pub mod client;
11pub use client::MCUmgrClient;
12
13mod errno;
14pub use errno::Errno;
15
16/// [MCUmgr command group](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_protocol.html#specifications-of-management-groups-supported-by-zephyr) definitions
17pub mod commands;
18
19/// [SMP protocol layer](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_protocol.html) implementation
20pub mod connection;
21
22/// [SMP transport layer](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_transport.html) implementation
23pub mod transport;
24
25/// Zephyr SMP error definitions
26pub mod smp_errors;
27
28/// Bootloader related definitions
29pub mod bootloader;
30
31/// MCUboot specific algorithms
32pub mod mcuboot;
33
34/// See [`enum mcumgr_group_t`](https://docs.zephyrproject.org/latest/doxygen/html/mgmt__defines_8h.html).
35#[derive(strum::FromRepr, strum::Display, Debug, Copy, Clone, PartialEq, Eq)]
36#[repr(u16)]
37#[allow(non_camel_case_types)]
38#[allow(missing_docs)]
39pub enum MCUmgrGroup {
40    MGMT_GROUP_ID_OS = 0,
41    MGMT_GROUP_ID_IMAGE,
42    MGMT_GROUP_ID_STAT,
43    MGMT_GROUP_ID_SETTINGS,
44    MGMT_GROUP_ID_LOG,
45    MGMT_GROUP_ID_CRASH,
46    MGMT_GROUP_ID_SPLIT,
47    MGMT_GROUP_ID_RUN,
48    MGMT_GROUP_ID_FS,
49    MGMT_GROUP_ID_SHELL,
50    MGMT_GROUP_ID_ENUM,
51    ZEPHYR_MGMT_GRP_BASIC = 63,
52    MGMT_GROUP_ID_PERUSER = 64,
53}
54
55impl MCUmgrGroup {
56    /// Converts a raw group id to a string
57    pub fn group_id_to_string(group_id: u16) -> String {
58        const PERUSER: MCUmgrGroup = MCUmgrGroup::MGMT_GROUP_ID_PERUSER;
59        if group_id < PERUSER as u16 {
60            if let Some(group_enum) = Self::from_repr(group_id) {
61                format!("{group_enum}")
62            } else {
63                format!("MGMT_GROUP_ID_UNKNOWN({group_id})")
64            }
65        } else {
66            format!("{PERUSER}({group_id})")
67        }
68    }
69}
70
71/// The default timeout used by this crate
72pub const DEFAULT_TIMEOUT_MS: u64 = 1000;
73
74/// The default retry count used by this crate
75pub const DEFAULT_RETRIES: u8 = 5;
mcumgr_toolkit/lib.rs

mcumgr_toolkit/
lib.rs
