#include <Gamma868.h>

Inheritance diagram for Boardcore::Gamma868:

Collaboration diagram for Boardcore::Gamma868:

Public Member Functions
	Gamma868 (const char *serialPath, const uint16_t multiplier=0)

	Gamma868 (const char serialPath, miosix::GpioPin learnModePin, const uint16_t multiplier=0)

	~Gamma868 ()

bool	send (uint8_t *pkt, size_t packetLength) override
	Send a packet.

ssize_t	receive (uint8_t *pkt, size_t packetLength) override
	Wait until a new packet is received.

bool	configure (const GammaConf &newConf)

GammaConf	readConfig ()

GammaConf	getConfig ()

Public Member Functions inherited from Boardcore::Transceiver
	Transceiver ()

virtual	~Transceiver ()

Public Attributes
const int	LEARN_MODE_TIMEOUT = 5000

Detailed Description

Definition at line 34 of file Gamma868.h.

Constructor & Destructor Documentation

◆ Gamma868() [1/2]

Boardcore::Gamma868::Gamma868	(	const char *	serialPath,
		const uint16_t	multiplier = 0 )

explicit

Definition at line 35 of file Gamma868.cpp.

◆ Gamma868() [2/2]

Boardcore::Gamma868::Gamma868	(	const char *	serialPath,
		miosix::GpioPin *	learnModePin,
		const uint16_t	multiplier = 0 )

◆ ~Gamma868()

Boardcore::Gamma868::~Gamma868 ( )

Definition at line 62 of file Gamma868.cpp.

Member Function Documentation

◆ configure()

bool Boardcore::Gamma868::configure ( const GammaConf & newConf )

Definition at line 112 of file Gamma868.cpp.

◆ getConfig()

GammaConf Boardcore::Gamma868::getConfig ( )

inline

Definition at line 103 of file Gamma868.h.

◆ readConfig()

GammaConf Boardcore::Gamma868::readConfig ( )

Definition at line 88 of file Gamma868.cpp.

◆ receive()

ssize_t Boardcore::Gamma868::receive	(	uint8_t *	packet,
		size_t	packetLength )

overridevirtual

Wait until a new packet is received.

Parameters

packet	Buffer to store the packet (at least packetLength bytes).
packetLength	Maximum length of the received data.

Returns: Size of the data received or -1 if failure

Implements Boardcore::Transceiver.

Definition at line 77 of file Gamma868.cpp.

◆ send()

bool Boardcore::Gamma868::send	(	uint8_t *	packet,
		size_t	packetLength )

overridevirtual

Send a packet.

The function must block the thread until the packet is sent (successfully or not).

Parameters

packet	Pointer to the packet (at least packetLength bytes).
packetLength	Length of the packet to be sent.

Returns: True if the message was sent correctly.

Implements Boardcore::Transceiver.

Definition at line 67 of file Gamma868.cpp.

Member Data Documentation

◆ LEARN_MODE_TIMEOUT

const int Boardcore::Gamma868::LEARN_MODE_TIMEOUT = 5000

Definition at line 37 of file Gamma868.h.

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

src/shared/radio/gamma868/Gamma868.h
src/shared/radio/gamma868/Gamma868.cpp

Public Member Functions

Public Attributes