ChibiOS/HAL  6.1.0
hal_compass.h File Reference

Generic compass interface header. More...

#include "hal_sensors.h"

Go to the source code of this file.

Data Structures

struct  BaseCompassVMT
 BaseCompass virtual methods table. More...
 
struct  BaseCompass
 Base compass class. More...
 

Macros

#define _base_compass_methods_alone
 BaseCompass specific methods. More...
 
#define _base_compass_methods
 BaseCompass specific methods with inherited ones. More...
 
#define _base_compass_data   _base_sensor_data
 BaseCompass specific data. More...
 
Macro Functions (BaseCompass)
#define compassGetAxesNumber(ip)   (ip)->vmt->get_channels_number(ip)
 Compass get axes number. More...
 
#define compassReadRaw(ip, dp)   (ip)->vmt->read_raw(ip, dp)
 Compass read raw data. More...
 
#define compassReadCooked(ip, dp)   (ip)->vmt->read_cooked(ip, dp)
 Compass read cooked data. More...
 
#define compassSetBias(ip, bp)   (ip)->vmt->set_bias(ip, bp)
 Updates compass bias data from received buffer. More...
 
#define compassResetBias(ip)   (ip)->vmt->reset_bias(ip)
 Reset compass bias data restoring it to zero. More...
 
#define compassSetSensitivity(ip, sp)   (ip)->vmt->set_sensitivity(ip, sp)
 Updates compass sensitivity data from received buffer. More...
 
#define compassResetSensitivity(ip)   (ip)->vmt->reset_sensitivity(ip)
 Reset compass sensitivity data restoring it to its typical value. More...
 

Detailed Description

Generic compass interface header.

Definition in file hal_compass.h.