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

use crate::{
    impl_command_display, impl_command_ops, impl_default, impl_message_from_buf, impl_message_ops,
    len::HOST_PROTOCOL_VERSION_COMMAND, CommandOps, MessageOps, MessageType, ProtocolVersion,
};

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

/// HostProtocolVersion - Command (0x0A)
///
/// Single byte command enables the unit. It will now respond to and execute commands.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct HostProtocolVersionCommand {
    buf: [u8; HOST_PROTOCOL_VERSION_COMMAND],
}

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

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

        msg
    }

    /// Gets the [ProtocolVersion].
    pub fn version(&self) -> ProtocolVersion {
        self.buf[index::PROTOCOL_VERSION].into()
    }

    /// Sets the [ProtocolVersion].
    pub fn set_version(&mut self, version: ProtocolVersion) {
        self.buf[index::PROTOCOL_VERSION] = version.into();
    }

    /// Builder function that sets the [ProtocolVersion].
    pub fn with_version(mut self, version: ProtocolVersion) -> Self {
        self.set_version(version);
        self
    }
}

impl_default!(HostProtocolVersionCommand);
impl_command_display!(HostProtocolVersionCommand);
impl_message_from_buf!(HostProtocolVersionCommand);
impl_message_ops!(HostProtocolVersionCommand);
impl_command_ops!(HostProtocolVersionCommand);