Merge pull request #28 from coffee-and-telesense/trim_bosch_library

Trim bosch library

Author: nkanderson

libs/bme68x/Inc/bme68x.h

@@ -238,7 +238,7 @@ extern "C"
    * \code
    * int8_t bme68x_set_conf(struct bme68x_conf *conf, struct bme68x_dev *dev);
    * \endcode
-   * @details This API is used to set the oversampling, filter and odr configuration
+   * @details This API is used to set the oversampling and filter configuration
    *
    * @param[in] conf    : Desired sensor configuration.
    * @param[in,out] dev : Structure instance of bme68x_dev.
@@ -255,8 +255,7 @@ extern "C"
    * \code
    * int8_t bme68x_get_conf(struct bme68x_conf *conf, struct bme68x_dev *dev);
    * \endcode
-   * @details This API is used to get the oversampling, filter and odr
-   * configuration
+   * @details This API is used to get the oversampling and filter configuration
    *
    * @param[out] conf   : Present sensor configuration.
    * @param[in,out] dev : Structure instance of bme68x_dev.

libs/bme68x/Inc/bme68x_defs.h

@@ -262,35 +262,6 @@
 /* Filter coefficient of 128 */
 #define BME68X_FILTER_SIZE_127 UINT8_C(7)
 
-/* ODR/Standby time macros */
-
-/* Standby time of 0.59ms */
-#define BME68X_ODR_0_59_MS UINT8_C(0)
-
-/* Standby time of 62.5ms */
-#define BME68X_ODR_62_5_MS UINT8_C(1)
-
-/* Standby time of 125ms */
-#define BME68X_ODR_125_MS UINT8_C(2)
-
-/* Standby time of 250ms */
-#define BME68X_ODR_250_MS UINT8_C(3)
-
-/* Standby time of 500ms */
-#define BME68X_ODR_500_MS UINT8_C(4)
-
-/* Standby time of 1s */
-#define BME68X_ODR_1000_MS UINT8_C(5)
-
-/* Standby time of 10ms */
-#define BME68X_ODR_10_MS UINT8_C(6)
-
-/* Standby time of 20ms */
-#define BME68X_ODR_20_MS UINT8_C(7)
-
-/* No standby time */
-#define BME68X_ODR_NONE UINT8_C(8)
-
 /* Operating mode macros */
 
 /* Sleep operation mode */
@@ -299,20 +270,6 @@
 /* Forced operation mode */
 #define BME68X_FORCED_MODE UINT8_C(1)
 
-/* Parallel operation mode */
-#define BME68X_PARALLEL_MODE UINT8_C(2)
-
-/* Sequential operation mode */
-#define BME68X_SEQUENTIAL_MODE UINT8_C(3)
-
-/* SPI page macros */
-
-/* SPI memory page 0 */
-#define BME68X_MEM_PAGE0 UINT8_C(0x10)
-
-/* SPI memory page 1 */
-#define BME68X_MEM_PAGE1 UINT8_C(0x00)
-
 /* Coefficient index macros */
 
 /* Length for all coefficients */
@@ -527,12 +484,6 @@
 /* Mask for IIR filter */
 #define BME68X_FILTER_MSK UINT8_C(0X1c)
 
-/* Mask for ODR[3] */
-#define BME68X_ODR3_MSK UINT8_C(0x80)
-
-/* Mask for ODR[2:0] */
-#define BME68X_ODR20_MSK UINT8_C(0xe0)
-
 /* Mask for temperature oversampling */
 #define BME68X_OST_MSK UINT8_C(0Xe0)
 
@@ -572,15 +523,6 @@
 /* Mask for heater stability */
 #define BME68X_HEAT_STAB_MSK UINT8_C(0x10)
 
-/* Mask for SPI memory page */
-#define BME68X_MEM_PAGE_MSK UINT8_C(0x10)
-
-/* Mask for reading a register in SPI */
-#define BME68X_SPI_RD_MSK UINT8_C(0x80)
-
-/* Mask for writing a register in SPI */
-#define BME68X_SPI_WR_MSK UINT8_C(0x7f)
-
 /* Mask for the H1 calibration coefficient */
 #define BME68X_BIT_H1_DATA_MSK UINT8_C(0x0f)
 
@@ -595,12 +537,6 @@
 /* Pressure oversampling bit position */
 #define BME68X_OSP_POS UINT8_C(2)
 
-/* ODR[3] bit position */
-#define BME68X_ODR3_POS UINT8_C(7)
-
-/* ODR[2:0] bit position */
-#define BME68X_ODR20_POS UINT8_C(5)
-
 /* Run gas bit position */
 #define BME68X_RUN_GAS_POS UINT8_C(4)
 
@@ -700,17 +636,6 @@ typedef void (*bme68x_delay_us_fptr_t)(uint32_t period, void *intf_ptr);
  * @param[in] len: Length of the data array
  */
 
-/*
- * @brief Interface selection Enumerations
- */
-enum bme68x_intf
-{
-  /*! SPI interface */
-  BME68X_SPI_INTF,
-  /*! I2C interface */
-  BME68X_I2C_INTF
-};
-
 /* Structure definitions */
 
 /*
@@ -859,7 +784,7 @@ struct bme68x_calib_data
 };
 
 /*
- * @brief BME68X sensor settings structure which comprises of ODR,
+ * @brief BME68X sensor settings structure which comprises of
  * over-sampling and filter settings.
  */
 struct bme68x_conf
@@ -875,12 +800,6 @@ struct bme68x_conf
 
   /*! Filter coefficient. Refer @ref filter*/
   uint8_t filter;
-
-  /*!
-   * Standby time between sequential mode measurement profiles.
-   * Refer @ref odr
-   */
-  uint8_t odr;
 };
 
 /*
@@ -905,12 +824,6 @@ struct bme68x_heatr_conf
 
   /*! Variable to store the length of the heating profile */
   uint8_t profile_len;
-
-  /*!
-   * Variable to store heating duration for parallel mode
-   * in milliseconds
-   */
-  uint16_t shared_heatr_dur;
 };
 
 /*
@@ -940,9 +853,6 @@ struct bme68x_dev
    */
   uint32_t variant_id;
 
-  /*! SPI/I2C interface */
-  enum bme68x_intf intf;
-
   /*! Memory page used */
   uint8_t mem_page;
 

libs/bme68x/Inc/bme68x_driver.h

@@ -68,7 +68,6 @@ typedef struct
   struct bme68x_heatr_conf heatr_conf;
 
   /** Structure to store sensor measurement data. */
-  /** @todo: May modify this to be an array in order to support parallel mode */
   /** @note: Since we're not using floating point, the data will be as follows:
    *  - Temperature in degrees celsius x100
    *  - Pressure in Pascal
@@ -77,16 +76,6 @@ typedef struct
    */
   struct bme68x_data sensor_data;
 
-  // /** Array to store multiple sensor data values (for parallel mode). */
-  // struct bme68x_data sensor_data[3];
-
-  /** @todo: Similar to a sensor_data array, n_fields and i_fields are for parallel mode support */
-  // /** Number of data fields in parallel mode. */
-  // uint8_t n_fields;
-
-  // /** Index for tracking sensor data fields. */
-  // uint8_t i_fields;
-
   /** Last operation mode used by the sensor. */
   uint8_t last_opmode;
 } bme68x_sensor_t;
@@ -146,22 +135,18 @@ void bme_set_TPH(bme68x_sensor_t *bme, uint8_t os_temp, uint8_t os_pres, uint8_t
  * @param[in] bme Pointer to bme68x sensor interface
  * @param[in] temp Heater temperature in degree Celsius
  * @param[in] dur Heating duration in milliseconds
- * @todo: Implement similar functions for sequential and parallel modes, as needed.
  */
 void bme_set_heaterprof(bme68x_sensor_t *bme, uint16_t temp, uint16_t dur);
 
 /**
  * @brief Set the operation mode
  *
- * Set the desired operation mode.
- * @todo: Initially, we will only support forced mode, which performs a single measurement
- * and allows for automatically returning to sleep mode. The gas sensor heater only operates
- * during measurement in this mode.
- * In parallel mode, multiple TPHG cycles are performed, the sensor does not return to sleep
- * mode automatically, and the gas sensor heater operates in parallel to TPH measurement.
+ * Set the desired operation mode. Currently supports sleep mode and forced mode for
+ * a single, low-power measurment which may automatically return to sleep mode.
+ * The gas sensor heater only operates during measurement in this mode.
  *
  * @param[in] bme Pointer to bme68x sensor interface
- * @param[in] opmode BME68X_SLEEP_MODE, BME68X_FORCED_MODE, BME68X_PARALLEL_MODE, BME68X_SEQUENTIAL_MODE
+ * @param[in] opmode BME68X_SLEEP_MODE, BME68X_FORCED_MODE
  */
 void bme_set_opmode(bme68x_sensor_t *bme, uint8_t opmode);
 
@@ -177,33 +162,12 @@ void bme_set_opmode(bme68x_sensor_t *bme, uint8_t opmode);
  */
 uint8_t bme_fetch_data(bme68x_sensor_t *bme);
 
-/**
- * @brief Get a single data field
- *
- * @todo: Implement as needed
- *
- * @param[in] bme Pointer to bme68x sensor interface
- * @param[out] data Structure where the data is to be stored
- * @return Number of new fields remaining
- */
-// uint8_t bme_get_data(bme68x_sensor_t *bme, bme68x_data &data);
-
-/**
- * @brief Function to get whole sensor data
- *
- * @todo: Implement as needed
- *
- * @param[in] bme Pointer to bme68x sensor interface
- * @return Sensor data
- */
-// bme68x_data *bme_get_alldata(bme68x_sensor_t *bme);
-
 /**
  * @brief Get the measurement duration in microseconds
  *
  * Calls bme68x_get_meas_dur, which calculates the total measurement duration
  * based on the total number of samples to be taken, as determined by the oversampling
- * for each value; if not operating in parallel mode, a wake-up duration of 1ms is added.
+ * for each value; a wake-up duration of 1ms is added.
  *
  * @param[in] bme Pointer to bme68x sensor interface
  * @param[in] opmode Operation mode of the sensor. Attempts to use the last one if nothing is set
@@ -269,14 +233,16 @@ int8_t bme_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t length, void *intf
  *     while (1)
  *     {
  *         bme_set_opmode(&bme, BME68X_FORCED_MODE);
+ *         // @todo: May adjust the specific timing function called here, but it should be based on bme_get_meas_dur
+ *         bme_delay_us(bme_get_meas_dur(&bme, BME68X_SLEEP_MODE), &hi2c1);
  *         int fetch_success = bme_fetch_data(&bme);
  *         if (fetch_success) {
-             debug_print("%d, ", bme.sensor_data.temperature);
-             debug_print("%d, ", bme.sensor_data.pressure);
-             debug_print("%d, ", bme.sensor_data.humidity);
-             debug_print("%d, ", bme.sensor_data.gas_resistance);
-             debug_print("%X, \r\n", bme.sensor_data.status);
-           }
+ *           debug_print("%d, ", bme.sensor_data.temperature);
+ *           debug_print("%d, ", bme.sensor_data.pressure);
+ *           debug_print("%d, ", bme.sensor_data.humidity);
+ *           debug_print("%d, ", bme.sensor_data.gas_resistance);
+ *           debug_print("%X, \r\n", bme.sensor_data.status);
+ *         }
  *     }
  * }
  * @endcode