|
BASIS 2 Driver 0.1.0
API 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. | |
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. | |
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.