LoRaMAC  4.6.0
Documentation of the API
LoRaMacSerializer.h File Reference

LoRa MAC layer message serializer functionality implementation. More...

#include <stdint.h>
#include "LoRaMacMessageTypes.h"

Go to the source code of this file.

enum  LoRaMacSerializerStatus_t { LORAMAC_SERIALIZER_SUCCESS = 0, LORAMAC_SERIALIZER_ERROR_NPE, LORAMAC_SERIALIZER_ERROR_BUF_SIZE, LORAMAC_SERIALIZER_ERROR }
 
LoRaMacSerializerStatus_t LoRaMacSerializerJoinRequest (LoRaMacMessageJoinRequest_t *macMsg)
 
LoRaMacSerializerStatus_t LoRaMacSerializerReJoinType1 (LoRaMacMessageReJoinType1_t *macMsg)
 
LoRaMacSerializerStatus_t LoRaMacSerializerReJoinType0or2 (LoRaMacMessageReJoinType0or2_t *macMsg)
 
LoRaMacSerializerStatus_t LoRaMacSerializerData (LoRaMacMessageData_t *macMsg)
 

Detailed Description

LoRa MAC layer message serializer functionality implementation.

______ _
/ _____) _ | |
( (____ _____ ____ _| |_ _____ ____| |__
\____ \| ___ | (_ _) ___ |/ ___) _ \
_____) ) ____| | | || |_| ____( (___| | | |
(______/|_____)_|_|_| \__)_____)\____)_| |_|
(C)2013 Semtech
___ _____ _ ___ _ _____ ___ ___ ___ ___
/ __|_ _/_\ / __| |/ / __/ _ \| _ \/ __| __|
\__ \ | |/ _ \ (__| ' <| _| (_) | / (__| _|
|___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
embedded.connectivity.solutions===============
Author
Miguel Luis ( Semtech )
Gregory Cristian ( Semtech )
Daniel Jaeckle ( STACKFORCE )
Johannes Bruder ( STACKFORCE )

addtogroup LORAMAC

Enumeration Type Documentation

◆ LoRaMacSerializerStatus_t

LoRaMac Serializer Status

Enumerator
LORAMAC_SERIALIZER_SUCCESS 

No error occurred

LORAMAC_SERIALIZER_ERROR_NPE 

Null pointer exception

LORAMAC_SERIALIZER_ERROR_BUF_SIZE 

Incompatible buffer size

LORAMAC_SERIALIZER_ERROR 

Undefined Error occurred

Function Documentation

◆ LoRaMacSerializerJoinRequest()

LoRaMacSerializerStatus_t LoRaMacSerializerJoinRequest ( LoRaMacMessageJoinRequest_t macMsg)

Creates serialized MAC message of structured object.

Parameters
[IN/OUT]macMsg - Join-request message object
Return values
-Status of the operation

◆ LoRaMacSerializerReJoinType1()

LoRaMacSerializerStatus_t LoRaMacSerializerReJoinType1 ( LoRaMacMessageReJoinType1_t macMsg)

Creates serialized MAC message of structured object.

Parameters
[IN/OUT]macMsg - Join-request message object
Return values
-Status of the operation

◆ LoRaMacSerializerReJoinType0or2()

LoRaMacSerializerStatus_t LoRaMacSerializerReJoinType0or2 ( LoRaMacMessageReJoinType0or2_t macMsg)

Creates serialized MAC message of structured object.

Parameters
[IN/OUT]macMsg - Join-request message object
Return values
-Status of the operation

◆ LoRaMacSerializerData()

LoRaMacSerializerStatus_t LoRaMacSerializerData ( LoRaMacMessageData_t macMsg)

Creates serialized MAC message of structured object.

Parameters
[IN/OUT]macMsg - Data message object
Return values
-Status of the operation