BASIS 2 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Namespace List
Here is a list of all documented namespaces with brief descriptions:
[detail level 123]
 ▼Nalicat_basis2The ALICAT_BASIS2 driver: everything it declares lives here; internals in detail
 ▼NasciiThe ASCII grammar: table, encoder, validator, decoders
 CArgsThe arguments of a request before encoding
 CCommandSpecOne row of the command table (rows C01 to C46)
 CFrameRulesThe rules a decoded frame is checked against
 CTokenOne token: where it starts and how long it is
 CTokensThe tokens of a line
 CValuesThe numbers of a short reply: ID v1 [v2 ...]
 NgasThe nine gases of M p.15
 ▼NmodbusThe Modbus RTU codec
 CResponseA parsed Modbus response
 ▼NregThe ALICAT_BASIS2 Modbus register map
 CRegisterSpecOne row of the register table: the only registers the driver touches
 CAddressScanThe Modbus addresses that answered a scan: bit n of byte n/8 is address n
 CAveragesResult of ReadAverages(): the current or most recent measurement window
 CBasis2Driver for one instrument on a Bus
 CBusThe transaction machine of one serial line, shared by every instrument on it
 CConfigThe 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
 CConfirmAbandonProtocol2Confirms SwitchToProtocol1(): the instrument leaves the protocol this driver speaks
 CConfirmAddressChangeConfirms SetModbusAddress(): the Modbus address changes at once
 CConfirmBaudChangeConfirms ChangeBaud(): the reply arrives at the new speed and the port must follow
 CConfirmFactoryRestoreConfirms FactoryRestore(): unit ID, baud rate, Modbus address and protocol revert; power cycle
 CConfirmReturnToProtocol2Guard token of SwitchToProtocol2
 CConfirmUnitIdChangeConfirms ChangeUnitId(): the instrument answers to the new ID afterwards; connect one instrument only
 CDecimalAn exact decimal number as the instrument printed it: +0021513.0 is {215130, 1}
 CFrameOne data frame (A) or a DV selection; present says which fields were read
 CFullScaleOne reading of FPF: a value and its unit text
 CGainsClosed-loop gains (LCG, Modbus 519 and 520)
 CGasEntryOne entry of the gas table of firmware 3.0.5 (Modbus 81 to 140, M p.26 to 27)
 CGasIdA gas number. Not a closed enumeration: the V3.0.5 gas table allows numbers up to 255 (A5)
 CGasListResult of ReadGasList(): the parsed pairs, or the raw text when the grammar did not match (A5)
 CGasTableThe whole gas table: twelve entries
 CIdentityWhat Begin() learned: read-only knowledge of the instrument
 CPreviousMeasurementResult of ReadPreviousMeasurement() (Modbus only, registers 4210 to 4215)
 CRampResult of ReadRamp(): rate and time unit as the instrument reported them
 CRangesResult of ReadRanges()
 CReplyA reply as received: one ASCII line without its CR, or one Modbus frame (raw bytes as chars)
 CRequestOne validated request. Only the factories of the grammar headers make one that can be sent
 CResultThe value of a call, or why there is none
 CResult< void >The result of a call that returns no value
 CStatusFlagsStatus flags of a data frame or of Modbus register 2101 (M p.10, p.21)
 CTextA short text value (serial number, firmware, unit label), NUL terminated
 CTimingWhat the bus needs to know about the instrument it talks to, per transaction
 CUartInterfaceCRTP base of the platform serial port
 CUnitIdScanThe unit IDs that answered a scan: bit 0 is A
 RUartPortSatisfied by a class that derives from UartInterface<Port> and implements the five required hooks with exactly the types above, noexcept