BASIS 2 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
alicat_basis2_registers.hpp
Go to the documentation of this file.
1
11#ifndef ALICAT_BASIS2_REGISTERS_HPP
12#define ALICAT_BASIS2_REGISTERS_HPP
13
14#include <array>
15#include <cstddef>
16#include <cstdint>
17
20
23
30inline constexpr uint16_t kBaud = 21;
31inline constexpr uint16_t kFirmware = 25;
32inline constexpr uint16_t kSerial = 26;
33inline constexpr uint16_t kSensorOffset =
34 32;
35inline constexpr uint16_t kFullScaleSccm = 35;
36inline constexpr uint16_t kTare = 39;
37inline constexpr uint16_t kModbusAddress = 45;
38inline constexpr uint16_t kUnitId = 46;
39inline constexpr uint16_t kFullScale = 47;
40inline constexpr uint16_t kFlowUnit = 49;
41inline constexpr uint16_t kTareSamples = 51;
42inline constexpr uint16_t kRefTemperature = 52;
43inline constexpr uint16_t kTotalReset = 53;
44inline constexpr uint16_t kTotalLimit = 54;
45inline constexpr uint16_t kAveraging = 55;
46inline constexpr uint16_t kProtocol = 56;
47inline constexpr uint16_t kFactoryRestore = 80;
48inline constexpr uint16_t kGasTable = 81;
49inline constexpr uint16_t kWatchdog = 514;
50inline constexpr uint16_t kAutotare = 515;
51inline constexpr uint16_t kSetpointType = 516;
52inline constexpr uint16_t kGainP = 519;
53inline constexpr uint16_t kGainI = 520;
54inline constexpr uint16_t kBatch = 521;
55inline constexpr uint16_t kRamp = 524;
56inline constexpr uint16_t kSetpoint = 2053;
57inline constexpr uint16_t kGas = 2100;
58inline constexpr uint16_t kStatus = 2101;
59inline constexpr uint16_t kTemperature = 2102;
60inline constexpr uint16_t kFlow = 2103;
61inline constexpr uint16_t kTotal = 2104;
62inline constexpr uint16_t kSetpointRead = 2106;
63inline constexpr uint16_t kValveDrive = 2107;
64inline constexpr uint16_t kBatchRemaining = 2108;
65inline constexpr uint16_t kTrigger = 4200;
66inline constexpr uint16_t kSamples = 4201;
67inline constexpr uint16_t kMeasureBlock =
68 4202;
69inline constexpr uint16_t kPreviousBlock = 4210;
70inline constexpr uint16_t kPreviousAvgFlow =
71 4214;
72
73inline constexpr uint16_t kMagicAction = 0xAA55;
74inline constexpr uint16_t kMagicRestore = 0x5214;
75
77inline constexpr uint16_t kMaxRead = 60;
79inline constexpr uint32_t kSampleTenthMs = 25;
80
82inline constexpr uint16_t kFw210 = 0x210;
83inline constexpr uint16_t kFw222 = 0x222;
84inline constexpr uint16_t kFw240 = 0x240;
85inline constexpr uint16_t kFw255 = 0x255;
86inline constexpr uint16_t kFw300 =
87 0x300;
88inline constexpr uint16_t kFw305 = 0x305;
89
91enum class Access : uint8_t {
92 Read = 1,
93 Write = 2,
94 ReadWrite = 3,
95};
96
99 uint16_t address;
100 uint16_t count;
102 uint16_t min_fw;
103 uint32_t min_value;
104 uint32_t max_value;
105 uint32_t magic;
106};
107
109inline constexpr uint32_t kNoMagic = 0xFFFF'FFFFU;
110
112inline constexpr std::size_t kRegisterRows = 39;
113
116inline constexpr std::array<RegisterSpec, kRegisterRows> kRegisters{{{.address = 21,
117 .count = 1,
118 .access = Access::ReadWrite,
119 .min_fw = 0,
120 .min_value = 0,
121 .max_value = 5,
122 .magic = kNoMagic},
123 {.address = 25,
124 .count = 1,
125 .access = Access::Read,
126 .min_fw = 0,
127 .min_value = 0,
128 .max_value = 0,
129 .magic = kNoMagic},
130 {.address = 26,
131 .count = 6,
132 .access = Access::Read,
133 .min_fw = 0,
134 .min_value = 0,
135 .max_value = 0,
136 .magic = kNoMagic},
137 {.address = 32,
138 .count = 1,
139 .access = Access::Read,
140 .min_fw = 0,
141 .min_value = 0,
142 .max_value = 0,
143 .magic = kNoMagic},
144 {.address = 35,
145 .count = 2,
146 .access = Access::Read,
147 .min_fw = 0,
148 .min_value = 0,
149 .max_value = 0,
150 .magic = kNoMagic},
151 {.address = 39,
152 .count = 1,
153 .access = Access::Write,
154 .min_fw = 0,
155 .min_value = 0,
156 .max_value = 0xAA55,
157 .magic = 0xAA55},
158 {.address = 45,
159 .count = 1,
160 .access = Access::ReadWrite,
161 .min_fw = kFw240,
162 .min_value = 1,
163 .max_value = 247,
164 .magic = kNoMagic},
165 {.address = 46,
166 .count = 1,
167 .access = Access::ReadWrite,
168 .min_fw = kFw240,
169 .min_value = 65,
170 .max_value = 90,
171 .magic = kNoMagic},
172 {.address = 47,
173 .count = 2,
174 .access = Access::Read,
175 .min_fw = kFw240,
176 .min_value = 0,
177 .max_value = 0,
178 .magic = kNoMagic},
179 {.address = 49,
180 .count = 1,
181 .access = Access::Read,
182 .min_fw = 0,
183 .min_value = 0,
184 .max_value = 0,
185 .magic = kNoMagic},
186 {.address = 51,
187 .count = 1,
188 .access = Access::ReadWrite,
189 .min_fw = kFw240,
190 .min_value = 1,
191 .max_value = 65535,
192 .magic = kNoMagic},
193 {.address = 52,
194 .count = 1,
195 .access = Access::ReadWrite,
196 .min_fw = kFw240,
197 .min_value = 0,
198 .max_value = 3000,
199 .magic = kNoMagic},
200 {.address = 53,
201 .count = 1,
202 .access = Access::Write,
203 .min_fw = kFw255,
204 .min_value = 0,
205 .max_value = 0xAA55,
206 .magic = 0xAA55},
207 {.address = 54,
208 .count = 1,
209 .access = Access::ReadWrite,
210 .min_fw = kFw300,
211 .min_value = 0,
212 .max_value = 3,
213 .magic = kNoMagic},
214 {.address = 55,
215 .count = 1,
216 .access = Access::ReadWrite,
217 .min_fw = kFw300,
218 .min_value = 0,
219 .max_value = 2500,
220 .magic = kNoMagic},
221 {.address = 56,
222 .count = 1,
223 .access = Access::ReadWrite,
224 .min_fw = kFw300,
225 .min_value = 0,
226 .max_value = 1,
227 .magic = kNoMagic},
228 {.address = 80,
229 .count = 1,
230 .access = Access::Write,
231 .min_fw = 0,
232 .min_value = 0,
233 .max_value = 0x5214,
234 .magic = 0x5214},
235 {.address = 81,
236 .count = 60,
237 .access = Access::Read,
238 .min_fw = kFw305,
239 .min_value = 0,
240 .max_value = 0,
241 .magic = kNoMagic},
242 {.address = 514,
243 .count = 1,
244 .access = Access::ReadWrite,
245 .min_fw = 0,
246 .min_value = 0,
247 .max_value = 5000,
248 .magic = kNoMagic},
249 {.address = 515,
250 .count = 1,
251 .access = Access::ReadWrite,
252 .min_fw = 0,
253 .min_value = 0,
254 .max_value = 1,
255 .magic = kNoMagic},
256 {.address = 516,
257 .count = 1,
258 .access = Access::ReadWrite,
259 .min_fw = 0,
260 .min_value = 0,
261 .max_value = 2,
262 .magic = kNoMagic},
263 {.address = 519,
264 .count = 1,
265 .access = Access::ReadWrite,
266 .min_fw = kFw240,
267 .min_value = 0,
268 .max_value = 65535,
269 .magic = kNoMagic},
270 {.address = 520,
271 .count = 1,
272 .access = Access::ReadWrite,
273 .min_fw = kFw240,
274 .min_value = 0,
275 .max_value = 65535,
276 .magic = kNoMagic},
277 {.address = 521,
278 .count = 2,
279 .access = Access::ReadWrite,
280 .min_fw = kFw300,
281 .min_value = 0,
282 .max_value = 0xFFFF'FFFFU,
283 .magic = kNoMagic},
284 {.address = 524,
285 .count = 2,
286 .access = Access::ReadWrite,
287 .min_fw = kFw300,
288 .min_value = 0,
289 .max_value = 1'000'000'000U,
290 .magic = kNoMagic},
291 {.address = 2053,
292 .count = 2,
293 .access = Access::ReadWrite,
294 .min_fw = kFw210,
295 .min_value = 0,
296 .max_value = 0x7FFF'FFFFU,
297 .magic = kNoMagic},
298 {.address = 2100,
299 .count = 1,
300 .access = Access::ReadWrite,
301 .min_fw = kFw300,
302 .min_value = 0,
303 .max_value = 255,
304 .magic = kNoMagic},
305 {.address = 2101,
306 .count = 1,
307 .access = Access::Read,
308 .min_fw = kFw300,
309 .min_value = 0,
310 .max_value = 0,
311 .magic = kNoMagic},
312 {.address = 2102,
313 .count = 1,
314 .access = Access::Read,
315 .min_fw = kFw300,
316 .min_value = 0,
317 .max_value = 0,
318 .magic = kNoMagic},
319 {.address = 2103,
320 .count = 1,
321 .access = Access::Read,
322 .min_fw = kFw300,
323 .min_value = 0,
324 .max_value = 0,
325 .magic = kNoMagic},
326 {.address = 2104,
327 .count = 2,
328 .access = Access::Read,
329 .min_fw = kFw300,
330 .min_value = 0,
331 .max_value = 0,
332 .magic = kNoMagic},
333 {.address = 2106,
334 .count = 1,
335 .access = Access::Read,
336 .min_fw = kFw300,
337 .min_value = 0,
338 .max_value = 0,
339 .magic = kNoMagic},
340 {.address = 2107,
341 .count = 1,
342 .access = Access::Read,
343 .min_fw = kFw300,
344 .min_value = 0,
345 .max_value = 0,
346 .magic = kNoMagic},
347 {.address = 2108,
348 .count = 2,
349 .access = Access::Read,
350 .min_fw = kFw300,
351 .min_value = 0,
352 .max_value = 0,
353 .magic = kNoMagic},
354 {.address = 4200,
355 .count = 1,
356 .access = Access::ReadWrite,
357 .min_fw = kFw300,
358 .min_value = 0,
359 .max_value = 7,
360 .magic = kNoMagic},
361 {.address = 4201,
362 .count = 1,
363 .access = Access::ReadWrite,
364 .min_fw = kFw300,
365 .min_value = 1,
366 .max_value = 65535,
367 .magic = kNoMagic},
368 {.address = 4202,
369 .count = 8,
370 .access = Access::Read,
371 .min_fw = kFw300,
372 .min_value = 0,
373 .max_value = 0,
374 .magic = kNoMagic},
375 {.address = 4210,
376 .count = 4,
377 .access = Access::Read,
378 .min_fw = kFw300,
379 .min_value = 0,
380 .max_value = 0,
381 .magic = kNoMagic},
382 {.address = 4214,
383 .count = 2,
384 .access = Access::Read,
385 .min_fw = kFw300,
386 .min_value = 0,
387 .max_value = 0,
388 .magic = kNoMagic}}};
389
391inline constexpr std::array<const char*, 20> kFlowUnitLabels{
392 "SCCM", "NCCM", "SLPM", "NLPM", "SmL/s", "NmL/s", "SmL/m", "NmL/m", "SL/h", "NL/h",
393 "SCCS", "NCCS", "Sm3/h", "Nm3/h", "Sm3/d", "Nm3/d", "SCIM", "SCFM", "SCFH", "SCFD"};
394
397[[nodiscard]] constexpr FlowUnit FlowUnitFromCode(uint16_t code) noexcept {
398 return (code < 20U) ? static_cast<FlowUnit>(code) : FlowUnit::Other;
399}
404} // namespace alicat_basis2::reg
405
406#endif // ALICAT_BASIS2_REGISTERS_HPP
Compile-time helpers of the ALICAT_BASIS2 driver: exact hook matching, typed register fields and enum...
Public types of the ALICAT_BASIS2 driver: errors, Result<T>, configuration, enumerations and the valu...
constexpr uint16_t kTrigger
R/W trigger bits 0 to 7.
Definition alicat_basis2_registers.hpp:65
constexpr uint16_t kSetpointType
R/W 0 analog, 1 saved, 2 unsaved.
Definition alicat_basis2_registers.hpp:51
constexpr uint16_t kTotal
R two registers, unsigned.
Definition alicat_basis2_registers.hpp:61
constexpr uint16_t kFw255
2.5.5: register 53.
Definition alicat_basis2_registers.hpp:85
constexpr uint16_t kSensorOffset
R flow sensor offset (ADC integer defined as zero).
Definition alicat_basis2_registers.hpp:33
constexpr std::array< RegisterSpec, kRegisterRows > kRegisters
The register table (M pp.18 to 27). Reads may span consecutive rows; writes must match one row.
Definition alicat_basis2_registers.hpp:116
constexpr uint16_t kFullScale
R two registers, full scale in flow units x 1000.
Definition alicat_basis2_registers.hpp:39
constexpr uint16_t kFullScaleSccm
R two registers, full scale in SCCM.
Definition alicat_basis2_registers.hpp:35
constexpr uint16_t kFw210
Firmware gates, 256a + 16b + c (M pp.21 to 27).
Definition alicat_basis2_registers.hpp:82
constexpr uint16_t kRamp
R/W two registers, % of FS per ms x 10^7.
Definition alicat_basis2_registers.hpp:55
constexpr uint16_t kFlowUnit
R flow unit code.
Definition alicat_basis2_registers.hpp:40
constexpr uint16_t kModbusAddress
R/W 1 to 247.
Definition alicat_basis2_registers.hpp:37
constexpr uint16_t kMaxRead
Largest register count of one read the driver issues.
Definition alicat_basis2_registers.hpp:77
constexpr uint16_t kTotalReset
W 0xAA55 resets the total volume.
Definition alicat_basis2_registers.hpp:43
constexpr uint16_t kFw222
2.2.2: baud 57600 and 115200.
Definition alicat_basis2_registers.hpp:83
constexpr uint16_t kGasTable
R 60 registers: twelve entries of five.
Definition alicat_basis2_registers.hpp:48
constexpr uint16_t kSerial
R six registers, two characters each (26 to 31).
Definition alicat_basis2_registers.hpp:32
Access
How a register may be accessed.
Definition alicat_basis2_registers.hpp:91
constexpr uint16_t kStatus
R status bits.
Definition alicat_basis2_registers.hpp:58
constexpr uint16_t kValveDrive
R /100.
Definition alicat_basis2_registers.hpp:63
constexpr uint16_t kAutotare
R/W 0 or 1.
Definition alicat_basis2_registers.hpp:50
constexpr uint16_t kTemperature
R signed, /100.
Definition alicat_basis2_registers.hpp:59
constexpr uint32_t kSampleTenthMs
Milliseconds per measurement or tare sample, times ten (about 2.5 ms, M p.22, p.26).
Definition alicat_basis2_registers.hpp:79
constexpr uint16_t kPreviousBlock
R 4210 to 4215: the previous window.
Definition alicat_basis2_registers.hpp:69
constexpr uint16_t kProtocol
R/W 0 BASIS 2, 1 BASIS 1.
Definition alicat_basis2_registers.hpp:46
constexpr uint16_t kGainI
R/W 0 to 65535.
Definition alicat_basis2_registers.hpp:53
constexpr uint16_t kSetpoint
R/W two registers, signed, /1000.
Definition alicat_basis2_registers.hpp:56
constexpr uint16_t kBaud
R/W baud code 0 to 5 (M p.25).
Definition alicat_basis2_registers.hpp:30
constexpr uint16_t kTare
W 0xAA55 tares.
Definition alicat_basis2_registers.hpp:36
constexpr uint16_t kFw300
3.0.0: block 2100 to 2109, 4200 to 4215, 54 to 56, 521, 524.
Definition alicat_basis2_registers.hpp:86
constexpr uint16_t kSamples
R/W samples in a measurement; a write starts it.
Definition alicat_basis2_registers.hpp:66
constexpr std::array< const char *, 20 > kFlowUnitLabels
Flow unit labels in the order of register 49 (M p.26, p.31).
Definition alicat_basis2_registers.hpp:391
constexpr FlowUnit FlowUnitFromCode(uint16_t code) noexcept
The flow unit of a Modbus code or label.
Definition alicat_basis2_registers.hpp:397
constexpr uint16_t kFlow
R signed, scaled by the factory decimals.
Definition alicat_basis2_registers.hpp:60
constexpr std::size_t kRegisterRows
Number of rows of kRegisters.
Definition alicat_basis2_registers.hpp:112
constexpr uint16_t kWatchdog
R/W 0 to 5000 ms.
Definition alicat_basis2_registers.hpp:49
constexpr uint16_t kFactoryRestore
W 0x5214.
Definition alicat_basis2_registers.hpp:47
constexpr uint16_t kUnitId
R/W ASCII 65 to 90.
Definition alicat_basis2_registers.hpp:38
constexpr uint16_t kTotalLimit
R/W 0 to 3.
Definition alicat_basis2_registers.hpp:44
constexpr uint32_t kNoMagic
Marker for "no magic value".
Definition alicat_basis2_registers.hpp:109
constexpr uint16_t kFw240
2.4.0: regs 45 to 48, 51, 52, 519, 520.
Definition alicat_basis2_registers.hpp:84
constexpr uint16_t kTareSamples
R/W 1 to 65535, about 2.5 ms each.
Definition alicat_basis2_registers.hpp:41
constexpr uint16_t kMagicAction
Tare and total reset value.
Definition alicat_basis2_registers.hpp:73
constexpr uint16_t kAveraging
R/W 0 to 2500 ms.
Definition alicat_basis2_registers.hpp:45
constexpr uint16_t kGainP
R/W 0 to 65535.
Definition alicat_basis2_registers.hpp:52
constexpr uint16_t kFirmware
R firmware, 256a + 16b + c.
Definition alicat_basis2_registers.hpp:31
constexpr uint16_t kPreviousAvgFlow
R signed 32-bit, 4214 high word first (A25); reading 4214 may trigger (A17).
Definition alicat_basis2_registers.hpp:70
constexpr uint16_t kGas
R/W gas number; start of the instantaneous block.
Definition alicat_basis2_registers.hpp:57
constexpr uint16_t kMagicRestore
Factory restore value.
Definition alicat_basis2_registers.hpp:74
constexpr uint16_t kBatchRemaining
R two registers, unsigned.
Definition alicat_basis2_registers.hpp:64
constexpr uint16_t kMeasureBlock
R 4202 to 4209: min/max/avg of the current window.
Definition alicat_basis2_registers.hpp:67
constexpr uint16_t kBatch
R/W two registers.
Definition alicat_basis2_registers.hpp:54
constexpr uint16_t kRefTemperature
R/W 0 to 3000, C x 100.
Definition alicat_basis2_registers.hpp:42
constexpr uint16_t kSetpointRead
R current setpoint.
Definition alicat_basis2_registers.hpp:62
constexpr uint16_t kFw305
3.0.5: gas table and GS *.
Definition alicat_basis2_registers.hpp:88
@ Write
Function 6 or 16 only.
@ Read
Function 3 only.
FlowUnit
Flow units (Modbus register 49, M p.26; M p.31).
Definition alicat_basis2_types.hpp:540
@ Other
A label not in the table of M p.31; the raw text is kept.
The ALICAT_BASIS2 Modbus register map.
Definition alicat_basis2_registers.hpp:22
One row of the register table: the only registers the driver touches.
Definition alicat_basis2_registers.hpp:98
Access access
Allowed functions.
Definition alicat_basis2_registers.hpp:101
uint32_t magic
When not 0xFFFFFFFF the only value a write may carry.
Definition alicat_basis2_registers.hpp:105
uint16_t count
Number of registers of the item.
Definition alicat_basis2_registers.hpp:100
uint32_t min_value
Lowest value a write may carry (32-bit items use the combined value).
Definition alicat_basis2_registers.hpp:103
uint16_t min_fw
Firmware gate, 0 for none.
Definition alicat_basis2_registers.hpp:102
uint32_t max_value
Highest value a write may carry.
Definition alicat_basis2_registers.hpp:104
uint16_t address
First register.
Definition alicat_basis2_registers.hpp:99