rn2483.h File Reference

#include <stdint.h>
#include "lora.h"

Go to the source code of this file.

Macros
#define	RN2483_COMMANDBUFFER_SIZE   160
#define	RN2483_POWER_14DBM   1
#define	RN2483_POWER_11DBM   2
#define	RN2483_POWER_8DBM   3
#define	RN2483_POWER_4DBM   4
#define	RN2483_POWER_2DBM   5

Typedefs
typedef enum rn2483_statuses	RN2483_Status_t

Enumerations
enum	rn2483_statuses {   MAC_OK, INVALID_PARAM, JOIN_ACCEPTED, JOIN_DENIED,   NOT_JOINED, NO_FREE_CH, SILENT, FRAME_COUNTER_ERR_REJOIN_NEEDED,   BUSY, MAC_PAUSED, INVALID_DATA_LEN, MAC_TX_OK,   MAC_RX, MAC_ERR, RADIO_TX_OK, RADIO_ERR,   UNKOWN_ERR, RN_TX_TIMEOUT, RN_RX_TIMEOUT, DATA_RETURNED }

Functions
void	RN2483_Init (void)
RN2483_Status_t	RN2483_MacReset (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_GetHardwareEUI (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_GetSystemVersion (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_GetApplicationEUI (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetDeviceEUI (char *eui, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetApplicationEUI (char *eui, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetApplicationKey (char *key, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetApplicationSessionKey (char *key, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetNetworkSessionKey (char *address, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetDeviceAddress (char *address, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetOutputPower (uint8_t pwr, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_DisableAdaptiveDataRate (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_DisableAutomaticReplies (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetDataRate (uint8_t dr, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_JoinOTAA (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_JoinABP (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_Setup (LoRaSettings_t settings, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetupOTAA (LoRaSettings_t settings, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SetupABP (LoRaSettings_t settings, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_TransmitUnconfirmed (uint8_t *data, uint8_t payloadSize, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_TransmitConfirmed (uint8_t *data, uint8_t payloadSize, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_SaveMac (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_ResumeMac (char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_Sleep (uint32_t sleepTime, volatile bool *wakeUp, char *receiveBuffer, uint8_t bufferSize)
RN2483_Status_t	RN2483_Wake (char *receiveBuffer, uint8_t bufferSize)

Macro Definition Documentation

RN2483_COMMANDBUFFER_SIZE

#define RN2483_COMMANDBUFFER_SIZE   160

Definition at line 26 of file rn2483.h.

RN2483_POWER_11DBM

#define RN2483_POWER_11DBM   2

Definition at line 28 of file rn2483.h.

RN2483_POWER_14DBM

#define RN2483_POWER_14DBM   1

Definition at line 27 of file rn2483.h.

RN2483_POWER_2DBM

#define RN2483_POWER_2DBM   5

Definition at line 31 of file rn2483.h.

RN2483_POWER_4DBM

#define RN2483_POWER_4DBM   4

Definition at line 30 of file rn2483.h.

RN2483_POWER_8DBM

#define RN2483_POWER_8DBM   3

Definition at line 29 of file rn2483.h.

Typedef Documentation

RN2483_Status_t

typedef enum rn2483_statuses RN2483_Status_t

Enumeration Type Documentation

rn2483_statuses

enum rn2483_statuses

Enumerator
MAC_OK
INVALID_PARAM
JOIN_ACCEPTED
JOIN_DENIED
NOT_JOINED
NO_FREE_CH
SILENT
FRAME_COUNTER_ERR_REJOIN_NEEDED
BUSY
MAC_PAUSED
INVALID_DATA_LEN
MAC_TX_OK
MAC_RX
MAC_ERR
RADIO_TX_OK
RADIO_ERR
UNKOWN_ERR
RN_TX_TIMEOUT
RN_RX_TIMEOUT
DATA_RETURNED

Definition at line 33 of file rn2483.h.

                            {
    MAC_OK,
    INVALID_PARAM,
    JOIN_ACCEPTED,
    JOIN_DENIED,
    NOT_JOINED,
    NO_FREE_CH,
    SILENT,
    FRAME_COUNTER_ERR_REJOIN_NEEDED,
    BUSY,
    MAC_PAUSED,
    INVALID_DATA_LEN,
    MAC_TX_OK,
    MAC_RX,
    MAC_ERR,
    RADIO_TX_OK,
    RADIO_ERR,
    UNKOWN_ERR,
    RN_TX_TIMEOUT,
    RN_RX_TIMEOUT,
    DATA_RETURNED
}RN2483_Status_t;

Function Documentation

RN2483_DisableAdaptiveDataRate()

RN2483_Status_t RN2483_DisableAdaptiveDataRate	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 193 of file rn2483.c.

                                                                                        {
    sprintf(commandBuffer, "mac set adr off\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_DisableAutomaticReplies()

RN2483_Status_t RN2483_DisableAutomaticReplies	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 198 of file rn2483.c.

                                                                                        {
    sprintf(commandBuffer, "mac set ar off\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_GetApplicationEUI()

RN2483_Status_t RN2483_GetApplicationEUI	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 153 of file rn2483.c.

                                                                                  {
    sprintf(commandBuffer, "sys get appeui\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_GetHardwareEUI()

RN2483_Status_t RN2483_GetHardwareEUI	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 143 of file rn2483.c.

                                                                               {
    sprintf(commandBuffer, "mac get deveui\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_GetSystemVersion()

RN2483_Status_t RN2483_GetSystemVersion	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 148 of file rn2483.c.

                                                                                 {
    sprintf(commandBuffer, "sys get ver\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_Init()

void RN2483_Init

(

void

)

Definition at line 123 of file rn2483.c.

                      { /* Setup with autobaud */
    GPIO_PinModeSet(RN2483_TX_PORT, RN2483_TX_PIN, gpioModePushPull, 1);
    delay(100);
    GPIO_PinModeSet(RN2483_RESET_PORT, RN2483_RESET_PIN, gpioModePushPull, 1);
    delay(50);
    GPIO_PinModeSet(RN2483_RESET_PORT, RN2483_RESET_PIN, gpioModePushPull, 0);
    delay(50);
    GPIO_PinModeSet(RN2483_RESET_PORT, RN2483_RESET_PIN, gpioModePushPull, 1);
    delay(350);

    memset(commandBuffer, '\0', RN2483_COMMANDBUFFER_SIZE);

    Leuart_Init();
}

RN2483_JoinABP()

RN2483_Status_t RN2483_JoinABP	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 241 of file rn2483.c.

                                                                        {
    sprintf(commandBuffer, "mac join abp\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, true));
}

RN2483_JoinOTAA()

RN2483_Status_t RN2483_JoinOTAA	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 236 of file rn2483.c.

                                                                         {
    sprintf(commandBuffer, "mac join otaa\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, true));
}

RN2483_MacReset()

RN2483_Status_t RN2483_MacReset	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 138 of file rn2483.c.

                                                                         {
    sprintf(commandBuffer, "mac reset 868\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_ResumeMac()

RN2483_Status_t RN2483_ResumeMac	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 369 of file rn2483.c.

                                                                          {
    sprintf(commandBuffer, "mac resume\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SaveMac()

RN2483_Status_t RN2483_SaveMac	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 364 of file rn2483.c.

                                                                        {
    sprintf(commandBuffer, "mac save\r\n");
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetApplicationEUI()

RN2483_Status_t RN2483_SetApplicationEUI	(	char *	eui,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 163 of file rn2483.c.

                                                                                              {
    sprintf(commandBuffer, "mac set appeui %s\r\n", eui);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetApplicationKey()

RN2483_Status_t RN2483_SetApplicationKey	(	char *	key,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 168 of file rn2483.c.

                                                                                              {
    sprintf(commandBuffer, "mac set appkey %s\r\n", key);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetApplicationSessionKey()

RN2483_Status_t RN2483_SetApplicationSessionKey	(	char *	key,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 173 of file rn2483.c.

                                                                                                     {
    sprintf(commandBuffer, "mac set appskey %s\r\n", key);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetDataRate()

RN2483_Status_t RN2483_SetDataRate	(	uint8_t	dr,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 203 of file rn2483.c.

                                                                                        {
    sprintf(commandBuffer, "mac set dr %i\r\n", dr);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetDeviceAddress()

RN2483_Status_t RN2483_SetDeviceAddress	(	char *	address,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 183 of file rn2483.c.

                                                                                                 {
    sprintf(commandBuffer, "mac set devaddr %s\r\n", address);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetDeviceEUI()

RN2483_Status_t RN2483_SetDeviceEUI	(	char *	eui,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 158 of file rn2483.c.

                                                                                         {
    sprintf(commandBuffer, "mac set deveui %s\r\n", eui);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetNetworkSessionKey()

RN2483_Status_t RN2483_SetNetworkSessionKey	(	char *	address,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 178 of file rn2483.c.

                                                                                                 {
    sprintf(commandBuffer, "mac set nwkskey %s\r\n", key);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_SetOutputPower()

RN2483_Status_t RN2483_SetOutputPower	(	uint8_t	pwr,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 188 of file rn2483.c.

                                                                                            {
    sprintf(commandBuffer, "mac set pwridx %i\r\n", pwr);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, false));
}

RN2483_Setup()

RN2483_Status_t RN2483_Setup	(	LoRaSettings_t	settings,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 270 of file rn2483.c.

                                                                                               {
    if(settings.activationMethod == OTAA){
        return (RN2483_SetupOTAA(settings, receiveBuffer, bufferSize));
    }else{
        return (RN2483_SetupABP(settings, receiveBuffer, bufferSize));
    }
}

RN2483_SetupABP()

RN2483_Status_t RN2483_SetupABP	(	LoRaSettings_t	settings,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 315 of file rn2483.c.

                                                                                                  {
    RN2483_Status_t status = RN2483_MacReset(receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    status = RN2483_SetDeviceAddress(settings.deviceAddress, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    status = RN2483_SetNetworkSessionKey(settings.networkSessionKey, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    status = RN2483_SetApplicationSessionKey(settings.applicationSessionKey, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    status = RN2483_SetDefaultOperation(settings, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    return (RN2483_JoinABP(receiveBuffer, bufferSize));
}

RN2483_SetupOTAA()

RN2483_Status_t RN2483_SetupOTAA	(	LoRaSettings_t	settings,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 278 of file rn2483.c.

                                                                                                   {
    RN2483_Status_t status = RN2483_MacReset(receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    if(settings.deviceEUI == NULL){
        status = RN2483_GetHardwareEUI(receiveBuffer, bufferSize);
        if(status != DATA_RETURNED){
            return (status);
        }
        char address[16];
        sprintf(address, "%s", receiveBuffer);
        status = RN2483_SetDeviceEUI(address, receiveBuffer, bufferSize);
        if(status != MAC_OK){
            return (status);
        }
    }else{
        status = RN2483_SetDeviceEUI(settings.deviceEUI, receiveBuffer, bufferSize);
        if(status != MAC_OK){
            return (status);
        }
    }
    status = RN2483_SetApplicationEUI(settings.applicationEUI, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    status = RN2483_SetApplicationKey(settings.applicationKey, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    status = RN2483_SetDefaultOperation(settings, receiveBuffer, bufferSize);
    if(status != MAC_OK){
        return (status);
    }
    return (RN2483_JoinOTAA(receiveBuffer, bufferSize));
}

RN2483_Sleep()

RN2483_Status_t RN2483_Sleep	(	uint32_t	sleepTime,
		volatile bool *	wakeUp,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 374 of file rn2483.c.

                                                                                                                  {
    sprintf(commandBuffer, "sys sleep %lu\r\n", (unsigned long) sleepTime);
    return (RN2483_ProcessSleepCommand(receiveBuffer, bufferSize, wakeUp));
}

RN2483_TransmitConfirmed()

RN2483_Status_t RN2483_TransmitConfirmed	(	uint8_t *	data,
		uint8_t	payloadSize,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 354 of file rn2483.c.

                                                                                                                       {
    char * encodedPayload;
    if(!HexToString(data, payloadSize, &encodedPayload )){
        return (MAC_ERR);
    }
    sprintf(commandBuffer, "mac tx cnf 1 %s\r\n", encodedPayload);
    free(encodedPayload);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, true));
}

RN2483_TransmitUnconfirmed()

RN2483_Status_t RN2483_TransmitUnconfirmed	(	uint8_t *	data,
		uint8_t	payloadSize,
		char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 339 of file rn2483.c.

                                                                                                                         {
    char * encodedPayload;
    if(!HexToString(data, payloadSize, &encodedPayload )){
        return (MAC_ERR);
    }
    //StringToHexString(data, payloadSize/2, &decodedPayload);

    // Sprintf caused a problem where it would overwrite data when using long LoRaWAN packets because the malloc statement
    //   in HexToString would create a too small buffer (according to RN2483_COMMANDBUFFER_SIZE, was 80 and increased to 160)
    //   compared to the data of the converted LoRaWAN packet.
    sprintf(commandBuffer, "mac tx uncnf 1 %s\r\n", encodedPayload);
    free(encodedPayload);
    return (RN2483_ProcessMacCommand(receiveBuffer, bufferSize, true));
}

RN2483_Wake()

RN2483_Status_t RN2483_Wake	(	char *	receiveBuffer,
		uint8_t	bufferSize
	)

Definition at line 379 of file rn2483.c.

                                                                     {
    Leuart_Reinit();

    /* Capture response "ok" from previous sleep command */
    Leuart_WaitForResponse();
    /* Read second response */
    Leuart_ReadResponse(receiveBuffer, bufferSize);
    if(StringStartsWith(receiveBuffer, "ok")){
        return (MAC_OK);
    }

    return (MAC_ERR);
}