osdp 0.2.1

Pure-Rust, no_std-friendly implementation of the SIA Open Supervised Device Protocol (OSDP) v2.2
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

//! `osdp_OUT` (`0x68`) — output control.
//!
//! # Spec: §6.8, Table 14
//!
//! Body is a sequence of 4-byte records, one per output to drive:
//!
//! ```text
//! +----------+-----------+--------------+--------------+
//! | output#  | code      | timer LSB    | timer MSB    |
//! +----------+-----------+--------------+--------------+
//! ```

use crate::error::Error;
use alloc::vec::Vec;

/// Output control codes — Table 14.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[repr(u8)]
#[allow(missing_docs)]
pub enum OutputControlCode {
    Nop = 0x00,
    PermanentOffAbortTimed = 0x01,
    PermanentOnAbortTimed = 0x02,
    PermanentOffAllowTimed = 0x03,
    PermanentOnAllowTimed = 0x04,
    TemporaryOnResume = 0x05,
    TemporaryOffResume = 0x06,
}

impl OutputControlCode {
    /// Parse from raw byte.
    pub const fn from_byte(b: u8) -> Result<Self, Error> {
        Ok(match b {
            0x00 => Self::Nop,
            0x01 => Self::PermanentOffAbortTimed,
            0x02 => Self::PermanentOnAbortTimed,
            0x03 => Self::PermanentOffAllowTimed,
            0x04 => Self::PermanentOnAllowTimed,
            0x05 => Self::TemporaryOnResume,
            0x06 => Self::TemporaryOffResume,
            _ => {
                return Err(Error::MalformedPayload {
                    code: 0x68,
                    reason: "unknown output control code",
                });
            }
        })
    }

    /// Raw byte value.
    pub const fn as_byte(self) -> u8 {
        self as u8
    }
}

/// Single output record.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct OutputRecord {
    /// Output number on the PD.
    pub output: u8,
    /// Control code.
    pub code: OutputControlCode,
    /// Timer in 100 ms increments (16-bit LE).
    pub timer: u16,
}

impl OutputRecord {
    /// Wire size of one record.
    pub const WIRE_LEN: usize = 4;
}

/// `osdp_OUT` body.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OutputControl {
    /// Records (one per output).
    pub records: Vec<OutputRecord>,
}

impl OutputControl {
    /// New, with the given records.
    pub fn new(records: Vec<OutputRecord>) -> Self {
        Self { records }
    }

    /// Encode.
    pub fn encode(&self) -> Result<Vec<u8>, Error> {
        if self.records.is_empty() {
            return Err(Error::MalformedPayload {
                code: 0x68,
                reason: "OUT requires at least one record",
            });
        }
        let mut out = Vec::with_capacity(self.records.len() * OutputRecord::WIRE_LEN);
        for r in &self.records {
            out.push(r.output);
            out.push(r.code.as_byte());
            out.extend_from_slice(&r.timer.to_le_bytes());
        }
        Ok(out)
    }

    /// Decode.
    pub fn decode(data: &[u8]) -> Result<Self, Error> {
        if data.is_empty() || data.len() % OutputRecord::WIRE_LEN != 0 {
            return Err(Error::MalformedPayload {
                code: 0x68,
                reason: "OUT payload must be a multiple of 4 bytes",
            });
        }
        let mut records = Vec::with_capacity(data.len() / OutputRecord::WIRE_LEN);
        for chunk in data.chunks_exact(OutputRecord::WIRE_LEN) {
            records.push(OutputRecord {
                output: chunk[0],
                code: OutputControlCode::from_byte(chunk[1])?,
                timer: u16::from_le_bytes([chunk[2], chunk[3]]),
            });
        }
        Ok(Self { records })
    }
}