onboardsdk
Loading...
Searching...
No Matches
Public Member Functions | List of all members
blunux::tilt::ITiltControl Class Referenceabstract

Public Member Functions

virtual bool calibrate ()=0
 Initialize and calibrate the tilt motor.
 
virtual std::optional< float > get_angle () const =0
 Get the tilt angle. Tilt needs to be initialized.
 
virtual void set_stabilization (bool stabilization_active)=0
 Activate/deactivate the tilt stabilization.
 
virtual void set_velocity (double angular_velocity_factor)=0
 Set the tilt velocity. Tilt needs to be initialized.
 
virtual void set_angle (double angle)=0
 Set the tilt angle. Tilt needs to be initialized.
 
virtual void set_pitch (double pitch)=0
 Set the pitch of the drone.
 
virtual bool is_stabilized () const =0
 Check if the tilt control is stabilized.
 
virtual bool is_calibrated () const =0
 Check if the tilt control is calibrated.
 

Member Function Documentation

◆ calibrate()

virtual bool blunux::tilt::ITiltControl::calibrate ( )
pure virtual

Initialize and calibrate the tilt motor.

Returns
True if successful

◆ get_angle()

virtual std::optional< float > blunux::tilt::ITiltControl::get_angle ( ) const
pure virtual

Get the tilt angle. Tilt needs to be initialized.

Returns
Optional tilt angle in °. {} if not initialized

◆ is_calibrated()

virtual bool blunux::tilt::ITiltControl::is_calibrated ( ) const
pure virtual

Check if the tilt control is calibrated.

This method returns a boolean value indicating whether the tilt control is currently calibrated. If the tilt control is calibrated, it has been adjusted to accurately measure and control pitch. If it is not calibrated, its measurements and control may be inaccurate.

Returns
True if the tilt control is calibrated, false otherwise.

◆ is_stabilized()

virtual bool blunux::tilt::ITiltControl::is_stabilized ( ) const
pure virtual

Check if the tilt control is stabilized.

This method returns a boolean value indicating whether the tilt control is currently stabilized. If the tilt control is stabilized, it is maintaining a constant pitch. If it is not stabilized, its pitch may be changing.

Returns
True if the tilt control is stabilized, false otherwise.

◆ set_angle()

virtual void blunux::tilt::ITiltControl::set_angle ( double  angle)
pure virtual

Set the tilt angle. Tilt needs to be initialized.

Parameters
angleAngle in °

◆ set_pitch()

virtual void blunux::tilt::ITiltControl::set_pitch ( double  pitch)
pure virtual

Set the pitch of the drone.

This method updated the tilt controller with the pitch state of the drone. This is used to calculate the compensation in the stabilization control.

Parameters
pitchThe estimated drone pitch in degrees.

◆ set_stabilization()

virtual void blunux::tilt::ITiltControl::set_stabilization ( bool  stabilization_active)
pure virtual

Activate/deactivate the tilt stabilization.

Parameters
stabilization_activetrue if to be activated

◆ set_velocity()

virtual void blunux::tilt::ITiltControl::set_velocity ( double  angular_velocity_factor)
pure virtual

Set the tilt velocity. Tilt needs to be initialized.

Parameters
angular_velocity_factorAngular velocity factor [-1..1]

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