LibDriver BME688
Loading...
Searching...
No Matches
driver_bme688_basic.c
Go to the documentation of this file.
1
36
37#include "driver_bme688_basic.h"
38
39static bme688_handle_t gs_handle;
40
51{
52 uint8_t res;
53
54 /* link interface function */
67
68 /* set interface */
69 res = bme688_set_interface(&gs_handle, interface);
70 if (res != 0)
71 {
72 bme688_interface_debug_print("bme688: set interface failed.\n");
73
74 return 1;
75 }
76
77 /* set addr pin */
78 res = bme688_set_addr_pin(&gs_handle, addr_pin);
79 if (res != 0)
80 {
81 bme688_interface_debug_print("bme688: set addr pin failed.\n");
82
83 return 1;
84 }
85
86 /* bme688 init */
87 res = bme688_init(&gs_handle);
88 if (res != 0)
89 {
90 bme688_interface_debug_print("bme688: init failed.\n");
91
92 return 1;
93 }
94
95 /* set default temperature oversampling */
97 if (res != 0)
98 {
99 bme688_interface_debug_print("bme688: set temperature oversampling failed.\n");
100 (void)bme688_deinit(&gs_handle);
101
102 return 1;
103 }
104
105 /* set default pressure oversampling */
107 if (res != 0)
108 {
109 bme688_interface_debug_print("bme688: set pressure oversampling failed.\n");
110 (void)bme688_deinit(&gs_handle);
111
112 return 1;
113 }
114
115 /* set default humidity oversampling */
117 if (res != 0)
118 {
119 bme688_interface_debug_print("bme688: set humidity oversampling failed.\n");
120 (void)bme688_deinit(&gs_handle);
121
122 return 1;
123 }
124
125 /* set default filter */
127 if (res != 0)
128 {
129 bme688_interface_debug_print("bme688: set filter failed.\n");
130 (void)bme688_deinit(&gs_handle);
131
132 return 1;
133 }
134
135 /* set default spi wire */
137 if (res != 0)
138 {
139 bme688_interface_debug_print("bme688: set spi wire failed.\n");
140 (void)bme688_deinit(&gs_handle);
141
142 return 1;
143 }
144
145 /* enable heater off */
146 res = bme688_set_heater_off(&gs_handle, BME688_BOOL_TRUE);
147 if (res != 0)
148 {
149 bme688_interface_debug_print("bme688: set heat off failed.\n");
150 (void)bme688_deinit(&gs_handle);
151
152 return 1;
153 }
154
155 /* disable run gas */
156 res = bme688_set_run_gas(&gs_handle, BME688_BOOL_FALSE);
157 if (res != 0)
158 {
159 bme688_interface_debug_print("bme688: set run gas failed.\n");
160 (void)bme688_deinit(&gs_handle);
161
162 return 1;
163 }
164
165 /* set sleep mode */
166 res = bme688_set_mode(&gs_handle, BME688_MODE_SLEEP);
167 if (res != 0)
168 {
169 bme688_interface_debug_print("bme688: set mode failed.\n");
170 (void)bme688_deinit(&gs_handle);
171
172 return 1;
173 }
174
175 return 0;
176}
177
188uint8_t bme688_basic_read(float *temperature, float *pressure, float *humidity_percentage)
189{
190 uint32_t temperature_yaw;
191 uint32_t pressure_yaw;
192 uint32_t humidity_raw;
193
194 /* read temperature pressure and humidity */
195 if (bme688_read_temperature_pressure_humidity(&gs_handle, BME688_SECTION_0, (uint32_t *)&temperature_yaw,
196 temperature, (uint32_t *)&pressure_yaw, pressure,
197 (uint32_t *)&humidity_raw, humidity_percentage) != 0)
198 {
199 return 1;
200 }
201
202 return 0;
203}
204
213{
214 /* enable heater off */
215 if (bme688_set_heater_off(&gs_handle, BME688_BOOL_TRUE) != 0)
216 {
217 return 1;
218 }
219
220 /* close bme688 */
221 if (bme688_deinit(&gs_handle) != 0)
222 {
223 return 1;
224 }
225
226 return 0;
227}
driver bme688 basic header file
uint8_t bme688_set_filter(bme688_handle_t *handle, bme688_filter_t filter)
set filter
uint8_t bme688_set_interface(bme688_handle_t *handle, bme688_interface_t interface)
set the interface
bme688_address_t
bme688 address enumeration definition
uint8_t bme688_set_addr_pin(bme688_handle_t *handle, bme688_address_t addr_pin)
set the iic address pin
uint8_t bme688_read_temperature_pressure_humidity(bme688_handle_t *handle, bme688_section_t section, uint32_t *temperature_raw, float *temperature_c, uint32_t *pressure_raw, float *pressure_pa, uint32_t *humidity_raw, float *humidity_percentage)
read the temperature pressure and humidity data
uint8_t bme688_set_temperature_oversampling(bme688_handle_t *handle, bme688_oversampling_t oversampling)
set temperature oversampling
uint8_t bme688_set_mode(bme688_handle_t *handle, bme688_mode_t mode)
set mode
uint8_t bme688_set_run_gas(bme688_handle_t *handle, bme688_bool_t enable)
enable or disable run gas
uint8_t bme688_set_spi_wire(bme688_handle_t *handle, bme688_spi_wire_t spi)
set spi wire
uint8_t bme688_init(bme688_handle_t *handle)
initialize the chip
uint8_t bme688_deinit(bme688_handle_t *handle)
close the chip
uint8_t bme688_set_heater_off(bme688_handle_t *handle, bme688_bool_t enable)
enable or disable heater off
bme688_interface_t
bme688 interface enumeration definition
uint8_t bme688_set_humidity_oversampling(bme688_handle_t *handle, bme688_oversampling_t oversampling)
set humidity oversampling
uint8_t bme688_set_pressure_oversampling(bme688_handle_t *handle, bme688_oversampling_t oversampling)
set pressure oversampling
struct bme688_handle_s bme688_handle_t
bme688 handle structure definition
@ BME688_MODE_SLEEP
@ BME688_SECTION_0
@ BME688_BOOL_TRUE
@ BME688_BOOL_FALSE
#define BME688_BASIC_DEFAULT_SPI_WIRE
uint8_t bme688_basic_init(bme688_interface_t interface, bme688_address_t addr_pin)
basic example init
uint8_t bme688_basic_read(float *temperature, float *pressure, float *humidity_percentage)
basic example read
#define BME688_BASIC_DEFAULT_PRESSURE_OVERSAMPLING
#define BME688_BASIC_DEFAULT_FILTER
uint8_t bme688_basic_deinit(void)
basic example deinit
#define BME688_BASIC_DEFAULT_HUMIDITY_OVERSAMPLING
#define BME688_BASIC_DEFAULT_TEMPERATURE_OVERSAMPLING
bme688 basic example default definition
uint8_t bme688_interface_spi_write(uint8_t reg, uint8_t *buf, uint16_t len)
interface spi bus write
uint8_t bme688_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
interface iic bus write
void bme688_interface_receive_callback(uint8_t status, bme688_parallel_data_t *data, uint8_t len)
interface receive callback
uint8_t bme688_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
interface iic bus read
void bme688_interface_delay_ms(uint32_t ms)
interface delay ms
uint8_t bme688_interface_spi_read(uint8_t reg, uint8_t *buf, uint16_t len)
interface spi bus read
void bme688_interface_debug_print(const char *const fmt,...)
interface print format data
uint8_t bme688_interface_spi_deinit(void)
interface spi bus deinit
uint8_t bme688_interface_spi_init(void)
interface spi bus init
uint8_t bme688_interface_iic_deinit(void)
interface iic bus deinit
uint8_t bme688_interface_iic_init(void)
interface iic bus init