The friendly Operating System for the Internet of Things
xbee.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 INRIA
3  * Copyright (C) 2015-2016 Freie Universit├Ąt Berlin
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
23 #ifndef XBEE_H
24 #define XBEE_H
25 
26 #include <stdint.h>
27 
28 #include "mutex.h"
29 #include "xtimer.h"
30 #include "periph/uart.h"
31 #include "periph/gpio.h"
32 #include "net/netdev.h"
33 #include "net/ieee802154.h"
34 #include "net/gnrc/nettype.h"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
43 #ifdef MODULE_XBEE_ENCRYPTION
44 #define XBEE_MAX_PAYLOAD_LENGTH (95U)
45 #else
46 #define XBEE_MAX_PAYLOAD_LENGTH (100U)
47 #endif
48 
52 #define XBEE_MAX_PKT_LENGTH (115U)
53 
57 #define XBEE_MAX_RESP_LENGTH (16U)
58 
62 #define XBEE_MAX_TXHDR_LENGTH (14U)
63 
67 #ifdef MODULE_GNRC_SIXLOWPAN
68 #define XBEE_DEFAULT_PROTOCOL (GNRC_NETTYPE_SIXLOWPAN)
69 #else
70 #define XBEE_DEFAULT_PROTOCOL (GNRC_NETTYPE_UNDEF)
71 #endif
72 
76 #define XBEE_DEFAULT_PANID (IEEE802154_DEFAULT_PANID)
77 
81 #define XBEE_DEFAULT_CHANNEL (IEEE802154_DEFAULT_CHANNEL)
82 
91 #define XBEE_ADDR_FLAGS_LONG (0x80)
92 
103 typedef enum {
115 
119 typedef struct {
121  uint32_t br;
122  gpio_t pin_sleep;
124  gpio_t pin_reset;
126 } xbee_params_t;
127 
131 typedef struct {
132  /* netdev fields */
133  const struct netdev_driver *driver;
135  void* context;
136 #ifdef MODULE_NETSTATS_L2
137  netstats_t stats;
138 #endif
139  /* device driver specific fields */
141  uint8_t options;
142  uint8_t addr_flags;
143  uint8_t addr_short[2];
145  /* general variables for the UART RX state machine */
147  uint16_t int_size;
149  /* values for the UART TX state machine */
152  uint8_t cmd_buf[XBEE_MAX_RESP_LENGTH];
153  uint8_t tx_fid;
154  /* buffer and synchronization for command responses */
157  uint8_t resp_buf[XBEE_MAX_RESP_LENGTH];
158  uint16_t resp_count;
159  uint16_t resp_limit;
160  /* buffer and synchronization for incoming network packets */
161  uint8_t rx_buf[XBEE_MAX_PKT_LENGTH];
162  uint16_t rx_count;
163  uint16_t rx_limit;
164 } xbee_t;
165 
169 typedef struct {
170  uint8_t addr_len;
171  uint8_t bcast;
172  uint8_t rssi;
173  uint8_t src_addr[8];
174  uint8_t dst_addr[8];
175 } xbee_l2hdr_t;
176 
180 extern const netdev_driver_t xbee_driver;
181 
192 void xbee_setup(xbee_t *dev, const xbee_params_t *params);
193 
208 int xbee_build_hdr(xbee_t *dev, uint8_t *xhdr, size_t payload_len,
209  void *dst_addr, size_t addr_len);
210 
221 int xbee_parse_hdr(xbee_t *dev, const uint8_t *xhdr, xbee_l2hdr_t *l2hdr);
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 
227 #endif /* XBEE_H */
228 
#define XBEE_MAX_RESP_LENGTH
Maximum length of a command response.
Definition: xbee.h:57
Low-level UART peripheral driver interface definition.
waiting for the second byte (LSB) of the frame size field
Definition: xbee.h:107
eui64_t addr_long
own 802.15.4 long address
Definition: xbee.h:144
Structure to hold driver interface -> function mapping.
uint16_t resp_count
counter for ongoing transmission
Definition: xbee.h:158
xbee_params_t p
configuration parameters
Definition: xbee.h:140
uint32_t br
baudrate to use
Definition: xbee.h:121
Low-level GPIO peripheral driver interface definitions.
unsigned int uart_t
Define default UART type identifier.
Definition: uart.h:65
Definitions low-level network driver interface.
mutex_t tx_lock
mutex to allow only one transmission at a time
Definition: xbee.h:150
gpio_t pin_sleep
GPIO pin that is connected to the SLEEP pin set to GPIO_UNDEF if not used.
Definition: xbee.h:122
uint8_t addr_flags
address flags as defined above
Definition: xbee.h:142
uint8_t addr_len
L2 address length (SRC and DST)
Definition: xbee.h:170
Global statistics struct.
XBee device descriptor.
Definition: xbee.h:131
IEEE 802.15.4 header definitions.
void * context
ptr to network stack context
Definition: xbee.h:135
waiting for the frame type field
Definition: xbee.h:109
xbee_rx_state_t int_state
current state if the UART RX FSM
Definition: xbee.h:146
xbee_rx_state_t
States of the internal FSM for handling incoming UART frames.
Definition: xbee.h:103
uint8_t bcast
0 := unicast, 1:=broadcast
Definition: xbee.h:171
int xbee_parse_hdr(xbee_t *dev, const uint8_t *xhdr, xbee_l2hdr_t *l2hdr)
Extract IEEE802.15.4 L2 header information from the XBee header.
void(* netdev_event_cb_t)(netdev_t *dev, netdev_event_t event)
Event callback for signaling event to upper layers.
xtimer interface definitions
handling incoming data when receiving radio packets
Definition: xbee.h:112
uint16_t resp_limit
size RESP frame in transferred
Definition: xbee.h:159
RIOT synchronization API.
uint16_t rx_limit
size RX frame transferred
Definition: xbee.h:163
#define XBEE_MAX_PKT_LENGTH
Maximum packet length, including XBee API frame overhead.
Definition: xbee.h:52
waiting for the first byte (MSB) of the frame size field
Definition: xbee.h:105
int xbee_build_hdr(xbee_t *dev, uint8_t *xhdr, size_t payload_len, void *dst_addr, size_t addr_len)
Put together the internal proprietary XBee header.
uint8_t rssi
RSSI value.
Definition: xbee.h:172
uart_t uart
UART interfaced the device is connected to.
Definition: xbee.h:120
uint8_t options
options field
Definition: xbee.h:141
netdev_event_cb_t event_callback
callback for device events
Definition: xbee.h:134
uint8_t tx_fid
TX frame ID.
Definition: xbee.h:153
uint16_t rx_count
counter for ongoing transmission
Definition: xbee.h:162
Mutex structure.
Definition: mutex.h:36
Data type to represent an EUI-64.
Definition: eui64.h:37
Configuration parameters for XBee devices.
Definition: xbee.h:119
const netdev_driver_t xbee_driver
Reference to the XBee driver interface.
void xbee_setup(xbee_t *dev, const xbee_params_t *params)
Prepare the given Xbee device.
const struct netdev_driver * driver
ptr to that driver's interface.
Definition: xbee.h:133
mutex_t resp_lock
mutex for waiting for AT command response frames
Definition: xbee.h:155
gpio_t pin_reset
GPIO pin that is connected to the STATUS pin set to GPIO_UNDEF if not used.
Definition: xbee.h:124
Protocol type definitions.
uint16_t int_size
temporary space for parsing the frame size
Definition: xbee.h:147
handling incoming data for AT command responses
Definition: xbee.h:110
waiting for the beginning of a new frame
Definition: xbee.h:104
Data structure for extraction L2 information of received packets.
Definition: xbee.h:169