The NSL01 library contains the software stack to control 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 have a look at: http://www.mcloud-systems.com/nsl01-lorawan-nucleo-arduino-shield

Fork of NSL01 by mCloud Systems

Embed: (wiki syntax)

« Back to documentation index

SLIP.h File Reference

SLIP.h File Reference

Functions for NSL01 class for SLIP encoder/decoder. More...

Go to the source code of this file.

Typedefs

typedef UINT8 *(* TSLIP_CbRxMessage )(UINT8 *message, int length)
 SLIP message receiver callback defintion.

Functions

void SLIP_Init (TSLIP_CbRxMessage cbRxMessage)
 Function to init SLIP decoder.
bool SLIP_SetRxBuffer (UINT8 *rxBuffer, int rxBufferSize)
 Function to init Rx buffer and enable receiver/decoder.
int SLIP_EncodeData (UINT8 *dstBuffer, int txBufferSize, UINT8 *srcData, int srcLength)
 Function to encode outgoing data.
void SLIP_DecodeData (UINT8 *srcData, int srcLength)
 Function to process/decode received byte stream.

Detailed Description

Functions for NSL01 class for SLIP encoder/decoder.

For more information about the NSL01 LoRaWAN shield: http://www.mcloud-systems.com/nsl01-lorawan-nucleo-arduino-shield

Note:
The SLIP files are included in the dependencies directory of the project and these files are necessary for the NSL01 class!
Author:
-
Version:
V1.0
Date:
20-June-2018

Definition in file SLIP.h.


Typedef Documentation

typedef UINT8*(* TSLIP_CbRxMessage)(UINT8 *message, int length)

SLIP message receiver callback defintion.

Parameters:
message: Pointer to message
length: Length of message

Definition at line 62 of file SLIP.h.


Function Documentation

void SLIP_DecodeData ( UINT8 *  srcData,
int  srcLength 
)

Function to process/decode received byte stream.

Parameters:
srcData: Pointer to source data
srcLength: Length of source data

Definition at line 236 of file SLIP.cpp.

int SLIP_EncodeData ( UINT8 *  dstBuffer,
int  txBufferSize,
UINT8 *  srcData,
int  srcLength 
)

Function to encode outgoing data.

Parameters:
dstBuffer: Pointer to destination buffer
txBufferSize: Tx message buffer size
srcData: Pointer to source data
srcLength: Length of source data
Returns:
>=0 on success, -1 on error

Definition at line 126 of file SLIP.cpp.

void SLIP_Init ( TSLIP_CbRxMessage  cbRxMessage )

Function to init SLIP decoder.

Parameters:
cbRxMessage: Message receiver callback

Definition at line 76 of file SLIP.cpp.

bool SLIP_SetRxBuffer ( UINT8 *  rxBuffer,
int  rxBufferSize 
)

Function to init Rx buffer and enable receiver/decoder.

Parameters:
rxBuffer: Pointer to Rx message buffer
rxBufferSize: Rx message buffer size
Returns:
true on success, false on error

Definition at line 189 of file SLIP.cpp.