altitude5.h File Reference

This file contains API for Altitude 5 Click Driver. More...

#include "drv_i2c_master.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures
struct	altitude5_s
	Altitude 5 Click context object. More...
struct	altitude5_cfg_t
	Altitude 5 Click configuration object. More...

Macros
#define	ALTITUDE5_SET_DEV_ADDR   0x4D
	Altitude 5 device address setting.
#define	ALTITUDE5_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Typedefs
typedef err_t(*	altitude5_master_io_t) (struct altitude5_s *, uint16_t *)
typedef struct altitude5_s	altitude5_t
	Altitude 5 Click context object.

Enumerations
enum	altitude5_drv_t { ALTITUDE5_DRV_SEL_AN , ALTITUDE5_DRV_SEL_I2C }
enum	altitude5_return_value_t { ALTITUDE5_OK = 0 , ALTITUDE5_ERROR = -1 }
	Altitude 5 Click return value data. More...

Functions
void	altitude5_cfg_setup (altitude5_cfg_t *cfg)
	Altitude 5 configuration object setup function.
err_t	altitude5_init (altitude5_t *ctx, altitude5_cfg_t *cfg)
	Altitude 5 initialization function.
err_t	altitude5_default_cfg (altitude5_t *ctx)
	Altitude 5 default configuration function.
err_t	altitude5_get_adc (altitude5_t *ctx, uint16_t *data_out)
	Altitude 5 get ADC function.
err_t	altitude5_read_an_pin_voltage (altitude5_t *ctx, float *data_out)
	Altitude 5 read AN pin voltage level function.
err_t	altitude5_get_adc_voltage (altitude5_t *ctx, float *adc_vtg)
	Altitude 5 get ADC voltage function.
err_t	altitude5_get_pressure (altitude5_t *ctx, float *pressure)
	Altitude 5 get pressure function.
err_t	altitude5_get_altitude (altitude5_t *ctx, float *altitude)
	Altitude 5 get altitude function.

Detailed Description

This file contains API for Altitude 5 Click Driver.

Typedef Documentation

altitude5_master_io_t

typedef err_t(* altitude5_master_io_t) (struct altitude5_s *, uint16_t *)

altitude5_t

typedef struct altitude5_s altitude5_t

Altitude 5 Click context object.

Context object definition of Altitude 5 Click driver.

Enumeration Type Documentation

altitude5_drv_t

enum altitude5_drv_t

Enumerator
ALTITUDE5_DRV_SEL_AN	AN driver descriptor.
ALTITUDE5_DRV_SEL_I2C	I2C driver descriptor.

altitude5_return_value_t

enum altitude5_return_value_t

Altitude 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
ALTITUDE5_OK
ALTITUDE5_ERROR