barometer5 2.0.0.0
barometer5.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  barometer5_t
 Barometer 5 Click context object. More...
 
struct  barometer5_cfg_t
 Barometer 5 Click configuration object. More...
 

Macros

#define BAROMETER5_CMD_RESET   0x1E
 Barometer 5 description commands.
 
#define BAROMETER5_CMD_CONV_D1_OSR_256   0x40
 
#define BAROMETER5_CMD_CONV_D1_OSR_512   0x42
 
#define BAROMETER5_CMD_CONV_D1_OSR_1024   0x44
 
#define BAROMETER5_CMD_CONV_D1_OSR_2048   0x46
 
#define BAROMETER5_CMD_CONV_D1_OSR_4096   0x48
 
#define BAROMETER5_CMD_CONV_D2_OSR_256   0x50
 
#define BAROMETER5_CMD_CONV_D2_OSR_512   0x52
 
#define BAROMETER5_CMD_CONV_D2_OSR_1024   0x54
 
#define BAROMETER5_CMD_CONV_D2_OSR_2048   0x56
 
#define BAROMETER5_CMD_CONV_D2_OSR_4096   0x58
 
#define BAROMETER5_CMD_ADC_READ   0x00
 
#define BAROMETER5_CMD_PROM_READ_START   0xA0
 
#define BAROMETER5_RATIO_256   0x00
 Barometer 5 description setting.
 
#define BAROMETER5_RATIO_512   0x01
 
#define BAROMETER5_RATIO_1024   0x02
 
#define BAROMETER5_RATIO_2048   0x03
 
#define BAROMETER5_RATIO_4096   0x04
 
#define BAROMETER5_SET_DEV_ADDR   0x76
 Barometer 5 device address setting.
 
#define BAROMETER5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  barometer5_return_value_t { BAROMETER5_OK = 0 , BAROMETER5_ERROR = -1 }
 Barometer 5 Click return value data. More...
 

Functions

void barometer5_cfg_setup (barometer5_cfg_t *cfg)
 Barometer 5 configuration object setup function.
 
err_t barometer5_init (barometer5_t *ctx, barometer5_cfg_t *cfg)
 Barometer 5 initialization function.
 
err_t barometer5_default_cfg (barometer5_t *ctx)
 Barometer 5 default configuration function.
 
err_t barometer5_generic_write (barometer5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 Barometer 5 I2C writing function.
 
err_t barometer5_generic_read (barometer5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 Barometer 5 I2C reading function.
 
err_t barometer5_set_command (barometer5_t *ctx, uint8_t cmd)
 Barometer 5 set command function.
 
err_t barometer5_set_ratio (barometer5_t *ctx, uint8_t temp_ratio, uint8_t press_ratio)
 Barometer 5 set data ratio function.
 
err_t barometer5_sw_reset (barometer5_t *ctx)
 Barometer 5 software reset function.
 
err_t barometer5_get_calibration_data (barometer5_t *ctx)
 Barometer 5 get calibration data function.
 
err_t barometer5_get_raw_data (barometer5_t *ctx, uint32_t *temp_data, uint32_t *press_data)
 Barometer 5 get raw data function.
 
err_t barometer5_get_temperature (barometer5_t *ctx, float *temperature)
 Barometer 5 get temperature data function.
 
err_t barometer5_get_pressure (barometer5_t *ctx, float *pressure)
 Barometer 5 get pressure data function.
 
err_t barometer5_calculate_altitude (barometer5_t *ctx, float *altitude)
 Barometer 5 calculate altitude function.
 
err_t barometer5_get_data (barometer5_t *ctx, float *temperature, float *pressure)
 Barometer 5 get data function.
 

Detailed Description

This file contains API for Barometer 5 Click Driver.

Enumeration Type Documentation

◆ barometer5_return_value_t

Barometer 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
BAROMETER5_OK 
BAROMETER5_ERROR