jmri_core.state

  1"""Shared state enums matching JMRI's Java values.
  2
  3Each enum mirrors the integer constants used in JMRI's wire formats and XML
  4files. **Do not renumber these** — the values are part of the persisted
  5contract that golden XML files in stage-0/contracts/xml/golden/ depend on.
  6
  7Per-bean state enums also live in this module so persistence code can import
  8a single namespace without circular imports through ``beans``.
  9"""
 10from __future__ import annotations
 11
 12from enum import IntEnum, IntFlag
 13
 14
 15class TurnoutState(IntEnum):
 16    """Matches ``jmri.Turnout.UNKNOWN/CLOSED/THROWN/INCONSISTENT`` Java constants."""
 17
 18    UNKNOWN      = 1
 19    CLOSED       = 2
 20    THROWN       = 4
 21    INCONSISTENT = 8
 22
 23
 24class TurnoutFeedback(IntFlag):
 25    """Matches ``jmri.Turnout`` feedback-mode flags."""
 26
 27    DIRECT     = 1
 28    ONESENSOR  = 2
 29    TWOSENSOR  = 4
 30    EXACT      = 8
 31    SIGNAL     = 16
 32    MONITORING = 32
 33    DELAYED    = 64
 34    LN_ALM     = 128
 35    PUSHBUTTON = 256
 36
 37
 38class SensorState(IntEnum):
 39    """Matches ``jmri.Sensor.UNKNOWN/ACTIVE/INACTIVE/INCONSISTENT``."""
 40
 41    UNKNOWN      = 1
 42    ACTIVE       = 2
 43    INACTIVE     = 4
 44    INCONSISTENT = 8
 45
 46
 47class SignalAppearance(IntEnum):
 48    """Matches ``jmri.SignalHead`` appearance constants — the 9 standard aspects.
 49
 50    Custom signals may add manufacturer-specific appearances via the
 51    SignalMast layer; SignalHead is restricted to this set.
 52    """
 53
 54    DARK          = 0
 55    RED           = 1
 56    YELLOW        = 2
 57    GREEN         = 4
 58    LUNAR         = 8
 59    FLASHRED      = 16
 60    FLASHYELLOW   = 32
 61    FLASHGREEN    = 64
 62    FLASHLUNAR    = 128
 63
 64
 65class BlockState(IntEnum):
 66    """Matches ``jmri.Block.UNDETECTED/UNOCCUPIED/OCCUPIED/UNKNOWN``."""
 67
 68    UNKNOWN    = 1
 69    OCCUPIED   = 2
 70    UNOCCUPIED = 4
 71    UNDETECTED = 256
 72
 73
 74class LightState(IntEnum):
 75    """Matches ``jmri.Light.OFF/ON/INTERMEDIATE``."""
 76
 77    UNKNOWN      = 1
 78    OFF          = 2
 79    ON           = 4
 80    INTERMEDIATE = 8
 81
 82
 83class PowerState(IntEnum):
 84    """Matches ``jmri.PowerManager.UNKNOWN/ON/OFF/IDLE``."""
 85
 86    UNKNOWN = 0
 87    ON      = 2
 88    OFF     = 4
 89    IDLE    = 8
 90
 91
 92class RouteState(IntEnum):
 93    """Internal route state — JMRI has no equivalent integer enum, this maps
 94    to behavior of ``jmri.Route`` (set / unlocked / locked)."""
 95
 96    UNLOCKED = 0
 97    LOCKED   = 1
 98    UNKNOWN  = 2
 99
100
101class ThrottleDirection(IntEnum):
102    """Locomotive direction. Matches NMRA convention."""
103
104    REVERSE = 0
105    FORWARD = 1