SFM_FLOW_METER Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Variables
sfm::feature Namespace Reference

Feature bits of a part (PartInfo::features); a clear bit makes the call Unsupported. More...

Variables

constexpr uint32_t kScaleRead = 1U << 0
 ReadScaling().
 
constexpr uint32_t kAveraging = 1U << 1
 SetAveraging().
 
constexpr uint32_t kAveragingZero = 1U << 2
 N = 0 (average until read) is legal.
 
constexpr uint32_t kConcentration = 1U << 3
 UpdateConcentration().
 
constexpr uint32_t kSleep = 1U << 4
 Sleep() and WakeUp().
 
constexpr uint32_t kStatusWord = 1U << 5
 The frame carries a status word.
 
constexpr uint32_t kTemperatureFrame = 1U << 6
 The frame carries the temperature.
 
constexpr uint32_t kTemperatureRead
 ReadTemperature() by a pointer sequence.
 
constexpr uint32_t kGeneralCallReset = 1U << 8
 SoftReset() is the general call.
 
constexpr uint32_t kSoftResetCommand
 SoftReset() is a command to the device.
 
constexpr uint32_t kResetPin = 1U << 10
 HardReset() pulses /RES (SFM4200).
 
constexpr uint32_t kClockStretch = 1U << 11
 Reads need ReadStretch() (SFM4100).
 
constexpr uint32_t kFilterArg = 1U << 12
 The start command takes a filter argument.
 
constexpr uint32_t kFirstByteAck = 1U << 13
 SF05: the first data byte must be ACKed.
 
constexpr uint32_t kTwoFlows = 1U << 14
 The frame carries two flows (SFM3505).
 
constexpr uint32_t kRestartBeforeRead = 1U << 15
 SF05: start again around each read.
 
constexpr uint32_t kPowerCycle
 HardReset() is a supply cycle (needs a hook).
 
constexpr uint32_t kWakeByte = 1U << 17
 Wake is address plus one dummy byte.
 
constexpr uint32_t kIrqPin = 1U << 18
 The module has an IRQn or DRDY output.
 

Detailed Description

Feature bits of a part (PartInfo::features); a clear bit makes the call Unsupported.

Variable Documentation

◆ kPowerCycle

constexpr uint32_t sfm::feature::kPowerCycle
inlineconstexpr
Initial value:
= 1U
<< 16

HardReset() is a supply cycle (needs a hook).

◆ kSoftResetCommand

constexpr uint32_t sfm::feature::kSoftResetCommand
inlineconstexpr
Initial value:
= 1U
<< 9

SoftReset() is a command to the device.

◆ kTemperatureRead

constexpr uint32_t sfm::feature::kTemperatureRead
inlineconstexpr
Initial value:
= 1U
<< 7

ReadTemperature() by a pointer sequence.