ebds 0.4.2

Messages and related types for implementing the EBDS serial communication protocol
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

use crate::std;
use std::fmt;

use crate::MessageOps;

/// Extended Commands (Type 7): The extended commands utilize message type 7 to provide functionality outside of the standard
/// omnibus commands. The use of message type 7 is complicated by the fact that it can be used by either
/// the host or device at anytime.
///
/// Developers: add additional types from the specification as needed
#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ExtendedCommand {
    ExtendedBarcodeReply = 0x1,
    ExtendedNoteSpecification = 0x2,
    SetExtendedNoteInhibits = 0x3,
    SetEscrowTimeout = 0x4,
    QueryValueTable = 0x6,
    NoteRetrieved = 0xb,
    AdvancedBookmark = 0xd,
    ClearAuditDataRequest = 0x1d,
    Reserved = 0xff,
}

impl From<u8> for ExtendedCommand {
    fn from(b: u8) -> Self {
        match b {
            0x1 => ExtendedCommand::ExtendedBarcodeReply,
            0x2 => ExtendedCommand::ExtendedNoteSpecification,
            0x3 => ExtendedCommand::SetExtendedNoteInhibits,
            0x4 => ExtendedCommand::SetEscrowTimeout,
            0x6 => ExtendedCommand::QueryValueTable,
            0xb => ExtendedCommand::NoteRetrieved,
            0xd => ExtendedCommand::AdvancedBookmark,
            0x1d => ExtendedCommand::ClearAuditDataRequest,
            // Missing values are either specified and unneeded, or unspecified and RFU
            _ => ExtendedCommand::Reserved,
        }
    }
}

impl From<ExtendedCommand> for u8 {
    fn from(e: ExtendedCommand) -> Self {
        e as u8
    }
}

impl From<&ExtendedCommand> for u8 {
    fn from(e: &ExtendedCommand) -> Self {
        (*e).into()
    }
}

impl From<ExtendedCommand> for &'static str {
    fn from(e: ExtendedCommand) -> Self {
        match e {
            ExtendedCommand::ExtendedBarcodeReply => "ExtendedBarcodeReply",
            ExtendedCommand::ExtendedNoteSpecification => "ExtendedNoteSpecification",
            ExtendedCommand::SetExtendedNoteInhibits => "SetExtendedNoteInhibits",
            ExtendedCommand::SetEscrowTimeout => "SetEscrowTimeout / ExtendedCoupon",
            ExtendedCommand::QueryValueTable => "QueryValueTable",
            ExtendedCommand::NoteRetrieved => "NoteRetrieved",
            ExtendedCommand::AdvancedBookmark => "AdvancedBookmark",
            ExtendedCommand::ClearAuditDataRequest => "ClearAuditDataRequest",
            ExtendedCommand::Reserved => "Reserved",
        }
    }
}

impl From<&ExtendedCommand> for &'static str {
    fn from(e: &ExtendedCommand) -> Self {
        (*e).into()
    }
}

impl fmt::Display for ExtendedCommand {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, r#""{}""#, <&str>::from(self))
    }
}

pub mod index {
    pub const SUBTYPE: usize = 3;
}

pub trait ExtendedCommandOps: MessageOps {
    /// Get the extended command sub-type
    fn extended_command(&self) -> ExtendedCommand {
        self.buf()[index::SUBTYPE].into()
    }

    /// Set the extended command sub-type
    fn set_extended_command(&mut self, ext_cmd: ExtendedCommand) {
        self.buf_mut()[index::SUBTYPE] = ext_cmd.into();
    }
}