RadioLib
Universal wireless communication library for Arduino
Public Member Functions | Friends | List of all members
AFSKClient Class Reference

Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direct mode transmission using DIO pins. More...

#include <AFSK.h>

Public Member Functions

 AFSKClient (PhysicalLayer *phy, RADIOLIB_PIN_TYPE pin)
 Default contructor. More...
 
int16_t begin ()
 Initialization method. More...
 
int16_t tone (uint16_t freq, bool autoStart=true)
 Start transmitting audio tone. More...
 
int16_t noTone ()
 Stops transmitting audio tone. More...
 

Friends

class RTTYClient
 
class MorseClient
 
class HellClient
 
class SSTVClient
 
class AX25Client
 
class FSK4Client
 

Detailed Description

Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direct mode transmission using DIO pins.

Constructor & Destructor Documentation

◆ AFSKClient()

AFSKClient::AFSKClient ( PhysicalLayer *  phy,
RADIOLIB_PIN_TYPE  pin 
)

Default contructor.

Parameters
phyPointer to the wireless module providing PhysicalLayer communication.
pinThe pin that will be used for audio output.

Member Function Documentation

◆ begin()

int16_t AFSKClient::begin ( )

Initialization method.

Returns
Status Codes

◆ noTone()

int16_t AFSKClient::noTone ( )

Stops transmitting audio tone.

Returns
Status Codes

◆ tone()

int16_t AFSKClient::tone ( uint16_t  freq,
bool  autoStart = true 
)

Start transmitting audio tone.

Parameters
freqFrequency of the tone in Hz.
autoStartWhether to automatically enter transmission mode. Defaults to true.
Returns
Status Codes
The documentation for this class was generated from the following files: