RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
LoRaWANPackage Class Reference

Common interface for all application packages. More...

#include <LoRaWANPacMan.h>

Inheritance diagram for LoRaWANPackage:
LoRaWANPackageTS003 LoRaWANPackageTS009

Public Types

typedef RadioLibTime_t(* GetSecondsCb_t) ()
 

Public Member Functions

 LoRaWANPackage (const LoRaWANPackage &obj)=delete
 
virtual size_t processData (const uint8_t *data, size_t len, LoRaWANEvent_t *event)
 Process a sequence of package commands and return how many bytes were consumed.
 
virtual LoRaWANTaskInfo hasTask ()
 Query the next scheduled task for this package.
 
virtual void doAction ()
 Perform an ACTION task (if any). Default no-op.
 
void getUplinkData (uint8_t *dataOut, size_t *lenOut)
 Get uplink data for UPLINK tasks. Returns internal buffer.
 
RadioLibTime_t getSeconds ()
 Get current time via the stored callback.
 

Detailed Description

Common interface for all application packages.

Member Function Documentation

◆ doAction()

void LoRaWANPackage::doAction ( )
virtual

Perform an ACTION task (if any). Default no-op.

Reimplemented in LoRaWANPackageTS003.

◆ getSeconds()

RadioLibTime_t LoRaWANPackage::getSeconds ( )
inline

Get current time via the stored callback.

Returns
Current time in seconds from the callback

◆ getUplinkData()

void LoRaWANPackage::getUplinkData ( uint8_t *  dataOut,
size_t *  lenOut 
)

Get uplink data for UPLINK tasks. Returns internal buffer.

Parameters
dataOutPointer to uplink buffer
lenOutPointer to uplink length

◆ hasTask()

LoRaWANTaskInfo LoRaWANPackage::hasTask ( )
virtual

Query the next scheduled task for this package.

Returns
LoRaWANTaskInfo containing task type and time

Reimplemented in LoRaWANPackageTS003.

◆ processData()

size_t LoRaWANPackage::processData ( const uint8_t *  data,
size_t  len,
LoRaWANEvent_t event 
)
virtual

Process a sequence of package commands and return how many bytes were consumed.

Parameters
dataPointer to incoming data
lenLength of incoming data
eventDownlink event details
Returns
Number of bytes consumed

Reimplemented in LoRaWANPackageTS003, and LoRaWANPackageTS009.


The documentation for this class was generated from the following files: