reg_descr.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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_REG_DESCR
#define __XBEE_REG_DESCR

#include "xbee/platform.h"

XBEE_BEGIN_DECLS

typedef enum
{
   XBEE_RCI_TYPE_UINT32,
   XBEE_RCI_TYPE_HEX32,
   XBEE_RCI_TYPE_STRING,
   XBEE_RCI_TYPE_BIN,   // Bin turns into XBEE_RCI_TYPE_STRING for RCI, but formatted as 0x
                        // followed by hex digits.
   XBEE_RCI_TYPE_ADDR64,
} _xbee_rci_type_t;

extern const char *_xbee_rci_types[];



typedef struct _xbee_reg_descr_t
{
   int   is_state;
   const char *alias;
   uint16_t    cxval;
   _xbee_rci_type_t     rci_type;
#ifdef IDIGI_USE_XBEE
   const char *rci_element;
   const char *desc;
   const char *units;
   // Note: these are stored as strings since it results in less storage
   // use compared with 32-bit numbers, plus the format is correct for RCI.
   const char *min;
   const char *max;
#endif
   uint16_t    sxa_offs;
   uint16_t    sxa_len;
   uint16_t    sxa_cache_group;
} _xbee_reg_descr_t;



extern const FAR _xbee_reg_descr_t _xbee_reg_table[];

XBEE_END_DECLS

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

#endif      // __XBEE_REG_DESCR