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

use crate::{
    impl_command_display, impl_command_ops, impl_default, impl_message_from_buf, impl_message_ops,
    len::FIRMWARE_HEADER_COMMAND, CommandOps, FirmwareHeader, MessageOps, Result,
};

mod index {
    pub const FIRMWARE_HEADER: usize = 3;
    pub const FIRMWARE_HEADER_END: usize = 131;
}

/// ProgramFirmware - Command (0x0B)
///
/// This two byte command prepares the unit for firmware programming.
///
/// The `FirmwareCode` field defines the type of programming.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct FirmwareHeaderCommand {
    buf: [u8; FIRMWARE_HEADER_COMMAND],
}

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

        msg.init();
        msg.set_firmware_header(&FirmwareHeader::new()).ok();

        msg
    }

    /// Creates a new [FirmwareHeaderCommand] message.
    pub fn create(header: &FirmwareHeader) -> Result<Self> {
        let mut msg = Self {
            buf: [0u8; FIRMWARE_HEADER_COMMAND],
        };

        msg.init();
        msg.set_firmware_header(header)?;

        Ok(msg)
    }

    /// Gets the [FirmwareCode] for the type of programming the unit expects.
    ///
    /// Example:
    ///
    /// ```
    /// # use ssp;
    /// let fw_cmd = ssp::FirmwareHeaderCommand::new();
    /// assert_eq!(fw_cmd.firmware_header().unwrap(), ssp::FirmwareHeader::new());
    /// ```
    pub fn firmware_header(&self) -> Result<FirmwareHeader> {
        FirmwareHeader::try_from(&self.buf[index::FIRMWARE_HEADER..index::FIRMWARE_HEADER_END])
    }

    /// Sets the [FirmwareHeader] for the type of programming the unit expects.
    ///
    /// Example:
    ///
    /// ```
    /// # use ssp;
    /// let mut fw_cmd = ssp::FirmwareHeaderCommand::new();
    /// let header = ssp::FirmwareHeader::new();
    /// fw_cmd.set_firmware_header(&header);
    /// assert_eq!(fw_cmd.firmware_header().unwrap(), header);
    /// ```
    pub fn set_firmware_header(&mut self, header: &FirmwareHeader) -> Result<()> {
        header.to_bytes(&mut self.buf[index::FIRMWARE_HEADER..index::FIRMWARE_HEADER_END])
    }
}

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