kopia lustrzana https://github.com/pimoroni/pimoroni-pico
Merge pull request #143 from pimoroni/driver/bme68x
Driver for BME688 and BME680 sensorspull/188/head
Philip Howard
GitHub
commit
c832bf27be
|
|
@ -27,6 +27,8 @@ jobs:
|
|||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: true
|
||||
|
||||
# Check out the Pico SDK
|
||||
- name: Checkout Pico SDK
|
||||
|
|
@ -62,4 +64,4 @@ jobs:
|
|||
working-directory: ${{runner.workspace}}/build
|
||||
shell: bash
|
||||
run: |
|
||||
cmake --build . --config $BUILD_TYPE -j 2
|
||||
cmake --build . --config $BUILD_TYPE -j 2
|
||||
|
|
|
|||
|
|
@ -1,3 +1,6 @@
|
|||
[submodule "micropython/modules/ulab"]
|
||||
path = micropython/modules/ulab
|
||||
url = https://github.com/v923z/micropython-ulab.git
|
||||
[submodule "drivers/bme68x-sensor-api/src"]
|
||||
path = drivers/bme68x/src
|
||||
url = https://github.com/BoschSensortec/BME68x-Sensor-API
|
||||
|
|
|
|||
|
|
@ -14,5 +14,6 @@ add_subdirectory(fatfs)
|
|||
add_subdirectory(sdcard)
|
||||
add_subdirectory(as7262)
|
||||
add_subdirectory(bh1745)
|
||||
add_subdirectory(bme68x)
|
||||
add_subdirectory(button)
|
||||
add_subdirectory(rgbled)
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
include(bme68x.cmake)
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
set(DRIVER_NAME bme68x)
|
||||
add_library(${DRIVER_NAME} INTERFACE)
|
||||
|
||||
target_sources(${DRIVER_NAME} INTERFACE
|
||||
${CMAKE_CURRENT_LIST_DIR}/src/bme68x.c
|
||||
${CMAKE_CURRENT_LIST_DIR}/bme68x.cpp
|
||||
)
|
||||
|
||||
target_include_directories(${DRIVER_NAME} INTERFACE ${CMAKE_CURRENT_LIST_DIR})
|
||||
target_include_directories(${DRIVER_NAME} INTERFACE ${CMAKE_CURRENT_LIST_DIR}/src)
|
||||
|
||||
|
||||
# We can't control the uninitialized result variables in the BME68X API
|
||||
# so demote unitialized to a warning for this target.
|
||||
target_compile_options(${DRIVER_NAME} INTERFACE -Wno-error=uninitialized)
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
#include "bme68x.hpp"
|
||||
#include "pico/stdlib.h"
|
||||
|
||||
namespace pimoroni {
|
||||
bool BME68X::init() {
|
||||
int8_t result = 0;
|
||||
|
||||
if(interrupt != PIN_UNUSED) {
|
||||
gpio_set_function(interrupt, GPIO_FUNC_SIO);
|
||||
gpio_set_dir(interrupt, GPIO_IN);
|
||||
gpio_pull_up(interrupt);
|
||||
}
|
||||
|
||||
device.intf_ptr = new i2c_intf_ptr{.i2c = i2c, .address = address};
|
||||
|
||||
device.intf = bme68x_intf::BME68X_I2C_INTF;
|
||||
device.read = (bme68x_read_fptr_t)&read_bytes;
|
||||
device.write = (bme68x_write_fptr_t)&write_bytes;
|
||||
device.delay_us = (bme68x_delay_us_fptr_t)&delay_us;
|
||||
device.amb_temp = 20;
|
||||
|
||||
result = bme68x_init(&device);
|
||||
bme68x_check_rslt("bme68x_init", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
result = bme68x_get_conf(&conf, &device);
|
||||
bme68x_check_rslt("bme68x_get_conf", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
configure(BME68X_FILTER_OFF, BME68X_ODR_NONE, BME68X_OS_16X, BME68X_OS_1X, BME68X_OS_2X);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool BME68X::configure(uint8_t filter, uint8_t odr, uint8_t os_humidity, uint8_t os_pressure, uint8_t os_temp) {
|
||||
int8_t result;
|
||||
|
||||
conf.filter = filter;
|
||||
conf.odr = odr;
|
||||
conf.os_hum = os_humidity;
|
||||
conf.os_pres = os_pressure;
|
||||
conf.os_temp = os_temp;
|
||||
|
||||
bme68x_set_conf(&conf, &device);
|
||||
bme68x_check_rslt("bme68x_set_conf", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool BME68X::read_forced(bme68x_data *data, uint16_t heater_temp, uint16_t heater_duration) {
|
||||
int8_t result = 0;
|
||||
uint8_t n_fields;
|
||||
uint32_t delay_period;
|
||||
|
||||
heatr_conf.enable = BME68X_ENABLE;
|
||||
heatr_conf.heatr_temp = heater_temp;
|
||||
heatr_conf.heatr_dur = heater_duration;
|
||||
result = bme68x_set_heatr_conf(BME68X_FORCED_MODE, &heatr_conf, &device);
|
||||
bme68x_check_rslt("bme68x_set_heatr_conf", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
result = bme68x_set_op_mode(BME68X_FORCED_MODE, &device);
|
||||
bme68x_check_rslt("bme68x_set_op_mode", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
delay_period = bme68x_get_meas_dur(BME68X_FORCED_MODE, &conf, &device) + (heatr_conf.heatr_dur * 1000);
|
||||
// Could probably just call sleep_us here directly, I guess the API uses this internally
|
||||
device.delay_us(delay_period, device.intf_ptr);
|
||||
|
||||
result = bme68x_get_data(BME68X_FORCED_MODE, data, &n_fields, &device);
|
||||
bme68x_check_rslt("bme68x_get_data", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
Will read profile_length results with the given temperatures and duration multipliers into the results array.
|
||||
Blocks until it has a valid result for each temp/duration, and returns the entire set in the given order.
|
||||
*/
|
||||
bool BME68X::read_parallel(bme68x_data *results, uint16_t *profile_temps, uint16_t *profile_durations, size_t profile_length) {
|
||||
int8_t result;
|
||||
bme68x_data data[3]; // Parallel & Sequential mode read 3 simultaneous fields
|
||||
uint8_t n_fields;
|
||||
uint32_t delay_period;
|
||||
|
||||
heatr_conf.enable = BME68X_ENABLE;
|
||||
heatr_conf.heatr_temp_prof = profile_temps;
|
||||
heatr_conf.heatr_dur_prof = profile_durations;
|
||||
heatr_conf.profile_len = profile_length;
|
||||
heatr_conf.shared_heatr_dur = 140 - (bme68x_get_meas_dur(BME68X_PARALLEL_MODE, &conf, &device) / 1000);
|
||||
result = bme68x_set_heatr_conf(BME68X_PARALLEL_MODE, &heatr_conf, &device);
|
||||
bme68x_check_rslt("bme68x_set_heatr_conf", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
result = bme68x_set_op_mode(BME68X_PARALLEL_MODE, &device);
|
||||
bme68x_check_rslt("bme68x_set_op_mode", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
while (1) {
|
||||
delay_period = bme68x_get_meas_dur(BME68X_PARALLEL_MODE, &conf, &device) + (heatr_conf.shared_heatr_dur * 1000);
|
||||
device.delay_us(delay_period, device.intf_ptr);
|
||||
|
||||
result = bme68x_get_data(BME68X_PARALLEL_MODE, data, &n_fields, &device);
|
||||
if(result == BME68X_W_NO_NEW_DATA) continue;
|
||||
bme68x_check_rslt("bme68x_get_data", result);
|
||||
if(result != BME68X_OK) return false;
|
||||
|
||||
for(auto i = 0u; i < n_fields; i++) {
|
||||
results[data[i].gas_index] = data[i];
|
||||
|
||||
if(data[i].gas_index == profile_length - 1) return true;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
#pragma once
|
||||
|
||||
#include "hardware/i2c.h"
|
||||
#include "hardware/gpio.h"
|
||||
#include "bme68x.h"
|
||||
#include "bme68x_defs.h"
|
||||
#include "common/pimoroni_i2c.hpp"
|
||||
#include "stdio.h"
|
||||
|
||||
namespace pimoroni {
|
||||
class BME68X {
|
||||
public:
|
||||
static const uint8_t DEFAULT_I2C_ADDRESS = 0x76;
|
||||
static const uint8_t ALTERNATE_I2C_ADDRESS = 0x77;
|
||||
|
||||
struct i2c_intf_ptr {
|
||||
I2C *i2c;
|
||||
int8_t address;
|
||||
};
|
||||
|
||||
bool debug = true;
|
||||
|
||||
bool init();
|
||||
bool configure(uint8_t filter, uint8_t odr, uint8_t os_humidity, uint8_t os_pressure, uint8_t os_temp);
|
||||
bool read_forced(bme68x_data *data, uint16_t heater_temp=300, uint16_t heater_duration=100);
|
||||
bool read_parallel(bme68x_data *results, uint16_t *profile_temps, uint16_t *profile_durations, size_t profile_length);
|
||||
|
||||
BME68X() : BME68X(new I2C()) {}
|
||||
BME68X(uint8_t address, uint interrupt = PIN_UNUSED) : BME68X(new I2C(), address, interrupt) {}
|
||||
BME68X(I2C *i2c, uint8_t address = DEFAULT_I2C_ADDRESS, uint interrupt = PIN_UNUSED) : i2c(i2c), address(address), interrupt(interrupt) {}
|
||||
|
||||
I2C *get_i2c() {return i2c;}
|
||||
uint get_int() {return PIN_UNUSED;}
|
||||
|
||||
// Bindings for bme68x_dev
|
||||
static int write_bytes(uint8_t reg_addr, uint8_t *reg_data, uint32_t length, void *intf_ptr) {
|
||||
BME68X::i2c_intf_ptr* i2c = (BME68X::i2c_intf_ptr *)intf_ptr;
|
||||
|
||||
uint8_t buffer[length + 1];
|
||||
buffer[0] = reg_addr;
|
||||
for(auto x = 0u; x < length; x++) {
|
||||
buffer[x + 1] = reg_data[x];
|
||||
}
|
||||
|
||||
int result = i2c->i2c->write_blocking(i2c->address, buffer, length + 1, false);
|
||||
|
||||
return result == PICO_ERROR_GENERIC ? 1 : 0;
|
||||
};
|
||||
|
||||
static int read_bytes(uint8_t reg_addr, uint8_t *reg_data, uint32_t length, void *intf_ptr) {
|
||||
BME68X::i2c_intf_ptr* i2c = (BME68X::i2c_intf_ptr *)intf_ptr;
|
||||
|
||||
int result = i2c->i2c->write_blocking(i2c->address, ®_addr, 1, true);
|
||||
result = i2c->i2c->read_blocking(i2c->address, reg_data, length, false);
|
||||
|
||||
return result == PICO_ERROR_GENERIC ? 1 : 0;
|
||||
};
|
||||
|
||||
static void delay_us(uint32_t period, void *intf_ptr) {
|
||||
sleep_us(period);
|
||||
}
|
||||
|
||||
/* From BME68X API examples/common/common.c */
|
||||
void bme68x_check_rslt(const char api_name[], int8_t rslt)
|
||||
{
|
||||
if(!debug) return;
|
||||
switch (rslt)
|
||||
{
|
||||
case BME68X_OK:
|
||||
/* Do nothing */
|
||||
break;
|
||||
case BME68X_E_NULL_PTR:
|
||||
printf("%s: Error [%d] : Null pointer\r\n", api_name, rslt);
|
||||
break;
|
||||
case BME68X_E_COM_FAIL:
|
||||
printf("%s: Error [%d] : Communication failure\r\n", api_name, rslt);
|
||||
break;
|
||||
case BME68X_E_INVALID_LENGTH:
|
||||
printf("%s: Error [%d] : Incorrect length parameter\r\n", api_name, rslt);
|
||||
break;
|
||||
case BME68X_E_DEV_NOT_FOUND:
|
||||
printf("%s: Error [%d] : Device not found\r\n", api_name, rslt);
|
||||
break;
|
||||
case BME68X_E_SELF_TEST:
|
||||
printf("%s: Error [%d] : Self test error\r\n", api_name, rslt);
|
||||
break;
|
||||
case BME68X_W_NO_NEW_DATA:
|
||||
printf("%s: Warning [%d] : No new data found\r\n", api_name, rslt);
|
||||
break;
|
||||
default:
|
||||
printf("%s: Error [%d] : Unknown error code\r\n", api_name, rslt);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
bme68x_dev device;
|
||||
bme68x_conf conf;
|
||||
bme68x_heatr_conf heatr_conf;
|
||||
|
||||
I2C *i2c;
|
||||
|
||||
int8_t address = DEFAULT_I2C_ADDRESS;
|
||||
uint interrupt = I2C_DEFAULT_INT;
|
||||
};
|
||||
}
|
||||
|
|
@ -0,0 +1 @@
|
|||
Subproject commit a31906a455fdde92e3ce5aeaa946ee4a20af5697
|
||||
|
|
@ -13,6 +13,7 @@ add_subdirectory(breakout_trackball)
|
|||
add_subdirectory(breakout_sgp30)
|
||||
add_subdirectory(breakout_colourlcd240x240)
|
||||
add_subdirectory(breakout_msa301)
|
||||
add_subdirectory(breakout_bme688)
|
||||
|
||||
add_subdirectory(pico_display)
|
||||
add_subdirectory(pico_unicorn)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
include("${CMAKE_CURRENT_LIST_DIR}/bme688_forced.cmake")
|
||||
include("${CMAKE_CURRENT_LIST_DIR}/bme688_parallel.cmake")
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
set(OUTPUT_NAME bme688_forced)
|
||||
|
||||
add_executable(
|
||||
${OUTPUT_NAME}
|
||||
${OUTPUT_NAME}.cpp
|
||||
)
|
||||
|
||||
# Pull in pico libraries that we need
|
||||
target_link_libraries(${OUTPUT_NAME} pico_stdlib hardware_i2c pimoroni_i2c bme68x)
|
||||
|
||||
# create map/bin/hex file etc.
|
||||
pico_add_extra_outputs(${OUTPUT_NAME})
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "pico/stdlib.h"
|
||||
|
||||
#include "bme68x.hpp"
|
||||
#include "common/pimoroni_i2c.hpp"
|
||||
|
||||
/*
|
||||
Read a single reading from the BME688
|
||||
*/
|
||||
|
||||
using namespace pimoroni;
|
||||
|
||||
I2C i2c(BOARD::BREAKOUT_GARDEN);
|
||||
BME68X bme68x(&i2c);
|
||||
|
||||
int main() {
|
||||
gpio_init(PICO_DEFAULT_LED_PIN);
|
||||
gpio_set_dir(PICO_DEFAULT_LED_PIN, GPIO_OUT);
|
||||
|
||||
stdio_init_all();
|
||||
|
||||
bme68x.init();
|
||||
|
||||
while (1) {
|
||||
sleep_ms(1000);
|
||||
auto time_abs = get_absolute_time();
|
||||
auto time_ms = to_ms_since_boot(time_abs);
|
||||
|
||||
bme68x_data data;
|
||||
|
||||
auto result = bme68x.read_forced(&data);
|
||||
(void)result;
|
||||
|
||||
printf("%lu, %.2f, %.2f, %.2f, %.2f, 0x%x, %d, %d\n",
|
||||
(long unsigned int)time_ms,
|
||||
data.temperature,
|
||||
data.pressure,
|
||||
data.humidity,
|
||||
data.gas_resistance,
|
||||
data.status,
|
||||
data.gas_index,
|
||||
data.meas_index);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
set(OUTPUT_NAME bme688_parallel)
|
||||
|
||||
add_executable(
|
||||
${OUTPUT_NAME}
|
||||
${OUTPUT_NAME}.cpp
|
||||
)
|
||||
|
||||
# Pull in pico libraries that we need
|
||||
target_link_libraries(${OUTPUT_NAME} pico_stdlib hardware_i2c pimoroni_i2c bme68x)
|
||||
|
||||
# create map/bin/hex file etc.
|
||||
pico_add_extra_outputs(${OUTPUT_NAME})
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "pico/stdlib.h"
|
||||
|
||||
#include "bme68x.hpp"
|
||||
#include "common/pimoroni_i2c.hpp"
|
||||
|
||||
/*
|
||||
Read a sequence of readings from the BME688 with given heat/duration profiles
|
||||
Reading the full batch of readings will take some time. This seems to take ~10sec.
|
||||
*/
|
||||
|
||||
using namespace pimoroni;
|
||||
|
||||
I2C i2c(BOARD::BREAKOUT_GARDEN);
|
||||
BME68X bme68x(&i2c);
|
||||
|
||||
constexpr uint16_t profile_length = 10;
|
||||
|
||||
// Space for <profile_length> results
|
||||
bme68x_data data[profile_length];
|
||||
|
||||
/* Heater temperature in degree Celsius */
|
||||
uint16_t temps[profile_length] = { 320, 100, 100, 100, 200, 200, 200, 320, 320, 320 };
|
||||
|
||||
/* Multiplier to the shared heater duration */
|
||||
uint16_t durations[profile_length] = { 5, 2, 10, 30, 5, 5, 5, 5, 5, 5 };
|
||||
|
||||
|
||||
int main() {
|
||||
gpio_init(PICO_DEFAULT_LED_PIN);
|
||||
gpio_set_dir(PICO_DEFAULT_LED_PIN, GPIO_OUT);
|
||||
|
||||
stdio_init_all();
|
||||
|
||||
bme68x.init();
|
||||
|
||||
while (1) {
|
||||
sleep_ms(1000);
|
||||
auto time_start = get_absolute_time();
|
||||
|
||||
printf("Fetching %u readings, please wait...\n", profile_length);
|
||||
|
||||
auto result = bme68x.read_parallel(data, temps, durations, profile_length);
|
||||
(void)result;
|
||||
|
||||
auto time_end = get_absolute_time();
|
||||
auto duration = absolute_time_diff_us(time_start, time_end);
|
||||
auto time_ms = to_ms_since_boot(time_start);
|
||||
|
||||
printf("Done at %lu in %lluus\n", (long unsigned int)time_ms, (long long unsigned int)duration);
|
||||
|
||||
for(auto i = 0u; i < 10u; i++){
|
||||
printf("%d, %d: %.2f, %.2f, %.2f, %.2f, 0x%x\n",
|
||||
data[i].gas_index,
|
||||
data[i].meas_index,
|
||||
data[i].temperature,
|
||||
data[i].pressure,
|
||||
data[i].humidity,
|
||||
data[i].gas_resistance,
|
||||
data[i].status);
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
# BME68X <!-- omit in toc -->
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Reading Data From The Sensor](#reading-data-from-the-sensor)
|
||||
- [Configuring The Sensor](#configuring-the-sensor)
|
||||
- [Filter Settings](#filter-settings)
|
||||
- [Oversampling Settings](#oversampling-settings)
|
||||
- [Mode Settings](#mode-settings)
|
||||
- [Standby/Output Data Rate Settings](#standbyoutput-data-rate-settings)
|
||||
- [Defaults](#defaults)
|
||||
|
||||
## Getting Started
|
||||
|
||||
Construct new `PimoroniI2C` and `BreakoutBME68X` instances:
|
||||
|
||||
```python
|
||||
from breakout_bme68x import BreakoutBME68X
|
||||
from pimoroni_i2c import PimoroniI2C
|
||||
|
||||
PINS_BREAKOUT_GARDEN = {"sda": 4, "scl": 5}
|
||||
PINS_PICO_EXPLORER = {"sda": 20, "scl": 21}
|
||||
|
||||
i2c = PimoroniI2C(**PINS_PICO_EXPLORER)
|
||||
bme = BreakoutBME68X(i2c)
|
||||
```
|
||||
|
||||
The `breakout_bme68x` module includes constants for the possible I2C addresses:
|
||||
|
||||
* `ADDRESS_DEFAULT`
|
||||
* `ADDRESS_ALT`
|
||||
|
||||
## Reading Data From The Sensor
|
||||
|
||||
The `read` method will return a tuple containing Temperature (degrees C), Pressure (Pa) humidity, and gas resistance values, plus the status code and gas/measurement indexes:
|
||||
|
||||
```python
|
||||
temperature, pressure, humidity, gas_resistance, status, gas_index, meas_index = bme.read()
|
||||
```
|
||||
|
||||
In all cases `gas_index` and `meas_index` will be zero, since these refer to the measurement profile used to gather the current readings. The MicroPython bindings currently only support a single measurement profile with a default of 300c for 100ms.
|
||||
|
||||
You can pass a custom temperature and duration into `read`:
|
||||
|
||||
```python
|
||||
temperature, pressure, humidity, gas_resistance, status, gas_index, meas_index = bme.read(heater_temp=250, heater_duration=50)
|
||||
```
|
||||
|
||||
## Configuring The Sensor
|
||||
|
||||
The `configure` method allows you to set up the oversampling, filtering and operation mode.
|
||||
|
||||
```python
|
||||
bme.configure(filter, standby_time, os_pressure, os_temp, os_humidity)
|
||||
```
|
||||
|
||||
The `breakout_bme68x` module includes constants for these:
|
||||
|
||||
### Filter Settings
|
||||
|
||||
* `FILTER_COEFF_OFF`
|
||||
* `FILTER_COEFF_1`
|
||||
* `FILTER_COEFF_3`
|
||||
* `FILTER_COEFF_8`
|
||||
* `FILTER_COEFF_15`
|
||||
* `FILTER_COEFF_31`
|
||||
* `FILTER_COEFF_63`
|
||||
* `FILTER_COEFF_127`
|
||||
|
||||
### Oversampling Settings
|
||||
|
||||
* `NO_OVERSAMPLING`
|
||||
* `OVERSAMPLING_1X`
|
||||
* `OVERSAMPLING_2X`
|
||||
* `OVERSAMPLING_4X`
|
||||
* `OVERSAMPLING_8X`
|
||||
* `OVERSAMPLING_16X`
|
||||
|
||||
### Mode Settings
|
||||
|
||||
* `SLEEP_MODE`
|
||||
* `FORCED_MODE`
|
||||
* `NORMAL_MODE`
|
||||
|
||||
### Standby/Output Data Rate Settings
|
||||
|
||||
* `STANDBY_TIME_0_59_MS`
|
||||
* `STANDBY_TIME_62_5_MS`
|
||||
* `STANDBY_TIME_125_MS`
|
||||
* `STANDBY_TIME_250_MS`
|
||||
* `STANDBY_TIME_500_MS`
|
||||
* `STANDBY_TIME_1000_MS`
|
||||
* `STANDBY_TIME_10_MS`
|
||||
* `STANDBY_TIME_20_MS`
|
||||
|
||||
### Defaults
|
||||
|
||||
```python
|
||||
bme.configure(FILTER_COEFF_3, STANDBY_TIME_1000_MS, OVERSAMPLING_16X, OVERSAMPLING_2X, OVERSAMPLING_1X)
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
"""BME688 / BME680 demo
|
||||
|
||||
This demo will work for both the BME680 and BME688.
|
||||
"""
|
||||
import time
|
||||
from breakout_bme68x import BreakoutBME68X, STATUS_HEATER_STABLE
|
||||
from pimoroni_i2c import PimoroniI2C
|
||||
|
||||
PINS_BREAKOUT_GARDEN = {"sda": 4, "scl": 5}
|
||||
PINS_PICO_EXPLORER = {"sda": 20, "scl": 21}
|
||||
|
||||
i2c = PimoroniI2C(**PINS_PICO_EXPLORER)
|
||||
bmp = BreakoutBME68X(i2c)
|
||||
|
||||
while True:
|
||||
temperature, pressure, humidity, gas, status, _, _ = bmp.read()
|
||||
heater = "Stable" if status & STATUS_HEATER_STABLE else "Unstable"
|
||||
print("{:0.2f}c, {:0.2f}Pa, {:0.2f}%, {:0.2f} Ohms, Heater: {}".format(
|
||||
temperature, pressure, humidity, gas, heater))
|
||||
time.sleep(1.0)
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
#include "breakout_bme68x.h"
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// BreakoutBME68X Class
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/***** Methods *****/
|
||||
MP_DEFINE_CONST_FUN_OBJ_KW(BreakoutBME68X_read_obj, 1, BreakoutBME68X_read);
|
||||
MP_DEFINE_CONST_FUN_OBJ_KW(BreakoutBME68X_configure_obj, 1, BreakoutBME68X_configure);
|
||||
|
||||
/***** Binding of Methods *****/
|
||||
STATIC const mp_rom_map_elem_t BreakoutBME68X_locals_dict_table[] = {
|
||||
{ MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&BreakoutBME68X_read_obj) },
|
||||
};
|
||||
STATIC MP_DEFINE_CONST_DICT(BreakoutBME68X_locals_dict, BreakoutBME68X_locals_dict_table);
|
||||
|
||||
/***** Class Definition *****/
|
||||
const mp_obj_type_t breakout_bme68x_BreakoutBME68X_type = {
|
||||
{ &mp_type_type },
|
||||
.name = MP_QSTR_breakout_bme68x,
|
||||
.print = BreakoutBME68X_print,
|
||||
.make_new = BreakoutBME68X_make_new,
|
||||
.locals_dict = (mp_obj_dict_t*)&BreakoutBME68X_locals_dict,
|
||||
};
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// breakout_bme68x Module
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/***** Globals Table *****/
|
||||
STATIC const mp_map_elem_t breakout_bme68x_globals_table[] = {
|
||||
{ MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_breakout_bme68x) },
|
||||
{ MP_OBJ_NEW_QSTR(MP_QSTR_BreakoutBME68X), (mp_obj_t)&breakout_bme68x_BreakoutBME68X_type },
|
||||
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_OFF), MP_ROM_INT(BME68X_FILTER_OFF) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_1), MP_ROM_INT(BME68X_FILTER_SIZE_1) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_3), MP_ROM_INT(BME68X_FILTER_SIZE_3) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_7), MP_ROM_INT(BME68X_FILTER_SIZE_7) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_15), MP_ROM_INT(BME68X_FILTER_SIZE_15) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_31), MP_ROM_INT(BME68X_FILTER_SIZE_31) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_63), MP_ROM_INT(BME68X_FILTER_SIZE_63) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FILTER_COEFF_127), MP_ROM_INT(BME68X_FILTER_SIZE_127) },
|
||||
|
||||
{ MP_ROM_QSTR(MP_QSTR_NO_OVERSAMPLING), MP_ROM_INT(BME68X_OS_NONE) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_OVERSAMPLING_1X), MP_ROM_INT(BME68X_OS_1X) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_OVERSAMPLING_2X), MP_ROM_INT(BME68X_OS_2X) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_OVERSAMPLING_4X), MP_ROM_INT(BME68X_OS_4X) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_OVERSAMPLING_8X), MP_ROM_INT(BME68X_OS_8X) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_OVERSAMPLING_16X), MP_ROM_INT(BME68X_OS_16X) },
|
||||
|
||||
/* TODO add MicroPython support for alternate reading modes?
|
||||
{ MP_ROM_QSTR(MP_QSTR_SLEEP_MODE), MP_ROM_INT(BME68X_SLEEP_MODE) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_FORCED_MODE), MP_ROM_INT(BME68X_FORCED_MODE) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_PARALLEL_MODE), MP_ROM_INT(BME68X_PARALLEL_MODE) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_SEQUENTIAL_MODE), MP_ROM_INT(BME68X_SEQUENTIAL_MODE) },
|
||||
*/
|
||||
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_OFF), MP_ROM_INT(BME68X_ODR_NONE) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_0_59_MS), MP_ROM_INT(BME68X_ODR_0_59_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_62_5_MS), MP_ROM_INT(BME68X_ODR_62_5_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_125_MS), MP_ROM_INT(BME68X_ODR_125_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_250_MS), MP_ROM_INT(BME68X_ODR_250_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_500_MS), MP_ROM_INT(BME68X_ODR_500_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_1000_MS), MP_ROM_INT(BME68X_ODR_1000_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_10_MS), MP_ROM_INT(BME68X_ODR_10_MS) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STANDBY_TIME_20_MS), MP_ROM_INT(BME68X_ODR_20_MS) },
|
||||
|
||||
{ MP_ROM_QSTR(MP_QSTR_STATUS_GAS_VALID), MP_ROM_INT(BME68X_GASM_VALID_MSK) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_STATUS_HEATER_STABLE), MP_ROM_INT(BME68X_HEAT_STAB_MSK) },
|
||||
|
||||
{ MP_ROM_QSTR(MP_QSTR_I2C_ADDRESS_DEFAULT), MP_ROM_INT(BME68X_I2C_ADDR_LOW) },
|
||||
{ MP_ROM_QSTR(MP_QSTR_I2C_ADDRESS_ALT), MP_ROM_INT(BME68X_I2C_ADDR_HIGH) },
|
||||
};
|
||||
STATIC MP_DEFINE_CONST_DICT(mp_module_breakout_bme68x_globals, breakout_bme68x_globals_table);
|
||||
|
||||
/***** Module Definition *****/
|
||||
const mp_obj_module_t breakout_bme68x_user_cmodule = {
|
||||
.base = { &mp_type_module },
|
||||
.globals = (mp_obj_dict_t*)&mp_module_breakout_bme68x_globals,
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
MP_REGISTER_MODULE(MP_QSTR_breakout_bme68x, breakout_bme68x_user_cmodule, MODULE_BREAKOUT_BME68X_ENABLED);
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
|
@ -0,0 +1,142 @@
|
|||
#include "drivers/bme68x/bme68x.hpp"
|
||||
|
||||
#define MP_OBJ_TO_PTR2(o, t) ((t *)(uintptr_t)(o))
|
||||
|
||||
// SDA/SCL on even/odd pins, I2C0/I2C1 on even/odd pairs of pins.
|
||||
#define IS_VALID_SCL(i2c, pin) (((pin) & 1) == 1 && (((pin) & 2) >> 1) == (i2c))
|
||||
#define IS_VALID_SDA(i2c, pin) (((pin) & 1) == 0 && (((pin) & 2) >> 1) == (i2c))
|
||||
|
||||
|
||||
using namespace pimoroni;
|
||||
|
||||
extern "C" {
|
||||
#include "breakout_bme68x.h"
|
||||
#include "pimoroni_i2c.h"
|
||||
|
||||
/***** I2C Struct *****/
|
||||
typedef struct _PimoroniI2C_obj_t {
|
||||
mp_obj_base_t base;
|
||||
I2C *i2c;
|
||||
} _PimoroniI2C_obj_t;
|
||||
|
||||
/***** Variables Struct *****/
|
||||
typedef struct _breakout_bme68x_BreakoutBME68X_obj_t {
|
||||
mp_obj_base_t base;
|
||||
BME68X *breakout;
|
||||
} breakout_bme68x_BreakoutBME68X_obj_t;
|
||||
|
||||
/***** Print *****/
|
||||
void BreakoutBME68X_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
|
||||
(void)kind; //Unused input parameter
|
||||
breakout_bme68x_BreakoutBME68X_obj_t *self = MP_OBJ_TO_PTR2(self_in, breakout_bme68x_BreakoutBME68X_obj_t);
|
||||
BME68X* breakout = self->breakout;
|
||||
mp_print_str(print, "BreakoutBME68X(");
|
||||
|
||||
mp_print_str(print, "i2c = ");
|
||||
mp_obj_print_helper(print, mp_obj_new_int((breakout->get_i2c()->get_i2c() == i2c0) ? 0 : 1), PRINT_REPR);
|
||||
|
||||
mp_print_str(print, ", sda = ");
|
||||
mp_obj_print_helper(print, mp_obj_new_int(breakout->get_i2c()->get_sda()), PRINT_REPR);
|
||||
|
||||
mp_print_str(print, ", scl = ");
|
||||
mp_obj_print_helper(print, mp_obj_new_int(breakout->get_i2c()->get_scl()), PRINT_REPR);
|
||||
|
||||
mp_print_str(print, ", int = ");
|
||||
mp_obj_print_helper(print, mp_obj_new_int(breakout->get_int()), PRINT_REPR);
|
||||
|
||||
mp_print_str(print, ")");
|
||||
}
|
||||
|
||||
/***** Constructor *****/
|
||||
mp_obj_t BreakoutBME68X_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
|
||||
breakout_bme68x_BreakoutBME68X_obj_t *self = nullptr;
|
||||
|
||||
enum { ARG_i2c, ARG_address, ARG_int };
|
||||
static const mp_arg_t allowed_args[] = {
|
||||
{ MP_QSTR_i2c, MP_ARG_OBJ, {.u_obj = nullptr} },
|
||||
{ MP_QSTR_address, MP_ARG_INT, {.u_int = BME68X::DEFAULT_I2C_ADDRESS} },
|
||||
{ MP_QSTR_interrupt, MP_ARG_INT, {.u_int = PIN_UNUSED} },
|
||||
};
|
||||
|
||||
// Parse args.
|
||||
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
||||
mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
||||
|
||||
|
||||
if(!MP_OBJ_IS_TYPE(args[ARG_i2c].u_obj, &PimoroniI2C_type)) {
|
||||
mp_raise_ValueError(MP_ERROR_TEXT("BreakoutBME68X: Bad i2C object"));
|
||||
return mp_const_none;
|
||||
}
|
||||
|
||||
_PimoroniI2C_obj_t *i2c = (_PimoroniI2C_obj_t *)MP_OBJ_TO_PTR(args[ARG_i2c].u_obj);
|
||||
|
||||
self = m_new_obj(breakout_bme68x_BreakoutBME68X_obj_t);
|
||||
self->base.type = &breakout_bme68x_BreakoutBME68X_type;
|
||||
|
||||
self->breakout = new BME68X(i2c->i2c, args[ARG_address].u_int, args[ARG_int].u_int);
|
||||
|
||||
if(!self->breakout->init()) {
|
||||
mp_raise_msg(&mp_type_RuntimeError, "BreakoutBME68X: breakout not found when initialising");
|
||||
}
|
||||
|
||||
return MP_OBJ_FROM_PTR(self);
|
||||
}
|
||||
|
||||
mp_obj_t BreakoutBME68X_read(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
|
||||
enum { ARG_self, ARG_temp, ARG_duration };
|
||||
static const mp_arg_t allowed_args[] = {
|
||||
{ MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ },
|
||||
{ MP_QSTR_heater_temp, MP_ARG_INT, { .u_int=300 } },
|
||||
{ MP_QSTR_heater_duration, MP_ARG_INT, { .u_int=100 } },
|
||||
};
|
||||
|
||||
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
||||
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
||||
|
||||
breakout_bme68x_BreakoutBME68X_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self].u_obj, breakout_bme68x_BreakoutBME68X_obj_t);
|
||||
|
||||
bme68x_data result;
|
||||
if(self->breakout->read_forced(&result, args[ARG_temp].u_int, args[ARG_duration].u_int)){
|
||||
mp_obj_t tuple[7];
|
||||
tuple[0] = mp_obj_new_float(result.temperature);
|
||||
tuple[1] = mp_obj_new_float(result.pressure);
|
||||
tuple[2] = mp_obj_new_float(result.humidity);
|
||||
tuple[3] = mp_obj_new_float(result.gas_resistance);
|
||||
tuple[4] = mp_obj_new_int(result.status);
|
||||
tuple[5] = mp_obj_new_int(result.gas_index);
|
||||
tuple[6] = mp_obj_new_int(result.meas_index);
|
||||
return mp_obj_new_tuple(7, tuple);
|
||||
}
|
||||
else {
|
||||
mp_raise_msg(&mp_type_RuntimeError, "BreakoutBME68X: failed read_forced");
|
||||
return mp_const_none;
|
||||
}
|
||||
}
|
||||
|
||||
mp_obj_t BreakoutBME68X_configure(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
|
||||
enum { ARG_self, ARG_filter, ARG_standby_time, ARG_os_pressure, ARG_os_temp, ARG_os_humidity };
|
||||
static const mp_arg_t allowed_args[] = {
|
||||
{ MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ },
|
||||
{ MP_QSTR_filter, MP_ARG_INT, { .u_int=BME68X_FILTER_SIZE_3 } },
|
||||
{ MP_QSTR_standby_time, MP_ARG_INT, { .u_int=BME68X_ODR_0_59_MS } },
|
||||
{ MP_QSTR_os_pressure, MP_ARG_INT, { .u_int=BME68X_OS_16X } },
|
||||
{ MP_QSTR_os_temp, MP_ARG_INT, { .u_int=BME68X_OS_2X } },
|
||||
{ MP_QSTR_os_humidity, MP_ARG_INT, { .u_int=BME68X_OS_1X } }
|
||||
};
|
||||
|
||||
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
||||
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
||||
|
||||
breakout_bme68x_BreakoutBME68X_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self].u_obj, breakout_bme68x_BreakoutBME68X_obj_t);
|
||||
self->breakout->configure(
|
||||
args[ARG_filter].u_int,
|
||||
args[ARG_standby_time].u_int,
|
||||
args[ARG_os_humidity].u_int,
|
||||
args[ARG_os_pressure].u_int,
|
||||
args[ARG_os_temp].u_int
|
||||
);
|
||||
|
||||
return mp_const_none;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
// Include MicroPython API.
|
||||
#include "py/runtime.h"
|
||||
#include "drivers/bme68x/src/bme68x_defs.h"
|
||||
|
||||
/***** Constants *****/
|
||||
|
||||
/***** Extern of Class Definition *****/
|
||||
extern const mp_obj_type_t breakout_bme68x_BreakoutBME68X_type;
|
||||
|
||||
/***** Extern of Class Methods *****/
|
||||
extern void BreakoutBME68X_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind);
|
||||
extern mp_obj_t BreakoutBME68X_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args);
|
||||
extern mp_obj_t BreakoutBME68X_read(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
|
||||
extern mp_obj_t BreakoutBME68X_configure(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
set(MOD_NAME breakout_bme68x)
|
||||
string(TOUPPER ${MOD_NAME} MOD_NAME_UPPER)
|
||||
add_library(usermod_${MOD_NAME} INTERFACE)
|
||||
|
||||
target_sources(usermod_${MOD_NAME} INTERFACE
|
||||
${CMAKE_CURRENT_LIST_DIR}/${MOD_NAME}.c
|
||||
${CMAKE_CURRENT_LIST_DIR}/${MOD_NAME}.cpp
|
||||
)
|
||||
|
||||
include(drivers/bme68x/bme68x)
|
||||
target_link_libraries(usermod_${MOD_NAME} INTERFACE bme68x)
|
||||
|
||||
target_include_directories(usermod_${MOD_NAME} INTERFACE
|
||||
${CMAKE_CURRENT_LIST_DIR}
|
||||
)
|
||||
|
||||
target_compile_definitions(usermod_${MOD_NAME} INTERFACE
|
||||
MODULE_${MOD_NAME_UPPER}_ENABLED=1
|
||||
)
|
||||
|
||||
target_link_libraries(usermod INTERFACE usermod_${MOD_NAME})
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
set(MOD_NAME breakout_bme68x)
|
||||
BREAKOUT_MOD_DIR := $(USERMOD_DIR)
|
||||
|
||||
# Add our source files to the respective variables.
|
||||
SRC_USERMOD += $(BREAKOUT_MOD_DIR)/${MOD_NAME}.c
|
||||
SRC_USERMOD_CXX += $(BREAKOUT_MOD_DIR)/${MOD_NAME}.cpp
|
||||
|
||||
# Add our module directory to the include path.
|
||||
CFLAGS_USERMOD += -I$(BREAKOUT_MOD_DIR)
|
||||
CXXFLAGS_USERMOD += -I$(BREAKOUT_MOD_DIR)
|
||||
|
||||
# We use C++ features so have to link against the standard library.
|
||||
LDFLAGS_USERMOD += -lstdc++
|
||||
|
|
@ -22,6 +22,7 @@ include(breakout_trackball/micropython)
|
|||
include(breakout_sgp30/micropython)
|
||||
include(breakout_colourlcd240x240/micropython)
|
||||
include(breakout_bh1745/micropython)
|
||||
include(breakout_bme68x/micropython)
|
||||
|
||||
include(pico_scroll/micropython)
|
||||
include(pico_rgb_keypad/micropython)
|
||||
|
|
@ -29,4 +30,4 @@ include(pico_unicorn/micropython)
|
|||
include(pico_display/micropython)
|
||||
include(pico_explorer/micropython)
|
||||
include(pico_wireless/micropython)
|
||||
include(ulab/code/micropython)
|
||||
include(ulab/code/micropython)
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue