BASIS 2 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Public Attributes | List of all members
alicat_basis2::Config Struct Reference

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...

#include <alicat_basis2_types.hpp>

Public Attributes

char unit_id {'A'}
 ASCII unit ID, A to Z (M p.10).
 
Protocol protocol {Protocol::Ascii}
 The protocol this object speaks.
 
uint8_t modbus_address {1}
 Modbus address 1 to 247.
 
uint32_t baud {38400}
 What the port runs at; sizes every timeout.
 
DeviceKind kind {DeviceKind::Auto}
 Meter or controller; Auto learns it at Begin().
 
uint16_t processing_ms {50}
 Instrument turnaround added to every reply wait.
 
uint16_t slow_command_ms {1000}
 Reply wait of commands that may write non-volatile memory.
 
uint16_t restore_holdoff_ms {3000}
 Quiet time after FACTORY RESTORE.
 
uint8_t read_retries {1}
 Retries of a read after a failed transaction; writes never repeat.
 
FrameLayout frame_layout {FrameLayout::Auto}
 Which data frame layout is accepted.
 
UnknownFlagPolicy unknown_flags {UnknownFlagPolicy::Report}
 What happens with a status flag the manual does not list.
 
EchoMode echo {EchoMode::None}
 Whether a first line equal to the command is dropped (half-duplex wiring that hears itself).
 
uint16_t flow_margin_permille {1100}
 Plausibility: the flow must not exceed the full scale times this over 1000.
 
int16_t temperature_min_c {-50}
 Plausibility lower limit of the temperature, C.
 
int16_t temperature_max_c {150}
 Plausibility upper limit of the temperature, C.
 
uint8_t setpoint_decimals {3}
 Digits sent after the point in a setpoint.
 
VerifyPolicy verify_setpoint {VerifyPolicy::WhenNoRamp}
 Whether a setpoint is read back.
 
uint16_t verify_tolerance_permille {5}
 Read-back tolerance in permille of the full scale.
 
uint32_t saved_setpoint_min_interval_ms {180000}
 Minimum time between setpoints while the source is saved.
 
FirmwareGate firmware_gate {FirmwareGate::Enforce}
 Whether the firmware gates of the register and command tables are enforced.
 
uint16_t assume_firmware {0}
 0 unknown; else 256a + 16b + c, used when the instrument gives no firmware.
 
uint8_t modbus_flow_decimals {kDecimalsUnset}
 Required in Modbus mode: 0 to 6 (the decimals are not readable over Modbus).
 
uint32_t full_scale_override_milli {0}
 0 learns the full scale at Begin(); else flow units times 1000.
 

Detailed Description

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.


The documentation for this struct was generated from the following file: