bm_serial/bm_serial_messages.h at develop · wavespotter/bm_serial · GitHub

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
#pragma once

#include <stdbool.h>
#include <stdint.h>

typedef enum {
  BM_SERIAL_DEBUG = 0x00,
  BM_SERIAL_ACK = 0x01,

  BM_SERIAL_PUB = 0x02,
  BM_SERIAL_SUB = 0x03,
  BM_SERIAL_UNSUB = 0x04,
  BM_SERIAL_LOG = 0x05,
  BM_SERIAL_NET_MSG = 0x06,
  BM_SERIAL_RTC_SET = 0x07,
  BM_SERIAL_SELF_TEST = 0x08,

  BM_SERIAL_DFU_START = 0x30,
  BM_SERIAL_DFU_CHUNK = 0x31,
  BM_SERIAL_DFU_RESULT = 0x32,
} bm_serial_message_t;

typedef struct {
  uint8_t type;
  uint8_t flags;
  uint16_t crc16;
  uint8_t payload[0];
} __attribute__ ((packed)) bm_serial_packet_t;

typedef struct {
  uint64_t node_id;
  uint16_t topic_len;
  uint8_t topic[0];
  // message goes after topic
  // len not included since we get the total len from COBS
} __attribute__ ((packed)) bm_serial_pub_header_t;

typedef struct {
  uint16_t topic_len;
  uint8_t topic[0];
} __attribute__ ((packed)) bm_serial_sub_unsub_header_t;

typedef struct {
  uint64_t node_id;

  // Will use later to signify if this should go out cellular/satellite or both
  uint8_t flags;
  uint8_t data[0];
} __attribute__ ((packed)) bm_serial_net_msg_header_t;

typedef struct {
  uint16_t year;
  uint8_t month;
  uint8_t day;
  uint8_t hour;
  uint8_t minute;
  uint8_t second;
  uint32_t us;
} __attribute__ ((packed)) bm_serial_time_t;

typedef struct {
  // Can be used to determine time source and other things
  uint32_t flags;

  bm_serial_time_t time;
} __attribute__ ((packed)) bm_serial_rtc_t;

typedef struct {
  // Node id of unit reporting test (leave blank for test request)
  uint64_t node_id;
  // Flags for self test result
  uint32_t result;
} __attribute__ ((packed)) bm_serial_self_test_t;

// DFU BELOW HERE.
typedef struct {
  // Node id of unit for update
  uint64_t node_id;
  // size of image to update
  uint32_t image_size;
  // size of chunks to send
  uint16_t chunk_size;
  // crc16
  uint16_t crc16;
  // major version
  uint8_t major_ver;
  // minor version
  uint8_t minor_ver;
  // filter for update
  uint32_t filter_key;
  // git hash
  uint32_t gitSHA;
} __attribute__ ((packed)) bm_serial_dfu_start_t;

#define DFU_CHUNK_NAK_BITFLAG (1<<31)
typedef struct {
  // offset from image start
  uint32_t offset;
  // data length
  uint32_t length;
  // data packet
  uint8_t data[0];
} __attribute__ ((packed)) bm_serial_dfu_chunk_t;

typedef struct {
  // Node id of unit reporting test (leave blank for test request)
  uint64_t node_id;
  // success of dfu
  bool success;
  // Errors for dfu result
  uint32_t dfu_status;
} __attribute__ ((packed)) bm_serial_dfu_finish_t;