SEAN O CONNELL / Mbed 2 deprecated mDot_LoRa_Sensornode

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.
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.

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 62 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 130 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 118 of file LoRaConfig.cpp.

LORA_MODE getLORA_MODE (  )

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

Returns:

Definition at line 134 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 110 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 114 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 122 of file LoRaConfig.cpp.

uint8_t getTxPowerdBm (  )

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

Returns:

Definition at line 126 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 106 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 102 of file LoRaConfig.cpp.