Loading...
Searching...
No Matches
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 "periph/uart.h"
30#include "periph/gpio.h"
31#include "net/netdev.h"
32#include "net/ieee802154.h"
33#include "net/gnrc/nettype.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
42#ifdef MODULE_XBEE_ENCRYPTION
43#define XBEE_MAX_PAYLOAD_LENGTH (95U)
44#else
45#define XBEE_MAX_PAYLOAD_LENGTH (100U)
46#endif
47
51#define XBEE_MAX_PKT_LENGTH (115U)
52
56#define XBEE_MAX_RESP_LENGTH (16U)
57
61#define XBEE_MAX_TXHDR_LENGTH (14U)
62
66#ifdef MODULE_GNRC_SIXLOWPAN
67#define XBEE_DEFAULT_PROTOCOL (GNRC_NETTYPE_SIXLOWPAN)
68#else
69#define XBEE_DEFAULT_PROTOCOL (GNRC_NETTYPE_UNDEF)
70#endif
71
75#define XBEE_DEFAULT_PANID (CONFIG_IEEE802154_DEFAULT_PANID)
76
80#define XBEE_DEFAULT_CHANNEL (CONFIG_IEEE802154_DEFAULT_CHANNEL)
81
90#define XBEE_ADDR_FLAGS_LONG (0x80)
112
116typedef struct {
118 uint32_t br;
119 gpio_t pin_sleep;
121 gpio_t pin_reset;
124
128typedef struct {
129 /* netdev fields */
130 const struct netdev_driver *driver;
132 void* context;
133 /* device driver specific fields */
135 uint8_t options;
136 uint8_t addr_flags;
137 uint8_t addr_short[2];
139 /* general variables for the UART RX state machine */
141 uint16_t int_size;
143 /* values for the UART TX state machine */
146 uint8_t cmd_buf[XBEE_MAX_RESP_LENGTH];
147 uint8_t tx_fid;
148 /* buffer and synchronization for command responses */
151 uint8_t resp_buf[XBEE_MAX_RESP_LENGTH];
152 uint16_t resp_count;
153 uint16_t resp_limit;
154 /* buffer and synchronization for incoming network packets */
155 uint8_t rx_buf[XBEE_MAX_PKT_LENGTH];
156 uint16_t rx_count;
157 uint16_t rx_limit;
158} xbee_t;
159
163typedef struct {
164 uint8_t addr_len;
165 uint8_t bcast;
166 uint8_t rssi;
167 uint8_t src_addr[8];
168 uint8_t dst_addr[8];
170
174extern const netdev_driver_t xbee_driver;
175
186void xbee_setup(xbee_t *dev, const xbee_params_t *params);
187
202int xbee_build_hdr(xbee_t *dev, uint8_t *xhdr, size_t payload_len,
203 void *dst_addr, size_t addr_len);
204
215int xbee_parse_hdr(xbee_t *dev, const uint8_t *xhdr, xbee_l2hdr_t *l2hdr);
216
217#ifdef __cplusplus
218}
219#endif
220
221#endif /* XBEE_H */
Definitions low-level network driver interface.
Low-level GPIO peripheral driver interface definitions.
Low-level UART peripheral driver interface definition.
void(* netdev_event_cb_t)(netdev_t *dev, netdev_event_t event)
Event callback for signaling event to upper layers.
Definition netdev.h:295
uint_fast8_t uart_t
Define default UART type identifier.
Definition uart.h:85
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.
#define XBEE_MAX_RESP_LENGTH
Maximum length of a command response.
Definition xbee.h:56
#define XBEE_MAX_PKT_LENGTH
Maximum packet length, including XBee API frame overhead.
Definition xbee.h:51
xbee_rx_state_t
States of the internal FSM for handling incoming UART frames.
Definition xbee.h:100
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.
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.
@ XBEE_INT_STATE_SIZE1
waiting for the first byte (MSB) of the frame size field
Definition xbee.h:102
@ XBEE_INT_STATE_TYPE
waiting for the frame type field
Definition xbee.h:106
@ XBEE_INT_STATE_SIZE2
waiting for the second byte (LSB) of the frame size field
Definition xbee.h:104
@ XBEE_INT_STATE_RX
handling incoming data when receiving radio packets
Definition xbee.h:109
@ XBEE_INT_STATE_RESP
handling incoming data for AT command responses
Definition xbee.h:107
@ XBEE_INT_STATE_IDLE
waiting for the beginning of a new frame
Definition xbee.h:101
Mutex for thread synchronization.
Protocol type definitions.
Mutex structure.
Definition mutex.h:146
Structure to hold driver interface -> function mapping.
Definition netdev.h:424
Data structure for extraction L2 information of received packets.
Definition xbee.h:163
uint8_t rssi
RSSI value.
Definition xbee.h:166
uint8_t bcast
0 := unicast, 1:=broadcast
Definition xbee.h:165
uint8_t addr_len
L2 address length (SRC and DST)
Definition xbee.h:164
Configuration parameters for XBee devices.
Definition xbee.h:116
gpio_t pin_sleep
GPIO pin that is connected to the SLEEP pin set to GPIO_UNDEF if not used.
Definition xbee.h:119
uint32_t br
baudrate to use
Definition xbee.h:118
uart_t uart
UART interfaced the device is connected to.
Definition xbee.h:117
gpio_t pin_reset
GPIO pin that is connected to the STATUS pin set to GPIO_UNDEF if not used.
Definition xbee.h:121
XBee device descriptor.
Definition xbee.h:128
uint16_t resp_limit
size RESP frame in transferred
Definition xbee.h:153
uint8_t options
options field
Definition xbee.h:135
xbee_params_t p
configuration parameters
Definition xbee.h:134
uint8_t tx_fid
TX frame ID.
Definition xbee.h:147
netdev_event_cb_t event_callback
callback for device events
Definition xbee.h:131
mutex_t resp_lock
mutex for waiting for AT command response frames
Definition xbee.h:149
xbee_rx_state_t int_state
current state if the UART RX FSM
Definition xbee.h:140
void * context
ptr to network stack context
Definition xbee.h:132
const struct netdev_driver * driver
ptr to that driver's interface.
Definition xbee.h:130
uint16_t resp_count
counter for ongoing transmission
Definition xbee.h:152
eui64_t addr_long
own 802.15.4 long address
Definition xbee.h:138
mutex_t tx_lock
mutex to allow only one transmission at a time
Definition xbee.h:144
uint8_t addr_flags
address flags as defined above
Definition xbee.h:136
uint16_t rx_count
counter for ongoing transmission
Definition xbee.h:156
uint16_t rx_limit
size RX frame transferred
Definition xbee.h:157
uint16_t int_size
temporary space for parsing the frame size
Definition xbee.h:141
IEEE 802.15.4 header definitions.
Data type to represent an EUI-64.
Definition eui64.h:55