ccsds_primary_header 0.15.0

Implementation of the CCSDS Primary Header for space applications
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

extern crate ccsds_primary_header;

use ccsds_primary_header::primary_header::*;


fn main() {
    // If we have the bytes for a primary header from a file, socket, or some other source,
    // we can cast it read and write its fields using the PrimaryHeader struct

    // This is a typical CCSDS Primary Header for a command with a secondary header,
    // 4 bytes of data section, unsegmented, with a sequence count of 1.
    let bytes : [u8;6] = [ 0x18, 0x10, 0xC0, 0x01, 0x00, 0x03 ];
    println!("starting bytes {:02X} {:02X} {:02X} {:02X} {:02X} {:02X}",
             bytes[0], bytes[1], bytes[2],
             bytes[3], bytes[4], bytes[5]);
    
    unsafe {
        let pri_header = std::mem::transmute::<[u8;6], PrimaryHeader>(bytes);

        let pri_header_new = PrimaryHeader::new(bytes);

        assert!(pri_header == pri_header_new);

        // CCSDS version is currently always 0
        assert!(pri_header.control.version() == 0);

        // Packet type is command
        assert!(pri_header.control.packet_type() == PacketType::Command);

        // Secondary header is present in this packet
        assert!(pri_header.control.secondary_header_flag() == SecondaryHeaderFlag::Present);

        // APID is 16 (0x10)
        assert!(pri_header.control.apid() == 16);

        // Unsegmented packet
        assert!(pri_header.sequence.sequence_type() == SeqFlag::Unsegmented);

        // Sequence count of 1
        assert!(pri_header.sequence.sequence_count() == 1);

        // Packet length field of 3
        assert!(pri_header.length.length_field() == 3);

        // Total packet length is 10 (length field + size of header + 1) as per the CCSDS
        // standard.
        assert!(pri_header.packet_length() == 10);
    }

    // We can also lay down a packet header with field setters.
    // We will build up the same packet that we have above, but using PrimaryHeader
    // rather then laying out the bytes in a [u8;6];
    let mut pri_header : PrimaryHeader = Default::default();

    pri_header.control.set_version(0);
    pri_header.control.set_packet_type(PacketType::Command);
    pri_header.control.set_secondary_header_flag(SecondaryHeaderFlag::Present);
    pri_header.control.set_apid(16);

    pri_header.sequence.set_sequence_type(SeqFlag::Unsegmented);
    pri_header.sequence.set_sequence_count(1);

    // you can also set the packet length with pri_header.set_packet_length(4), which
    // accounts for the primary header size and the 1 byte minimum size defined in the standard.
    pri_header.length.set_length_field(3);
    
    unsafe {
        let bytes : [u8;6] = std::mem::transmute::<PrimaryHeader, [u8;6]>(pri_header);
        println!("ending bytes   {:02X} {:02X} {:02X} {:02X} {:02X} {:02X}",
                 bytes[0], bytes[1], bytes[2],
                 bytes[3], bytes[4], bytes[5]);
    }
}