xbee.h

Go to the documentation of this file.

 
#ifndef XBEE_H
#define XBEE_H
 
#if defined(__cplusplus)
extern "C"
{
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stdlib.h>
#include "config.h"
#include "port.h"
 
// Abstract base class for XBee
typedef struct XBee XBee;
 
typedef struct {
    bool (*init)(XBee* self, uint32_t baudrate, void* device);
    bool (*connect)(XBee* self);
    bool (*disconnect)(XBee* self);
    uint8_t (*sendData)(XBee* self, const void* data);
    bool (*softReset)(XBee* self);
    void (*hardReset)(XBee* self);
    void (*process)(XBee* self);
    bool (*connected)(XBee* self);
    void (*handleRxPacketFrame)(XBee* self, void *frame);
    void (*handleTransmitStatusFrame)(XBee* self, void *frame);
} XBeeVTable;
 
 
typedef struct {
    int (*PortUartRead)(uint8_t *buffer, int length);
    int (*PortUartWrite)(const uint8_t *buf, uint16_t len);
    uint32_t (*PortMillis)(void);
    void (*PortFlushRx)(void);
    int (*PortUartInit)(uint32_t baudrate, void *device);
    void (*PortDelay)(uint32_t ms);
} XBeeHTable;
 
typedef struct {
    void (*OnReceiveCallback)(XBee* self, void * data);
    void (*OnConnectCallback)(XBee* self);
    void (*OnDisconnectCallback)(XBee* self);
    void (*OnSendCallback)(XBee* self, void * data);
} XBeeCTable;
 
struct XBee {
    // Add common XBee attributes here
    const XBeeVTable* vtable;
    const XBeeHTable* htable;
    const XBeeCTable* ctable;
    uint8_t frameIdCntr;
    bool txStatusReceived;        
    uint8_t deliveryStatus;        
 
};
 
// Interface functions to call the methods
bool XBeeInit(XBee* self, uint32_t baudrate, void* device);
bool XBeeConnect(XBee* self);
bool XBeeDisconnect(XBee* self);
uint8_t XBeeSendData(XBee* self, const void*);
bool XBeeSoftReset(XBee* self);
void XBeeHardReset(XBee* self);
void XBeeProcess(XBee* self);
bool XBeeConnected(XBee* self);
bool XBeeWriteConfig(XBee* self);
bool XBeeApplyChanges(XBee* self);
bool XBeeSetAPIOptions(XBee* self, const uint8_t value);
 
#if defined(__cplusplus)
}
#endif
 
#endif // XBEE_H