gusimplewhiteboard
Public Attributes | List of all members
wb_sensors_body_sensors Struct Reference

WHITEBOARD_POSTER_STRING_CONVERSION. More...

#include <wb_sensors_body_sensors.h>

Inheritance diagram for wb_sensors_body_sensors:
Collaboration diagram for wb_sensors_body_sensors:

Public Attributes

signed int DCM_Time
 Absolute time used for all timed commands in the DCM, an integer (signed), with 1 ms precision. More...
 
float InertialSensor_AccX
 accelerometer X value More...
 
float InertialSensor_AccY
 accelerometer Y value More...
 
float InertialSensor_AccZ
 accelerometer Z value More...
 
float InertialSensor_GyrX
 gyro X value More...
 
float InertialSensor_GyrY
 gyro Y value More...
 
float InertialSensor_GyrZ
 gyro Z value (Nao V5 have a Z axis) More...
 
float InertialSensor_AngleX
 new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)' More...
 
float InertialSensor_AngleY
 new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)' More...
 
float InertialSensor_AngleZ
 new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)' More...
 
float InertialSensor_AccelerometerX
 new Accelerometer X value More...
 
float InertialSensor_AccelerometerY
 new Accelerometer Y value More...
 
float InertialSensor_AccelerometerZ
 new Accelerometer Z value More...
 
float InertialSensor_GyroscopeX
 new Gyro X value More...
 
float InertialSensor_GyroscopeY
 new Gyro Y value More...
 
float InertialSensor_GyroscopeZ
 new Gyro Z value More...
 
uint8_t Battery_Charge
 % of charge More...
 
uint8_t Battery_Current
 Amps. More...
 
float US
 unsure, check naoqi docs! Not sure about this type, might only be 1 byte More...
 
bool ChestBoard_Button
 state of the chest button, on / off. More...
 

Detailed Description

WHITEBOARD_POSTER_STRING_CONVERSION.

Contains the current values of sensors located in the robots chest (designed for Nao)

Examples

Get the state of the Chest Button

SensorsBodySensors s = SensorsBodySensors_t.get(); //get from the whiteboard bool button_state = s.ChestBoard_Button(); //pull the variable out of the class

Notes: 1) InertialSensor_GyrRef does not exist in Naoqi 2.1.4.13, thus removed. 2) doc/family/nao_dcm/actuator_sensor_names.html states "There are other deprecated values still returned." This comment likely applies to AccX, AccY, AccZ, GyrX, GyrY, and GyrZ, which appear to be replaced with AccelerometerX, AccelerometerY, AccelerometerZ, GyroscopeX, GyroscopeY, and GyroscopeZ. 3) InertialSensor_GyrZ added. 4) On the Nao V4/V5, DCM_Time is a 4 byte 'int'.

Definition at line 119 of file wb_sensors_body_sensors.h.

Member Data Documentation

◆ Battery_Charge

uint8_t wb_sensors_body_sensors::Battery_Charge

% of charge

Definition at line 205 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::Battery_Charge(), guWhiteboard::SensorsBodySensors::operator=(), guWhiteboard::SensorsBodySensors::set_Battery_Charge(), and wb_sensors_body_sensors_from_network_serialised().

◆ Battery_Current

uint8_t wb_sensors_body_sensors::Battery_Current

Amps.

Definition at line 210 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::Battery_Current(), guWhiteboard::SensorsBodySensors::operator=(), guWhiteboard::SensorsBodySensors::set_Battery_Current(), and wb_sensors_body_sensors_from_network_serialised().

◆ ChestBoard_Button

bool wb_sensors_body_sensors::ChestBoard_Button

state of the chest button, on / off.

could use a 1 bit var here

Definition at line 220 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::ChestBoard_Button(), guWhiteboard::SensorsBodySensors::operator=(), guWhiteboard::SensorsBodySensors::set_ChestBoard_Button(), and wb_sensors_body_sensors_from_network_serialised().

◆ DCM_Time

signed int wb_sensors_body_sensors::DCM_Time

Absolute time used for all timed commands in the DCM, an integer (signed), with 1 ms precision.

Be careful: it can roll-over (doc/naoqi/sensors/dcm-api.html).

Definition at line 125 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::DCM_Time(), guWhiteboard::SensorsBodySensors::operator=(), guWhiteboard::SensorsBodySensors::set_DCM_Time(), and wb_sensors_body_sensors_from_network_serialised().

◆ InertialSensor_AccelerometerX

float wb_sensors_body_sensors::InertialSensor_AccelerometerX

new Accelerometer X value

Definition at line 175 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerX(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AccelerometerX().

◆ InertialSensor_AccelerometerY

float wb_sensors_body_sensors::InertialSensor_AccelerometerY

new Accelerometer Y value

Definition at line 180 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerY(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AccelerometerY().

◆ InertialSensor_AccelerometerZ

float wb_sensors_body_sensors::InertialSensor_AccelerometerZ

new Accelerometer Z value

Definition at line 185 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerZ(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AccelerometerZ().

◆ InertialSensor_AccX

float wb_sensors_body_sensors::InertialSensor_AccX

accelerometer X value

Definition at line 130 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AccX(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AccX().

◆ InertialSensor_AccY

float wb_sensors_body_sensors::InertialSensor_AccY

accelerometer Y value

Definition at line 135 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AccY(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AccY().

◆ InertialSensor_AccZ

float wb_sensors_body_sensors::InertialSensor_AccZ

accelerometer Z value

Definition at line 140 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AccZ(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AccZ().

◆ InertialSensor_AngleX

float wb_sensors_body_sensors::InertialSensor_AngleX

new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)'

Definition at line 160 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AngleX(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AngleX().

◆ InertialSensor_AngleY

float wb_sensors_body_sensors::InertialSensor_AngleY

new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)'

Definition at line 165 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AngleY(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AngleY().

◆ InertialSensor_AngleZ

float wb_sensors_body_sensors::InertialSensor_AngleZ

new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)'

Definition at line 170 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_AngleZ(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_AngleZ().

◆ InertialSensor_GyroscopeX

float wb_sensors_body_sensors::InertialSensor_GyroscopeX

new Gyro X value

Definition at line 190 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeX(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_GyroscopeX().

◆ InertialSensor_GyroscopeY

float wb_sensors_body_sensors::InertialSensor_GyroscopeY

new Gyro Y value

Definition at line 195 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeY(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_GyroscopeY().

◆ InertialSensor_GyroscopeZ

float wb_sensors_body_sensors::InertialSensor_GyroscopeZ

new Gyro Z value

Definition at line 200 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeZ(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_GyroscopeZ().

◆ InertialSensor_GyrX

float wb_sensors_body_sensors::InertialSensor_GyrX

gyro X value

Definition at line 145 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_GyrX(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_GyrX().

◆ InertialSensor_GyrY

float wb_sensors_body_sensors::InertialSensor_GyrY

gyro Y value

Definition at line 150 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_GyrY(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_GyrY().

◆ InertialSensor_GyrZ

float wb_sensors_body_sensors::InertialSensor_GyrZ

gyro Z value (Nao V5 have a Z axis)

Definition at line 155 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::InertialSensor_GyrZ(), guWhiteboard::SensorsBodySensors::operator=(), and guWhiteboard::SensorsBodySensors::set_InertialSensor_GyrZ().

◆ US

float wb_sensors_body_sensors::US

unsure, check naoqi docs! Not sure about this type, might only be 1 byte

Definition at line 215 of file wb_sensors_body_sensors.h.

Referenced by guWhiteboard::SensorsBodySensors::SensorsBodySensors(), guWhiteboard::SensorsBodySensors::operator=(), guWhiteboard::SensorsBodySensors::set_US(), and guWhiteboard::SensorsBodySensors::US().

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