|
SFM_FLOW_METER Driver 0.1.0
API reference
|
SFM flow meter driver: the one header to include. More...
#include <array>#include <cstddef>#include <cstdint>#include <span>#include "sfm_flow_meter_detail.hpp"#include "sfm_flow_meter_i2c_interface.hpp"#include "sfm_flow_meter_parts.hpp"#include "sfm_flow_meter_protocols.hpp"#include "sfm_flow_meter_registers.hpp"#include "sfm_flow_meter_types.hpp"#include "sfm_flow_meter_version.h"#include "../src/sfm_flow_meter.ipp"Go to the source code of this file.
Classes | |
| class | sfm::SfmFlowMeter< Port, FamilyMask > |
| The driver. More... | |
Namespaces | |
| namespace | sfm |
The SFM flow meter driver: everything it declares lives here; internals in detail. | |
SFM flow meter driver: the one header to include.
sfm::SfmFlowMeter<Port> drives one Sensirion SFM mass flow meter (SFM3000 to SFM6000D) through a platform port you write (see sfm_flow_meter_i2c_interface.hpp). The driver has no platform code, allocates nothing, throws nothing, takes no lock and is not thread-safe: give each object one owner, or guard it with one mutex.
Every operation is a bounded plan of bus steps. A plan that has to wait (a reset, a first sample, a wake) returns the wait to you as Result<Wait>; delay that long and call Poll(). With a DelayUs hook, AwaitPending() does that for you. ReadSample() and ReadTemperature() never wait.