bm_serial/bm_serial.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
#pragma once

#include <stdint.h>
#include <stdio.h>
#include "bm_serial_messages.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  // Function used to transmit data over the wire
  bool (*tx_fn)(const uint8_t *buff, size_t len);

  // Function called when published data is received
  bool (*pub_fn)(const char *topic, uint16_t topic_len, uint64_t node_id, const uint8_t *payload, size_t len);

  // Function called when a subscribe request is received
  bool (*sub_fn)(const char *topic, uint16_t topic_len);

  // Function called when an unsusbscribe request is received
  bool (*unsub_fn)(const char *topic, uint16_t topic_len);

  // Function called when a log request is received
  bool (*log_fn)(uint64_t node_id, const uint8_t *data, size_t len);

  // Function called when a log request is received
  bool (*debug_fn)(const uint8_t *data, size_t len);

  // Function called when a message to send over wireless network is received
  bool (*net_msg_fn)(uint64_t node_id, const uint8_t *data, size_t len);

  // Function called to set RTC on device
  bool (*rtc_set_fn)(bm_serial_time_t *time);

  // Function called when self test is received.
  bool (*self_test_fn)(uint64_t node_id, uint32_t result);

  // Function called when dfu start message is recieved.
  bool (*dfu_start_fn)(bm_serial_dfu_start_t *dfu_start);

  // Function called when a dfu chunk is recieved.
  bool (*dfu_chunk_fn)(uint32_t offset, size_t length, uint8_t * data);

  // Function called when a dfu end is received.
  bool (*dfu_end_fn)(uint64_t node_id, bool success, uint32_t err);
} bm_serial_callbacks_t;

typedef enum {
  BM_SERIAL_OK = 0,
  BM_SERIAL_NULL_BUFF = -1,
  BM_SERIAL_OVERFLOW = -2,
  BM_SERIAL_MISSING_CALLBACK = -3,
  BM_SERIAL_OUT_OF_MEMORY = -4,
  BM_SERIAL_TX_ERR = -5,
  BM_SERIAL_CRC_ERR = -6,
  BM_SERIAL_UNSUPPORTED_MSG = -7,
  BM_SERIAL_INVALID_TOPIC_LEN = -8,
  BM_SERIAL_INVALID_MSG_LEN = -9,

  BM_SERIAL_MISC_ERR,
} bm_serial_error_e;

void bm_serial_set_callbacks(bm_serial_callbacks_t *callbacks);
bm_serial_error_e bm_serial_process_packet(bm_serial_packet_t *packet, size_t len);
bm_serial_error_e bm_serial_tx(bm_serial_message_t type, const uint8_t *buff, size_t len);

bm_serial_error_e bm_serial_pub(uint64_t node_id, const char *topic, uint16_t topic_len, const uint8_t *data, uint16_t data_len);
bm_serial_error_e bm_serial_sub(const char *topic, uint16_t topic_len);
bm_serial_error_e bm_serial_unsub(const char *topic, uint16_t topic_len);
bm_serial_error_e bm_serial_set_rtc(bm_serial_time_t *time);
bm_serial_error_e bm_serial_send_self_test(uint64_t node_id, uint32_t result);

bm_serial_error_e bm_serial_dfu_send_start(bm_serial_dfu_start_t *dfu_start);
bm_serial_error_e bm_serial_dfu_send_chunk(uint32_t offset, size_t length, uint8_t * data);
bm_serial_error_e bm_serial_dfu_send_finish(uint64_t node_id, bool success, uint32_t status);

#ifdef __cplusplus
}
#endif