Data Structures | Typedefs | Enumerations | Functions
BCDS_LoRaDevice.h File Reference
#include "BCDS_Basics.h"
#include "BCDS_Retcode.h"
#include "BCDS_LoRaDriversConfig.h"
+ Include dependency graph for BCDS_LoRaDevice.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  LoRaMacEventInfo_S
 

Typedefs

typedef void(* LoRa_callbackFunction_T )(void *, LoRaMacEventInfo_T *)
 
typedef enum LoRa_NetworkEvent_E LoRa_NetworkEvent_T
 
typedef enum LoRaDeviceBand_E LoRaDeviceBand_T
 
typedef enum LoRaDeviceJoin_E LoRaDeviceJoin_T
 
typedef enum LoRaDeviceTxPower_E LoRaDeviceTxPower_T
 
typedef struct LoRaMacEventInfo_S LoRaMacEventInfo_T
 

Enumerations

enum  BCDS_LORA_ModuleID_E
 BCDS_MODULE_ID for each LoRa C module usage: #undef BCDS_MODULE_ID #define BCDS_MODULE_ID BCDS_LORA_MODULE_ID_xxx. More...
 
enum  LoRa_NetworkEvent_E
 Network events for the supported drivers. More...
 
enum  LoRa_Retcode_E
 return value for the supported lora drivers More...
 
enum  LoRaDeviceBand_E
 
enum  LoRaDeviceJoin_E
 
enum  LoRaDeviceReset_E
 
enum  LoRaDeviceTxPower_E
 

Functions

Retcode_T LoRaDevice_Deinit (void)
 Switches off the module and deinitializes the driver. More...
 
Retcode_T LoRaDevice_GetADR (bool *adr)
 Returns the status of the Adaptive data Rate. More...
 
Retcode_T LoRaDevice_GetAppEUI (uint64_t *appEUI)
 Returns the device unique identifier used during the join procedure. More...
 
Retcode_T LoRaDevice_GetAutomaticReply (bool *autoReply)
 Returns the status of the automatic reply: ON or OFF. More...
 
Retcode_T LoRaDevice_GetBand (LoRaDeviceBand_T *band)
 Returns the frequency band in which the LoRa module is currently operating. More...
 
Retcode_T LoRaDevice_GetChannelDataRateRange (uint8_t chId, uint8_t *minRange, uint8_t *maxRange)
 Gets a channel's Data Rate range. More...
 
Retcode_T LoRaDevice_GetChannelDutyCycle (uint8_t chId, uint16_t *dutyCycle)
 Gets a channels duty cycle. More...
 
Retcode_T LoRaDevice_GetChannelFreq (uint8_t chId, uint32_t *freq_Hz)
 Gets the channel frequency. More...
 
Retcode_T LoRaDevice_GetChannelStatus (uint8_t chId, bool *status)
 Gets a channels Status. More...
 
Retcode_T LoRaDevice_GetDataRate (uint8_t *dataRate)
 Gets the Data Rate used for transmission. More...
 
uint32_t LoRaDevice_GetDemodulationMargin (void *)
 Gets the demodulation margin as received in the last Link_Check_Answer frame. More...
 
Retcode_T LoRaDevice_GetDevAddr (uint32_t *devAddr)
 returns the device address assigned by the network server to the module after successful join or preprogrammed in the device for ABP type join More...
 
Retcode_T LoRaDevice_GetDevEUI (uint64_t *devEUI)
 Returns the device unique identifier used during the join procedure. More...
 
uint32_t LoRaDevice_GetDutycyclePrescaler (void *)
 Gets the duty cycle prescaler which can only be configured by the network server. More...
 
Retcode_T LoRaDevice_GetFCntDown (uint32_t *dnctr)
 Gets the value of the current downlink frame counter. More...
 
Retcode_T LoRaDevice_GetFCntUp (uint32_t *upctr)
 Gets the value of the current uplink frame counter. More...
 
Retcode_T LoRaDevice_GetFrequencyDeviation (uint32_t *freqdev)
 Gets the frequency deviation configured for the device. More...
 
uint8_t LoRaDevice_GetGatewayNumber (void *)
 This command will return the number of gateways that successfully received the last Link_Check_Request frame command, as received in the last Link_Check_Answer. More...
 
Retcode_T LoRaDevice_GetHwEUI (uint64_t *hwEUI)
 Returns the globally unique identifier of the LoRa module (if existing) More...
 
Retcode_T LoRaDevice_GetIQInversion (bool *iqi)
 Gets the IQ inversion status. More...
 
Retcode_T LoRaDevice_GetRadioBandwidth (uint16_t *bandWidth_kHz)
 Get the value used for the radio bandwidth. More...
 
Retcode_T LoRaDevice_GetRadioCodingRate (char *codingRate)
 Get the coding rate used by the radio. More...
 
Retcode_T LoRaDevice_GetRadioCRC (bool *crc)
 Gets the Status of CRC use. More...
 
Retcode_T LoRaDevice_GetRadioFrequency (uint32_t *frequency_Hz)
 Gets the Frequency used for by the radio transceiver. More...
 
Retcode_T LoRaDevice_GetRadioPreambleLength (uint16_t *preamble)
 Gets the length of the preamble used by the radio transceiver. More...
 
Retcode_T LoRaDevice_GetRadioSNR (int8_t *snr)
 Get the signal noise ratio (SNR) of the last received packet. More...
 
Retcode_T LoRaDevice_GetRadioSpreadingFactor (uint8_t *sf)
 Gets the Spreading Factor currently configured for radio transmission. More...
 
Retcode_T LoRaDevice_GetRadioTxPower (int8_t *pwrout)
 returns the currently configured Radio transmission power More...
 
Retcode_T LoRaDevice_GetRetransmissions (uint8_t *retx)
 Gets the number of retransmissions used for an uplink confirmed packet. More...
 
Retcode_T LoRaDevice_GetRxDelay (uint32_t *rxDelay_ms)
 Gets the delay between the transmission and the first receive window. More...
 
Retcode_T LoRaDevice_GetRxWindow2 (uint8_t *dataRate, uint32_t *frequency_Hz, uint16_t band)
 Gets the data rate and frequency used for the second Receive window at the specified frequency band. More...
 
Retcode_T LoRaDevice_GetStatus (uint32_t *status)
 Gets the current status of the module. More...
 
Retcode_T LoRaDevice_GetSyncWord (uint8_t *sync)
 Gets the synchronization word for the LoRaWAN communication. More...
 
Retcode_T LoRaDevice_GetTxPower (LoRaDeviceTxPower_T *pwr)
 Gets the Radio transmit power. More...
 
Retcode_T LoRaDevice_Init (LoRa_callbackFunction_T EventCallback, uint32_t frequency)
 Switches ON the module and initializes the driver. More...
 
Retcode_T LoRaDevice_Join (LoRaDeviceJoin_T joinType)
 performs a join request if the device has not joined a network yet More...
 
Retcode_T LoRaDevice_LoRaWANPause (uint32_t *pauseWAN)
 Pauses the LoRaWAN stack functionality to allow transceiver (radio) configuration. More...
 
Retcode_T LoRaDevice_LoRaWANResume (void)
 This command resumes LoRaWAN stack functionality, in order to continue normal functionality after being paused. More...
 
Retcode_T LoRaDevice_RadioListen (uint16_t rxWindowSize_ms)
 Puts the Radio device into listening mode for a specified period of time. More...
 
Retcode_T LoRaDevice_RadioTransmit (uint8_t *dataBuffer, uint16_t dataBufferSize)
 Transmits a simple data frame over the radio transceiver of the LoRa device FSK or LoRa modulation can be used. More...
 
Retcode_T LoRaDevice_Reset (enum LoRaDeviceReset_E resetType)
 Performs Reset operation to the LoRa device. More...
 
Retcode_T LoRaDevice_ResetMac (uint16_t frequency)
 Performs Reset of the MAC layer of the LoRa module to a specific frequency band. More...
 
Retcode_T LoRaDevice_SaveConfig (void)
 Saves the device configuration to permanent storage. More...
 
Retcode_T LoRaDevice_SendConfirmed (uint8_t LoRaPort, uint8_t *dataBuffer, uint16_t dataBufferSize)
 Sends confirmed data over LoRa. More...
 
Retcode_T LoRaDevice_SendUnconfirmed (uint8_t LoRaPort, uint8_t *dataBuffer, uint16_t dataBufferSize)
 Sends unconfirmed data frame over LoRa. More...
 
Retcode_T LoRaDevice_SetADR (bool adr)
 Sets the Adaptive Data Rate option to ON/OFF. More...
 
Retcode_T LoRaDevice_SetAppEUI (uint64_t AppEui)
 Sets the Application unique identifier attributed by the device operator. More...
 
Retcode_T LoRaDevice_SetAppKey (uint8_t *appKey)
 Sets the Application key which is used to encrypt the join request messages. More...
 
Retcode_T LoRaDevice_SetAppSKey (uint8_t *appSKey)
 Sets The application session key used for the encryption of frames to the application server. More...
 
Retcode_T LoRaDevice_SetAutomaticReply (bool autoReply)
 Sets Automatic reply on or off. More...
 
Retcode_T LoRaDevice_SetBatteryLevel (uint8_t bat)
 Sets the battery level for Device Status Answer frame command response. More...
 
Retcode_T LoRaDevice_SetChannelDataRateRange (uint8_t chId, uint8_t minRange, uint8_t maxRange)
 Sets a channel's Data Rate range. More...
 
Retcode_T LoRaDevice_SetChannelDutyCycle (uint8_t chId, uint16_t dutyCycle)
 Sets a channel's duty cycle. More...
 
Retcode_T LoRaDevice_SetChannelFreq (uint8_t chId, uint32_t freq_Hz)
 Sets a channel's frequency. More...
 
Retcode_T LoRaDevice_SetChannelStatus (uint8_t chId, bool status)
 Sets a channels Status to ON or OFF. More...
 
Retcode_T LoRaDevice_SetDataRate (uint8_t dataRate)
 Sets the Data Rate used for the transmission. More...
 
Retcode_T LoRaDevice_SetDevAddr (uint32_t devAddr)
 Programs the device address to the LoRa module. More...
 
Retcode_T LoRaDevice_SetDevEUI (uint64_t DevEui)
 Sets the device unique identifier attributed by the device owner. More...
 
Retcode_T LoRaDevice_SetDutyCycle (bool enable)
 Sets the Duty cyle ON/OFF. More...
 
Retcode_T LoRaDevice_SetFCntDown (uint32_t dnctr)
 Sets the value of the downlink frame counter that will be used for the next uplink transmission. More...
 
Retcode_T LoRaDevice_SetFCntUp (uint32_t upctr)
 Sets the value of the uplink frame counter that will be used for the next uplink transmission. More...
 
Retcode_T LoRaDevice_SetFrequencyDeviation (uint32_t freqdev)
 Set the frequency deviation allowed by the end device. More...
 
Retcode_T LoRaDevice_SetIQInversion (bool iqi)
 Sets the IQ inversion to ON/OFF. More...
 
Retcode_T LoRaDevice_SetJoinAcceptDelay (uint32_t JoinAcceptDelay1, uint32_t JoinAcceptDelay2)
 Sets the delay between the Lora Join and JoinAccept reception window's. More...
 
Retcode_T LoRaDevice_SetLinkCheckPeriod (uint16_t linkchk)
 
Retcode_T LoRaDevice_SetNwSKey (uint8_t *nwSKey)
 sets the network session key for encryption of frames to the network server. More...
 
Retcode_T LoRaDevice_SetRadioBandwidth (uint16_t bandWidth_kHz)
 Set the value used for the radio bandwidth. More...
 
Retcode_T LoRaDevice_SetRadioCodingRate (char *codingRate)
 Set the coding rate used by the radio. More...
 
Retcode_T LoRaDevice_SetRadioCRC (bool crc)
 Enables or disables the use of CRC header. More...
 
Retcode_T LoRaDevice_SetRadioFrequency (uint32_t frequency_Hz)
 Sets the Frequency used for transmission by the radio transceiver. More...
 
Retcode_T LoRaDevice_SetRadioPreambleLength (uint16_t preamble)
 Sets the length of the preamble used for the radio transceiver. More...
 
Retcode_T LoRaDevice_SetRadioSpreadingFactor (uint8_t sf)
 Sets the spreading factor to be used for the next radio transmission. More...
 
Retcode_T LoRaDevice_SetRadioTxPower (int8_t pwrout)
 Sets the radio Transmission power used for transmitting packets in FSK modulation mode. More...
 
Retcode_T LoRaDevice_SetRetransmissions (uint8_t retx)
 Sets the number of retransmissions to be used for an uplink confirmed packet. More...
 
Retcode_T LoRaDevice_SetRxDelay (uint16_t rxDelay_ms)
 Sets the delay between the transmission and the first reception window. More...
 
Retcode_T LoRaDevice_SetRxWindow2 (uint32_t dataRate, uint32_t frequency_Hz)
 Sets the data rate and frequency used for the second Receive window. More...
 
Retcode_T LoRaDevice_SetRxWindowDelay (uint32_t rxDelay1, uint32_t rxDelay2)
 Sets the delay between the transmission and reception window's. More...
 
Retcode_T LoRaDevice_SetSyncWord (uint8_t sync)
 Sets the synchronization word for the LoRaWAN™ communication. More...
 
Retcode_T LoRaDevice_SetTxPower (LoRaDeviceTxPower_T pwr)
 Sets the Radio transmit power. More...
 
Retcode_T LoRaDevice_Sleep (uint32_t duration_ms)
 Puts the LoRa module in sleep mode. More...
 
Retcode_T LoRaDevice_SwitchOFF (void)
 Switches OFF the LoRa module. More...
 
Retcode_T LoRaDevice_SwitchON (void)
 Switches ON the LoRa module. More...
 
Retcode_T LoRaDevice_Wakeup (void)
 Wake up the module from sleep. More...
 

This documentation file has been automatically generated on Wed May 6 2020 20:45:16 by doxygen 1.8.8