XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Enumerations | Enumerator | Functions | Variables

This module handles the LORA peripheral feature. More...

+ Collaboration diagram for LoRa:

Files

file  XDK_LoRa.h
 

Data Structures

struct  LoRa_Setup_S
 Structure to represent the LORA setup features. More...
 

Typedefs

typedef enum LoRa_Event_E LoRa_Event_T
 LORA events for the supported drivers. More...
 
typedef void(* LoRa_EventNotificationCB_T )(LoRa_Event_T event)
 Typedef of the LORA event notification callback. More...
 
typedef enum LoRa_JoinType_E LoRa_JoinType_T
 
typedef struct LoRa_Setup_S LoRa_Setup_T
 Typedef to represent the WLAN setup feature. More...
 

Enumerations

enum  LoRa_Event_E
 LORA events for the supported drivers. More...
 
enum  LoRa_JoinType_E
 

Functions

Retcode_T LoRa_Close (void)
 This will close the LoRa medium. More...
 
Retcode_T LoRa_Disable (void)
 This will disable the LoRa medium. More...
 
Retcode_T LoRa_Enable (void)
 This will enable the LORA(by calling this the Rxwindow2 frequency,DevEUI,appEUI,appKey, Coding rate will be set and saved) More...
 
Retcode_T LoRa_GetADR (bool *adr)
 Returns the status of the Adaptive data Rate. More...
 
Retcode_T LoRa_GetHwEUI (uint64_t *hwDevEUI)
 This will read the hardware dev EUI of the LoRa medium. More...
 
Retcode_T LoRa_Join (void)
 performs a join request if the device has not joined a network yet More...
 
Retcode_T LoRa_SendConfirmed (uint8_t LoRaPort, uint8_t *dataBuffer, uint32_t dataBufferSize)
 Sends confirmed data over LoRa. More...
 
Retcode_T LoRa_SendUnconfirmed (uint8_t LoRaPort, uint8_t *dataBuffer, uint32_t dataBufferSize)
 Sends unconfirmed data frame over LoRa. More...
 
Retcode_T LoRa_SetADR (bool enable)
 Sets the Adaptive Data Rate option to ON/OFF. More...
 
Retcode_T LoRa_SetDataRate (uint8_t dataRate)
 Sets the Data Rate used for the transmission. More...
 
Retcode_T LoRa_Setup (LoRa_Setup_T *setup)
 This will setup the LORA. More...
 

Variables

uint64_t AppEUI
 
uint8_t * AppKey
 
char * CodingRate
 
uint64_t * DevEUI
 
LoRa_EventNotificationCB_T EventCallback
 
uint32_t Freq
 
LoRa_JoinType_T JoinType
 
uint32_t RxFreq
 

Detailed Description


Data Structure Documentation

struct LoRa_Setup_S

Data Fields

uint64_t AppEUI
 
uint8_t * AppKey
 
char * CodingRate
 
uint64_t * DevEUI
 
LoRa_EventNotificationCB_T EventCallback
 
uint32_t Freq
 
LoRa_JoinType_T JoinType
 
uint32_t RxFreq
 

Typedef Documentation

typedef enum LoRa_Event_E LoRa_Event_T
typedef void(* LoRa_EventNotificationCB_T)(LoRa_Event_T event)
Parameters
[in]eventrun-time event of the LORA stack

Enumeration representing supported join procedures as in LoRaWAN specification V1.0.1

typedef struct LoRa_Setup_S LoRa_Setup_T

Enumeration Type Documentation

Enumerator
LORA_EVENT_RECEIVED_PACKET 
LORA_EVENT_SEND_FAILED 
LORA_EVENT_RECEIVE_FAILED 

Enumeration representing supported join procedures as in LoRaWAN specification V1.0.1

Enumerator
LORA_JOINTYPE_OTAA 
LORA_JOINTYPE_ABP 

Function Documentation

Retcode_T LoRa_Close ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Retcode_T LoRa_Disable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Retcode_T LoRa_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LoRa_GetADR ( bool *  adr)
Parameters
[out]adr
Returns
RETCODE_OK in case of success error code otherwise.
Retcode_T LoRa_GetHwEUI ( uint64_t *  hwDevEUI)
Parameters
[out]hwDevEUIplace holder for Unique Identifier of the LoRa module
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LoRa_Join ( void  )
Returns
RETCODE_OK in case of success error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LoRa_SendConfirmed ( uint8_t  LoRaPort,
uint8_t *  dataBuffer,
uint32_t  dataBufferSize 
)
Parameters
[in]LoRaPortThe LoraWan Port that will be used for sending
[in]dataBufferPointer to the data frame that will be sent
[in]dataBufferSizeLength of the frame to send
Returns
RETCODE_OK in case of success error code otherwise
Retcode_T LoRa_SendUnconfirmed ( uint8_t  LoRaPort,
uint8_t *  dataBuffer,
uint32_t  dataBufferSize 
)
Parameters
[in]LoRaPortThe LoraWan Port that will be used for sending
[in]dataBufferPointer to the data frame that will be sent
[in]dataBufferSizeLength of the frame to send
Returns
RETCODE_OK in case of success error code otherwise. This function returns if an ACK has been received from the Network Server or if an error or a timeout occurred

+ Here is the caller graph for this function:

Retcode_T LoRa_SetADR ( bool  enable)
Parameters
adrset to true if ADR is to be enabled, set to false otherwise.
Returns
RETCODE_OK in case of success error code otherwise.
Retcode_T LoRa_SetDataRate ( uint8_t  dataRate)
Parameters
[in]dataRateto be used according to LoRaWAN spec
Returns
RETCODE_OK in case of success error code otherwise.

+ Here is the caller graph for this function:

Retcode_T LoRa_Setup ( LoRa_Setup_T setup)
Parameters
[in]setupPointer to the LORA setup feature
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This must be the first API to be called if LORA feature is to be used.
  • Do not call this API more than once.

+ Here is the caller graph for this function:

Variable Documentation

uint64_t AppEUI

AppEUI is unique to the Application Server and each Application Server will have its own AppEUI

uint8_t* AppKey

AppKey is the data encryption key used to "encode" the messages between the end nodes and the Application Server

char* CodingRate

Coding rate used for LORA communication

uint64_t* DevEUI

Unique ID of the end device. if it is NULL then Hardware EUI will be used

LORA event callback

uint32_t Freq

Frequency band used for the LORA

LoRa_JoinType_T JoinType

LORA Join Type

uint32_t RxFreq

Frequency used for the Receive window


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8