A* conventions for naming, properties and values

    <properties.md
    <devices.md

Suffixes for names such as P, RunningSt, …

This section defines the suffixes for names, e.g. the P in Gen1P which indicates it is in kW. General conventions include:

1. Phases are name 1, 2, 3 so the U31 is the voltage between phase 3 and phase 1.
2. Neutral and ground are namedn and g.
3. These names follow normal practise, e.g. the GE Vernova electrical naming convention.

TODO: review RMS vs Peak vs … AC vs DC vs …

Mode: AutoMd, …

Each device can be in one of manual, remote or automatic mode. The control system will not send commands to the unit unless it indicates in automatic.

%p ManualMd -en "Manual Mode" -type bool
%p RemoteMd -en "Remote Mode" -type bool
%p AutoMd -en "Automatic Mode" -type bool

%group Modes ManualMd RemoteMd AutoMd

Status: RunningSt, …

Status variables such as Gen2RunningSt are either 0 or 1 (bool) and indicate the current status of a device.

%pn StoppedSt -en "Stopped with CB opened" -type bool
%pn StartingSt -en "Starting" -type bool
%pn RunningSt -en "Running with CB closed" -type bool
%pn StoppingSt -en "Stopping" -type bool

%group Status StoppedSt StartingSt RunningSt StoppingSt

Alarms: WarningAl, …

Alarms are categorized into critical, non-critical and warning classes and summarised.

%pn Al -en "Alarm" -type bool
%pn Critical -en "Critical"
%pn Noncritical -en "Noncritical"
%pn Warning -en "Warning"

Commands: StartCmd, …

Commands are either 0 or 1 (bool) and cause the device to attempt the defined operation.

%pn StartCmd -en "Start"
%pn StopCmd -en "Stop"
%pn ResetCmd -en "Reset Alarms"

%group Commands

Note that once a device indicates it is StartCmd should be reset to 0, i.e. it is not a level. TODO: rewrite this betterer.

Individual Phase names: 1, 2 and 3

Individual phases are identifed using 1, 2 and 3.

set phases {
  "" "Total"
    1 "Phase 1"
    2 "Phase 2"
    3 "Phase 3"
}

Phase to Phase names: 12, 23, 31, 1g, …

These are the phase to phase variations.

set volt_phases {
    "" "Average"
    "12" "Phase 1 to Phase 2"
    "23" "Phase 2 to Phase 3"
    "31" "Phase 1 to Phase 1"
    "1n" "Phase 1 to Neutral"
    "2n" "Phase 2 to Neutral"
    "3n" "Phase 3 to Neutral"
    "1g" "Phase 1 to Ground"
    "2g" "Phase 2 to Ground"
    "3g" "Phase 3 to Ground"
}

Powers: P, Q, S, …

Powers:

foreach {s d} $::phases {
    %pn P$s -units kW -en "Active Power $d"
    %pn Q$s -units kvar -en "Reactive Power $d"
    %pn S$s -units kVA -en "Apparent Power$d"
}

Note that kvar is the correct unit for reactive power not kVAr since it does represent the product of V x A, see IEC Technical Standards.

Frequency: F, …

Frequency.

foreach {s d} $::phases {
    %pn F$s -units Hz -en "Frequency $d"
}

Voltages: U, …

Voltages

foreach {s d} $::volt_phases {
    %pn U$s -units V -en "Voltage $d"
}

Currents

foreach {s d} $phases {
    %pn I$s -units A -en "Current $d"
}
%pn Ig -units A -en "Current Ground"
%pn In -units A -en "Current Neutral"

Energies

Energies are the time intergral of the Powers in the previous sections.

foreach {s d} $::phases {
    %pn E$s -units kWh -en "Total Active Energy $d"
    %pn Eq$s -units kvarh -en "Total Reactive Energy $d"
    %pn Es$s -units kVAh -en "Total Apparent Energy $d"
}

Generic groups

%group Meter P Q S F E

Overview a-conventions

a-conventions provides … in order to do …

It is intended to be used by …

Summary a-conventions

Quick summary of the component.

Status a-conventions

RFC

Related works and references

TBA

a-conventions

The user manual including admin.

Implementation of a-conventions

Properties

Other Languages

%p -pt -en "Portugese"

Units

%p -units -en "Physical units" -check {
  ?oneof $v $::units
  }

set ::units {}
proc %unit {u args} {
  lappend ::units $u {*}$args
}

%units kW -en "Active Power"
%units kvar -en "Reactive Power"
%units kVA -en "Apparent Power"

Partnames

%pn Gen -en "Generator"
%pn P -en "Active Power" -units kW
%pn Set -en "Setpoint"

I1-3 U1…

Security implications of a-conventions

Details on the security implications

Further sources for a-conventions

Other sources…