Struct TuneArgs 

pub struct TuneArgs {

    pub tagname: String,
    pub template: String,
    pub process_type: ProcessTypeArg,
    pub controller_type: ControllerTypeArg,
    pub relay_amp: f32,
    pub cycles_skip: Option<u32>,
    pub cycles_count: Option<u32>,
    pub noise_protection_secs: Option<u32>,
    pub driver: DriverKindArg,
    pub bridge_host: Option<String>,
    pub server: Option<String>,
    pub sim_gain: f32,
    pub sim_tau: f32,
    pub sim_dead_time: f32,
    pub sim_noise: f32,
    pub sim_seed: u64,
    pub sim_initial_pv: f32,
    pub sim_initial_mv: f32,
    pub pv_range_high: Option<f32>,
    pub pv_range_low: Option<f32>,
    pub mv_range_high: Option<f32>,
    pub mv_range_low: Option<f32>,
    pub direction: Option<DirectionArg>,
    pub tag_overrides: Option<TagOverrides>,
    pub notes: Option<String>,
    pub yes: bool,
    pub write_pid: Option<ResponseLevelArg>,
    pub output: OutputFormat,
}

Flags shared by tune and (a defaulted subset of) simulate.

Fields

tagname: String

PV tag prefix; the rest of the tag set is derived from it using --template’s suffix convention. Ignored for --driver simulator, which uses two fixed internal tag names instead.

template: String

DCS/PLC template name (see bhtune template list).

process_type: ProcessTypeArg

controller_type: ControllerTypeArg

relay_amp: f32

Relay amplitude, as a percentage of the MV range.

cycles_skip: Option<u32>

Relay cycles to skip before counting begins (default: looked up per --process-type).

cycles_count: Option<u32>

Relay cycles to count once the skip period ends (default: looked up per --process-type).

noise_protection_secs: Option<u32>

Seconds a switch must persist before it’s accepted (default: looked up per --process-type).

driver: DriverKindArg

Which driver drives this tune.

bridge_host: Option<String>

opcda-bridge gateway address. bhtune connects to the bridge gateway rather than a DCOM host directly — see AGENTS.md’s OPC DA integration notes. Only meaningful with --driver opcda (default: crate::config::DEFAULT_BRIDGE_HOST, overridable via the BHTUNE_BRIDGE_HOST env var or the config file’s bridge_host key).

server: Option<String>

OPC DA server ProgID (legacy: -s/--opcServerID). Required with --driver opcda.

sim_gain: f32

Simulator process gain (--driver simulator only).

sim_tau: f32

Simulator process time constant, in seconds (--driver simulator only).

sim_dead_time: f32

Simulator dead time, in seconds (--driver simulator only).

sim_noise: f32

Simulator measurement noise amplitude (--driver simulator only).

sim_seed: u64

Simulator RNG seed, for reproducible noise (--driver simulator only).

sim_initial_pv: f32

Simulator initial PV (--driver simulator only).

sim_initial_mv: f32

Simulator initial MV (--driver simulator only).

pv_range_high: Option<f32>

Fixed PV range high, overriding a live tag read (legacy: the PV range “toggle tag/value” button). Required (defaults to 100.0) for --driver simulator, which has no range tags at all.

pv_range_low: Option<f32>

Fixed PV range low, overriding a live tag read.

mv_range_high: Option<f32>

Fixed MV range high, overriding a live tag read.

mv_range_low: Option<f32>

Fixed MV range low, overriding a live tag read.

direction: Option<DirectionArg>

Fixed controller direction, overriding a live tag read.

tag_overrides: Option<TagOverrides>

Per-tune replacements for template-derived tag names. This is populated by the HTTP API/UI; the CLI has no separate flags for the nested object.

notes: Option<String>

Operator notes to attach to this run. Notes can be edited or cleared from the web GUI while the run is active or after it finishes.

yes: bool

Confirm an unattended PID write-back. Required alongside --write-pid – the command refuses to start otherwise – since writing to a live loop with no human present must be an explicit, deliberate choice. Has no effect without --write-pid.

write_pid: Option<ResponseLevelArg>

Non-interactively write this response level’s calculated PID parameters back to the DCS instead of prompting on stdin – the flag that makes a scheduled/scripted tune able to actually update a loop with no one watching. Requires --yes.

output: OutputFormat

How to print this run’s final outcome line.

Trait Implementations

impl Args for TuneArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for TuneArgs

fn clone(&self) -> TuneArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for TuneArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for TuneArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for TuneArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for TuneArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.