|
BASIS 2 Driver 0.1.0
API reference
|
| ▼Nalicat_basis2 | The ALICAT_BASIS2 driver: everything it declares lives here; internals in detail |
| ▼Nascii | The ASCII grammar: table, encoder, validator, decoders |
| CArgs | The arguments of a request before encoding |
| CCommandSpec | One row of the command table (rows C01 to C46) |
| CFrameRules | The rules a decoded frame is checked against |
| CToken | One token: where it starts and how long it is |
| CTokens | The tokens of a line |
| CValues | The numbers of a short reply: ID v1 [v2 ...] |
| Ngas | The nine gases of M p.15 |
| ▼Nmodbus | The Modbus RTU codec |
| CResponse | A parsed Modbus response |
| ▼Nreg | The ALICAT_BASIS2 Modbus register map |
| CRegisterSpec | One row of the register table: the only registers the driver touches |
| CAddressScan | The Modbus addresses that answered a scan: bit n of byte n/8 is address n |
| CAverages | Result of ReadAverages(): the current or most recent measurement window |
| CBasis2 | Driver for one instrument on a Bus |
| CBus | The transaction machine of one serial line, shared by every instrument on it |
| CConfig | 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 |
| CConfirmAbandonProtocol2 | Confirms SwitchToProtocol1(): the instrument leaves the protocol this driver speaks |
| CConfirmAddressChange | Confirms SetModbusAddress(): the Modbus address changes at once |
| CConfirmBaudChange | Confirms ChangeBaud(): the reply arrives at the new speed and the port must follow |
| CConfirmFactoryRestore | Confirms FactoryRestore(): unit ID, baud rate, Modbus address and protocol revert; power cycle |
| CConfirmReturnToProtocol2 | Guard token of SwitchToProtocol2 |
| CConfirmUnitIdChange | Confirms ChangeUnitId(): the instrument answers to the new ID afterwards; connect one instrument only |
| CDecimal | An exact decimal number as the instrument printed it: +0021513.0 is {215130, 1} |
| CFrame | One data frame (A) or a DV selection; present says which fields were read |
| CFullScale | One reading of FPF: a value and its unit text |
| CGains | Closed-loop gains (LCG, Modbus 519 and 520) |
| CGasEntry | One entry of the gas table of firmware 3.0.5 (Modbus 81 to 140, M p.26 to 27) |
| CGasId | A gas number. Not a closed enumeration: the V3.0.5 gas table allows numbers up to 255 (A5) |
| CGasList | Result of ReadGasList(): the parsed pairs, or the raw text when the grammar did not match (A5) |
| CGasTable | The whole gas table: twelve entries |
| CIdentity | What Begin() learned: read-only knowledge of the instrument |
| CPreviousMeasurement | Result of ReadPreviousMeasurement() (Modbus only, registers 4210 to 4215) |
| CRamp | Result of ReadRamp(): rate and time unit as the instrument reported them |
| CRanges | Result of ReadRanges() |
| CReply | A reply as received: one ASCII line without its CR, or one Modbus frame (raw bytes as chars) |
| CRequest | One validated request. Only the factories of the grammar headers make one that can be sent |
| CResult | The value of a call, or why there is none |
| CResult< void > | The result of a call that returns no value |
| CStatusFlags | Status flags of a data frame or of Modbus register 2101 (M p.10, p.21) |
| CText | A short text value (serial number, firmware, unit label), NUL terminated |
| CTiming | What the bus needs to know about the instrument it talks to, per transaction |
| CUartInterface | CRTP base of the platform serial port |
| CUnitIdScan | The unit IDs that answered a scan: bit 0 is A |
| RUartPort | Satisfied by a class that derives from UartInterface<Port> and implements the five required hooks with exactly the types above, noexcept |