ssp 0.5.4

Messages and related types for implementing the SSP/eSSP 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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::{len, std::fmt, CommandOps, MessageOps, MessageType};

mod index {
    pub const PAYOUT_OPTION: usize = 4;
}

mod bitmask {
    pub const OPTION: u8 = 0b11;
}

bitfield! {
    /// Option byte for the [EnablePayoutCommand](crate::EnablePayoutCommand) message.
    #[repr(C)]
    #[derive(Clone, Copy, Debug, Default, PartialEq)]
    pub struct EnablePayoutOption(u8);
    u8;
    /// Option bitfield zero, has different meaning based on device type.
    ///
    /// - `nv11`: `GIVE_VALUE_ON_STORED` - set to enable the value of the note stored to be given
    /// with the `Note Stored` event.
    /// - `smart payout`: `REQUIRE_FULL_STARTUP` - if set, the `Smart Payout` will return busy
    /// until it has fully completed the startup procedure.
    pub field_0, set_field_0: 0;
    /// Option bitfield one, has different meaning based on device type.
    ///
    /// - `nv11`: `NO_HOLD_NOTE_ON_PAYOUT` - set to enable the function of fully rejecting the
    /// dispensed banknote rather then holding it in the bezel.
    /// - `smart payout`: `OPTIMISE_FOR_PAYIN_SPEED` - if set, the `Smart Payout` will always move
    /// towards an empty slot when idle to try and ensure the shortest pay in speed possible.
    pub field_1, set_field_1: 1;
}

impl From<u8> for EnablePayoutOption {
    fn from(val: u8) -> Self {
        Self(val & bitmask::OPTION)
    }
}

impl From<&EnablePayoutOption> for u8 {
    fn from(val: &EnablePayoutOption) -> Self {
        val.0
    }
}

impl From<EnablePayoutOption> for u8 {
    fn from(val: EnablePayoutOption) -> Self {
        (&val).into()
    }
}

impl fmt::Display for EnablePayoutOption {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let f0 = self.field_0();
        let f1 = self.field_1();

        write!(f, r#"{{"field_0": {f0}, "field_1": {f1}}}"#)
    }
}

/// EnablePayout - Command (0x5C)
///
/// A command to enable the attached payout device for storing/paying out notes.
///
/// A successful enable will return OK.
///
/// If there is a problem the reply will be generic response `COMMAND_CANNOT_BE_PROCESSED`, followed by an error code.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct EnablePayoutCommand {
    buf: [u8; len::ENABLE_PAYOUT_COMMAND],
}

impl EnablePayoutCommand {
    /// Creates a new [EnablePayoutCommand] message.
    pub fn new() -> Self {
        let mut msg = Self {
            buf: [0u8; len::ENABLE_PAYOUT_COMMAND],
        };

        msg.init();
        msg.set_command(MessageType::EnablePayout);

        msg
    }

    /// Gets the [EnablePayoutOption].
    pub fn option(&self) -> EnablePayoutOption {
        self.buf[index::PAYOUT_OPTION].into()
    }

    /// Sets the [EnablePayoutOption].
    pub fn set_option(&mut self, option: EnablePayoutOption) {
        self.buf[index::PAYOUT_OPTION] = option.into();
    }

    /// Builder function that sets the [EnablePayoutOption].
    pub fn with_option(mut self, option: EnablePayoutOption) -> Self {
        self.set_option(option);
        self
    }
}

impl_default!(EnablePayoutCommand);
impl_message_from_buf!(EnablePayoutCommand);
impl_message_ops!(EnablePayoutCommand);
impl_command_ops!(EnablePayoutCommand);

impl fmt::Display for EnablePayoutCommand {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{{")?;
        write!(f, r#""stx": "0x{:02x}", "#, self.stx())?;
        write!(f, r#""sequence_id": {}, "#, self.sequence_id())?;
        write!(f, r#""len": "0x{:02x}", "#, self.data_len())?;
        write!(f, r#""command": {}, "#, self.command())?;
        write!(f, r#""option": {}, "#, self.option())?;
        write!(f, r#""checksum": "0x{:04x}""#, self.checksum())?;
        write!(f, "}}")
    }
}