SRK Version of mDot LoRa_Sensormode_SRK

Dependencies:   libmDot mbed-rtos mbed

Fork of mDot_LoRa_Sensornode by Adrian Mitevski

Embed: (wiki syntax)

« Back to documentation index

LoRaConfig Class Reference

LoRaConfig Class Reference

A configuration container for the LoRa Module. More...

#include <LoRaConfig.h>

Public Member Functions

void build (LORA_MODE desiredMode)
 Generates a configuration according to the chosen LORA_MODE by setting all LoRa Module specific configuration values depending on the chosen LORA_MODE.
bool isPublic ()
 Gets info if the Network to which the LoRa Module sings up is public or not from its Configuration.
bool isActiv ()
 Gets info if LoRa Module will be active and run or not from its Configuration.
std::string getNetworkName ()
 Gets the name of the Network to which the LoRa Module sings up from its Configuration.
std::string getNetworkPassphrase ()
 Gets the Passphrase of the Network to which the LoRa Module sings up from its Configuration.
std::string getNetworkAddress ()
 Gets the Network Address.
std::vector< uint8_t > getAppEUI ()
 Gets the App EUI.
std::vector< uint8_t > getAppKey ()
 Gets the App Key.
std::vector< uint8_t > getDeviceEUI ()
 Gets the Device EUI.
uint8_t getFrequencySubBand ()
 Gets the frequency SubBand that will be used by the LoRa Module to send and receive its data from its Configuration.
uint8_t getSpreadingFactor ()
 Gets the spreading Factor that the LoRa Module will us for data transmission from its Configuration.
uint8_t getTxPowerdBm ()
 Gets the transmission Power of the LoRa Module from its Configuration.
uint8_t getAcknowledgeRetries ()
 Gets the number of Acknowledgment Retries that will be made from its Configuration.
LORA_MODE getLORA_MODE ()
 Gets the Actual LORA_MODE of the built LoRaConfiguration from its Configuration.
JOIN_MODE getJOIN_MODE ()
 Gets the Actual JOIN_MODE of the built LoRaConfiguration form its Configuration.

Detailed Description

A configuration container for the LoRa Module.

All its configuration values are stored an held inside this Class. Depending on the LORA_MODE it sets all the configuration values.

Definition at line 81 of file LoRaConfig.h.


Member Function Documentation

void build ( LORA_MODE  desiredMode )

Generates a configuration according to the chosen LORA_MODE by setting all LoRa Module specific configuration values depending on the chosen LORA_MODE.

Parameters:
desiredModethe mode to build the configuration according to

Definition at line 18 of file LoRaConfig.cpp.

uint8_t getAcknowledgeRetries (  )

Gets the number of Acknowledgment Retries that will be made from its Configuration.

Returns:

Definition at line 145 of file LoRaConfig.cpp.

std::vector< uint8_t > getAppEUI (  )

Gets the App EUI.

Returns:

Definition at line 121 of file LoRaConfig.cpp.

std::vector< uint8_t > getAppKey (  )

Gets the App Key.

Returns:

Definition at line 125 of file LoRaConfig.cpp.

std::vector< uint8_t > getDeviceEUI (  )

Gets the Device EUI.

Returns:

Definition at line 129 of file LoRaConfig.cpp.

uint8_t getFrequencySubBand (  )

Gets the frequency SubBand that will be used by the LoRa Module to send and receive its data from its Configuration.

Returns:

Definition at line 133 of file LoRaConfig.cpp.

JOIN_MODE getJOIN_MODE (  )

Gets the Actual JOIN_MODE of the built LoRaConfiguration form its Configuration.

Returns:

Definition at line 153 of file LoRaConfig.cpp.

LORA_MODE getLORA_MODE (  )

Gets the Actual LORA_MODE of the built LoRaConfiguration from its Configuration.

Returns:

Definition at line 149 of file LoRaConfig.cpp.

std::string getNetworkAddress (  )

Gets the Network Address.

Only used when using ABP JoinMode

Returns:

Definition at line 117 of file LoRaConfig.cpp.

std::string getNetworkName (  )

Gets the name of the Network to which the LoRa Module sings up from its Configuration.

Returns:

Definition at line 109 of file LoRaConfig.cpp.

std::string getNetworkPassphrase (  )

Gets the Passphrase of the Network to which the LoRa Module sings up from its Configuration.

Returns:

Definition at line 113 of file LoRaConfig.cpp.

uint8_t getSpreadingFactor (  )

Gets the spreading Factor that the LoRa Module will us for data transmission from its Configuration.

Returns:

Definition at line 137 of file LoRaConfig.cpp.

uint8_t getTxPowerdBm (  )

Gets the transmission Power of the LoRa Module from its Configuration.

Returns:

Definition at line 141 of file LoRaConfig.cpp.

bool isActiv (  )

Gets info if LoRa Module will be active and run or not from its Configuration.

Returns:

Definition at line 105 of file LoRaConfig.cpp.

bool isPublic (  )

Gets info if the Network to which the LoRa Module sings up is public or not from its Configuration.

Definition at line 101 of file LoRaConfig.cpp.