RF22 subclass for sending addressed, acknowledged, retransmitted datagrams. More...

#include <RF22ReliableDatagram.h>

Public Types
enum	ModemConfigChoice { UnmodulatedCarrier = 0, FSK_PN9_Rb2Fd5, FSK_Rb2Fd5, FSK_Rb2_4Fd36, FSK_Rb4_8Fd45, FSK_Rb9_6Fd45, FSK_Rb19_2Fd9_6, FSK_Rb38_4Fd19_6, FSK_Rb57_6Fd28_8, FSK_Rb125Fd125, GFSK_Rb2Fd5, GFSK_Rb2_4Fd36, GFSK_Rb4_8Fd45, GFSK_Rb9_6Fd45, GFSK_Rb19_2Fd9_6, GFSK_Rb38_4Fd19_6, GFSK_Rb57_6Fd28_8, GFSK_Rb125Fd125, OOK_Rb1_2Bw75, OOK_Rb2_4Bw335, OOK_Rb4_8Bw335, OOK_Rb9_6Bw335, OOK_Rb19_2Bw335, OOK_Rb38_4Bw335, OOK_Rb40Bw335 }
	Choices for setModemConfig() for a selected subset of common modulation types, and data rates. More...
Public Member Functions
	RF22ReliableDatagram (uint8_t thisAddress, PinName slaveSelectPin, PinName mosi, PinName miso, PinName sclk, PinName interrupt)
	Constructor.
void	setTimeout (uint16_t timeout)
	Sets the minimum retransmit timeout.
void	setRetries (uint8_t retries)
	Sets the max number of retries.
boolean	sendtoWait (uint8_t *buf, uint8_t len, uint8_t address)
	Send the message and waits for an ack.
boolean	recvfromAck (uint8_t buf, uint8_t len, uint8_t from=NULL, uint8_t to=NULL, uint8_t id=NULL, uint8_t flags=NULL)
	If there is a valid message available for this node, send an acknowledgement to the SRC address (blocking until this is complete), then copy the message to buf and return true else return false.
boolean	recvfromAckTimeout (uint8_t buf, uint8_t len, uint16_t timeout, uint8_t from=NULL, uint8_t to=NULL, uint8_t id=NULL, uint8_t flags=NULL)
	Similar to recvfromAck(), this will block until either a valid message available for this node or the timeout expires.
uint16_t	retransmissions ()
	Returns the number of retransmissions we have had to send.
boolean	init ()
	Initialises this instance and the radio module connected to it.
void	setThisAddress (uint8_t thisAddress)
	Sets the address of this node.
boolean	sendto (uint8_t *buf, uint8_t len, uint8_t address)
	Sends a message to the node(s) with the given address RF22_BROADCAST_ADDRESS is a valid address which will cause the message to be accepted by all RF22Datagram nodes within range.
boolean	recvfrom (uint8_t buf, uint8_t len, uint8_t from=NULL, uint8_t to=NULL, uint8_t id=NULL, uint8_t flags=NULL)
	Turns the receiver on if it not already on.
void	reset ()
	Issues a software reset to the RF22 module.
uint8_t	spiRead (uint8_t reg)
	Reads a single register from the RF22.
void	spiWrite (uint8_t reg, uint8_t val)
	Writes a single byte to the RF22.
void	spiBurstRead (uint8_t reg, uint8_t *dest, uint8_t len)
	Reads a number of consecutive registers from the RF22 using burst read mode.
void	spiBurstWrite (uint8_t reg, const uint8_t *src, uint8_t len)
	Write a number of consecutive registers using burst write mode.
uint8_t	statusRead ()
	Reads and returns the device status register RF22_REG_02_DEVICE_STATUS.
uint8_t	adcRead (uint8_t adcsel=RF22_ADCSEL_INTERNAL_TEMPERATURE_SENSOR, uint8_t adcref=RF22_ADCREF_BANDGAP_VOLTAGE, uint8_t adcgain=0, uint8_t adcoffs=0)
	Reads a value from the on-chip analog-digital converter.
uint8_t	temperatureRead (uint8_t tsrange=RF22_TSRANGE_M64_64C, uint8_t tvoffs=0)
	Reads the on-chip temperature sensoer.
uint16_t	wutRead ()
	Reads the wakeup timer value in registers RF22_REG_17_WAKEUP_TIMER_VALUE1 and RF22_REG_18_WAKEUP_TIMER_VALUE2.
void	setWutPeriod (uint16_t wtm, uint8_t wtr=0, uint8_t wtd=0)
	Sets the wakeup timer period registers RF22_REG_14_WAKEUP_TIMER_PERIOD1, RF22_REG_15_WAKEUP_TIMER_PERIOD2 and RF22_R<EG_16_WAKEUP_TIMER_PERIOD3.
boolean	setFrequency (float centre, float afcPullInRange=0.05)
	Sets the transmitter and receiver centre frequency.
boolean	setFHStepSize (uint8_t fhs)
	Sets the frequency hopping step size.
boolean	setFHChannel (uint8_t fhch)
	Sets the frequncy hopping channel.
uint8_t	rssiRead ()
	Reads and returns the current RSSI value from register RF22_REG_26_RSSI.
uint8_t	ezmacStatusRead ()
	Reads and returns the current EZMAC value from register RF22_REG_31_EZMAC_STATUS.
void	setMode (uint8_t mode)
	Sets the parameters for the RF22 Idle mode in register RF22_REG_07_OPERATING_MODE.
void	setModeIdle ()
	If current mode is Rx or Tx changes it to Idle.
void	setModeRx ()
	If current mode is Tx or Idle, changes it to Rx.
void	setModeTx ()
	If current mode is Rx or Idle, changes it to Rx.
uint8_t	mode ()
	Returns the operating mode of the library.
void	setTxPower (uint8_t power)
	Sets the transmitter power output level in register RF22_REG_6D_TX_POWER.
void	setModemRegisters (const ModemConfig *config)
	Sets all the registered required to configure the data modem in the RF22, including the data rate, bandwidths etc.
boolean	setModemConfig (ModemConfigChoice index)
	Select one of the predefined modem configurations.
boolean	available ()
	Starts the receiver and checks whether a received message is available.
void	waitAvailable ()
	Starts the receiver and blocks until a valid received message is available.
bool	waitAvailableTimeout (uint16_t timeout)
	Starts the receiver and blocks until a received message is available or a timeout.
boolean	recv (uint8_t buf, uint8_t len)
	Turns the receiver on if it not already on.
boolean	send (const uint8_t *data, uint8_t len)
	Waits until any previous transmit packet is finished being transmitted with waitPacketSent().
void	waitPacketSent ()
	Blocks until the RF22 is not in mode RF22_MODE_TX (ie until the RF22 is not transmitting).
void	setPromiscuous (boolean promiscuous)
	Tells the receiver to accept messages with any TO address, not just messages addressed to this node or the broadcast address.
uint8_t	headerTo ()
	Returns the TO header of the last received message.
uint8_t	headerFrom ()
	Returns the FROM header of the last received message.
uint8_t	headerId ()
	Returns the ID header of the last received message.
uint8_t	headerFlags ()
	Returns the FLAGS header of the last received message.
uint8_t	lastRssi ()
	Returns the RSSI (Receiver Signal Strength Indicator) of the last received message.
void	setPreambleLength (uint8_t nibbles)
	Sets the length of the preamble in 4-bit nibbles.
void	setSyncWords (const uint8_t *syncWords, uint8_t len)
	Sets the sync words for transmit and receive in registers RF22_REG_36_SYNC_WORD3 to RF22_REG_39_SYNC_WORD0 Caution: this should be set to the same value on all nodes in your network.
Static Public Member Functions
static void	printBuffer (const char prompt, const uint8_t buf, uint8_t len)
	Prints a data buffer in HEX.
Protected Member Functions
void	acknowledge (uint8_t id, uint8_t from)
	Send an ACK for the message id to the given from address Blocks until the ACK has been sent.
boolean	haveNewMessage ()
	Checks whether the message currently in the Rx buffer is a new message, not previously received based on the from address and the sequence.
void	handleInterrupt ()
	This is a low level function to handle the interrupts for one instance of RF22.
void	clearRxBuf ()
	Clears the receiver buffer.
void	clearTxBuf ()
	Clears the transmitter buffer Internal use only.
boolean	fillTxBuf (const uint8_t *data, uint8_t len)
	Fills the transmitter buffer with the data of a mesage to be sent.
boolean	appendTxBuf (const uint8_t *data, uint8_t len)
	Appends the transmitter buffer with the data of a mesage to be sent.
void	sendNextFragment ()
	Internal function to load the next fragment of the current message into the transmitter FIFO Internal use only.
void	readNextFragment ()
	function to copy the next fragment from the receiver FIF) into the receiver buffer
void	resetFifos ()
	Clears the RF22 Rx and Tx FIFOs Internal use only.
void	resetRxFifo ()
	Clears the RF22 Rx FIFO Internal use only.
void	resetTxFifo ()
	Clears the RF22 Tx FIFO Internal use only.
virtual void	handleExternalInterrupt ()
	This function will be called by handleInterrupt() if an RF22 external interrupt occurs.
virtual void	handleWakeupTimerInterrupt ()
	This function will be called by handleInterrupt() if an RF22 wakeup timer interrupt occurs.
void	setHeaderTo (uint8_t to)
	Sets the TO header to be sent in all subsequent messages.
void	setHeaderFrom (uint8_t from)
	Sets the FROM header to be sent in all subsequent messages.
void	setHeaderId (uint8_t id)
	Sets the ID header to be sent in all subsequent messages.
void	setHeaderFlags (uint8_t flags)
	Sets the FLAGS header to be sent in all subsequent messages.
void	startTransmit ()
	Start the transmission of the contents of the Tx buffer.
void	restartTransmit ()
	ReStart the transmission of the contents of the Tx buffer after a atransmission failure.
void	isr0 ()
	Low level interrupt service routine for RF22 connected to interrupt 0.
Protected Attributes
uint8_t	_thisAddress
	The address of this node. Defaults to 0.

Detailed Description

RF22 subclass for sending addressed, acknowledged, retransmitted datagrams.

Extends RF22Datagram to define addressed, reliable datagrams with acknowledgement and retransmission. Based on RF22Datagram, adds flags and sequence numbers. RF22ReliableDatagram is reliable in the sense that messages are acknowledged, and unacknowledged messages are retransmitted until acknowledged or the retries are exhausted. When addressed messages are sent (by sendtoWait()), it will wait for an ack, and retransmit after timeout until an ack is received or retries are exhausted. When addressed messages are collected by the application (by recvfromAck()), an acknowledgement is automatically sent.

The retransmit timeout is randomly varied between timeout and timeout*2 to prevent collisions on all retries when 2 nodes happen to start sending at the same time .

Each new message sent by sendtoWait() has its ID incremented.

An ack consists of a message with:

TO set to the from address of the original message
FROM set to this node address
ID set to the ID of the original message
FLAGS with the RF22_FLAGS_ACK bit set

Part of the Arduino RF22 library for operating with HopeRF RF22 compatible transceivers (see http://www.hoperf.com)

Definition at line 42 of file RF22ReliableDatagram.h.

Member Enumeration Documentation

enum ModemConfigChoice [inherited]

Choices for setModemConfig() for a selected subset of common modulation types, and data rates.

If you need another configuration, use the register calculator. and call setModemRegisters() with your desired settings These are indexes into _modemConfig

Enumerator:

UnmodulatedCarrier	Unmodulated carrier for testing.
FSK_PN9_Rb2Fd5	FSK, No Manchester, Rb = 2kbs, Fd = 5kHz, PN9 random modulation for testing.
FSK_Rb2Fd5	FSK, No Manchester, Rb = 2kbs, Fd = 5kHz.
FSK_Rb2_4Fd36	FSK, No Manchester, Rb = 2.4kbs, Fd = 36kHz.
FSK_Rb4_8Fd45	FSK, No Manchester, Rb = 4.8kbs, Fd = 45kHz.
FSK_Rb9_6Fd45	FSK, No Manchester, Rb = 9.6kbs, Fd = 45kHz.
FSK_Rb19_2Fd9_6	FSK, No Manchester, Rb = 19.2kbs, Fd = 9.6kHz.
FSK_Rb38_4Fd19_6	FSK, No Manchester, Rb = 38.4kbs, Fd = 19.6kHz.
FSK_Rb57_6Fd28_8	FSK, No Manchester, Rb = 57.6kbs, Fd = 28.8kHz.
FSK_Rb125Fd125	FSK, No Manchester, Rb = 125kbs, Fd = 125kHz.
GFSK_Rb2Fd5	GFSK, No Manchester, Rb = 2kbs, Fd = 5kHz.
GFSK_Rb2_4Fd36	GFSK, No Manchester, Rb = 2.4kbs, Fd = 36kHz.
GFSK_Rb4_8Fd45	GFSK, No Manchester, Rb = 4.8kbs, Fd = 45kHz.
GFSK_Rb9_6Fd45	GFSK, No Manchester, Rb = 9.6kbs, Fd = 45kHz.
GFSK_Rb19_2Fd9_6	GFSK, No Manchester, Rb = 19.2kbs, Fd = 9.6kHz.
GFSK_Rb38_4Fd19_6	GFSK, No Manchester, Rb = 38.4kbs, Fd = 19.6kHz.
GFSK_Rb57_6Fd28_8	GFSK, No Manchester, Rb = 57.6kbs, Fd = 28.8kHz.
GFSK_Rb125Fd125	GFSK, No Manchester, Rb = 125kbs, Fd = 125kHz.
OOK_Rb1_2Bw75	OOK, No Manchester, Rb = 1.2kbs, Rx Bandwidth = 75kHz.
OOK_Rb2_4Bw335	OOK, No Manchester, Rb = 2.4kbs, Rx Bandwidth = 335kHz.
OOK_Rb4_8Bw335	OOK, No Manchester, Rb = 4.8kbs, Rx Bandwidth = 335kHz.
OOK_Rb9_6Bw335	OOK, No Manchester, Rb = 9.6kbs, Rx Bandwidth = 335kHz.
OOK_Rb19_2Bw335	OOK, No Manchester, Rb = 19.2kbs, Rx Bandwidth = 335kHz.
OOK_Rb38_4Bw335	OOK, No Manchester, Rb = 38.4kbs, Rx Bandwidth = 335kHz.
OOK_Rb40Bw335	OOK, No Manchester, Rb = 40kbs, Rx Bandwidth = 335kHz.

Definition at line 758 of file RF22.h.

Constructor & Destructor Documentation

RF22ReliableDatagram	(	uint8_t	thisAddress,
		PinName	slaveSelectPin,
		PinName	mosi,
		PinName	miso,
		PinName	sclk,
		PinName	interrupt
	)

Constructor.

Parameters:

[in]	thisAddress	The address to assign to this node. Defaults to 0
[in]	slaveSelectPin	the Arduino pin number of the output to use to select the RF22 before accessing it. Defaults to the normal SS pin for your Arduino (D10 for Diecimila, Uno etc, D53 for Mega)
[in]	interrupt	The interrupt number to use. Default is interrupt 0 (Arduino input pin 2)

Definition at line 21 of file RF22ReliableDatagram.cpp.

Member Function Documentation

void acknowledge	(	uint8_t	id,
		uint8_t	from
	)		`[protected]`

Send an ACK for the message id to the given from address Blocks until the ACK has been sent.

Definition at line 155 of file RF22ReliableDatagram.cpp.

uint8_t adcRead	(	uint8_t	adcsel = `RF22_ADCSEL_INTERNAL_TEMPERATURE_SENSOR`,
		uint8_t	adcref = `RF22_ADCREF_BANDGAP_VOLTAGE`,
		uint8_t	adcgain = `0`,
		uint8_t	adcoffs = `0`
	)		`[inherited]`

Reads a value from the on-chip analog-digital converter.

Parameters:

[in]	adcsel	Selects the ADC input to measure. One of RF22_ADCSEL_*. Defaults to the internal temperature sensor
[in]	adcref	Specifies the refernce voltage to use. One of RF22_ADCREF_*. Defaults to the internal bandgap voltage.
[in]	adcgain	Amplifier gain selection.
[in]	adcoffs	Amplifier offseet (0 to 15).

Returns:: The analog value. 0 to 255.

Definition at line 409 of file RF22.cpp.

boolean appendTxBuf	(	const uint8_t *	data,
		uint8_t	len
	)		`[protected, inherited]`

Appends the transmitter buffer with the data of a mesage to be sent.

Parameters:

[in]	data	Array of data bytes to be sent (0 to 255)
[in]	len	Number of data bytes in data

Returns:: false if the resulting message would exceed RF22_MAX_MESSAGE_LEN, else true

Definition at line 716 of file RF22.cpp.

boolean available ( ) [inherited]

Starts the receiver and checks whether a received message is available.

This can be called multiple times in a timeout loop

Returns:: true if a complete, valid message has been received and is able to be retrieved by recv()

Definition at line 603 of file RF22.cpp.

void clearRxBuf ( ) [protected, inherited]

Clears the receiver buffer.

Internal use only

Definition at line 595 of file RF22.cpp.

void clearTxBuf ( ) [protected, inherited]

Clears the transmitter buffer Internal use only.

Definition at line 670 of file RF22.cpp.

uint8_t ezmacStatusRead ( ) [inherited]

Reads and returns the current EZMAC value from register RF22_REG_31_EZMAC_STATUS.

Returns:: The current EZMAC value

Definition at line 508 of file RF22.cpp.

boolean fillTxBuf	(	const uint8_t *	data,
		uint8_t	len
	)		`[protected, inherited]`

Fills the transmitter buffer with the data of a mesage to be sent.

Parameters:

[in]	data	Array of data bytes to be sent (1 to 255)
[in]	len	Number of data bytes in data (> 0)

Returns:: true if the message length is valid

Definition at line 708 of file RF22.cpp.

void handleExternalInterrupt ( ) [protected, virtual, inherited]

This function will be called by handleInterrupt() if an RF22 external interrupt occurs.

This can only happen if external interrupts are enabled in the RF22 (which they are not by default). Subclasses may override this function to get control when an RF22 external interrupt occurs.

Definition at line 777 of file RF22.cpp.

void handleInterrupt ( ) [protected, inherited]

This is a low level function to handle the interrupts for one instance of RF22.

Called automatically by isr0() and isr1() Should not need to be called.

Definition at line 192 of file RF22.cpp.

void handleWakeupTimerInterrupt ( ) [protected, virtual, inherited]

This function will be called by handleInterrupt() if an RF22 wakeup timer interrupt occurs.

This can only happen if wakeup timer interrupts are enabled in the RF22 (which they are not by default). Subclasses may override this function to get control when an RF22 wakeup timer interrupt occurs.

Definition at line 782 of file RF22.cpp.

boolean haveNewMessage ( ) [protected]

Checks whether the message currently in the Rx buffer is a new message, not previously received based on the from address and the sequence.

If it is new, it is acknowledged and returns true

Returns:: true if there is a message received and it is a new message

uint8_t headerFlags ( ) [inherited]

Returns the FLAGS header of the last received message.

Returns:: The FLAGS header

Definition at line 821 of file RF22.cpp.

uint8_t headerFrom ( ) [inherited]

Returns the FROM header of the last received message.

Returns:: The FROM header

Definition at line 811 of file RF22.cpp.

uint8_t headerId ( ) [inherited]

Returns the ID header of the last received message.

Returns:: The ID header

Definition at line 816 of file RF22.cpp.

uint8_t headerTo ( ) [inherited]

Returns the TO header of the last received message.

Returns:: The TO header

Definition at line 806 of file RF22.cpp.

boolean init ( ) [inherited]

Initialises this instance and the radio module connected to it.

Overrides the init() function in RF22

Reimplemented from RF22.

Reimplemented in RF22Router.

Definition at line 18 of file RF22Datagram.cpp.

void isr0 ( ) [protected, inherited]

Low level interrupt service routine for RF22 connected to interrupt 0.

Definition at line 335 of file RF22.cpp.

uint8_t lastRssi ( ) [inherited]

Returns the RSSI (Receiver Signal Strength Indicator) of the last received message.

This measurement is taken when the preamble has been received. It is a (non-linear) measure of the received signal strength.

Returns:: The RSSI

Definition at line 826 of file RF22.cpp.

uint8_t mode ( ) [inherited]

Returns the operating mode of the library.

Returns:: the current mode, one of RF22_MODE_*

Definition at line 547 of file RF22.cpp.

void printBuffer	(	const char *	prompt,
		const uint8_t *	buf,
		uint8_t	len
	)		`[static, inherited]`

Prints a data buffer in HEX.

For diagnostic use

Parameters:

[in]	prompt	string to preface the print
[in]	buf	Location of the buffer to print
[in]	len	Length of the buffer in octets.

Definition at line 637 of file RF22.cpp.

void readNextFragment ( ) [protected, inherited]

function to copy the next fragment from the receiver FIF) into the receiver buffer

Definition at line 745 of file RF22.cpp.

boolean recv	(	uint8_t *	buf,
		uint8_t *	len
	)		`[inherited]`

Turns the receiver on if it not already on.

If there is a valid message available, copy it to buf and return true else return false. If a message is copied, *len is set to the length (Caution, 0 length messages are permitted). You should be sure to call this function frequently enough to not miss any messages It is recommended that you call it in your main loop.

Parameters:

[in]	buf	Location to copy the received message
[in,out]	len	Pointer to available space in buf. Set to the actual number of octets copied.

Returns:: true if a valid message was copied to buf

Definition at line 655 of file RF22.cpp.

boolean recvfrom	(	uint8_t *	buf,
		uint8_t *	len,
		uint8_t *	from = `NULL`,
		uint8_t *	to = `NULL`,
		uint8_t *	id = `NULL`,
		uint8_t *	flags = `NULL`
	)		`[inherited]`

Turns the receiver on if it not already on.

If there is a valid message available for this node, copy it to buf and return true The SRC address is placed in *from if present and not NULL. The DEST address is placed in *to if present and not NULL. If a message is copied, *len is set to the length. You should be sure to call this function frequently enough to not miss any messages It is recommended that you call it in your main loop.

Parameters:

[in]	buf	Location to copy the received message
[in,out]	len	Pointer to available space in buf. Set to the actual number of octets copied.
[in]	from	If present and not NULL, the referenced uint8_t will be set to the FROM address
[in]	to	If present and not NULL, the referenced uint8_t will be set to the TO address
[in]	id	If present and not NULL, the referenced uint8_t will be set to the ID
[in]	flags	If present and not NULL, the referenced uint8_t will be set to the FLAGS (not just those addressed to this node).

Returns:: true if a valid message was copied to buf

Definition at line 41 of file RF22Datagram.cpp.

boolean recvfromAck	(	uint8_t *	buf,
		uint8_t *	len,
		uint8_t *	from = `NULL`,
		uint8_t *	to = `NULL`,
		uint8_t *	id = `NULL`,
		uint8_t *	flags = `NULL`
	)

If there is a valid message available for this node, send an acknowledgement to the SRC address (blocking until this is complete), then copy the message to buf and return true else return false.

If a message is copied, *len is set to the length.. If from is not NULL, the SRC address is placed in *from. If to is not NULL, the DEST address is placed in *to. This is the preferred function for getting messages addressed to this node. If the message is not a broadcast, acknowledge to the sender before returning. You should be sure to call this function frequently enough to not miss any messages It is recommended that you call it in your main loop.

Parameters:

[in]	buf	Location to copy the received message
[in,out]	len	Available space in buf. Set to the actual number of octets copied.
[in]	from	If present and not NULL, the referenced uint8_t will be set to the SRC address
[in]	to	If present and not NULL, the referenced uint8_t will be set to the DEST address
[in]	id	If present and not NULL, the referenced uint8_t will be set to the ID
[in]	flags	If present and not NULL, the referenced uint8_t will be set to the FLAGS (not just those addressed to this node).

Returns:: true if a valid message was copied to buf

Reimplemented in RF22Mesh, and RF22Router.

Definition at line 105 of file RF22ReliableDatagram.cpp.

boolean recvfromAckTimeout	(	uint8_t *	buf,
		uint8_t *	len,
		uint16_t	timeout,
		uint8_t *	from = `NULL`,
		uint8_t *	to = `NULL`,
		uint8_t *	id = `NULL`,
		uint8_t *	flags = `NULL`
	)

Similar to recvfromAck(), this will block until either a valid message available for this node or the timeout expires.

Starts the receiver automatically. You should be sure to call this function frequently enough to not miss any messages It is recommended that you call it in your main loop.

Parameters:

[in]	buf	Location to copy the received message
[in,out]	len	Available space in buf. Set to the actual number of octets copied.
[in]	timeout	Maximum time to wait in milliseconds
[in]	from	If present and not NULL, the referenced uint8_t will be set to the SRC address
[in]	to	If present and not NULL, the referenced uint8_t will be set to the DEST address
[in]	id	If present and not NULL, the referenced uint8_t will be set to the ID
[in]	flags	If present and not NULL, the referenced uint8_t will be set to the FLAGS (not just those addressed to this node).

Returns:: true if a valid message was copied to buf

Reimplemented in RF22Mesh, and RF22Router.

Definition at line 141 of file RF22ReliableDatagram.cpp.

void reset ( ) [inherited]

Issues a software reset to the RF22 module.

Blocks for 1ms to ensure the reset is complete.

Definition at line 348 of file RF22.cpp.

void resetFifos ( ) [protected, inherited]

Clears the RF22 Rx and Tx FIFOs Internal use only.

Definition at line 756 of file RF22.cpp.

void resetRxFifo ( ) [protected, inherited]

Clears the RF22 Rx FIFO Internal use only.

Definition at line 763 of file RF22.cpp.

void resetTxFifo ( ) [protected, inherited]

Clears the RF22 Tx FIFO Internal use only.

Definition at line 770 of file RF22.cpp.

void restartTransmit ( ) [protected, inherited]

ReStart the transmission of the contents of the Tx buffer after a atransmission failure.

Definition at line 687 of file RF22.cpp.

uint16_t retransmissions ( )

Returns the number of retransmissions we have had to send.

Returns:: The number of retransmissions since initialisation.

Definition at line 150 of file RF22ReliableDatagram.cpp.

uint8_t rssiRead ( ) [inherited]

Reads and returns the current RSSI value from register RF22_REG_26_RSSI.

If you want to find the RSSI of the last received message, use lastRssi() instead.

Returns:: The current RSSI value

Definition at line 503 of file RF22.cpp.

boolean send	(	const uint8_t *	data,
		uint8_t	len
	)		`[inherited]`

Waits until any previous transmit packet is finished being transmitted with waitPacketSent().

Then loads a message into the transmitter and starts the transmitter. Note that a message length of 0 is NOT permitted.

Parameters:

[in]	data	Array of data to be sent
[in]	len	Number of bytes of data to send (> 0)

Returns:: true if the message length was valid and it was correctly queued for transmit

Definition at line 695 of file RF22.cpp.

void sendNextFragment ( ) [protected, inherited]

Internal function to load the next fragment of the current message into the transmitter FIFO Internal use only.

Definition at line 730 of file RF22.cpp.

boolean sendto	(	uint8_t *	buf,
		uint8_t	len,
		uint8_t	address
	)		`[inherited]`

Sends a message to the node(s) with the given address RF22_BROADCAST_ADDRESS is a valid address which will cause the message to be accepted by all RF22Datagram nodes within range.

Parameters:

[in]	buf	Pointer to the binary message to send
[in]	len	Number of octets to send (> 0)
[in]	address	The address to send the message to.

Returns:: true if the message was transmitted.

Definition at line 35 of file RF22Datagram.cpp.

boolean sendtoWait	(	uint8_t *	buf,
		uint8_t	len,
		uint8_t	address
	)

Send the message and waits for an ack.

Returns true if an acknowledgement is received. Synchronous: any message other than the desired ACK received while waiting is discarded. Blocks until an ACK is received or all retries are exhausted (ie up to retries*timeout milliseconds).

Parameters:

[in]	address	The address to send the message to.
[in]	buf	Pointer to the binary message to send
[in]	len	Number of octets to send

Returns:: true if the message was transmitted and an acknowledgement was received.

Reimplemented in RF22Mesh, and RF22Router.

Definition at line 43 of file RF22ReliableDatagram.cpp.

boolean setFHChannel ( uint8_t fhch ) [inherited]

Sets the frequncy hopping channel.

Adds fhch * fhs to centre frequency

Parameters:

[in] fhch The channel number

Returns:: true if the selected frquency centre + (fhch * fhs) is within range

Definition at line 497 of file RF22.cpp.

boolean setFHStepSize ( uint8_t fhs ) [inherited]

Sets the frequency hopping step size.

Parameters:

[in] fhs Frequency Hopping step size in 10kHz increments

Returns:: true if centre + (fhch * fhs) is within limits

Definition at line 489 of file RF22.cpp.

boolean setFrequency	(	float	centre,
		float	afcPullInRange = `0.05`
	)		`[inherited]`

Sets the transmitter and receiver centre frequency.

Parameters:

[in]	centre	Frequency in MHz. 240.0 to 960.0. Caution, some versions of RF22 and derivatives implemented more restricted frequency ranges.
[in]	afcPullInRange	Sets the AF Pull In Range in MHz. Defaults to 0.05MHz (50kHz). Range is 0.0 to 0.159375 for frequencies 240.0 to 480MHz, and 0.0 to 0.318750MHz for frequencies 480.0 to 960MHz,

Returns:: true if the selected frquency centre + (fhch * fhs) is within range and the afcPullInRange is within range

Definition at line 454 of file RF22.cpp.

void setHeaderFlags ( uint8_t flags ) [protected, inherited]

Sets the FLAGS header to be sent in all subsequent messages.

Parameters:

[in] flags The new FLAGS header value

Definition at line 801 of file RF22.cpp.

void setHeaderFrom ( uint8_t from ) [protected, inherited]

Sets the FROM header to be sent in all subsequent messages.

Parameters:

[in] from The new FROM header value

Definition at line 791 of file RF22.cpp.

void setHeaderId ( uint8_t id ) [protected, inherited]

Sets the ID header to be sent in all subsequent messages.

Parameters:

[in] id The new ID header value

Definition at line 796 of file RF22.cpp.

void setHeaderTo ( uint8_t to ) [protected, inherited]

Sets the TO header to be sent in all subsequent messages.

Parameters:

[in] to The new TO header value

Definition at line 786 of file RF22.cpp.

void setMode ( uint8_t mode ) [inherited]

Sets the parameters for the RF22 Idle mode in register RF22_REG_07_OPERATING_MODE.

Idle mode is the mode the RF22 will be in when not transmitting or receiving. The default idle mode is RF22_XTON ie READY mode.

Parameters:

[in] mode Mask of mode bits, using RF22_SWRES, RF22_ENLBD, RF22_ENWT, RF22_X32KSEL, RF22_PLLON, RF22_XTON.

Definition at line 513 of file RF22.cpp.

void setModeIdle ( ) [inherited]

If current mode is Rx or Tx changes it to Idle.

If the transmitter or receiver is running, disables them.

Definition at line 518 of file RF22.cpp.

boolean setModemConfig ( ModemConfigChoice index ) [inherited]

Select one of the predefined modem configurations.

If you need a modem configuration not provided here, use setModemRegisters() with your own ModemConfig.

Parameters:

[in] index The configuration choice.

Returns:: true if index is a valid choice.

Definition at line 571 of file RF22.cpp.

void setModemRegisters ( const ModemConfig * config ) [inherited]

Sets all the registered required to configure the data modem in the RF22, including the data rate, bandwidths etc.

You cas use this to configure the modem with custom configuraitons if none of the canned configurations in ModemConfigChoice suit you.

Parameters:

[in] config A ModemConfig structure containing values for the modem configuration registers.

Definition at line 558 of file RF22.cpp.

void setModeRx ( ) [inherited]

If current mode is Tx or Idle, changes it to Rx.

Starts the receiver in the RF22.

Definition at line 526 of file RF22.cpp.

void setModeTx ( ) [inherited]

If current mode is Rx or Idle, changes it to Rx.

Starts the transmitter in the RF22.

Definition at line 534 of file RF22.cpp.

void setPreambleLength ( uint8_t nibbles ) [inherited]

Sets the length of the preamble in 4-bit nibbles.

Caution: this should be set to the same value on all nodes in your network. Default is 8. Sets the message preamble length in RF22_REG_34_PREAMBLE_LENGTH

Parameters:

[in] nibbles Preamble length in nibbles of 4 bits each.

Definition at line 584 of file RF22.cpp.

void setPromiscuous ( boolean promiscuous ) [inherited]

Tells the receiver to accept messages with any TO address, not just messages addressed to this node or the broadcast address.

Parameters:

[in] promiscuous true if you wish to receive messages with any TO address

Definition at line 831 of file RF22.cpp.

void setRetries ( uint8_t retries )

Sets the max number of retries.

Defaults to 3. If set to 0, the message will only be sent once. sendtoWait will give up and return false if there is no ack received after all transmissions time out. param[in] retries The maximum number a retries.

Definition at line 37 of file RF22ReliableDatagram.cpp.

void setSyncWords	(	const uint8_t *	syncWords,
		uint8_t	len
	)		`[inherited]`

Sets the sync words for transmit and receive in registers RF22_REG_36_SYNC_WORD3 to RF22_REG_39_SYNC_WORD0 Caution: this should be set to the same value on all nodes in your network.

Default is { 0x2d, 0xd4 }

Parameters:

[in]	syncWords	Array of sync words
[in]	len	Number of sync words to set

Definition at line 590 of file RF22.cpp.

void setThisAddress ( uint8_t thisAddress ) [inherited]

Sets the address of this node.

Defaults to 0. This will be used to set the FROM address of all messages sent by this node. If all the nodes leave the address unset (ie 0), In a conventional multinode system, all nodes will have a unique address (which you could store in EEPROM).

Parameters:

[in] thisAddress The address of this node

Definition at line 26 of file RF22Datagram.cpp.

void setTimeout ( uint16_t timeout )

Sets the minimum retransmit timeout.

If sendtoWait is waiting for an ack longer than this time (in milliseconds), it will retransmit the message. Defaults to 200ms. The timeout is measured from the end of transmission of the message. It must be at least longer than the the transmit time of the acknowledgement (preamble+6 octets) plus the latency/poll time of the receiver. For fast modulation schemes you can considerably shorten this time. The actual timeout is randomly varied between timeout and timeout*2.

Parameters:

[in] timeout The new timeout period in milliseconds

Definition at line 31 of file RF22ReliableDatagram.cpp.

void setTxPower ( uint8_t power ) [inherited]

Sets the transmitter power output level in register RF22_REG_6D_TX_POWER.

Be a good neighbour and set the lowest power level you need. After init(), the power wil be set to RF22_TXPOW_8DBM. Caution: In some countries you may only select RF22_TXPOW_17DBM if you are also using frequency hopping.

Parameters:

[in] power Transmitter power level, one of RF22_TXPOW_*

Definition at line 552 of file RF22.cpp.

void setWutPeriod	(	uint16_t	wtm,
		uint8_t	wtr = `0`,
		uint8_t	wtd = `0`
	)		`[inherited]`

Sets the wakeup timer period registers RF22_REG_14_WAKEUP_TIMER_PERIOD1, RF22_REG_15_WAKEUP_TIMER_PERIOD2 and RF22_R<EG_16_WAKEUP_TIMER_PERIOD3.

Parameters:

[in]	wtm	Wakeup timer mantissa value
[in]	wtr	Wakeup timer exponent R value
[in]	wtd	Wakeup timer exponent D value

Definition at line 441 of file RF22.cpp.

void spiBurstRead	(	uint8_t	reg,
		uint8_t *	dest,
		uint8_t	len
	)		`[inherited]`

Reads a number of consecutive registers from the RF22 using burst read mode.

Parameters:

[in]	reg	Register number of the first register, one of RF22_REG_*
[in]	dest	Array to write the register values to. Must be at least len bytes
[in]	len	Number of bytes to read

Definition at line 382 of file RF22.cpp.

void spiBurstWrite	(	uint8_t	reg,
		const uint8_t *	src,
		uint8_t	len
	)		`[inherited]`

Write a number of consecutive registers using burst write mode.

Parameters:

[in]	reg	Register number of the first register, one of RF22_REG_*
[in]	src	Array of new register values to write. Must be at least len bytes
[in]	len	Number of bytes to write

Definition at line 393 of file RF22.cpp.

uint8_t spiRead ( uint8_t reg ) [inherited]

Reads a single register from the RF22.

Parameters:

[in] reg Register number, one of RF22_REG_*

Returns:: The value of the register

Definition at line 356 of file RF22.cpp.

void spiWrite	(	uint8_t	reg,
		uint8_t	val
	)		`[inherited]`

Writes a single byte to the RF22.

Parameters:

[in]	reg	Register number, one of RF22_REG_*
[in]	val	The value to write

Definition at line 370 of file RF22.cpp.

void startTransmit ( ) [protected, inherited]

Start the transmission of the contents of the Tx buffer.

Definition at line 679 of file RF22.cpp.

uint8_t statusRead ( ) [inherited]

Reads and returns the device status register RF22_REG_02_DEVICE_STATUS.

Returns:: The value of the device status register

Definition at line 404 of file RF22.cpp.

uint8_t temperatureRead	(	uint8_t	tsrange = `RF22_TSRANGE_M64_64C`,
		uint8_t	tvoffs = `0`
	)		`[inherited]`

Reads the on-chip temperature sensoer.

Parameters:

[in]	tsrange	Specifies the temperature range to use. One of RF22_TSRANGE_*
[in]	tvoffs	Specifies the temperature value offset. This is actually signed value added to the measured temperature value

Returns:: The measured temperature.

Definition at line 426 of file RF22.cpp.

void waitAvailable ( ) [inherited]

Starts the receiver and blocks until a valid received message is available.

Definition at line 611 of file RF22.cpp.

bool waitAvailableTimeout ( uint16_t timeout ) [inherited]

Starts the receiver and blocks until a received message is available or a timeout.

Parameters:

[in] timeout Maximum time to wait in milliseconds.

Returns:: true if a message is available

Definition at line 619 of file RF22.cpp.

void waitPacketSent ( ) [inherited]

Blocks until the RF22 is not in mode RF22_MODE_TX (ie until the RF22 is not transmitting).

This effectively waits until any previous transmit packet is finished being transmitted.

Definition at line 630 of file RF22.cpp.

uint16_t wutRead ( ) [inherited]

Reads the wakeup timer value in registers RF22_REG_17_WAKEUP_TIMER_VALUE1 and RF22_REG_18_WAKEUP_TIMER_VALUE2.

Returns:: The wakeup timer value

Definition at line 433 of file RF22.cpp.

Field Documentation

uint8_t _thisAddress [protected, inherited]

The address of this node. Defaults to 0.

Definition at line 73 of file RF22Datagram.h.

Type:	Library
Created:	29 Aug 2013
Imports:	23
Forks:	0
Commits:	10
Dependents:	0
Dependencies:	0
Followers:	4

Important changes to repositories hosted on mbed.com

RF22ReliableDatagram Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

RF22ReliableDatagram Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning