RadioLib
Universal wireless communication library for Arduino
APRSClient Class Reference

Client for APRS communication. More...

#include <APRS.h>

Public Member Functions

 APRSClient (AX25Client *ax)
 Default constructor. More...
 
int16_t begin (char symbol, bool alt=false)
 Initialization method. More...
 
int16_t sendPosition (char *destCallsign, uint8_t destSSID, char *lat, char *lon, char *msg=NULL, char *time=NULL)
 Transmit position. More...
 
int16_t sendMicE (float lat, float lon, uint16_t heading, uint16_t speed, uint8_t type, uint8_t *telem=NULL, size_t telemLen=0, char *grid=NULL, char *status=NULL, int32_t alt=RADIOLIB_APRS_MIC_E_ALTITUDE_UNUSED)
 
int16_t sendFrame (char *destCallsign, uint8_t destSSID, char *info)
 Transmit generic APRS frame. More...
 

Detailed Description

Client for APRS communication.

Constructor & Destructor Documentation

◆ APRSClient()

APRSClient::APRSClient ( AX25Client ax)
explicit

Default constructor.

Parameters
axPointer to the instance of AX25Client to be used for APRS.

Member Function Documentation

◆ begin()

int16_t APRSClient::begin ( char  symbol,
bool  alt = false 
)

Initialization method.

Parameters
symbolAPRS symbol to be displayed.
altWhether to use the primary (false) or alternate (true) symbol table. Defaults to primary table.
Returns
Status Codes

◆ sendFrame()

int16_t APRSClient::sendFrame ( char *  destCallsign,
uint8_t  destSSID,
char *  info 
)

Transmit generic APRS frame.

Parameters
destCallsignDestination station callsign.
destSSIDDestination station SSID.
infoAX.25 info field contents.
Returns
Status Codes

◆ sendPosition()

int16_t APRSClient::sendPosition ( char *  destCallsign,
uint8_t  destSSID,
char *  lat,
char *  lon,
char *  msg = NULL,
char *  time = NULL 
)

Transmit position.

Parameters
destCallsignDestination station callsign.
destSSIDDestination station SSID.
latLatitude as a null-terminated string.
longLongitude as a null-terminated string.
msgMessage to be transmitted. Defaults to NULL (no message).
msgPosition timestamp. Defaults to NULL (no timestamp).
Returns
Status Codes

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