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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use crate::{impl_default, std::fmt};

use super::*;

/// Container structure for configuring device barcode readers.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct BarcodeConfiguration {
    hardware_status: Option<BarcodeHardwareStatus>,
    enabled_status: BarcodeEnabledStatus,
    format: BarcodeFormat,
    chars: BarcodeCharacters,
}

impl BarcodeConfiguration {
    /// Creates a new [BarcodeConfiguration].
    pub const fn new() -> Self {
        Self {
            hardware_status: None,
            enabled_status: BarcodeEnabledStatus::None,
            format: BarcodeFormat::None,
            chars: BarcodeCharacters(0),
        }
    }

    /// Gets the [BarcodeHardwareStatus](crate::BarcodeHardwareStatus).
    pub fn hardware_status(&self) -> BarcodeHardwareStatus {
        if let Some(status) = self.hardware_status {
            status
        } else {
            BarcodeHardwareStatus::None
        }
    }

    /// Sets the [BarcodeHardwareStatus](crate::BarcodeHardwareStatus).
    pub fn set_hardware_status(&mut self, status: BarcodeHardwareStatus) {
        self.hardware_status = Some(status);
    }

    /// Unsets the [BarcodeHardwareStatus](crate::BarcodeHardwareStatus).
    pub fn unset_hardware_status(&mut self) {
        self.hardware_status = None;
    }

    /// Gets the [BarcodeEnabledStatus](crate::BarcodeEnabledStatus).
    pub fn enabled_status(&self) -> BarcodeEnabledStatus {
        self.enabled_status
    }

    /// Sets the [BarcodeEnabledStatus](crate::BarcodeEnabledStatus).
    pub fn set_enabled_status(&mut self, status: BarcodeEnabledStatus) {
        self.enabled_status = status;
    }

    /// Gets the [BarcodeFormat].
    pub fn format(&self) -> BarcodeFormat {
        self.format
    }

    /// Sets the [BarcodeFormat].
    pub fn set_format(&mut self, format: BarcodeFormat) {
        self.format = format;
    }

    /// Gets the number of [BarcodeCharacters].
    pub fn num_characters(&self) -> BarcodeCharacters {
        self.chars
    }

    /// Sets the number of [BarcodeCharacters].
    pub fn set_num_characters(&mut self, chars: BarcodeCharacters) {
        self.chars = chars;
    }

    /// Gets the [BarcodeConfiguration] as a byte array.
    pub fn as_bytes(&self) -> [u8; 4] {
        [
            self.hardware_status().into(),
            self.enabled_status().into(),
            self.format().into(),
            self.num_characters().into(),
        ]
    }
}

impl From<&[u8]> for BarcodeConfiguration {
    fn from(val: &[u8]) -> Self {
        match val.len() {
            0..=2 => Self::new(),
            3 => Self {
                hardware_status: None,
                enabled_status: val[0].into(),
                format: val[1].into(),
                chars: val[2].into(),
            },
            _ => Self {
                hardware_status: Some(val[0].into()),
                enabled_status: val[1].into(),
                format: val[2].into(),
                chars: val[3].into(),
            },
        }
    }
}

impl<const N: usize> From<[u8; N]> for BarcodeConfiguration {
    fn from(val: [u8; N]) -> Self {
        val.as_ref().into()
    }
}

impl<const N: usize> From<&[u8; N]> for BarcodeConfiguration {
    fn from(val: &[u8; N]) -> Self {
        val.as_ref().into()
    }
}

impl From<&BarcodeConfiguration> for [u8; 4] {
    fn from(val: &BarcodeConfiguration) -> Self {
        val.as_bytes()
    }
}

impl fmt::Display for BarcodeConfiguration {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let en_status = self.enabled_status();
        let format = self.format();
        let chars = self.num_characters();

        if let Some(hd_status) = self.hardware_status {
            write!(f, "Barcode hardware status: {hd_status} | Barcode enabled status: {en_status} | Barcode format: {format} | Number of barcode characters: {chars}")
        } else {
            write!(f, "Barcode enabled status: {en_status} | Barcode format: {format} | Number of barcode characters: {chars}")
        }
    }
}

impl_default!(BarcodeConfiguration);