sfDevBMV080.h

Go to the documentation of this file.

 
#pragma once
 
#if __has_include("bmv080.h")
#include "bmv080.h"
#include "bmv080_defs.h"
#else
#error                                                                                                                 \
    "BOSCH BMV080 SDK Must be installed.  See instructions at www.github.com/sparkfun/SparkFun_BMV080_Arduino_Library - ERROR: bmv080.h not found"
 
#endif
 
// Include the platform independent layer of the SparkFun Toolkit
#include <sfTk/sfTkIBus.h>
#include <sfTk/sfToolkit.h>
#include <stdint.h>
 
#define SF_BMV080_DEFAULT_ADDRESS 0x57
#define SF_BMV080_DEFAULT_IRQ_PIN 14
 
#define SF_BMV080_MODE_CONTINUOUS 0
#define SF_BMV080_MODE_DUTY_CYCLE 1
 
class sfDevBMV080
{
  public:
    sfDevBMV080() : _theBus{nullptr}
    {
    }
 
    sfTkError_t begin(sfTkIBus *theBus = nullptr);
 
    bool init(void);
 
    bool driverVersion(uint16_t &major, uint16_t &minor, uint16_t &patch);
 
    bool open(void);
 
    bool close(void);
 
    bool reset(void);
 
    static const size_t kBMV800IDLength = 13;
    bool ID(char idOut[kBMV800IDLength]);
 
    bool setMode(uint8_t mode);
 
    float PM10(void);
 
    float PM25(void);
 
    float PM1(void);
 
    bool isObstructed();
 
    void setSensorValue(bmv080_output_t bmv080_output);
 
    bool readSensor(bmv080_output_t *bmv080_output = nullptr);
 
    uint16_t dutyCyclingPeriod();
 
    bool setDutyCyclingPeriod(uint16_t duty_cycling_period);
 
    float volumetricMassDensity();
 
    bool setVolumetricMassDensity(float volumetric_mass_density);
 
    float integrationTime();
 
    bool setIntegrationTime(float integration_time);
 
    uint32_t distributionId();
 
    bool setDistributionId(uint32_t distribution_id);
 
    bool doObstructionDetection();
 
    bool setDoObstructionDetection(bool do_obstruction_detection);
 
    bool doVibrationFiltering();
 
    bool setDoVibrationFiltering(bool do_vibration_filtering);
 
    uint8_t measurementAlgorithm();
 
    bool setMeasurementAlgorithm(uint8_t measurement_algorithm);
 
  private:
    // bosch bmv080 library callback functions (static methods to be used as callbacks)
    static int8_t device_read_16bit_CB(bmv080_sercom_handle_t, uint16_t, uint16_t *, uint16_t);
 
    static int8_t device_write_16bit_CB(bmv080_sercom_handle_t, uint16_t, const uint16_t *, uint16_t);
 
    static int8_t device_delay_CB(uint32_t);
 
    static void set_sensor_value(bmv080_output_t, void *);
 
    bool sensorServiceRoutine(void);
 
    // BMV080 sensor handle - used when referencing the sensor using the Bosch API
    bmv080_handle_t _bmv080_handle_class = NULL;
 
    // Internal flag to track if new sensor data is available
    bool _dataAvailable = false;
 
    // Internal cache for the latest sensor values
    bmv080_output_t _sensorValue;
 
  protected:
    // Pointer to the SparkFun Toolkit bus interface used for communication
    sfTkIBus *_theBus;
};