BASIS 2 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces | Enumerations | Functions | Variables
alicat_basis2_types.hpp File Reference

Public types of the ALICAT_BASIS2 driver: errors, Result<T>, configuration, enumerations and the values an instrument reports. More...

#include <array>
#include <cstddef>
#include <cstdint>
#include "alicat_basis2_detail.hpp"
#include "alicat_basis2_version.h"

Go to the source code of this file.

Classes

struct  alicat_basis2::Result< T >
 The value of a call, or why there is none. More...
 
struct  alicat_basis2::Result< void >
 The result of a call that returns no value. More...
 
struct  alicat_basis2::Config
 The driver's configuration. Every default is the instrument's factory value or a documented driver choice; fields that exist because the manual is silent are described in docs/configuration.md. More...
 
struct  alicat_basis2::Decimal
 An exact decimal number as the instrument printed it: +0021513.0 is {215130, 1}. More...
 
struct  alicat_basis2::GasId
 A gas number. Not a closed enumeration: the V3.0.5 gas table allows numbers up to 255 (A5). More...
 
struct  alicat_basis2::StatusFlags
 Status flags of a data frame or of Modbus register 2101 (M p.10, p.21). More...
 
struct  alicat_basis2::Frame
 One data frame (A) or a DV selection; present says which fields were read. More...
 
struct  alicat_basis2::Text
 A short text value (serial number, firmware, unit label), NUL terminated. More...
 
struct  alicat_basis2::Ramp
 Result of ReadRamp(): rate and time unit as the instrument reported them. More...
 
struct  alicat_basis2::Gains
 Closed-loop gains (LCG, Modbus 519 and 520). More...
 
struct  alicat_basis2::Averages
 Result of ReadAverages(): the current or most recent measurement window. More...
 
struct  alicat_basis2::Ranges
 Result of ReadRanges(). More...
 
struct  alicat_basis2::PreviousMeasurement
 Result of ReadPreviousMeasurement() (Modbus only, registers 4210 to 4215). More...
 
struct  alicat_basis2::FullScale
 One reading of FPF: a value and its unit text. More...
 
struct  alicat_basis2::GasEntry
 One entry of the gas table of firmware 3.0.5 (Modbus 81 to 140, M p.26 to 27). More...
 
struct  alicat_basis2::GasTable
 The whole gas table: twelve entries. More...
 
struct  alicat_basis2::GasList
 Result of ReadGasList(): the parsed pairs, or the raw text when the grammar did not match (A5). More...
 
struct  alicat_basis2::Identity
 What Begin() learned: read-only knowledge of the instrument. More...
 

Namespaces

namespace  alicat_basis2
 The ALICAT_BASIS2 driver: everything it declares lives here; internals in detail.
 
namespace  alicat_basis2::gas
 The nine gases of M p.15.
 

Enumerations

enum class  alicat_basis2::Error : uint8_t {
  alicat_basis2::Error::Ok = 0 , alicat_basis2::Error::NotInitialized , alicat_basis2::Error::InvalidArgument = 2 , alicat_basis2::Error::Bus = 3 ,
  alicat_basis2::Error::Timeout = 4 , alicat_basis2::Error::DeviceIdMismatch , alicat_basis2::Error::Crc = 6 , alicat_basis2::Error::Busy ,
  alicat_basis2::Error::DeviceFault = 8 , alicat_basis2::Error::Unsupported , alicat_basis2::Error::BadReply = 16 , alicat_basis2::Error::Rejected = 17 ,
  alicat_basis2::Error::OutOfRange = 18 , alicat_basis2::Error::Overflow = 19 , alicat_basis2::Error::VerifyMismatch = 20 , alicat_basis2::Error::FirmwareTooOld = 21 ,
  alicat_basis2::Error::StateUnknown , alicat_basis2::Error::RateLimited , alicat_basis2::Error::GuardNotConfirmed = 24
}
 Why a call failed. Every call of the driver returns one of these in its Result. More...
 
enum class  alicat_basis2::LogLevel : uint8_t { alicat_basis2::LogLevel::Error = 0 , alicat_basis2::LogLevel::Warning , alicat_basis2::LogLevel::Info , alicat_basis2::LogLevel::Debug }
 Severity passed to the optional Log() hook. More...
 
enum class  alicat_basis2::Protocol : uint8_t { alicat_basis2::Protocol::Ascii = 0 , alicat_basis2::Protocol::ModbusRtu = 1 }
 The command protocol one Basis2 object speaks. More...
 
enum class  alicat_basis2::DeviceKind : uint8_t { alicat_basis2::DeviceKind::Auto = 0 , alicat_basis2::DeviceKind::Meter = 1 , alicat_basis2::DeviceKind::Controller = 2 }
 Whether the instrument is a meter (B series) or a controller (BC series). More...
 
enum class  alicat_basis2::FrameLayout : uint8_t { alicat_basis2::FrameLayout::Auto = 0 , alicat_basis2::FrameLayout::Meter = 1 , alicat_basis2::FrameLayout::Controller = 2 }
 Which data frame layout is accepted (assumption A2: a meter's frame is not shown in the manual). More...
 
enum class  alicat_basis2::UnknownFlagPolicy : uint8_t { alicat_basis2::UnknownFlagPolicy::Report = 0 , alicat_basis2::UnknownFlagPolicy::Reject = 1 }
 What happens with a flag token the manual does not list. More...
 
enum class  alicat_basis2::EchoMode : uint8_t { alicat_basis2::EchoMode::None = 0 , alicat_basis2::EchoMode::Skip = 1 }
 Whether a half-duplex wiring that hears its own transmission is handled. More...
 
enum class  alicat_basis2::VerifyPolicy : uint8_t { alicat_basis2::VerifyPolicy::Off = 0 , alicat_basis2::VerifyPolicy::WhenNoRamp }
 Whether a setpoint is read back after it was set. More...
 
enum class  alicat_basis2::FirmwareGate : uint8_t { alicat_basis2::FirmwareGate::Enforce , alicat_basis2::FirmwareGate::Ignore = 1 }
 Whether the firmware gates of the register and command tables are enforced. More...
 
enum class  alicat_basis2::SetpointSource : uint8_t { alicat_basis2::SetpointSource::Analog = 0 , alicat_basis2::SetpointSource::SavedDigital , alicat_basis2::SetpointSource::UnsavedDigital = 2 }
 Setpoint source (LSS, Modbus 516; M p.11 to 12 and p.19). More...
 
enum class  alicat_basis2::TimeUnit : uint8_t { alicat_basis2::TimeUnit::Millisecond = 3 , alicat_basis2::TimeUnit::Second = 4 , alicat_basis2::TimeUnit::Minute = 5 }
 Time unit of the ramp command (SR r t, M p.12). More...
 
enum class  alicat_basis2::TotalizerLimit : uint8_t { alicat_basis2::TotalizerLimit::HoldNoError = 0 , alicat_basis2::TotalizerLimit::ResetNoError = 1 , alicat_basis2::TotalizerLimit::HoldWithError = 2 , alicat_basis2::TotalizerLimit::ResetWithError = 3 }
 Totalizer limit behaviour (TC, Modbus 54; M p.16). More...
 
enum class  alicat_basis2::FullScaleItem : uint8_t { alicat_basis2::FullScaleItem::Flow = 0 , alicat_basis2::FullScaleItem::TotalVolume = 1 , alicat_basis2::FullScaleItem::MaxTemperature = 2 }
 The item read by FPF (M p.16). More...
 
enum class  alicat_basis2::DataItem : uint8_t {
  alicat_basis2::DataItem::Flow = 1 , alicat_basis2::DataItem::Setpoint = 2 , alicat_basis2::DataItem::Temperature = 4 , alicat_basis2::DataItem::ValveDrive = 8 ,
  alicat_basis2::DataItem::Gas = 16 , alicat_basis2::DataItem::TotalVolume = 32 , alicat_basis2::DataItem::BatchRemaining = 64 , alicat_basis2::DataItem::Status = 128
}
 Items of DV (a bit mask, M p.11). More...
 
enum class  alicat_basis2::TriggerMode : uint8_t { alicat_basis2::TriggerMode::OnSetpointChange = 1 , alicat_basis2::TriggerMode::OnHoldChange = 2 , alicat_basis2::TriggerMode::OnAverageRead = 4 }
 Measurement trigger bits (MT, Modbus 4200; M p.13 to 14). More...
 
enum class  alicat_basis2::Baud : uint8_t {
  alicat_basis2::Baud::B4800 = 0 , alicat_basis2::Baud::B9600 = 1 , alicat_basis2::Baud::B19200 = 2 , alicat_basis2::Baud::B38400 = 3 ,
  alicat_basis2::Baud::B57600 = 4 , alicat_basis2::Baud::B115200 = 5
}
 Serial speeds the instrument offers (NCB, Modbus 21; M p.17, p.25). More...
 
enum class  alicat_basis2::CommandProtocol : uint8_t { alicat_basis2::CommandProtocol::BasisProtocol2 = 0 , alicat_basis2::CommandProtocol::BasisProtocol1 = 1 }
 Command protocol selector (P, Modbus 56). More...
 
enum class  alicat_basis2::FlowUnit : uint8_t {
  Sccm = 0 , Nccm = 1 , Slpm = 2 , Nlpm = 3 ,
  SmLs = 4 , NmLs = 5 , SmLm = 6 , NmLm = 7 ,
  SLh = 8 , NLh = 9 , Sccs = 10 , Nccs = 11 ,
  Sm3h = 12 , Nm3h = 13 , Sm3d = 14 , Nm3d = 15 ,
  Scim = 16 , Scfm = 17 , Scfh = 18 , Scfd = 19 ,
  alicat_basis2::FlowUnit::Other = 20
}
 Flow units (Modbus register 49, M p.26; M p.31). More...
 

Functions

constexpr const char * alicat_basis2::ToString (Error error) noexcept
 The name of an error, for logs.
 
constexpr uint32_t alicat_basis2::GetDriverVersionMajor () noexcept
 Major version of the driver, from the generated alicat_basis2_version.h.
 
constexpr uint32_t alicat_basis2::GetDriverVersionMinor () noexcept
 Minor version of the driver.
 
constexpr uint32_t alicat_basis2::GetDriverVersionPatch () noexcept
 Patch version of the driver.
 
constexpr const char * alicat_basis2::GetDriverVersion () noexcept
 The version as text, such as "0.1.0".
 
constexpr Error alicat_basis2::Validate (const Config &c) noexcept
 Check a configuration against the documented ranges.
 
constexpr const char * alicat_basis2::GasName (uint8_t number) noexcept
 The name of a gas of the nine of M p.15.
 
constexpr uint8_t alicat_basis2::operator| (DataItem a, DataItem b) noexcept
 Union of DataItem bits.
 
constexpr uint8_t alicat_basis2::operator| (uint8_t a, DataItem b) noexcept
 Union of a mask and an item.
 
constexpr StatusFlags alicat_basis2::StatusFromBits (uint32_t bits) noexcept
 Decode status bits (Modbus register 2101 or an integer DV status): +1 MOV, +2 TOV, +4 OVR, +8 HLD, +16 VTM.
 

Variables

constexpr uint8_t alicat_basis2::kDecimalsUnset = 0xFF
 "Not set" marker of Config::modbus_flow_decimals: Begin() fails in Modbus mode while it is.
 
constexpr std::size_t alicat_basis2::kMaxLine = 256
 Largest line or frame the driver buffers: the gas list (GS *) reply can be this long.
 
constexpr GasId alicat_basis2::gas::kAir {0}
 Clean dry air.
 
constexpr GasId alicat_basis2::gas::kArgon {1}
 Ar.
 
constexpr GasId alicat_basis2::gas::kCarbonDioxide {2}
 CO2.
 
constexpr GasId alicat_basis2::gas::kNitrogen {3}
 N2.
 
constexpr GasId alicat_basis2::gas::kOxygen {4}
 O2.
 
constexpr GasId alicat_basis2::gas::kNitrousOxide {5}
 N2O.
 
constexpr GasId alicat_basis2::gas::kHydrogen {6}
 H2.
 
constexpr GasId alicat_basis2::gas::kHelium {7}
 He.
 
constexpr GasId alicat_basis2::gas::kMethane {8}
 CH4.
 
constexpr std::size_t alicat_basis2::kTextMax = 24
 Maximum characters kept of a text reply.
 
constexpr uint8_t alicat_basis2::kFlagCount = 5
 Position of the unit ID in a StatusFlags text: helper used by tests.
 

Detailed Description

Public types of the ALICAT_BASIS2 driver: errors, Result<T>, configuration, enumerations and the values an instrument reports.

Everything here is plain data with no platform dependency. "M p.N" cites the printed page of the operating manual DOC-MANUAL-BASIS2 Rev 4 (see docs/datasheets.yml). Quantities are Decimal: the exact text the instrument printed, never rounded by the driver.