BASIS 2 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Enumerations | Variables
alicat_basis2::reg Namespace Reference

The ALICAT_BASIS2 Modbus register map. More...

Classes

struct  RegisterSpec
 One row of the register table: the only registers the driver touches. More...
 

Enumerations

enum class  Access : uint8_t { Access::Read = 1 , Access::Write = 2 , Access::ReadWrite = 3 }
 How a register may be accessed. More...
 

Functions

constexpr FlowUnit FlowUnitFromCode (uint16_t code) noexcept
 The flow unit of a Modbus code or label.
 

Variables

constexpr uint16_t kBaud = 21
 R/W baud code 0 to 5 (M p.25).
 
constexpr uint16_t kFirmware = 25
 R firmware, 256a + 16b + c.
 
constexpr uint16_t kSerial = 26
 R six registers, two characters each (26 to 31).
 
constexpr uint16_t kSensorOffset
 R flow sensor offset (ADC integer defined as zero).
 
constexpr uint16_t kFullScaleSccm = 35
 R two registers, full scale in SCCM.
 
constexpr uint16_t kTare = 39
 W 0xAA55 tares.
 
constexpr uint16_t kModbusAddress = 45
 R/W 1 to 247.
 
constexpr uint16_t kUnitId = 46
 R/W ASCII 65 to 90.
 
constexpr uint16_t kFullScale = 47
 R two registers, full scale in flow units x 1000.
 
constexpr uint16_t kFlowUnit = 49
 R flow unit code.
 
constexpr uint16_t kTareSamples = 51
 R/W 1 to 65535, about 2.5 ms each.
 
constexpr uint16_t kRefTemperature = 52
 R/W 0 to 3000, C x 100.
 
constexpr uint16_t kTotalReset = 53
 W 0xAA55 resets the total volume.
 
constexpr uint16_t kTotalLimit = 54
 R/W 0 to 3.
 
constexpr uint16_t kAveraging = 55
 R/W 0 to 2500 ms.
 
constexpr uint16_t kProtocol = 56
 R/W 0 BASIS 2, 1 BASIS 1.
 
constexpr uint16_t kFactoryRestore = 80
 W 0x5214.
 
constexpr uint16_t kGasTable = 81
 R 60 registers: twelve entries of five.
 
constexpr uint16_t kWatchdog = 514
 R/W 0 to 5000 ms.
 
constexpr uint16_t kAutotare = 515
 R/W 0 or 1.
 
constexpr uint16_t kSetpointType = 516
 R/W 0 analog, 1 saved, 2 unsaved.
 
constexpr uint16_t kGainP = 519
 R/W 0 to 65535.
 
constexpr uint16_t kGainI = 520
 R/W 0 to 65535.
 
constexpr uint16_t kBatch = 521
 R/W two registers.
 
constexpr uint16_t kRamp = 524
 R/W two registers, % of FS per ms x 10^7.
 
constexpr uint16_t kSetpoint = 2053
 R/W two registers, signed, /1000.
 
constexpr uint16_t kGas = 2100
 R/W gas number; start of the instantaneous block.
 
constexpr uint16_t kStatus = 2101
 R status bits.
 
constexpr uint16_t kTemperature = 2102
 R signed, /100.
 
constexpr uint16_t kFlow = 2103
 R signed, scaled by the factory decimals.
 
constexpr uint16_t kTotal = 2104
 R two registers, unsigned.
 
constexpr uint16_t kSetpointRead = 2106
 R current setpoint.
 
constexpr uint16_t kValveDrive = 2107
 R /100.
 
constexpr uint16_t kBatchRemaining = 2108
 R two registers, unsigned.
 
constexpr uint16_t kTrigger = 4200
 R/W trigger bits 0 to 7.
 
constexpr uint16_t kSamples = 4201
 R/W samples in a measurement; a write starts it.
 
constexpr uint16_t kMeasureBlock
 R 4202 to 4209: min/max/avg of the current window.
 
constexpr uint16_t kPreviousBlock = 4210
 R 4210 to 4215: the previous window.
 
constexpr uint16_t kPreviousAvgFlow
 R signed 32-bit, 4214 high word first (A25); reading 4214 may trigger (A17).
 
constexpr uint16_t kMagicAction = 0xAA55
 Tare and total reset value.
 
constexpr uint16_t kMagicRestore = 0x5214
 Factory restore value.
 
constexpr uint16_t kMaxRead = 60
 Largest register count of one read the driver issues.
 
constexpr uint32_t kSampleTenthMs = 25
 Milliseconds per measurement or tare sample, times ten (about 2.5 ms, M p.22, p.26).
 
constexpr uint16_t kFw210 = 0x210
 Firmware gates, 256a + 16b + c (M pp.21 to 27).
 
constexpr uint16_t kFw222 = 0x222
 2.2.2: baud 57600 and 115200.
 
constexpr uint16_t kFw240 = 0x240
 2.4.0: regs 45 to 48, 51, 52, 519, 520.
 
constexpr uint16_t kFw255 = 0x255
 2.5.5: register 53.
 
constexpr uint16_t kFw300
 3.0.0: block 2100 to 2109, 4200 to 4215, 54 to 56, 521, 524.
 
constexpr uint16_t kFw305 = 0x305
 3.0.5: gas table and GS *.
 
constexpr uint32_t kNoMagic = 0xFFFF'FFFFU
 Marker for "no magic value".
 
constexpr std::size_t kRegisterRows = 39
 Number of rows of kRegisters.
 
constexpr std::array< RegisterSpec, kRegisterRows > kRegisters
 The register table (M pp.18 to 27). Reads may span consecutive rows; writes must match one row.
 
constexpr std::array< const char *, 20 > kFlowUnitLabels
 Flow unit labels in the order of register 49 (M p.26, p.31).
 

Detailed Description

The ALICAT_BASIS2 Modbus register map.