FSK4Client Class Reference

Client for FSK-4 communication. The public interface is the same as Arduino Serial. More...

#include <FSK4.h>

Public Member Functions
	FSK4Client (PhysicalLayer *phy)
	Constructor for FSK-4 mode. More...
	FSK4Client (AFSKClient *audio)
	Constructor for AFSK mode. More...
int16_t	begin (float base, uint32_t shift, uint16_t rate)
	Initialization method. More...
void	idle ()
	Send out idle condition (RF tone at mark frequency).
size_t	write (uint8_t *buff, size_t len)
size_t	write (uint8_t b)

Detailed Description

Client for FSK-4 communication. The public interface is the same as Arduino Serial.

Constructor & Destructor Documentation

FSK4Client() [1/2]

FSK4Client::FSK4Client ( PhysicalLayer *  phy )

explicit

Constructor for FSK-4 mode.

Parameters

phy	Pointer to the wireless module providing PhysicalLayer communication.

FSK4Client() [2/2]

FSK4Client::FSK4Client ( AFSKClient *  audio )

explicit

Constructor for AFSK mode.

Parameters

audio

Pointer to the AFSK instance providing audio.

Member Function Documentation

begin()

int16_t FSK4Client::begin	(	float	base,
		uint32_t	shift,
		uint16_t	rate
	)

Initialization method.

Parameters

base	Base (space) frequency to be used in MHz (in FSK-4 mode), or the space tone frequency in Hz (in AFSK mode)
shift	Frequency shift between each tone in Hz.
rate	Baud rate to be used during transmission.

Returns

Status Codes

---

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

• src/protocols/FSK4/FSK4.h
• src/protocols/FSK4/FSK4.cpp