SignalK-Orientation 1.0.0
Orientation output in Signal K format for ESP32
Loading...
Searching...
No Matches
Public Attributes | List of all members
Attitude Struct Reference

#include <signalk_orientation.h>

Public Attributes

bool is_data_valid
 Indicates whether yaw,pitch,roll data are valid.
 
float yaw
 Compass heading of the vessel in radians.
 
float pitch
 
float roll
 

Detailed Description

Attitude struct contains the yaw, pitch, and roll values from the orientation sensor-fusion algorithm. Additionally, an out-of-band signal is needed to pass the information from the Producer (sensor) to the Consumer (SignalKOutput) whether the data is valid or not. Using magic numbers can be done (e.g. a negative value for temperature or heading) but needs customization for particular parameters and data types. Rather than special values, for Attitude we add a field to the struct that indicates whether or not the numerical members are valid.

Definition at line 19 of file signalk_orientation.h.

Member Data Documentation

◆ is_data_valid

bool Attitude::is_data_valid

Indicates whether yaw,pitch,roll data are valid.

Definition at line 20 of file signalk_orientation.h.

◆ pitch

float Attitude::pitch

Rotation about transverse axis in radians. Bow up is positive.

Definition at line 22 of file signalk_orientation.h.

◆ roll

float Attitude::roll

Rotation about longitudinal axis in radians. Starboard roll is positive.

Definition at line 24 of file signalk_orientation.h.

◆ yaw

float Attitude::yaw

Compass heading of the vessel in radians.

Definition at line 21 of file signalk_orientation.h.


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