Expand description
The rule catalogue.
One table, from which cargo xtask render-rules writes the published catalogue.
Every rule
quotes the sentence it implements, so a disagreement with another implementation can
be settled by reading rather than by arguing.
Severity is a judgement about the specification, not about the message. A rule is
an Error when the standard states the requirement plainly, and a Warning when the
text is ambiguous, silent, or contradicts itself — with the issue number or the E
number in the citation. That is what keeps this crate
from refusing traffic that another conforming implementation is entitled to send.
Structs§
- Rule
- One entry of the catalogue.
Constants§
- ABNORMAL_
ONLY - An abnormal-condition-only mode, transition or range needs abnormal_condition
- APPLICATION_
REFUSED - The receiving application refused the message through its inbound policy
- ARRAY_
BOUNDS - An array must respect the schema’s minItems and maxItems
- BLOCKED_
BY_ TIMER - The instructed transition is blocked by a timer that has not finished
- COMMODITY_
WITHOUT_ POWER_ RANGE - Every operation mode should publish a power range for each commodity the actuator supports
- CONTROL_
TYPE_ NOT_ OFFERED - The CEM may only select a control type the resource offers
- CURRENCY_
REQUIRED - A resource that publishes costs should declare a currency
- DDBC_
FORECAST_ NOT_ OFFERED - A demand forecast may only be sent if the system description offers one
- DDBC_
TRANSITION_ REFERENCES - A transition must name operation modes and timers of its own actuator
- DDBC_
UNKNOWN_ ACTUATOR - An instruction must name an actuator the system description declares
- DDBC_
UNKNOWN_ MODE - An instruction must name an operation mode that actuator has
- DECODE_
FAILED - The frame could not be decoded into an S2 message
- DUPLICATE_
ID - Identifiers must be unique within the scope the standard names
- DUPLICATE_
INSTRUCTION_ ID - An instruction identifier must not be reused within a session
- DUPLICATE_
MESSAGE_ ID - A message_id should not repeat within a session
- DUPLICATE_
ROLE - A resource should declare each role once per commodity
- DUPLICATE_
SUPPORTED_ COMMODITY - An actuator should list each supported commodity once
- FACTOR_
RANGE - An operation-mode factor must be within [0, 1]
- FORECAST_
NOT_ OFFERED - A forecast may only be sent by a resource that said it provides forecasts
- FRBC_
ELEMENTS_ CONTIGUOUS - An operation mode’s fill-level bands must be contiguous
- FRBC_
FILL_ LEVEL_ OUT_ OF_ RANGE - The reported fill level is outside the range the storage described
- FRBC_
LEAKAGE_ CONTIGUOUS - Leakage bands must be contiguous
- FRBC_
NOT_ OFFERED - Leakage, usage forecast and target profile may only be sent if the storage offers them
- FRBC_
TRANSITION_ REFERENCES - A transition must name operation modes and timers of its own actuator
- FRBC_
UNKNOWN_ ACTUATOR - An instruction must name an actuator the system description declares
- FRBC_
UNKNOWN_ MODE - An instruction must name an operation mode that actuator has
- HANDSHAKE_
UNDER_ CONNECT - Handshake messages are redundant under S2 Connect
- MEASUREMENT_
NOT_ OFFERED - A measurement may only use a quantity the resource said it provides
- NON_
FINITE - Every number must be finite
- NOT_
ALLOWED_ FOR_ ROLE - The message is not allowed from this role
- NOT_
ALLOWED_ IN_ STATE - The message is not allowed in the session’s current state
- NO_
SELECTION_ OFFERED - NO_SELECTION is not something a resource can offer
- NO_
SUCH_ TRANSITION - No transition is described from the active operation mode to the instructed one
- OMBC_
TRANSITION_ REFERENCES - A transition must name operation modes and timers of its own description
- OMBC_
UNKNOWN_ MODE - An instruction must name an operation mode the system description declares
- ONE_
VALUE_ PER_ QUANTITY - At most one value per CommodityQuantity
- PEBC_
BOTH_ LIMITS - Power constraints need at least one upper and one lower allowed range
- PEBC_
ENERGY_ ORDER - The lower average power must not exceed the upper
- PEBC_
ENVELOPE_ LIMIT_ ORDER - An envelope element’s lower limit must not exceed its upper limit
- PEBC_
ONE_ ENVELOPE_ PER_ QUANTITY - At most one envelope per CommodityQuantity
- PEBC_
OUTSIDE_ ALLOWED - An envelope limit must lie within an allowed range for its quantity
- PEBC_
UNKNOWN_ CONSTRAINTS - An instruction must reference power constraints that are published and in force
- PEBC_
VALIDITY_ WINDOW - valid_from must precede valid_until
- PERCENTILE_
ORDER - Confidence bands should be ordered from the lower limit to the upper
- PHASE_
EXCLUSIVITY - Per-phase and three-phase-symmetric quantities should not be mixed
- PPBC_
NOT_ INTERRUPTIBLE - Only a sequence that says it is interruptible may be interrupted
- PPBC_
PROGRESS - A status for a sequence that has started must report its progress
- PPBC_
PROGRESS_ UNEXPECTED - Progress was reported for a sequence that has not started
- PPBC_
SEQUENCE_ NOT_ NAMED - A status that says a sequence was selected must name which one
- PPBC_
STATUS_ COVERAGE - A profile status must cover every container of the profile
- PPBC_
UNKNOWN_ SEQUENCE - An instruction must resolve profile, container and sequence together
- PPBC_
WINDOW - A profile’s start must not be after its end
- PPBC_
WINDOW_ TOO_ SHORT - The window is shorter than the shortest sequence offered
- PREVIOUS_
MODE_ MISSING - A status after the first for the same actuator should name the previous mode
- PROFILE_
FIELD - A field must be present exactly when the negotiated wire profile defines it
- RANGE_
ORDER - A range’s start must not be after its end
- RANGE_
STRICT_ ORDER - A fill-level band’s start must be strictly below its end
- REVOKE_
ROLE_ MISMATCH - The revoked object type is not one this sender owns
- REVOKE_
UNKNOWN - The revoked object was never published on this session
- ROLE_
REQUIRED_ FIELD - A field that is optional in general is mandatory for this sender’s role
- STATUS_
REGRESSION - An instruction’s status should not move backwards
- TIMESTAMP_
SKEW - A timestamp is further from the local clock than its meaning allows
- UNKNOWN_
INSTRUCTION - An InstructionStatusUpdate must name an instruction that was sent
- UNKNOWN_
PROPERTY - A property the schema does not define was removed before decoding
- UNKNOWN_
TIMER - A timer status must name a timer the description declares
Statics§
- RULES
- Every rule, in identifier order.