Top-level Library Class providing access to all VMX-pi functionality. More...

#include <VMXPi.h>

Public Member Functions
	VMXPi (bool realtime, uint8_t ahrs_update_rate_hz)
	Constructs the VMXPi object using the specified parameters. More...

bool	IsOpen ()
	Returns true if the communication with the VMX-pi firmware has been established.

Public Attributes
AHRS	ahrs
	The AHRS object providing access to VMX-pi IMU functionality. More...

VMXTime	time
	The VMXTime object providing access to VMX-pi Time functionality. More...

VMXIO	io
	The VMXIO object providing access to VMX-pi IO functionality. More...

VMXCAN	can
	The VMXCAN object providing access to VMX-pi CAN functionality. More...

VMXPower	power
	The VMXPower object providing access to VMX-pi Power functionality. More...

VMXVersion	version
	The VMXVersion object providing access to VMX-pi Version functionality. More...

VMXThread	thread
	The VMXThread object providing access to VMX-pi Threading functionality. More...

Detailed Description

Top-level Library Class providing access to all VMX-pi functionality.

Constructor & Destructor Documentation

◆ VMXPi()

VMXPi::VMXPi	(	bool	realtime,
		uint8_t	ahrs_update_rate_hz
	)

Constructs the VMXPi object using the specified parameters.

This constructor initializes the VMX-pi HAL.

Parameters

realtime	true if the VMX-pi host Linux operating system supports real-time priorities, as implemented via a fully-preemptible Real-time Linux Kernel.
ahrs_update_rate_hz	The update rate to use for the VMX-pi AHRS/IMU interface. Default is 50 hz. Valid range: 4-200Hz.

Member Data Documentation

◆ ahrs

AHRS VMXPi::ahrs

The AHRS object providing access to VMX-pi IMU functionality.

◆ can

VMXCAN VMXPi::can

The VMXCAN object providing access to VMX-pi CAN functionality.

◆ io

VMXIO VMXPi::io

The VMXIO object providing access to VMX-pi IO functionality.

◆ power

VMXPower VMXPi::power

The VMXPower object providing access to VMX-pi Power functionality.

◆ thread

VMXThread VMXPi::thread

The VMXThread object providing access to VMX-pi Threading functionality.

◆ time

VMXTime VMXPi::time

The VMXTime object providing access to VMX-pi Time functionality.

◆ version

VMXVersion VMXPi::version

The VMXVersion object providing access to VMX-pi Version functionality.

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

/home/pi/vmx/vmx-pi/hal/hal_cpp/include/VMXPi.h
/home/pi/vmx/vmx-pi/hal/hal_cpp/src/VMXPi.cpp

Public Member Functions

Public Attributes