cfn_sal_dev_magnetometer_api_s Struct Reference

Magnetometer Sensor Virtual Method Table (VMT). More...

#include <cfn_sal_dev_magnetometer.h>

Data Fields
cfn_hal_api_base_t	base
cfn_hal_error_code_t(*	read_xyz_ugauss )(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_data_t *data_out)
cfn_hal_error_code_t(*	read_xyz_raw )(cfn_sal_dev_magnetometer_t *driver, int16_t *x, int16_t *y, int16_t *z)
cfn_hal_error_code_t(*	set_range )(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_range_t range)
cfn_hal_error_code_t(*	get_range )(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_range_t *range_out)
cfn_hal_error_code_t(*	set_mode )(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_mode_t mode)
cfn_hal_error_code_t(*	set_datarate )(cfn_sal_dev_magnetometer_t *driver, uint32_t hz)
cfn_hal_error_code_t(*	soft_reset )(cfn_sal_dev_magnetometer_t *driver)
cfn_hal_error_code_t(*	get_status )(cfn_sal_dev_magnetometer_t *driver, uint32_t *status_flags)

Detailed Description

Magnetometer Sensor Virtual Method Table (VMT).

Field Documentation

base

cfn_hal_api_base_t cfn_sal_dev_magnetometer_api_s::base

get_range

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::get_range) (cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_range_t *range_out)

get_status

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::get_status) (cfn_sal_dev_magnetometer_t *driver, uint32_t *status_flags)

read_xyz_raw

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::read_xyz_raw) (cfn_sal_dev_magnetometer_t *driver, int16_t *x, int16_t *y, int16_t *z)

read_xyz_ugauss

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::read_xyz_ugauss) (cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_data_t *data_out)

set_datarate

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::set_datarate) (cfn_sal_dev_magnetometer_t *driver, uint32_t hz)

set_mode

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::set_mode) (cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_mode_t mode)

set_range

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::set_range) (cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_range_t range)

soft_reset

cfn_hal_error_code_t(* cfn_sal_dev_magnetometer_api_s::soft_reset) (cfn_sal_dev_magnetometer_t *driver)

---

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

• include/devices/cfn_sal_dev_magnetometer.h