pytrain-ogr-deck 2.9.10__py3-none-any.whl

pytrain/__init__.py

@@ -0,0 +1,230 @@
+#
+#
+# PyTrain: a library for controlling Lionel Legacy engines, trains, switches, and accessories
+#
+# Copyright (c) 2024-2025 Dave Swindell <pytraininfo.gmail.com>
+#
+# SPDX-License-Identifier: LPGL
+
+import importlib.metadata
+import sys
+from importlib.metadata import PackageNotFoundError
+
+from .atc.block import Block  # noqa: F401
+from .cli.pytrain import (
+    PyTrain,
+    PyTrainExitException,  # noqa: F401
+    PyTrainExitStatus,  # noqa: F401
+)
+from .db.accessory_state import AccessoryState  # noqa: F401
+from .db.component_state import (
+    ComponentState,  # noqa: F401
+    RouteState,  # noqa: F401
+    SwitchState,  # noqa: F401
+)
+from .db.component_state_store import ComponentStateStore  # noqa: F401
+from .db.engine_state import EngineState, TrainState  # noqa: F401
+from .db.irda_state import IrdaState  # noqa: F401
+from .db.sync_state import SyncState  # noqa: F401
+from .gpio.base_watcher import BaseWatcher  # noqa: F401
+from .gpio.controller import Controller  # noqa: F401
+from .gpio.crane_car import CraneCar  # noqa: F401
+from .gpio.culvert_loader import CulvertLoader, CulvertUnloader  # noqa: F401
+from .gpio.engine_controller import EngineController  # noqa: F401
+from .gpio.engine_status import EngineStatus  # noqa: F401
+from .gpio.gantry_crane import GantryCrane  # noqa: F401
+from .gpio.gpio_handler import (
+    GpioHandler,  # noqa: F401
+    JoyStickHandler,  # noqa: F401
+    PotHandler,  # noqa: F401
+)
+from .gpio.launch_pad import LaunchPad  # noqa: F401
+from .gpio.launch_status import LaunchStatus  # noqa: F401
+from .gpio.power_district import PowerDistrict  # noqa: F401
+from .gpio.power_watcher import PowerWatcher  # noqa: F401
+from .gpio.route import Route  # noqa: F401
+from .gpio.smoke_fluid_loader import SmokeFluidLoader  # noqa: F401
+from .gpio.switch import Switch  # noqa: F401
+from .gpio.sys_admin import SystemAdmin  # noqa: F401
+from .gui.accessories.accessory_gui import AccessoryGui  # noqa: F401
+from .gui.accessories.construction_gui import ConstructionGui  # noqa: F401
+from .gui.accessories.control_tower_gui import ControlTowerGui  # noqa: F401
+from .gui.accessories.culvert_gui import CulvertGui  # noqa: F401
+from .gui.accessories.fire_station_gui import FireStationGui  # noqa: F401
+from .gui.accessories.gas_station_gui import GasStationGui  # noqa: F401
+from .gui.accessories.hobby_shop_gui import HobbyShopGui  # noqa: F401
+from .gui.accessories.milk_loader_gui import MilkLoaderGui  # noqa: F401
+from .gui.accessories.playground_gui import PlaygroundGui  # noqa: F401
+from .gui.accessories.smoke_fluid_loader_gui import SmokeFluidLoaderGui  # noqa: F401
+from .gui.accessories.station_gui import StationGui  # noqa: F401
+from .gui.accessories_gui import AccessoriesGui  # noqa: F401
+from .gui.component_state_gui import ComponentStateGui  # noqa: F401
+from .gui.controller.engine_gui import EngineGui  # noqa: F401
+from .gui.controller.steam_deck_gui import SteamDeckGui  # noqa: F401
+from .gui.launch_gui import LaunchGui  # noqa: F401
+from .gui.motors_gui import MotorsGui  # noqa: F401
+from .gui.power_district_gui import PowerDistrictsGui  # noqa: F401
+from .gui.routes_gui import RoutesGui  # noqa: F401
+from .gui.switches_gui import SwitchesGui  # noqa: F401
+from .gui.systems_gui import SystemsGui  # noqa: F401
+from .gui.wide_component_state_gui import WideComponentStateGui  # noqa: F401
+from .protocol.command_def import CommandDefEnum  # noqa: F401
+from .protocol.command_req import CommandReq  # noqa: F401
+from .protocol.constants import (
+    CommandScope,  # noqa: F401
+    CommandSyntax,  # noqa: F401
+    ControlType,  # noqa: F401
+    PROGRAM_BASE,  # noqa: F401
+    PROGRAM_NAME,
+)
+from .protocol.multibyte.multibyte_constants import (
+    TMCC2EffectsControl,  # noqa: F401
+    TMCC2LightingControl,  # noqa: F401
+    TMCC2MaskingControl,  # noqa: F401
+    TMCC2R4LCEnum,  # noqa: F401
+    TMCC2RailSoundsDialogControl,  # noqa: F401
+    TMCC2RailSoundsEffectsControl,  # noqa: F401
+    TMCC2EngineCommandEnumEx,  # noqa: F401
+    TMCC2VariableEnum,  # noqa: F401
+    UnitAssignment,  # noqa: F401
+)
+from .protocol.sequence.cycle_tone_req import (
+    CycleBellToneReq,  # noqa: F401
+    CycleHornToneReq,  # noqa: F401
+)
+from .protocol.sequence.grade_crossing_req import (
+    GradeCrossingReq,  # noqa: F401
+)
+from .protocol.sequence.labor_effect import (
+    LaborEffectDownReq,  # noqa: F401
+    LaborEffectUpReq,  # noqa: F401
+)
+from .protocol.sequence.ramped_speed_req import (
+    RampedSpeedDialogReq,  # noqa: F401
+    RampedSpeedReq,  # noqa: F401
+)
+from .protocol.sequence.sequence_constants import (
+    SequenceCommandEnum,  # noqa: F401  # noqa: F401
+)
+from .protocol.sequence.sequence_req import (
+    SequenceReq,  # noqa: F401
+    SequencedReq,  # noqa: F401
+)
+from .protocol.sequence.set_speed_req import (
+    SetSpeedReq,  # noqa: F401
+)
+from .protocol.sequence.steward_chatter_req import (
+    StewardChatterReq,  # noqa: F401
+)
+from .protocol.tmcc1.tmcc1_constants import (
+    TMCC1AuxCommandEnum,  # noqa: F401
+    TMCC1EngineCommandEnum,  # noqa: F401
+    TMCC1HaltCommandEnum,  # noqa: F401
+    TMCC1RRSpeedsEnum,  # noqa: F401
+    TMCC1RouteCommandEnum,  # noqa: F401
+    TMCC1SwitchCommandEnum,  # noqa: F401
+)
+from .protocol.tmcc2.tmcc2_constants import (
+    TMCC2EngineCommandEnum,  # noqa: F401
+    TMCC2EngineOpsEnum,  # noqa: F401
+    TMCC2HaltCommandEnum,  # noqa: F401
+    TMCC2RRSpeedsEnum,  # noqa: F401
+    TMCC2RouteCommandEnum,  # noqa: F401
+)
+from .utils.host_info import is_linux  # noqa: F401
+from .utils.path_utils import (
+    find_dir,  # noqa: F401
+    find_file,  # noqa: F401
+)
+
+PROGRAM_PACKAGE = "pytrain-ogr"
+PROGRAM_PACKAGE_DECK = "pytrain-ogr-deck"
+
+# The distributions that install this package, most specific first. pytrain-ogr targets
+# the Raspberry Pi and requires rpi-lgpio and spidev; pytrain-ogr-deck is the same
+# release built without them, because neither is installable on the Steam Deck. Both
+# provide the identical code and console scripts, so only one is ever installed.
+PROGRAM_PACKAGES = (PROGRAM_PACKAGE, PROGRAM_PACKAGE_DECK)
+
+
+def main(args: list[str] | None = None) -> int:
+    if args is None:
+        args = sys.argv[1:]
+    try:
+        PyTrain(args)
+        return 0
+    except Exception as e:
+        # Output anything else nicely formatted on stderr and exit code 1
+        sys.exit(f"{PROGRAM_NAME}: error: {e}\n")
+
+
+def installed_package() -> str | None:
+    #
+    # which of the PyTrain distributions are we running from, if any? this is what
+    # tells a Steam Deck install to update itself rather than the Pi package...
+    #
+    for package in PROGRAM_PACKAGES:
+        try:
+            importlib.metadata.version(package)
+            return package
+        except PackageNotFoundError:
+            continue
+    return None
+
+
+def is_package() -> bool:
+    # production version
+    return installed_package() is not None
+
+
+def get_version() -> str:
+    #
+    # this should be easier, but it is what it is.
+    # we handle the two major cases; we're running from
+    # the PyTrain pypi package, or we're running from
+    # source retrieved from git...
+    #
+    # we try the package path first...
+    version = None
+    package = installed_package()
+    if package is not None:
+        # production version
+        version = importlib.metadata.version(package)
+
+    # finally, call the method to read it from git
+    if version is None:
+        from setuptools_scm import get_version as get_git_version
+
+        version = get_git_version(root="../..", relative_to=__file__, version_scheme="only-version")
+
+    v_parts = version.split("+", 1)
+    version = v_parts[0] + ("" if len(v_parts) == 1 else "+")
+    version = version if version.startswith("v") else f"v{version}"
+    version = version.replace(".post0", "")
+    return version
+
+
+def get_version_tuple() -> tuple[int, int, int]:
+    version = get_version()
+    version = version.replace("v", "")
+    if "+" in version:
+        plus_pos = version.find("+")
+        version = version[0:plus_pos]
+    version = version.split(".")
+    return int(version[0]), int(version[1]), int(version[2])
+
+
+def get_version_bytes() -> bytes:
+    version = get_version_tuple()
+    ver_bytes = bytes()
+    for v in version:
+        ver_bytes += v.to_bytes(1, "big")
+    return ver_bytes
+
+
+SMOKE_LEVEL_MAP = {
+    0: TMCC2EffectsControl.SMOKE_OFF,
+    1: TMCC2EffectsControl.SMOKE_LOW,
+    2: TMCC2EffectsControl.SMOKE_MEDIUM,
+    3: TMCC2EffectsControl.SMOKE_HIGH,
+}

pytrain/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '2.9.10'
+__version_tuple__ = version_tuple = (2, 9, 10)
+
+__commit_id__ = commit_id = None

pytrain/atc/__init__.py

@@ -0,0 +1,9 @@
+#
+#  PyTrain: a library for controlling Lionel Legacy engines, trains, switches, and accessories.
+#
+#  Copyright (c) 2024-2026 Dave Swindell <pytraininfo.gmail.com>
+#
+#  SPDX-FileCopyrightText: 2024-2026 Dave Swindell <pytraininfo.gmail.com>
+#  SPDX-License-Identifier: LGPL-3.0-only
+#
+