Diff: app/LoRaConfig.h

Revision:

0:f2815503561f

Child:

1:fe242f3e341b

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/app/LoRaConfig.h	Wed Jul 06 20:40:36 2016 +0000
@@ -0,0 +1,205 @@
+/**
+ * @file LoRaConfig.h
+ *
+ * @author Adrian
+ * @date Jun 11, 2016
+ *
+ */
+
+#include <string>
+#include <stdint.h>
+#ifndef LORACONFIG_H_
+#define LORACONFIG_H_
+
+#define LORA_NETWORK_NAME				"conduitgwy"
+#define LORA_NETWORK_PASSPHRASE			"conduitgwy"
+
+#define LORA_SUBBAND_0						0
+#define LORA_SUBBAND_1						1
+#define LORA_SUBBAND_2						2
+#define LORA_SUBBAND_3						3
+#define LORA_SUBBAND_4						4
+#define LORA_SUBBAND_5						5
+#define LORA_SUBBAND_6						6
+#define LORA_SUBBAND_7						7
+#define LORA_SUBBAND_8						8
+
+#define LORA_SPREADING_FACTOR_7				7
+#define LORA_SPREADING_FACTOR_8				8
+#define LORA_SPREADING_FACTOR_9				9
+#define LORA_SPREADING_FACTOR_10			10
+#define LORA_SPREADING_FACTOR_11			11
+#define LORA_SPREADING_FACTOR_12			12
+
+#define LORA_TX_POWER_2_DBM					2
+#define LORA_TX_POWER_4_DBM					4
+#define LORA_TX_POWER_8_DBM					8
+#define LORA_TX_POWER_16_DBM				16
+#define LORA_TX_POWER_20_DBM				20
+
+#define LORA_ACKNOWLEDGE_RETRIES_0			0
+#define LORA_ACKNOWLEDGE_RETRIES_1			1
+#define LORA_ACKNOWLEDGE_RETRIES_2			2
+
+/**
+ * LoRa Modes.
+ */
+enum LORA_MODE{
+	LORA_MODE_0_OFF = 0,//!< LORA_MODE_0
+	LORA_MODE_1 = 1,//!< LORA_MODE_1
+	LORA_MODE_2 = 2,//!< LORA_MODE_2
+	LORA_MODE_3 = 3,//!< LORA_MODE_3
+	LORA_MODE_4 = 4,//!< LORA_MODE_4
+	LORA_MODE_5 = 5,//!< LORA_MODE_5
+};
+
+/**
+ * @class LoRaConfig
+ * @brief 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.
+ */
+class LoRaConfig {
+public:
+	LoRaConfig();
+	virtual ~LoRaConfig();
+
+	/**
+	 * @brief Generates a configuration according to the chosen LORA_MODE
+	 * by setting all LoRa Module specific configuration values depending on the chosen LORA_MODE
+	 * @param desiredMode the mode to build the configuration according to
+	 */
+	void build(LORA_MODE desiredMode);
+
+	/**
+	 * @brief Gets info if the Network to which the LoRa Module sings up
+	 * is public or not from its Configuration
+	 */
+	bool isPublic();
+
+	/**
+	 * @brief Gets info if LoRa Module will be active and run or not
+	 * from its Configuration
+	 * @return
+	 */
+	bool isActiv();
+
+	/**
+	 * @brief Gets the name of the Network to which the LoRa Module sings up
+	 * from its Configuration
+	 * @return
+	 */
+	std::string getNetworkName();
+
+	/**
+	 * @brief Gets the Passphrase of the Network to which the LoRa Module sings up
+	 * from its Configuration
+	 * @return
+	 */
+	std::string getNetworkPassphrase();
+
+	/**
+	 * @brief Gets the frequency SubBand that will be used by the LoRa Module to
+	 * send and receive its data from its Configuration
+	 * @return
+	 */
+	uint8_t getFrequencySubBand();
+
+	/**
+	 * @brief Gets the spreading Factor that the LoRa Module will us for data transmission
+	 * from its Configuration
+	 * @return
+	 */
+	uint8_t getSpreadingFactor();
+
+	/**
+	 * @brief Gets the transmission Power of the LoRa Module from its Configuration
+	 * @return
+	 */
+	uint8_t getTxPowerdBm();
+
+	/**
+	 * @brief Gets the number of Acknowledgment Retries that will be made
+	 * from its Configuration
+	 * @return
+	 */
+	uint8_t getAcknowledgeRetries();
+
+	/**
+	 * @brief Gets the Actual LORA_MODE of the built LoRaConfiguration
+	 * from its Configuration
+	 * @return
+	 */
+	LORA_MODE getLORA_MODE();
+
+
+private:
+	std::string* networkName;
+	std::string* networkPassphrase;
+	bool publicity;
+	bool activity;
+	uint8_t frequencySubBand;
+	uint8_t spreadingFactor;
+	uint8_t txPowerdBm;
+	uint8_t acknowledgeRetries;
+
+	LORA_MODE loraMode;
+
+
+	/**
+	 * @brief Sets the Network publicity of the network that will be used in the Configuration
+	 * @param
+	 */
+	void setNetworkPublicity(bool publicity);
+
+	/**
+	 * @brief Sets the Activity of the LoRa module for the Configuration
+	 * @param activity true = module will be active false = module will not be active
+	 */
+	void setActivity(bool activity);
+
+	/**
+	 * @brief Sets the Name of the Network that will be used in the Configuration
+	 * @param networkName the name of the network
+	 */
+	void setNetworkName(char* networkName);
+
+	/**
+	 * @brief Sets the Passphrase of the Network that will be used in the Configuration
+	 * @param networkPassphrase passphrase of the Network
+	 */
+	void setNetworkPassphrase(char* networkPassphrase);
+
+	/**
+	 * @brief Sets the SubBand that will be used in by the LoRa Module in the Configuration
+	 * @param subBand the SubBand that will be used
+	 */
+	void setFrequencySubBand(uint8_t subBand);
+
+	/**
+	 * @brief Sets the spreading Factor of a LoRa Data Transmission in the Configuration
+	 * @param spreadingFactor
+	 */
+	void setSpreadingFactor(uint8_t spreadingFactor);
+
+	/**
+	 * @brief Sets the Data transmission Power via LoRa in the Configuration
+	 * @param
+	 */
+	void setTxPowerdBm(uint8_t );
+
+	/**
+	 * @brief Set the Acknowledgment Retries in the Configuration
+	 * @param
+	 */
+	void setAcknowledgeRetries(uint8_t);
+
+	/**
+	 * @brief Sets the LORA_MODE of the Configuration
+	 * @param
+	 */
+	void setLORA_MODE(LORA_MODE);
+
+};
+
+#endif /* LORACONFIG_H_ */