wpan.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2013 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

#ifndef __XBEE_WPAN_H
#define __XBEE_WPAN_H

#include "xbee/device.h"
#include "wpan/types.h"
#include "xbee/delivery_status.h"

XBEE_BEGIN_DECLS

typedef XBEE_PACKED(xbee_frame_receive_t, {
   uint8_t        frame_type;          
   addr64         ieee_address;
   uint16_t       network_address_be;
   uint8_t        options;             
   uint8_t        payload[1];          
}) xbee_frame_receive_t;


typedef XBEE_PACKED(xbee_frame_receive_explicit_t, {
   uint8_t        frame_type;          
   addr64         ieee_address;
   uint16_t       network_address_be;
   uint8_t        source_endpoint;
   uint8_t        dest_endpoint;
   uint16_t       cluster_id_be;
   uint16_t       profile_id_be;
   uint8_t        options;             
   uint8_t        payload[1];          
}) xbee_frame_receive_explicit_t;

int xbee_wpan_init( xbee_dev_t *xbee,
   const wpan_endpoint_table_entry_t *ep_table);

#define XBEE_FRAME_HANDLE_RX_EXPLICIT  \
   { XBEE_FRAME_RECEIVE_EXPLICIT, 0, _xbee_handle_receive_explicit, NULL }

int _xbee_handle_receive_explicit( xbee_dev_t *xbee, const void FAR *raw,
   uint16_t length, void FAR *context);

typedef XBEE_PACKED(xbee_header_transmit_t, {
   uint8_t        frame_type;          
   uint8_t        frame_id;
   addr64         ieee_address;
   uint16_t       network_address_be;
   uint8_t        broadcast_radius;    
   uint8_t        options;             
}) xbee_header_transmit_t;

typedef XBEE_PACKED(xbee_header_transmit_explicit_t, {
   uint8_t        frame_type;          
   uint8_t        frame_id;
   addr64         ieee_address;
   uint16_t       network_address_be;
   uint8_t        source_endpoint;
   uint8_t        dest_endpoint;
   uint16_t       cluster_id_be;
   uint16_t       profile_id_be;
   uint8_t        broadcast_radius;    
   uint8_t        options;             
}) xbee_header_transmit_explicit_t;

#define XBEE_TX_OPT_DISABLE_ACK                 (1<<0)
#define XBEE_TX_OPT_DISABLE_ROUTE_DISC          (1<<1)
#define XBEE_TX_OPT_ENABLE_UNICAST_NACK         (1<<2)
#define XBEE_TX_OPT_ENABLE_UNICAST_TRACE        (1<<3)
#define XBEE_TX_OPT_SEND_ENCRYPTED              (1<<4)
#define XBEE_TX_OPT_APS_ENCRYPT                 (1<<5)
#define XBEE_TX_OPT_EXTENDED_TIMEOUT            (1<<6)
#define XBEE_TX_OPT_MODE_POINT_MULTIPOINT       (1<<6)
#define XBEE_TX_OPT_MODE_REPEATER               (2<<6)
#define XBEE_TX_OPT_MODE_DIGIMESH               (3<<6)

typedef XBEE_PACKED(xbee_frame_transmit_status_t, {
   uint8_t        frame_type;       
   uint8_t        frame_id;
   uint16_t       network_address_be;
   uint8_t        retries;          // # of application Tx retries
   uint8_t        delivery;         
   uint8_t        discovery;        // bitfield
}) xbee_frame_transmit_status_t;

      #define XBEE_TX_DISCOVERY_NONE             0x00

      #define XBEE_TX_DISCOVERY_ADDRESS          0x01

      #define XBEE_TX_DISCOVERY_ROUTE            0x02

      #define XBEE_TX_DISCOVERY_EXTENDED_TIMEOUT 0x40

int _xbee_handle_transmit_status( xbee_dev_t *xbee,
   const void FAR *frame, uint16_t length, void FAR *context);

#define XBEE_FRAME_HANDLE_TRANSMIT_STATUS \
   { XBEE_FRAME_TRANSMIT_STATUS, 0, _xbee_handle_transmit_status, NULL }

int xbee_frame_dump_transmit_status( xbee_dev_t *xbee,
   const void FAR *frame, uint16_t length, void FAR *context);

#define XBEE_FRAME_TRANSMIT_STATUS_DEBUG \
   { XBEE_FRAME_TRANSMIT_STATUS, 0, xbee_frame_dump_transmit_status, NULL }

XBEE_END_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "xbee_wpan.c"
#endif

#endif