Detailed Description

Microstrain3DMGX3 software driver.

Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)

void	onUpdateParameters (void)

void	onResourceRelease (void)

void	onResourceAcquisition (void)

void	onResourceInitialization (void)

void	consume (const IMC::MagneticField *msg)

bool	poll (Commands cmd, Sizes cmd_size, uint16_t addr, uint16_t value)

bool	listen (Commands cmd, Sizes cmd_size)

bool	validateChecksum (const uint8_t *bfr, unsigned bfr_len)

void	runCalibration (void)

bool	isCalibrated (void)

void	resetDevice (void)

void	requestCalibration (uint16_t addr)

bool	setHardIron (void)

void	calibrate (uint16_t addr, uint16_t value)

void	rotateData (void)

void	reportEntityState (void)

void	task (void)

Public Member Functions inherited from DUNE::Tasks::Periodic
	Periodic (const std::string &name, Context &ctx)

virtual	~Periodic (void)

void	setFrequency (double freq)

double	getFrequency (void) const

double	getRunTime (void) const

unsigned	getRunCount (void) const

Public Member Functions inherited from DUNE::Tasks::Task
	Task (const std::string &name, Context &context)

virtual	~Task (void)

const char *	getName (void) const

const char *	getSystemName (void) const

unsigned int	getSystemId (void) const

unsigned int	getEntityId (void) const

unsigned int	resolveEntity (const std::string &label) const

std::string	resolveEntity (unsigned int id) const

DebugLevel	getDebugLevel (void) const

uint16_t	getActivationTime (void) const

uint16_t	getDeactivationTime (void) const

unsigned int	resolveSystemName (const std::string &name) const

const char *	resolveSystemId (unsigned int id) const

void	loadConfig (void)

void	setPriority (unsigned int value)

unsigned int	getPriority (void) const

void	inf (const char *format,...) DUNE_PRINTF_FORMAT(2

void void	war (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void	err (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void	cri (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void	debug (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void void	trace (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void void void	spew (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void void void void	dispatch (IMC::Message *msg, unsigned int flags=0)

void	dispatch (IMC::Message &msg, unsigned int flags=0)

void	dispatchReply (const IMC::Message &original, IMC::Message &msg, unsigned int flags=0)

void	receive (const IMC::Message *msg)

void	reserveEntities (void)

void	resolveEntities (void)

void	acquireResources (void)

void	releaseResources (void)

void	initializeResources (void)

void	updateParameters (bool act_deact=true)

void	writeParamsXML (std::ostream &os) const

const char *	getEntityLabel (void) const

void	setEntityLabel (const std::string &label)

Public Member Functions inherited from DUNE::Tasks::AbstractTask
	AbstractTask (void)

virtual	~AbstractTask (void)

Public Member Functions inherited from DUNE::Concurrency::Thread
	Thread (void)

virtual	~Thread (void)

int	getProcessorUsage (void)

Public Member Functions inherited from DUNE::Concurrency::Runnable
	Runnable (void)

virtual	~Runnable (void)

void	start (void)

void	stop (void)

void	join (void)

void	stopAndJoin (void)

void	setPriority (Scheduler::Policy policy, unsigned priority)

unsigned	getPriority (void)

State	getState (void)

bool	isCreated (void)

bool	isStopping (void)

bool	isRunning (void)

bool	isStarting (void)

bool	isDead (void)

Public Attributes
Math::Matrix	m_rotation

float	m_hard_iron [3]

SerialPort *	m_uart

IMC::EulerAngles	m_euler

IMC::Acceleration	m_accel

IMC::AngularVelocity	m_agvel

IMC::MagneticField	m_magfield

Time::Counter< float >	m_timer

uint8_t	m_bfr [c_bfr_size]

uint16_t	m_addr [c_num_addr]

double	m_tstamp

Counter< double >	m_wdog

Counter< double >	m_state_timer

size_t	m_sample_count

size_t	m_faults_count

size_t	m_timeout_count

Arguments	m_args

Static Public Attributes
static const unsigned	c_bfr_size

static const unsigned	c_num_addr

static const uint16_t	c_mag_addr

Additional Inherited Members
Public Types inherited from DUNE::Concurrency::Runnable
enum	State { StateStarting, StateRunning, StateStopping, StateDead, StateUnknown }

Protected Member Functions inherited from DUNE::Tasks::Task
void	setEntityState (IMC::EntityState::StateEnum state, Status::Code code)

void	setEntityState (IMC::EntityState::StateEnum state, const std::string &description)

IMC::EntityState::StateEnum	getEntityState (void) const

unsigned int	reserveEntity (const std::string &label)

template<typename E >
E *	reserveEntity (const std::string &label)

Entities::BasicEntity *	getLocalEntity (const std::string &label)

bool	stopping (void)

bool	isActive (void) const

bool	isActivating (void) const

bool	isDeactivating (void) const

void	waitForMessages (double timeout)

void	consumeMessages (void)

template<typename T >
Parameter &	param (const std::string &name, T &var)

template<typename Y , typename T >
Parameter &	param (const std::string &name, T &var)

template<typename T >
bool	paramChanged (T &var)

void	paramActive (Parameter::Scope def_scope, Parameter::Visibility def_visibility, bool def_value=false)

void	setParamSectionEditor (const std::string &name)

template<typename M , typename T >
void	bind (T task_obj, void(T::consumer)(const M *)=&T::consume)

template<typename T >
void	bind (T *task_obj, const std::vector< uint32_t > &list)

template<typename T , typename M >
void	bind (T task_obj, const std::vector< uint32_t > &list, void(T::consumer)(const M *)=&T::consume)

template<typename T >
void	bind (T *task_obj, const std::vector< std::string > &list)

void	bind (unsigned int message_id, AbstractConsumer *consumer)

void	requestActivation (void)

void	requestDeactivation (void)

void	activate (void)

void	activationFailed (const std::string &reason)

void	deactivate (void)

void	deactivationFailed (const std::string &reason)

virtual bool	onWriteParamsXML (std::ostream &os) const

virtual void	onEntityReservation (void)

virtual void	onEntityResolution (void)

virtual void	onReportEntityState (void)

virtual void	onRequestActivation (void)

virtual void	onRequestDeactivation (void)

virtual void	onActivation (void)

virtual void	onDeactivation (void)

virtual void	onQueryEntityParameters (const IMC::QueryEntityParameters *msg)

virtual void	onSetEntityParameters (const IMC::SetEntityParameters *msg)

virtual void	onPushEntityParameters (const IMC::PushEntityParameters *msg)

virtual void	onPopEntityParameters (const IMC::PopEntityParameters *msg)

Protected Member Functions inherited from DUNE::Concurrency::Thread
void	startImpl (void)

void	stopImpl (void)

void	joinImpl (void)

void	setPriorityImpl (Scheduler::Policy policy, unsigned priority)

unsigned	getPriorityImpl (void)

Protected Attributes inherited from DUNE::Tasks::Task
Context &	m_ctx

std::vector< Entities::BasicEntity * >	m_entities

Constructor & Destructor Documentation

◆ Task()

Sensors::Microstrain3DMGX3::Task::Task	(	const std::string &	name,
		Tasks::Context &	ctx
	)

inline

References Sensors::Microstrain3DMGX3::Arguments::calib_threshold, Sensors::Microstrain3DMGX3::Arguments::calib_time, Sensors::Microstrain3DMGX3::Arguments::hard_iron, Sensors::Microstrain3DMGX3::Arguments::rotation_mx, Sensors::Microstrain3DMGX3::Arguments::timeout_error, Sensors::Microstrain3DMGX3::Arguments::timeout_failure, Sensors::Microstrain3DMGX3::Arguments::uart_baud, and Sensors::Microstrain3DMGX3::Arguments::uart_dev.

Member Function Documentation

◆ calibrate()

void Sensors::Microstrain3DMGX3::Task::calibrate	(	uint16_t	addr,
		uint16_t	value
	)

inline

Send calibration frame to the device.

Parameters

[in]	addr	EEPROM address.
[in]	value	new calibration value.

References Sensors::Microstrain3DMGX3::CMD_WRITE_EEPROM.

◆ consume()

void Sensors::Microstrain3DMGX3::Task::consume ( const IMC::MagneticField * msg )

inline

References Sensors::Microstrain3DMGX3::Arguments::calib_threshold, and Sensors::Microstrain3DMGX3::Arguments::hard_iron.

◆ isCalibrated()

bool Sensors::Microstrain3DMGX3::Task::isCalibrated ( void )

inline

Check if sensor has the same hard iron calibration parameters.

Returns: true if the parameters are the same, false otherwise.

References Sensors::Microstrain3DMGX3::CMD_READ_EEPROM, Sensors::Microstrain3DMGX3::CMD_READ_EEPROM_SIZE, and Sensors::Microstrain3DMGX3::Arguments::hard_iron.

◆ listen()

bool Sensors::Microstrain3DMGX3::Task::listen	(	Commands	cmd,
		Sizes	cmd_size
	)

inline

Listen for responses.

Parameters

[in]	cmd	command char.
[in]	cmd_size	expected frame response size.

Returns: true if communication successful, false otherwise.

◆ onResourceAcquisition()

void Sensors::Microstrain3DMGX3::Task::onResourceAcquisition ( void )

inlinevirtual

Acquire resources.

Reimplemented from DUNE::Tasks::Task.

References Sensors::Microstrain3DMGX3::Arguments::uart_baud, and Sensors::Microstrain3DMGX3::Arguments::uart_dev.

◆ onResourceInitialization()

void Sensors::Microstrain3DMGX3::Task::onResourceInitialization ( void )

inlinevirtual

Initialize resources.

Reimplemented from DUNE::Tasks::Task.

References Sensors::Microstrain3DMGX3::CMD_DATA_SIZE, Sensors::Microstrain3DMGX3::CMD_FWARE_VERSION, and Sensors::Microstrain3DMGX3::CMD_FWARE_VERSION_SIZE.

◆ onResourceRelease()

void Sensors::Microstrain3DMGX3::Task::onResourceRelease ( void )

inlinevirtual

Release resources.

Reimplemented from DUNE::Tasks::Task.

◆ onUpdateParameters()

void Sensors::Microstrain3DMGX3::Task::onUpdateParameters ( void )

inlinevirtual

Update parameters.

Reimplemented from DUNE::Tasks::Task.

References Sensors::Microstrain3DMGX3::Arguments::hard_iron, Sensors::Microstrain3DMGX3::Arguments::rotation_mx, Sensors::Microstrain3DMGX3::Arguments::timeout_error, and DUNE::Math::transpose().

◆ poll()

bool Sensors::Microstrain3DMGX3::Task::poll	(	Commands	cmd,
		Sizes	cmd_size,
		uint16_t	addr,
		uint16_t	value
	)

inline

Send commands to the device.

Parameters

[in]	cmd	command char.
[in]	cmd_size	expected frame response size.
[in]	addr	address.
[in]	value	value to be assigned.

Returns: true if communication successful, false otherwise.

References Sensors::Microstrain3DMGX3::CMD_DATA, Sensors::Microstrain3DMGX3::CMD_DEVICE_RESET, Sensors::Microstrain3DMGX3::CMD_FWARE_VERSION, Sensors::Microstrain3DMGX3::CMD_READ_EEPROM, and Sensors::Microstrain3DMGX3::CMD_WRITE_EEPROM.

◆ reportEntityState()

void Sensors::Microstrain3DMGX3::Task::reportEntityState ( void )

inline

References Sensors::Microstrain3DMGX3::Arguments::timeout_failure.

◆ requestCalibration()

void Sensors::Microstrain3DMGX3::Task::requestCalibration ( uint16_t addr )

inline

Request calibration parameters from device.

Parameters

[in] addr address.

References Sensors::Microstrain3DMGX3::CMD_READ_EEPROM.

◆ resetDevice()

void Sensors::Microstrain3DMGX3::Task::resetDevice ( void )

inline

Soft-reset device.

References Sensors::Microstrain3DMGX3::CMD_DEVICE_RESET.

◆ rotateData()

void Sensors::Microstrain3DMGX3::Task::rotateData ( void )

inline

Correct data according with mounting position.

◆ runCalibration()

void Sensors::Microstrain3DMGX3::Task::runCalibration ( void )

inline

Routine to run calibration proceedings.

References Sensors::Microstrain3DMGX3::CMD_DEVICE_RESET, and Sensors::Microstrain3DMGX3::CMD_DEVICE_RESET_SIZE.

◆ setHardIron()

bool Sensors::Microstrain3DMGX3::Task::setHardIron ( void )

inline

Set new hard iron calibration parameters.

Returns: true if successful, false otherwise.

References Sensors::Microstrain3DMGX3::CMD_WRITE_EEPROM, Sensors::Microstrain3DMGX3::CMD_WRITE_EEPROM_SIZE, and Sensors::Microstrain3DMGX3::Arguments::hard_iron.

◆ task()

void Sensors::Microstrain3DMGX3::Task::task ( void )

inlinevirtual

Main task.

Implements DUNE::Tasks::Periodic.

References Sensors::Microstrain3DMGX3::CMD_DATA, Sensors::Microstrain3DMGX3::CMD_DATA_SIZE, and DUNE::Math::transpose().

◆ validateChecksum()

bool Sensors::Microstrain3DMGX3::Task::validateChecksum	(	const uint8_t *	bfr,
		unsigned	bfr_len
	)

inline

Validate response checksum.

Parameters

[in]	bfr	buffer to be validated.
[in]	bfr_len	length of the buffer.

Returns: true if checksum validated, false otherwise.

Member Data Documentation

◆ c_bfr_size

const unsigned Sensors::Microstrain3DMGX3::Task::c_bfr_size

static

Internal read buffer.

◆ c_mag_addr

const uint16_t Sensors::Microstrain3DMGX3::Task::c_mag_addr

static

Magnetic calibration initial address.

◆ c_num_addr

const unsigned Sensors::Microstrain3DMGX3::Task::c_num_addr

static

Number of addresses for magnetic calibration.

◆ m_accel

IMC::Acceleration Sensors::Microstrain3DMGX3::Task::m_accel

Acceleration message.

◆ m_addr

uint16_t Sensors::Microstrain3DMGX3::Task::m_addr[c_num_addr]

Magnetic Calibration addresses.

◆ m_agvel

IMC::AngularVelocity Sensors::Microstrain3DMGX3::Task::m_agvel

Angular velocity message.

◆ m_args

Arguments Sensors::Microstrain3DMGX3::Task::m_args

Task arguments.

◆ m_bfr

uint8_t Sensors::Microstrain3DMGX3::Task::m_bfr[c_bfr_size]

Internal read buffer.

◆ m_euler

IMC::EulerAngles Sensors::Microstrain3DMGX3::Task::m_euler

Euler angles message.

◆ m_faults_count

size_t Sensors::Microstrain3DMGX3::Task::m_faults_count

Faults count.

◆ m_hard_iron

float Sensors::Microstrain3DMGX3::Task::m_hard_iron[3]

Rotated calibration parameters.

◆ m_magfield

IMC::MagneticField Sensors::Microstrain3DMGX3::Task::m_magfield

Magnetometer Vector message.

◆ m_rotation

Math::Matrix Sensors::Microstrain3DMGX3::Task::m_rotation

Rotation Matrix to correct mounting position.

◆ m_sample_count

size_t Sensors::Microstrain3DMGX3::Task::m_sample_count

Sample count.

◆ m_state_timer

Counter<double> Sensors::Microstrain3DMGX3::Task::m_state_timer

Entity state timer.

◆ m_timeout_count

size_t Sensors::Microstrain3DMGX3::Task::m_timeout_count

Timeout count.

◆ m_timer

Time::Counter<float> Sensors::Microstrain3DMGX3::Task::m_timer

Timer to wait for soft-reset without issuing error.

◆ m_tstamp

double Sensors::Microstrain3DMGX3::Task::m_tstamp

Read timestamp.

◆ m_uart

SerialPort* Sensors::Microstrain3DMGX3::Task::m_uart

Serial port.

◆ m_wdog

Counter<double> Sensors::Microstrain3DMGX3::Task::m_wdog

Watchdog.

Collaboration diagram for Sensors::Microstrain3DMGX3::Task:

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Task()

Member Function Documentation

◆ calibrate()

◆ consume()

◆ isCalibrated()

◆ listen()

◆ onResourceAcquisition()

◆ onResourceInitialization()

◆ onResourceRelease()

◆ onUpdateParameters()

◆ poll()

◆ reportEntityState()

◆ requestCalibration()

◆ resetDevice()

◆ rotateData()

◆ runCalibration()

◆ setHardIron()

◆ task()

◆ validateChecksum()

Member Data Documentation

◆ c_bfr_size

◆ c_mag_addr

◆ c_num_addr

◆ m_accel

◆ m_addr

◆ m_agvel

◆ m_args

◆ m_bfr

◆ m_euler

◆ m_faults_count

◆ m_hard_iron

◆ m_magfield

◆ m_rotation

◆ m_sample_count

◆ m_state_timer

◆ m_timeout_count

◆ m_timer

◆ m_tstamp

◆ m_uart

◆ m_wdog