The NSL01 library contains all functions for controlling the NSL01 LoRaWAN shield from mCloud System GmbH. The NSL01 is a professional plug & play LoRaWAN shield for a wide range of STM32 Nucleo-64 boards with Arduino Uno Rev 3 connectivity. For more information about the NSL01 LoRaWAN shield: http://www.mcloud-systems.com/nsl01-lorawan-nucleo-arduino-shield
Functions for NSL01 class to create a Human Control Interface (HCI) for controlling the onboard RF radio module. More...
Go to the source code of this file.
Typedefs | |
| typedef TWiMOD_HCI_Message *(* | TWiMOD_HCI_CbRxMessage )(TWiMOD_HCI_Message *rxMessage) |
| Human Control Interface (HCI) message receiver callback defintion. | |
Functions | |
| void | WiMOD_HCI_Init (TWiMOD_HCI_CbRxMessage cbRxMessage, TWiMOD_HCI_Message *rxMessage) |
| Function to initialize Human Control Interface (HCI) message layer. | |
| int | WiMOD_HCI_SendMessage (TWiMOD_HCI_Message *txMessage) |
| Function to transmit a message via specified Human Control Interface (HCI) with or without payload. | |
| void | WiMOD_HCI_Process () |
| Function to read/process incoming serial data, which is a user triggered function without using interrupts. | |
Detailed Description
Functions for NSL01 class to create a Human Control Interface (HCI) for controlling the onboard RF radio module.
For more information about the NSL01 LoRaWAN shield: http://www.mcloud-systems.com/nsl01-lorawan-nucleo-arduino-shield
- Note:
- The NSL01_HCI_Layer files are included in the dependencies directory of the project and these files are necessary for the NSL01 class!
- Version:
- V1.0
- Date:
- 20-June-2018
Definition in file NSL01_HCI_Layer.h.
Typedef Documentation
| typedef TWiMOD_HCI_Message*(* TWiMOD_HCI_CbRxMessage)(TWiMOD_HCI_Message *rxMessage) |
Human Control Interface (HCI) message receiver callback defintion.
- Parameters:
-
rxMessage : Pointer to HCI Rx message struct
Definition at line 102 of file NSL01_HCI_Layer.h.
Function Documentation
| void WiMOD_HCI_Init | ( | TWiMOD_HCI_CbRxMessage | cbRxMessage, |
| TWiMOD_HCI_Message * | rxMessage | ||
| ) |
Function to initialize Human Control Interface (HCI) message layer.
- Parameters:
-
cbRxMessage : Function pointer rxMessage : Pointer to HCI Rx message struct
Definition at line 77 of file NSL01_HCI_Layer.cpp.
| void WiMOD_HCI_Process | ( | ) |
Function to read/process incoming serial data, which is a user triggered function without using interrupts.
- Note:
- This function is not necessary at the moment, because the incoming serial data is processed via an Interrupt Service Routine (ISR).
Definition at line 196 of file NSL01_HCI_Layer.cpp.
| int WiMOD_HCI_SendMessage | ( | TWiMOD_HCI_Message * | txMessage ) |
Function to transmit a message via specified Human Control Interface (HCI) with or without payload.
- Parameters:
-
txMessage : Pointer to HCI Tx message struct
- Returns:
- 1 on success, -1 on error
Definition at line 113 of file NSL01_HCI_Layer.cpp.
Generated on Wed Jul 13 2022 06:29:55 by
1.7.2