xbee.h

#ifndef _AVRIO_XBEE_H_
#define _AVRIO_XBEE_H_

#include <avrio/defs.h>

__BEGIN_C_DECLS
/* ========================================================================== */
#include <errno.h>
#include <stdio.h>
#include <avrio/tc.h>
#include <avrio/dpin.h>
#include <avrio/net.h>

/* structures =============================================================== */
typedef struct _xXBeePkt xXBeePkt;

typedef struct _xXBee xXBee;


/* types ==================================================================== */
typedef int (*iXBeeRxCB) (xXBee *xbee, xXBeePkt *pkt, uint8_t len);

typedef enum {
  XBEE_CB_AT_LOCAL      = 0, 
  XBEE_CB_AT_REMOTE     = 1, 
  XBEE_CB_DATA          = 2, 
  XBEE_CB_IO            = 3, 
  XBEE_CB_TX_STATUS     = 4, 
  XBEE_CB_MODEM_STATUS  = 5, 
  XBEE_CB_SENSOR        = 6, 
  XBEE_CB_NODE_IDENT    = 7, 
  XBEE_CB_UNKNOWN       = -1,
  XBEE_CB_FIRST         = XBEE_CB_AT_LOCAL,
  XBEE_CB_LAST          = XBEE_CB_NODE_IDENT
} eXBeeCbType;

#ifndef __DOXYGEN__
// A modifier si eXBeeCbType modifié
#define XBEE_SIZEOF_CB 8
#endif

typedef enum {
  /* S1 & S2 Series */
  XBEE_PKT_TYPE_ATCMD             = 0x08,
  XBEE_PKT_TYPE_QATCMD            = 0x09, /* wait til an immed param or apply cmd */
  XBEE_PKT_TYPE_REMOTE_ATCMD      = 0x17,
  XBEE_PKT_TYPE_ATCMD_RESP        = 0x88,
  XBEE_PKT_TYPE_MODEM_STATUS      = 0x8a,
  XBEE_PKT_TYPE_REMOTE_ATCMD_RESP = 0x97,

  /* S1 Series */
  XBEE_PKT_TYPE_TX64              = 0x00,
  XBEE_PKT_TYPE_TX16              = 0x01,
  XBEE_PKT_TYPE_RX64              = 0x80,
  XBEE_PKT_TYPE_RX16              = 0x81,
  XBEE_PKT_TYPE_RX64_IO           = 0x82,
  XBEE_PKT_TYPE_RX16_IO           = 0x83,
  XBEE_PKT_TYPE_TX_STATUS         = 0x89,

  /* S2 Series */
  XBEE_PKT_TYPE_ZB_TX_REQ         = 0x10,
  XBEE_PKT_TYPE_ZB_CMD_FRAME      = 0x11, /* Not yet impl */
  XBEE_PKT_TYPE_ZB_TX_STATUS      = 0x8b,
  XBEE_PKT_TYPE_ZB_RX             = 0x90,
  XBEE_PKT_TYPE_ZB_RX_IO          = 0x92,
  XBEE_PKT_TYPE_ZB_RX_SENSOR      = 0x94,
  XBEE_PKT_TYPE_ZB_NODE_IDENT     = 0x95,
} eXBeePktType;

typedef enum {

  XBEE_PKT_STATUS_OK = 0,
  XBEE_PKT_STATUS_ERROR = 1,
  XBEE_PKT_STATUS_INVALID_COMMAND = 2,
  XBEE_PKT_STATUS_INVALID_PARAMETER = 3,
  XBEE_PKT_STATUS_TX_FAILURE = 4,
  XBEE_PKT_STATUS_UNKNOWN = -1
} eXBeeCmdStatus;

typedef enum {

  XBEE_PKT_MODEM_HARDWARE_RESET = 0,
  XBEE_PKT_MODEM_WATCHDOG_TIMER_RESET = 1,
  XBEE_PKT_MODEM_JOINED_NETWORK = 2,
  XBEE_PKT_MODEM_DISASSOCIATED = 3,
  XBEE_PKT_MODEM_COORDINATOR_STARTED = 4,
  XBEE_PKT_MODEM_NETWORK_SECURITY_KEY_WAS_UPDATED = 7,
  XBEE_PKT_MODEM_VOLTAGE_SUPPLY_LIMIT_EXCEEDED = 0x0D,
  XBEE_PKT_MODEM_CONFIGURATION_CHANGED = 0x11,
  XBEE_PKT_MODEM_STACK_ERROR = 0x80
} eXBeeModemStatus;

typedef enum {

  XBEE_RECV = 0x00, 
  XBEE_XMIT = 0x01  
} eXBeeDirection;

typedef enum {

  XBEE_SERIES_S1  = 1,
  XBEE_SERIES_S2  = 2,
  XBEE_SERIES_S2B = 3,
  XBEE_SERIES_UNKNOWN = -1
} eXBeeSeries;

typedef enum {

  XBEE_DEVICE_COORDINATOR = 0,
  XBEE_DEVICE_ROUTER  = 1,
  XBEE_DEVICE_END_DEVICE = 2,
  XBEE_DEVICE_UNKNOWN = -1
} eXBeeDeviceType;

typedef enum {

  XBEE_EVENT_BUTTON   = 1,
  XBEE_EVENT_JOIN     = 2,
  XBEE_EVENT_POWER_ON = 3,
  XBEE_EVENT_UNKNOWN  = -1
} eXBeeSourceEvent;


/* internal public functions ================================================ */
xXBee * xXBeeNew (eXBeeSeries eSeries, xDPin * xResetPin);

int iXBeeOpen (xXBee *xbee, const char * pcDevice, xSerialIos * xIos);

int iXBeeClose (xXBee *xbee);

void vXBeeSetCB (xXBee *xbee, eXBeeCbType cb_type, iXBeeRxCB cb);

void * pvXBeeGetUserContext(xXBee *xbee);

void vXBeeSetUserContext(xXBee *xbee, void * pvContext);

eXBeeSeries eXBeeGetSeries (const xXBee *xbee);

int iXBeePoll (xXBee *xbee, int timeout);

/*
 * Basic communication parameters/values
 */
#define XBEE_CMD_CHANNEL                "CH"
#define XBEE_CMD_PAN_ID                 "ID"
#define XBEE_CMD_OPERATING_PAN_ID       "OP"
#define XBEE_CMD_DEST_ADDR64_HI         "DH"
#define XBEE_CMD_DEST_ADDR64_LO         "DL"
#define XBEE_CMD_SRC_ADDR16             "MY"
#define XBEE_CMD_SER_HI                 "SH"
#define XBEE_CMD_SER_LO                 "SL"
#define XBEE_CMD_RAND_DLY_SLOTS         "RN"
#define XBEE_CMD_MAC_MODE               "MM"
#define XBEE_CMD_COORD_ENA              "CE"
#define XBEE_CMD_SCAN                   "SC"
#define XBEE_CMD_SCAN_DURATION          "SD"
#define XBEE_CMD_ASSOC_END              "A1"
#define XBEE_CMD_ASSOC_COORD            "A2"
#define XBEE_CMD_ASSOC_STATUS           "AI"
#define XBEE_CMD_RSSI                   "DB"

/*
 * Transceiver Control
 */
#define XBEE_CMD_PWR_LEVEL              "PL"
#define XBEE_CMD_CCA_THRESH             "CA"

/*
 * Sleep Parameters
 */
#define XBEE_CMD_SLEEP_MODE             "SM"
#define XBEE_CMD_SLEEP_TIMEOUT          "ST"
#define XBEE_CMD_SLEEP_PERIOD           "SP"
#define XBEE_CMD_SLEEP_PERIOD_DISASSOC  "DP"

/*
 * Interface parameters
 */
#define XBEE_CMD_DATA_RATE              "BD"
#define XBEE_CMD_PACKETIZATION_TIMEOUT  "RO"
#define XBEE_CMD_DIO7_CONFIG            "D7"
#define XBEE_CMD_DIO6_CONFIG            "D6"
#define XBEE_CMD_DIO5_CONFIG            "D5"
#define XBEE_CMD_DIO4_CONFIG            "D4"
#define XBEE_CMD_DIO3_CONFIG            "D3"
#define XBEE_CMD_DIO2_CONFIG            "D2"
#define XBEE_CMD_DIO1_CONFIG            "D1"
#define XBEE_CMD_DIO0_CONFIG            "D0"
#define XBEE_CMD_PWM0_CONFIG            "PO"
#define XBEE_CMD_API_ENA                "AP"
#define XBEE_CMD_PULLUP_ENA             "PR"

/*
 * Version Info
 */
#define XBEE_CMD_VERS_FIRMWARE          "VR"
#define XBEE_CMD_VERS_HARDWARE          "HV"
#define XBEE_CMD_VERS_FIRM_VERBOSE      "VL"

/*
 * Received Signal Strength
 */
#define XBEE_CMD_RSSI_PWM_TIMER         "RP"
#define XBEE_CMD_RSS                    "DB"

/*
 * Error counters
 */
#define XBEE_CMD_CCA_FAILS              "EC"
#define XBEE_CMD_ACK_FAILS              "EA"

/*
 * AT Command Params
 */
#define XBEE_CMD_AT_MODE_TIMEOUT        "CT"
#define XBEE_CMD_AT_GUARD_TIME          "GT"
#define XBEE_CMD_AT_CMD_CHAR            "CC"
#define XBEE_CMD_AT_EXIT                "CN"

/*
 * XBEE specific routing
 */
#define XBEE_CMD_NODE_FIND_DEST         "DN"
#define XBEE_CMD_NODE_DISCOVER          "ND"
#define XBEE_CMD_NODE_ID                "NI"
#define XBEE_CMD_ACTIVE_SCAN            "AS"
#define XBEE_CMD_FORCE_DISASSOC         "DA"
#define XBEE_CMD_ENERGY_SCAN            "ED"
#define XBEE_CMD_FORCE_POLL             "FP"

/*
 * IO Line Passing / Sensor Interfacing
 */
#define XBEE_CMD_SAMPLE_RATE            "IR"
#define XBEE_CMD_SAMPLES_BEFORE_TX      "IT"

/*
 * Misc
 */
#define XBEE_CMD_WRITE_PARAMS           "WR"
#define XBEE_CMD_RESET_SOFT             "FR"
#define XBEE_CMD_APPLY_CHANGES          "AC"
#define XBEE_CMD_RESTORE_DEFAULTS       "RE"
#define XBEE_CMD_MAX_PAYLOAD            "NP"

int iXBeeSendAt (xXBee *xbee,
                 const char cmd[],
                 const uint8_t *params,
                 uint8_t param_len);

int iXBeeSendRemoteAt (xXBee *xbee,
                       const char cmd[],
                       const uint8_t params[],
                       uint8_t param_len,
                       const uint8_t addr64[8],
                       const uint8_t addr16[2],
                       uint8_t apply);


int iXBeeZbSend (xXBee *xbee,
                 const void *data,
                 uint8_t len,
                 const uint8_t addr64[8],
                 const uint8_t addr16[2],
                 uint8_t opt,
                 uint8_t radius);

int iXBeeZbSendToCoordinator (xXBee *xbee, const void *data, uint8_t len);

int iXBeeZbSendBroadcast (xXBee *xbee, const void *data, uint8_t len);

int iXBeeSend64 (xXBee *xbee,
                 const void *data,
                 uint8_t len,
                 const uint8_t addr[8],
                 uint8_t opt);

int iXBeeSend16 (xXBee *xbee,
                 const void *data,
                 uint8_t len,
                 const uint8_t addr[2],
                 uint8_t opt);


#ifdef __DOXYGEN__

void *pvXBeeAllocPkt (xXBee *xbee, uint8_t direction, uint8_t len);

void vXBeeFreePkt (xXBee *xbee, xXBeePkt *pkt);

#else
// weak permet à l'utilisateur de redéfinir ces fonctions...
void *pvXBeeAllocPkt (xXBee *xbee, uint8_t direction, uint8_t len) __attribute__ ( (weak));
void vXBeeFreePkt (xXBee *xbee, xXBeePkt *pkt) __attribute__ ( (weak));
#endif

uint8_t ucXBeePktType (xXBeePkt *pkt);

uint16_t usXBeePktLength (xXBeePkt *pkt);

uint8_t * pucXBeePktAddrSrc64 (xXBeePkt *pkt);

uint8_t * pucXBeePktAddrSrc16 (xXBeePkt *pkt);

uint8_t * iXBeePktDst16 (xXBeePkt *pkt);

uint8_t * pucXBeePktData (xXBeePkt *pkt);

int iXBeePktDataLen (xXBeePkt *pkt);

int iXBeePktFrameId (xXBeePkt *pkt);

int iXBeePktStatus (xXBeePkt *pkt);

int iXBeePktDiscovery (xXBeePkt *pkt);

int iXBeePktRetry (xXBeePkt *pkt);

char * pcXBeePktCommand (xXBeePkt *pkt);

uint8_t * pucXBeePktParam (xXBeePkt *pkt);

int iXBeePktParamGetStr (char * pcDest, xXBeePkt *pkt, int iDestSize);

int iXBeePktParamGetULong (uint32_t * ulDest, xXBeePkt *pkt, int iOffset);

int iXBeePktParamGetULong (uint32_t * ulDest, xXBeePkt *pkt, int iOffset);

int iXBeePktParamGetULongLong (uint64_t * ullDest, xXBeePkt *pkt, int iOffset);

int iXBeePktParamGetUShort (uint16_t * usDest, xXBeePkt *pkt, int iOffset);

int iXBeePktParamGetUByte (uint8_t * ucDest, xXBeePkt *pkt, int iOffset);

int iXBeePktParamLen (xXBeePkt *pkt);

int iXBeePktOptions (xXBeePkt *pkt);

int iXBeePktRadius (xXBeePkt *pkt);

int iXBeePktApply (xXBeePkt *pkt);

int iXBeePktRssi (xXBeePkt *pkt);

uint8_t * pucXBeePktAddrRemote64 (xXBeePkt *pkt);

uint8_t * pucXBeePktAddrRemote16 (xXBeePkt *pkt);

char * pcXBeePktNiString (xXBeePkt * pkt);

uint8_t * pucXBeePktAddrParent16 (xXBeePkt *pkt);

eXBeeDeviceType eXBeePktDeviceType (xXBeePkt * pkt);

eXBeeSourceEvent eXBeePktSourceEvent (xXBeePkt * pkt);

int iXBeePktProfileId (xXBeePkt * pkt);

int iXBeePktManufacturerId (xXBeePkt * pkt);


int iXBeePktIsBroadcast (xXBeePkt *pkt);


bool bXBeePktAddressIsEqual (const uint8_t *a1, const uint8_t *a2, uint8_t len);

const uint8_t * pucXBeeAddr16Unknown (void);

const uint8_t * pucXBeeAddr64Unknown (void);

const uint8_t * pucXBeeAddr64Coordinator (void);

const uint8_t * pucXBeeAddr64Broadcast (void);

/*==============================================================================
 *
 * TODO: Partie non finalisée par manque de temps
 *
 *============================================================================*/
#ifndef __DOXYGEN__
int iXBeePktDigital (xXBeePkt * pkt, int array[9], unsigned int index);
int iXBeePktAnalog (xXBeePkt * pkt, int array[6], unsigned int index);
int iXBeePktSamples (xXBeePkt * pkt);

#endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /*  _AVRIO_XBEE_H_ defined */