cfn_sal_dev_proximity_api_s Struct Reference

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

#include <cfn_sal_dev_proximity.h>

Data Fields
cfn_hal_api_base_t	base
cfn_hal_error_code_t(*	read_distance_mm )(cfn_sal_dev_proximity_t *driver, float *mm_out)
cfn_hal_error_code_t(*	read_raw )(cfn_sal_dev_proximity_t *driver, uint32_t *raw_out)
cfn_hal_error_code_t(*	get_status )(cfn_sal_dev_proximity_t *driver, uint32_t *status_flags)
cfn_hal_error_code_t(*	get_id )(cfn_sal_dev_proximity_t *driver, uint32_t *id_out)
void(*	handle_interrupt )(cfn_sal_dev_proximity_t *driver)

Detailed Description

Proximity Sensor Virtual Method Table (VMT).

Field Documentation

base

cfn_hal_api_base_t cfn_sal_dev_proximity_api_s::base

get_id

cfn_hal_error_code_t(* cfn_sal_dev_proximity_api_s::get_id) (cfn_sal_dev_proximity_t *driver, uint32_t *id_out)

get_status

cfn_hal_error_code_t(* cfn_sal_dev_proximity_api_s::get_status) (cfn_sal_dev_proximity_t *driver, uint32_t *status_flags)

handle_interrupt

void(* cfn_sal_dev_proximity_api_s::handle_interrupt) (cfn_sal_dev_proximity_t *driver)

read_distance_mm

cfn_hal_error_code_t(* cfn_sal_dev_proximity_api_s::read_distance_mm) (cfn_sal_dev_proximity_t *driver, float *mm_out)

read_raw

cfn_hal_error_code_t(* cfn_sal_dev_proximity_api_s::read_raw) (cfn_sal_dev_proximity_t *driver, uint32_t *raw_out)

---

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

• include/devices/cfn_sal_dev_proximity.h