discovery.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2012 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_DISCOVERY_H
#define XBEE_DISCOVERY_H

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

XBEE_BEGIN_DECLS

#define XBEE_DISC_MAX_NODEID_LEN 20

typedef XBEE_PACKED(xbee_node_id1_t, {
   uint16_t       network_addr_be;     
   addr64         ieee_addr_be;        
   char           node_info[XBEE_DISC_MAX_NODEID_LEN + 1];
}) xbee_node_id1_t;

// data following variable-length node info
typedef XBEE_PACKED(xbee_node_id2_t, {
   uint16_t       parent_addr_be;      

   uint8_t        device_type;         
      #define XBEE_ND_DEVICE_TYPE_COORD   0
      #define XBEE_ND_DEVICE_TYPE_ROUTER  1
      #define XBEE_ND_DEVICE_TYPE_ENDDEV  2

   uint8_t        source_event;        
      #define XBEE_ND_SOURCE_EVENT_NONE         0
      #define XBEE_ND_SOURCE_EVENT_PUSHBUTTON   1
      #define XBEE_ND_SOURCE_EVENT_JOINED       2
      #define XBEE_ND_SOURCE_EVENT_POWER_CYCLE  3

   uint16_t       profile_be;          
   uint16_t       manufacturer_be;     

   uint32_t       device_id_be;

   uint8_t        rssi;
}) xbee_node_id2_t;

typedef XBEE_PACKED(xbee_frame_node_id_t, {
   uint8_t           frame_type;       
   addr64            ieee_address_be;
   uint16_t          network_address_be;
   uint8_t           options;
   xbee_node_id1_t   node_data;
   // an xbee_node_id2_t follows the variable-length xbee_node_id1_t
}) xbee_frame_node_id_t;

typedef struct xbee_node_id_t {
   addr64         ieee_addr_be;     
   uint16_t       network_addr;     
   uint16_t       parent_addr;      
   uint8_t        device_type;
   char           node_info[XBEE_DISC_MAX_NODEID_LEN + 1];
} xbee_node_id_t;

int xbee_disc_nd_parse( xbee_node_id_t FAR *parsed, const void FAR *source,
      int source_length);

void xbee_disc_node_id_dump( const xbee_node_id_t FAR *ni);

const char *xbee_disc_device_type_str( uint8_t device_type);

int xbee_disc_nodeid_cluster_handler( const wpan_envelope_t FAR *envelope,
   void FAR *context);

#define XBEE_DISC_DIGI_DATA_CLUSTER_ENTRY    \
   { DIGI_CLUST_NODEID_MESSAGE, xbee_disc_nodeid_cluster_handler, NULL, \
      WPAN_CLUST_FLAG_INPUT | WPAN_CLUST_FLAG_NOT_ZCL}

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

#define XBEE_FRAME_HANDLE_ATND_RESPONSE      \
   { XBEE_FRAME_LOCAL_AT_RESPONSE, 0, xbee_disc_atnd_response_handler, NULL }

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

#define XBEE_FRAME_HANDLE_AO0_NODEID         \
   { XBEE_FRAME_NODE_ID, 0, xbee_disc_nodeid_frame_handler, NULL }

int xbee_disc_add_node_id_handler( xbee_dev_t *xbee, xbee_disc_node_id_fn fn);

int xbee_disc_remove_node_id_handler( xbee_dev_t *xbee,
      xbee_disc_node_id_fn fn);

int xbee_disc_discover_nodes( xbee_dev_t *xbee, const char *identifier);

XBEE_END_DECLS

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

#endif