xbee_api_frames.h

Go to the documentation of this file.

 
#ifndef XBEE_FRAMES_H
#define XBEE_FRAMES_H
 
#if defined(__cplusplus)
extern "C"
{
#endif
 
#include "xbee_at_cmds.h"
#include "xbee.h"
 
#define XBEE_MAX_FRAME_DATA_SIZE 256
#define API_SEND_SUCCESS 0
#define API_SEND_ERROR_TIMEOUT -1
#define API_SEND_ERROR_INVALID_COMMAND -2
#define API_SEND_ERROR_UART_FAILURE -3
#define API_SEND_ERROR_FRAME_TOO_LARGE -4
#define API_SEND_AT_CMD_ERROR -5
#define API_SEND_AT_CMD_RESONSE_TIMEOUT -6
 
typedef enum {
    XBEE_DELIVERY_STATUS_SUCCESS = 0x00,         // Success
    XBEE_DELIVERY_STATUS_NO_ACK = 0x01,          // No acknowledgment received
    XBEE_DELIVERY_STATUS_CCA_FAILURE = 0x02,     // Clear Channel Assessment (CCA) failure
    XBEE_DELIVERY_STATUS_PURGED = 0x03,          // Transmission purged
    XBEE_DELIVERY_STATUS_INVALID_DEST = 0x15,    // Invalid destination endpoint
    XBEE_DELIVERY_STATUS_NET_ACK_FAILURE = 0x21, // Network acknowledgment failure
    XBEE_DELIVERY_STATUS_NOT_JOINED = 0x22,      // Not joined to network
    XBEE_DELIVERY_STATUS_SELF_ADDRESSED = 0x23,  // Attempted to transmit to self
    XBEE_DELIVERY_STATUS_ADDRESS_NOT_FOUND = 0x24, // Address not found
    XBEE_DELIVERY_STATUS_ROUTE_NOT_FOUND = 0x25, // Route not found
    XBEE_DELIVERY_STATUS_PAYLOAD_TOO_LARGE = 0x74 // Payload too large
} xbee_deliveryStatus_t;
 
typedef enum {
 
    XBEE_API_TYPE_AT_COMMAND = 0x08,               
    XBEE_API_TYPE_TX_REQUEST = 0x10,               
    XBEE_API_TYPE_MODEM_STATUS = 0x8A,             
    XBEE_API_TYPE_AT_RESPONSE = 0x88,              
    XBEE_API_TYPE_TX_STATUS = 0x89,                
 
    XBEE_API_TYPE_LR_JOIN_REQUEST = 0x14,          
    XBEE_API_TYPE_LR_TX_REQUEST = 0x50,            
    XBEE_API_TYPE_LR_RX_PACKET = 0xD0,             
    XBEE_API_TYPE_LR_EXPLICIT_RX_PACKET = 0xD1,    
    XBEE_API_TYPE_LR_EXPLICIT_TX_STATUS = 0xD2,    
 
    XBEE_API_TYPE_3RF_REMOTE_AT_COMMAND = 0x17,    
    XBEE_API_TYPE_3RF_REMOTE_AT_RESPONSE = 0x97,   
    XBEE_API_TYPE_3RF_RX_PACKET = 0x90,            
    XBEE_API_TYPE_3RF_RX_EXPLICIT_PACKET = 0x91,   
 
    XBEE_API_TYPE_CELLULAR_TX_IPV4 = 0x20,         
    XBEE_API_TYPE_CELLULAR_RX_IPV4 = 0xB0,         
    XBEE_API_TYPE_CELLULAR_MODEM_STATUS = 0x8A,    
 
    XBEE_API_TYPE_IO_DATA_SAMPLE_RX = 0x92,        
    XBEE_API_TYPE_REMOTE_AT_COMMAND = 0x17,        
    XBEE_API_TYPE_REMOTE_AT_RESPONSE = 0x97,       
    XBEE_API_TYPE_IO_SAMPLE_RX_INDICATOR = 0x8F,   
 
    // Add other types as needed
 
} xbee_api_frame_type_t;
 
 
typedef enum {
    API_RECEIVE_SUCCESS = 0,                  
    API_RECEIVE_ERROR_INVALID_POINTER = -1,   
    API_RECEIVE_ERROR_TIMEOUT_START_DELIMITER = -2, 
    API_RECEIVE_ERROR_INVALID_START_DELIMITER = -3, 
    API_RECEIVE_ERROR_TIMEOUT_LENGTH = -4,    
    API_RECEIVE_ERROR_FRAME_TOO_LARGE = -5,   
    API_RECEIVE_ERROR_TIMEOUT_DATA = -6,      
    API_RECEIVE_ERROR_TIMEOUT_CHECKSUM = -7,  
    API_RECEIVE_ERROR_INVALID_CHECKSUM = -8,  
    API_RECEIVE_ERROR_UART_FAILURE = -9       
} api_receive_status_t;
 
typedef struct {
    xbee_api_frame_type_t type;  
    uint16_t length;             
    uint8_t checksum;            
    uint8_t data[XBEE_MAX_FRAME_DATA_SIZE]; 
} xbee_api_frame_t;
 
 
// Function prototypes
api_receive_status_t apiReceiveApiFrame(XBee* self, xbee_api_frame_t *frame);
int apiSendAtCommand(XBee* self,at_command_t command, const uint8_t *parameter, uint8_t paramLength);
int apiSendFrame(XBee* self,uint8_t frame_type, const uint8_t *data, uint16_t len);
int apiSendAtCommandAndGetResponse(XBee* self, at_command_t command, const uint8_t *parameter, 
    uint8_t paramLength, uint8_t *responseBuffer, uint8_t *responseLength, uint32_t timeoutMs);
void apiHandleFrame(XBee* self,xbee_api_frame_t frame);
void xbeeHandleAtResponse(XBee* self,xbee_api_frame_t *frame);
void xbeeHandleModemStatus(XBee* self,xbee_api_frame_t *frame);
void xbeeHandleRxPacket(XBee* self,xbee_api_frame_t *frame);
 
#if defined(__cplusplus)
}
#endif
 
#endif // XBEE_FRAMES_H