LoRaMacCommands.h

Go to the documentation of this file.

 
#ifndef __LORAMAC_COMMANDS_H__
#define __LORAMAC_COMMANDS_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <stddef.h>
#include "LoRaMacTypes.h"
 
 
/*
 * Number of MAC Command slots
 */
#define LORAMAC_COMMADS_MAX_NUM_OF_PARAMS   2
 
typedef struct sMacCommand MacCommand_t;
 
struct sMacCommand
{
    MacCommand_t* Next;
    uint8_t CID;
    uint8_t Payload[LORAMAC_COMMADS_MAX_NUM_OF_PARAMS];
    size_t PayloadSize;
    bool IsSticky;
};
 
typedef enum eLoRaMacCommandsStatus
{
    LORAMAC_COMMANDS_SUCCESS = 0,
    LORAMAC_COMMANDS_ERROR_NPE,
    LORAMAC_COMMANDS_ERROR_MEMORY,
    LORAMAC_COMMANDS_ERROR_CMD_NOT_FOUND,
    LORAMAC_COMMANDS_ERROR_UNKNOWN_CMD,
    LORAMAC_COMMANDS_ERROR,
}LoRaMacCommandStatus_t;
 
typedef void ( *LoRaMacCommandsNvmEvent )( void );
 
LoRaMacCommandStatus_t LoRaMacCommandsInit( LoRaMacCommandsNvmEvent commandsNvmCtxChanged );
 
LoRaMacCommandStatus_t LoRaMacCommandsRestoreNvmCtx( void* commandsNvmCtx );
 
void* LoRaMacCommandsGetNvmCtx( size_t* commandsNvmCtxSize );
 
LoRaMacCommandStatus_t LoRaMacCommandsAddCmd( uint8_t cid, uint8_t* payload, size_t payloadSize );
 
LoRaMacCommandStatus_t LoRaMacCommandsRemoveCmd( MacCommand_t* macCmd );
 
LoRaMacCommandStatus_t LoRaMacCommandsGetCmd( uint8_t cid, MacCommand_t** macCmd );
 
LoRaMacCommandStatus_t LoRaMacCommandsRemoveNoneStickyCmds( void );
 
LoRaMacCommandStatus_t LoRaMacCommandsRemoveStickyAnsCmds( void );
 
LoRaMacCommandStatus_t LoRaMacCommandsGetSizeSerializedCmds( size_t* size );
 
LoRaMacCommandStatus_t LoRaMacCommandsSerializeCmds( size_t availableSize, size_t* effectiveSize,  uint8_t* buffer );
 
LoRaMacCommandStatus_t LoRaMacCommandsStickyCmdsPending( bool* cmdsPending );
 
uint8_t LoRaMacCommandsGetCmdSize( uint8_t cid );
 
#ifdef __cplusplus
}
#endif
 
#endif // __LORAMAC_COMMANDS_H__