Public Member Functions
	Driver (Tasks::Task task, IO::Handle handle)

	~Driver (void)

void	sendReset (void)

void	setAddress (unsigned addr)

void	setSourceLevel (unsigned value)

void	setLowGain (bool low_gain)

void	setIdleTimeout (unsigned value)

void	setRetryCount (unsigned value)

void	setRetryCountIM (unsigned value)

void	setRetryTimeout (unsigned value)

std::string	getFirmwareVersion (void)

void	setExtendedNotifications (bool enable)

void	setPromiscuous (bool enable)

void	setHighestAddress (unsigned value)

void	sendIM (const uint8_t *data, size_t data_size, unsigned dst, bool ack)

void	sendBurst (const uint8_t *data, size_t data_size, unsigned dst)

void	sendPBM (const uint8_t *data, size_t data_size, unsigned dst)

unsigned	getPropagationTime (void)

unsigned	getSoundSpeed (void)

void	setSoundSpeed (unsigned value)

void	setCarrierWaveformID (unsigned value)

void	setPositionDataOutput (bool enable)

uint32_t	getClock (void)

std::vector< unsigned >	getMultipathStructure (void)

void	switchToNoiseState (void)

void	switchToListenState (void)

void	getRSSI (void)

void	parseReceivedBurst (const std::string &str, RecvIM &msg)

void	parse (const std::string &str, RecvIM &msg, bool piggyback)

Constructor & Destructor Documentation

Transports::Evologics::Driver::Driver	(	Tasks::Task *	task,
		IO::Handle *	handle
	)

inline

Constructor.

Parameters

[in]	task	parent task.
[in]	handle	I/O handle.

Transports::Evologics::Driver::~Driver ( void )

inline

Destructor.

Member Function Documentation

uint32_t Transports::Evologics::Driver::getClock ( void )

inline

Retrieve value of system clock.

Returns: sound speed (in m/s).

Referenced by Transports::Evologics::Task::keepAlive().

std::string Transports::Evologics::Driver::getFirmwareVersion ( void )

inline

Retrieve the firmware version string.

Returns: firmware version.

Referenced by parse().

std::vector<unsigned> Transports::Evologics::Driver::getMultipathStructure ( void )

inline

Retrieve a table illustrating the structure of the last received acoustic signal’s multipath propagation from its source to the local device.

Returns: multipath structure.

Referenced by Transports::Evologics::Task::handleBurstMessage(), Transports::Evologics::Task::handleInstantMessage(), and Transports::Evologics::Task::handleMessageDelivered().

unsigned Transports::Evologics::Driver::getPropagationTime ( void )

inline

Retrieve the last computed acoustic signal propagation time between communicating devices.

Returns: propagation time (microsecond).

Referenced by Transports::Evologics::Task::handleMessageDelivered().

void Transports::Evologics::Driver::getRSSI ( void )

inline

unsigned Transports::Evologics::Driver::getSoundSpeed ( void )

inline

Retrieve the configured sound speed.

Returns: sound speed (in m/s).

void Transports::Evologics::Driver::parse	(	const std::string &	str,
		RecvIM &	msg,
		bool	piggyback
	)

inline

References Transports::Evologics::RecvIM::ack, Transports::Evologics::RecvIM::bitrate, Transports::Evologics::RecvIM::data, Transports::Evologics::RecvIM::dst, Transports::Evologics::RecvIM::duration, getFirmwareVersion(), Transports::Evologics::RecvIM::integrity, Transports::Evologics::RecvIM::propagation_time, Transports::Evologics::RecvIM::rssi, Transports::Evologics::RecvIM::src, and Transports::Evologics::RecvIM::velocity.

Referenced by Transports::Evologics::Task::handleInstantMessage().

void Transports::Evologics::Driver::parseReceivedBurst	(	const std::string &	str,
		RecvIM &	msg
	)

inline

References Transports::Evologics::RecvIM::data, Transports::Evologics::RecvIM::dst, Transports::Evologics::RecvIM::integrity, Transports::Evologics::RecvIM::rssi, Transports::Evologics::RecvIM::src, and Transports::Evologics::RecvIM::velocity.

Referenced by Transports::Evologics::Task::handleBurstMessage().

void Transports::Evologics::Driver::sendBurst	(	const uint8_t *	data,
		size_t	data_size,
		unsigned	dst
	)

inline

Send burst data.

Parameters

[in]	data	data to send.
[in]	data_size	number of bytes to send.
[in]	dst	destination address.

Referenced by Transports::Evologics::Task::consume().

void Transports::Evologics::Driver::sendIM	(	const uint8_t *	data,
		size_t	data_size,
		unsigned	dst,
		bool	ack
	)

inline

Send instant message.

Parameters

[in]	data	data to send.
[in]	data_size	number of bytes to send.
[in]	dst	destination address.
[in]	ack	true to wait for acknowledgment, false otherwise.

Referenced by Transports::Evologics::Task::consume().

void Transports::Evologics::Driver::sendPBM	(	const uint8_t *	data,
		size_t	data_size,
		unsigned	dst
	)

inline

Send piggyback instant message.

Parameters

[in]	data	data to send.
[in]	data_size	number of bytes to send.
[in]	dst	destination address.

Referenced by Transports::Evologics::Task::consume().

void Transports::Evologics::Driver::sendReset ( void )

inline

Reset device.

void Transports::Evologics::Driver::setAddress ( unsigned addr )

inline

Set modem address.

Parameters

[in] addr address.

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setCarrierWaveformID ( unsigned value )

inline

void Transports::Evologics::Driver::setExtendedNotifications ( bool enable )

inline

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setHighestAddress ( unsigned value )

inline

Set highest address.

Parameters

[in] value highest address.

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setIdleTimeout ( unsigned value )

inline

Set the timeout before closing an idle acoustic connection.

Parameters

[in] value timeout (s).

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setLowGain ( bool low_gain )

inline

Set low gain mode.

Recommended for short distances or testing purposes.

Parameters

[in] low_gain true to enable low gain, false otherwise.

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setPositionDataOutput ( bool enable )

inline

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setPromiscuous ( bool enable )

inline

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setRetryCount ( unsigned value )

inline

Set how many times will the device retry to establish an acoustic connection.

Parameters

[in] value number of retries.

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setRetryCountIM ( unsigned value )

inline

Set the number of instant message delivery retries.

Parameters

[in] value number of delivery retries.

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setRetryTimeout ( unsigned value )

inline

Set the time interval that the device waits for a response to its acoustic connection establishment request.

Parameters

[in] value interval (millisecond).

Referenced by Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::setSoundSpeed ( unsigned value )

inline

Set sound speed.

Parameters

[in] value sound speed (m/s).

void Transports::Evologics::Driver::setSourceLevel ( unsigned value )

inline

Set the sound pressure level (SPL) in transmission mode.

Parameters

[in] value from 3 to 0.

Referenced by Transports::Evologics::Task::consume(), and Transports::Evologics::Task::onResourceInitialization().

void Transports::Evologics::Driver::switchToListenState ( void )

inline

void Transports::Evologics::Driver::switchToNoiseState ( void )

inline

Collaboration diagram for Transports::Evologics::Driver:

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation