XDK API  3.6.0
Documentation
Enumerations | Functions
LoRa RN2483/RN2903

Generic interface to the LPWAN (LoRa) RN2483/RN2903 BSP API. More...

+ Collaboration diagram for LoRa RN2483/RN2903:

Enumerations

enum  BSP_LoRa_RN2xx3_Retcode_E
 

Functions

Retcode_T BSP_LoRa_RN2xx3_ChangeBaudrate (uint32_t baudrate)
 Changes the baudrate of the communication interface. More...
 
Retcode_T BSP_LoRa_RN2xx3_Connect (void)
 Maps the GPIO pins to their desired function. More...
 
Retcode_T BSP_LoRa_RN2xx3_Disable (void)
 Disables the control over the peripheral. More...
 
Retcode_T BSP_LoRa_RN2xx3_Disconnect (void)
 Disconnects the LPWAN (LoRa) peripheral. More...
 
Retcode_T BSP_LoRa_RN2xx3_Enable (void)
 Enables the control over the peripheral. More...
 
HWHandle_T BSP_LoRa_RN2xx3_GetUartHandle (void)
 Returns the UART handle of the communication interface used by the peripheral. More...
 
Retcode_T BSP_LoRa_RN2xx3_SetResetPin (uint32_t state)
 Sets the reset pin of the module to the desired state Low or High. More...
 
Retcode_T BSP_LoRa_RN2xx3_WakeUp (void)
 Sends wake-up signal to the LoRa module. More...
 

Detailed Description

A prior call to BSP_Board_Initialize(param1, param2) function is necessary to initialize the MCU resources needed by the LPWAN (LoRa) device.

Once the LPWAN (LoRa) is requested a call to BSP_LoRa_RN2xx3_Connect() function is required to map the internal MCU resources to their associated function.

The application needs get the handle for the MCU resource driver via BSP_LoRa_RN2xx3_GetUartHandle() and to initialize the MCU resource driver by calling the MCU_<RESOURCE>_Initialize() and providing it with the previously acquired handle and an event callback function.

Then a call to BSP_LoRa_RN2xx3_Enable() will execute the required sequence to enable the LoRa module and the MCU resources dedicated for it (UART, SPI, I2C, etc.) and will associate the interrupt requests to their appropriate service routines.

The BSP_LoRa_RN2xx3_Disable() will revert back what the BSP_LoRa_RN2xx3_Enable() has done and set the LPWAN (LoRa) and the MCU resource into disabled state.

The BSP_LoRa_RN2xx3_Disconnect() will put the GPIO pins associated to the LoRa module in analog mode to further reduce the consumption.

Enumeration Type Documentation

enumeration representing return codes from the LoRa module BSP interface

Enumerator
RETCODE_BSP_LORA_SERIAL_NOT_INITIALIZED 
RETCODE_BSP_LORA_DISABLED 

Function Documentation

Retcode_T BSP_LoRa_RN2xx3_ChangeBaudrate ( uint32_t  baudrate)
Parameters
baudratedesired baudrate -if 0 will keep the current baudrate and send a break command with synchronization frame could be used to wakeup the module from sleep according to datasheet.
Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

Retcode_T BSP_LoRa_RN2xx3_Connect ( void  )

This function once called will map the GPIO pins to their desired functions to drive the Microchip(R) RN2483/RN2903 LPWAN (LoRa) peripheral. It is needed to call this function prior to the BSP_LoRa_RN2xx3_Enable().

Return values
RETCODE_OKin the case of success or an error code otherwise.
Retcode_T BSP_LoRa_RN2xx3_Disable ( void  )

This function once called will disable control over the Microchip(R) RN2483/RN2903 LPWAN (LoRa) peripheral by executing the disabling procedure as prescribed in the vendor datasheet.

Return values
RETCODE_OKin the case of success or an error code otherwise.
Retcode_T BSP_LoRa_RN2xx3_Disconnect ( void  )

This function disconnects the GPIO pins dedicatded to the Microchip(R) RN2483/RN2903 LPWAN (LoRa) peripheral and put them into low power consumption status.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

Retcode_T BSP_LoRa_RN2xx3_Enable ( void  )

A prior call to MCU_<RESOURCE>_Initialize() is necessary for this function in order to operate.This function once called will allow the Microchip(R) RN2483/RN2903 LPWAN (LoRa) peripheral to receive, execute commands and transmit process data.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

HWHandle_T BSP_LoRa_RN2xx3_GetUartHandle ( void  )

After successful execution of BSP_Board_Initialize(param1, param2), the application is free to call this function in order to get the handle needed by the resources drivers. This handle will be used by the MCU drivers for the intended resource.

Returns
HWHandle_T: Handle for the used MCU resource.
Retcode_T BSP_LoRa_RN2xx3_SetResetPin ( uint32_t  state)
Parameters
0for Low 1 for High
Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T BSP_LoRa_RN2xx3_WakeUp ( void  )
Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:


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:53 by doxygen 1.8.8