rsmp 0.45.1 → 0.45.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a71c7f02cc5b94aa0b4d4f4b7ad87fbd0406c3b8cd1ceacfc7fa12aad6ccaba5
-  data.tar.gz: 7de215575f1e79a7494c629ae9211f86b31077586f348c12041590d70f859605
+  metadata.gz: ceec0bb561c61873341a4af09334ed0c6e0eb7bb1909b6fb38f2a350aaae8ca9
+  data.tar.gz: 41f8df99b563e086770f502e69ff8bc8a8dc91b075aa9e50c2f0dd451b8bc0ad
 SHA512:
-  metadata.gz: 5580aa1b51574cc1f81feb53040b44c8b540287e15f09a966c5dbb90ce16d54a67be73043a6882ae93075636163f0d7f72e181716fd95d691ade8d8e899b722e
-  data.tar.gz: e7aa473295a9ed35350f5ae4b04e114959f68322d1e19a6ef88ec8743b46af5b448b2e4a9dd2f9b95f531b719c5952af0e1bd73af88ebb63c896492777817eb5
+  metadata.gz: 46ee01791490e180283de79f9568b4d37ad8bef6bd228f2cee5c6eca7d95f568fad715f5f48314c1ebfec8610185bd027b7cc5e65701af248d2253d3569ff491
+  data.tar.gz: 26b27b919cc42a3fdf337720bfb31c3168e8a2a95a0361b642efe27973352eaffbcb4e4c07ea3d55a6f0d4e59d57650c226ed603edcf6a9c45747bb1b3439c98

data/AGENTS.md

@@ -0,0 +1,57 @@
+# RSMP Agent Guide
+
+This repository contains the Ruby implementation of RSMP, the `rsmp` CLI, and vendored RSMP Core and TLC SXL JSON Schemas.
+
+## Where Things Live
+
+- `lib/rsmp/` contains the library, protocol logic, CLI implementation, schema handling, and converters.
+- `exe/rsmp` is the executable entrypoint.
+- `test/rsmp/` contains the internal `sus` test suite.
+- `config/` contains example site and supervisor configuration files.
+- `documentation/` contains project documentation.
+- `schemas/` contains vendored Core and TLC schemas used at runtime. Do not edit these casually; update them from the source repos when possible.
+
+## Commands
+
+- `bundle exec sus` runs the test suite.
+- `bundle exec rake test` also runs the test suite.
+- `bundle exec rubocop` checks Ruby style.
+- `bundle exec exe/rsmp schema generate --in path/to/sxl.yaml --out path/to/output` generates JSON Schema files from an SXL YAML file.
+
+Always run project executables through `bundle exec` so the correct bundle is used.
+
+## Schema Workflows
+
+To generate JSON Schema files from an SXL YAML file:
+
+```sh
+bundle exec exe/rsmp schema generate --in ../rsmp_sxl_traffic_lights/schema/sxl.yaml --out ../rsmp_sxl_traffic_lights/schema
+```
+
+To refresh the vendored schemas in this repo from the sibling source repositories:
+
+```sh
+bundle exec rake schemas:update
+```
+
+The `schemas:update` task assumes sibling repos at `../rsmp_core` and `../rsmp_sxl_traffic_lights` by default. Pass explicit paths when needed:
+
+```sh
+bundle exec rake schemas:update[/path/to/rsmp_core,/path/to/rsmp_sxl_traffic_lights]
+```
+
+The task archives `schema/` from configured version branches in those repos, so make sure the local branches exist and are up to date before running it.
+
+## Editing Guidance
+
+- Follow existing Ruby, `sus`, Thor CLI, and Async patterns.
+- Tests may start local sites and supervisors; they use port `13111` to avoid the default RSMP port `12111`.
+- CLI tests call the Thor class directly rather than spawning a separate process.
+- Keep schema converter changes aligned with `RSMP::Schema` loading and validation behavior.
+- If vendored schemas change, run the relevant schema and CLI tests.
+
+## Validation
+
+- Run the narrowest relevant `bundle exec sus ...` command after edits, or the full `bundle exec sus` when behavior is shared.
+- Run `bundle exec rubocop` for Ruby changes when practical.
+- If schema source repos, branches, or dependencies are unavailable, mention which validation or schema update step was skipped and why.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.45.1)
+    rsmp (0.45.2)
       async (~> 2.39)
       colorize (~> 1.1)
       io-endpoint (~> 0.17)
@@ -35,7 +35,7 @@ GEM
     io-endpoint (0.17.2)
     io-event (1.16.1)
     io-stream (0.13.0)
-    json (2.19.8)
+    json (2.19.9)
     json_schemer (2.5.0)
       bigdecimal
       hana (~> 1.3)

data/documentation/configuration.md

@@ -85,18 +85,18 @@ The following lists the top-level supervisor settings and the keys available for
 
 Top-level supervisor settings
 
-- `port`: integer|string — TCP port the supervisor listens on (default: `12111`).
-- `ip`: string — address to bind to.
-- `ips`: string or array — `'all'` or a list of allowed IP addresses.
-- `site_id`: string — optional site identifier for the supervisor itself.
-- `max_sites`: integer — limit concurrent connected sites.
-- `default`: object — default settings applied to sites that don't have a specific `sites` entry. Contains keys:
-  - `sxls`: object — default SXL versions for default sites, for example `{ "tlc": "1.3.0" }`.
+- `port`: integer|string - TCP port the supervisor listens on (default: `12111`).
+- `ip`: string - address to bind to.
+- `ips`: string or array - `'all'` or a list of allowed IP addresses.
+- `site_id`: string - optional site identifier for the supervisor itself.
+- `max_sites`: integer - limit concurrent connected sites.
+- `default`: object - default settings applied to sites that don't have a specific `sites` entry. Contains keys:
+  - `sxls`: object - default SXL versions for default sites, for example `{ "tlc": "1.3.0" }`.
   - `core_version`: string for the accepted RSMP Core version.
   - `intervals`: object with `timer`, `watchdog` (numbers, seconds).
   - `timeouts`: object with `watchdog`, `acknowledgement` (numbers, seconds).
-- `log`: object — log settings (see `log_settings` elsewhere in docs).
-- `sites`: mapping — per-site settings (see below).
+- `log`: object - log settings (see `log_settings` elsewhere in docs).
+- `sites`: mapping - per-site settings (see below).
 
 ## Per-site settings (`sites` mapping)
 
@@ -113,8 +113,8 @@ Common per-site keys
 - `site_id` (string): explicit site identifier (if different from the mapping key).
 - `supervisors` (array): list of supervisor endpoints (objects with `ip` and `port`). Useful for reverse mappings or local-site configs.
 - `components` (object): component definitions (same structure as site `components`), used by the supervisor-side proxies to set up component proxies.
-- `intervals` (object): per-site timer settings — `timer`, `watchdog`, `reconnect`, `after_connect` (numbers, seconds).
-- `timeouts` (object): per-site timeouts — `connect`, `watchdog`, `acknowledgement` (numbers, seconds).
+- `intervals` (object): per-site timer settings - `timer`, `watchdog`, `reconnect`, `after_connect` (numbers, seconds).
+- `timeouts` (object): per-site timeouts - `connect`, `watchdog`, `acknowledgement` (numbers, seconds).
 - `send_after_connect` (boolean): whether to send messages after connect without waiting for additional events.
 - `skip_validation` (array[string]): list of message types to skip JSON schema validation for this site.
 - `security_codes` (object): map of security code levels to secrets.

data/lib/rsmp/tlc/proxy/control.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for operational control of a remote TLC.
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module Control
-        # M0001 — Set functional position (NormalControl, YellowFlash, Dark).
+        # M0001 - Set functional position (NormalControl, YellowFlash, Dark).
         def set_functional_position(status, within:, timeout_minutes: 0)
           validate_ready 'set functional position'
           raise 'TLC main component not found' unless main
@@ -17,7 +17,7 @@ module RSMP
           { collector: collector }
         end
 
-        # M0005 — Set or clear an emergency route.
+        # M0005 - Set or clear an emergency route.
         def set_emergency_route(route:, active:, within:)
           validate_ready 'set emergency route'
           raise 'TLC main component not found' unless main
@@ -45,7 +45,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0007 — Enable or disable fixed-time control.
+        # M0007 - Enable or disable fixed-time control.
         def set_fixed_time(status, within:)
           validate_ready 'set fixed time'
           raise 'TLC main component not found' unless main
@@ -70,7 +70,7 @@ module RSMP
           wait_for_status "fixed time #{status}", confirm_status, timeout: within
         end
 
-        # M0003 — Set traffic situation (activate a specific situation number).
+        # M0003 - Set traffic situation (activate a specific situation number).
         def set_traffic_situation(situation, within:)
           validate_ready 'set traffic situation'
           raise 'TLC main component not found' unless main
@@ -99,7 +99,7 @@ module RSMP
           wait_for_status "traffic situation #{situation}", confirm_status, timeout: within
         end
 
-        # M0003 — Clear the active traffic situation.
+        # M0003 - Clear the active traffic situation.
         def unset_traffic_situation(within:)
           validate_ready 'unset traffic situation'
           raise 'TLC main component not found' unless main

data/lib/rsmp/tlc/proxy/detectors.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for operational control of a remote TLC.
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module Detectors
-        # M0008 — Force detector logic to a given mode and status.
+        # M0008 - Force detector logic to a given mode and status.
         # component_id must refer to the detector logic component, not main.
         def force_detector_logic(component_id, status:, mode:, within:)
           validate_ready 'force detector logic'
@@ -30,7 +30,7 @@ module RSMP
           send_command_and_collect(command_list, component: component_id, within: within).ok!
         end
 
-        # M0021 — Set the trigger level for traffic counting.
+        # M0021 - Set the trigger level for traffic counting.
         def set_trigger_level(status, within:)
           validate_ready 'set trigger level'
           raise 'TLC main component not found' unless main

data/lib/rsmp/tlc/proxy/io.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for I/O control of a remote TLC.
       # Covers detector logic, input/output forcing and setting.
       module IO
-        # M0006 — Set a single input to a given status.
+        # M0006 - Set a single input to a given status.
         def set_input(input:, status:, within:)
           validate_ready 'set input'
           raise 'TLC main component not found' unless main
@@ -30,7 +30,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0013 — Set all inputs via a bit-pattern string.
+        # M0013 - Set all inputs via a bit-pattern string.
         def set_inputs(status, within:)
           validate_ready 'set inputs'
           raise 'TLC main component not found' unless main
@@ -51,7 +51,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0019 — Force an input to a given value.
+        # M0019 - Force an input to a given value.
         def force_input(input:, status:, value:, within:)
           validate_ready 'force input'
           raise 'TLC main component not found' unless main
@@ -62,7 +62,7 @@ module RSMP
           wait_for_status "force input #{input}", confirm_status, timeout: within
         end
 
-        # M0020 — Force an output to a given value.
+        # M0020 - Force an output to a given value.
         def force_output(output:, status:, value:, within:)
           validate_ready 'force output'
           raise 'TLC main component not found' unless main

data/lib/rsmp/tlc/proxy/plans.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for signal plans.
       # Covers time plans, week/day tables, bands, offsets, and cycle times.
       module Plans
-        # M0014 — Set dynamic bands for a signal plan.
+        # M0014 - Set dynamic bands for a signal plan.
         def set_dynamic_bands(plan:, status:, within:)
           validate_ready 'set dynamic bands'
           raise 'TLC main component not found' unless main
@@ -30,7 +30,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0023 — Set timeout for dynamic bands.
+        # M0023 - Set timeout for dynamic bands.
         def set_dynamic_bands_timeout(status, within:)
           validate_ready 'set dynamic bands timeout'
           raise 'TLC main component not found' unless main
@@ -51,7 +51,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0015 — Set offset for a signal plan.
+        # M0015 - Set offset for a signal plan.
         def set_offset(plan:, offset:, within:)
           validate_ready 'set offset'
           raise 'TLC main component not found' unless main
@@ -105,7 +105,7 @@ module RSMP
           wait_for_status("timeplan #{plan_nr}", confirm_status, timeout: within)
         end
 
-        # M0016 — Set week table (mapping week days to traffic situations).
+        # M0016 - Set week table (mapping week days to traffic situations).
         def set_week_table(status, within:)
           validate_ready 'set week table'
           raise 'TLC main component not found' unless main
@@ -126,7 +126,7 @@ module RSMP
           send_command_and_collect(command_list, within:).ok!
         end
 
-        # M0017 — Set day table (mapping time periods to signal plans).
+        # M0017 - Set day table (mapping time periods to signal plans).
         def set_day_table(status, within:)
           validate_ready 'set day table'
           raise 'TLC main component not found' unless main
@@ -147,7 +147,7 @@ module RSMP
           send_command_and_collect(command_list, within:).ok!
         end
 
-        # M0018 — Set cycle time for a signal plan.
+        # M0018 - Set cycle time for a signal plan.
         def set_cycle_time(plan:, cycle_time:, within:)
           validate_ready 'set cycle time'
           raise 'TLC main component not found' unless main
@@ -173,7 +173,7 @@ module RSMP
           send_command_and_collect(command_list, within:).ok!
         end
 
-        # M0010 — Order signal start for a signal group component.
+        # M0010 - Order signal start for a signal group component.
         def order_signal_start(component_id, within:)
           validate_ready 'order signal start'
 
@@ -193,7 +193,7 @@ module RSMP
           send_command_and_collect(command_list, component: component_id, within:).ok!
         end
 
-        # M0011 — Order signal stop for a signal group component.
+        # M0011 - Order signal stop for a signal group component.
         def order_signal_stop(component_id, within:)
           validate_ready 'order signal stop'
 

data/lib/rsmp/tlc/proxy/system.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for operational control of a remote TLC.
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module System
-        # M0103 — Change security code for a given level.
+        # M0103 - Change security code for a given level.
         # Does not use security_code_for since the codes are passed explicitly.
         def set_security_code(level:, old_code:, new_code:, within:)
           validate_ready 'set security code'
@@ -29,7 +29,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0104 — Set the clock on the remote TLC. clock must respond to year/month/day/hour/min/sec.
+        # M0104 - Set the clock on the remote TLC. clock must respond to year/month/day/hour/min/sec.
         def set_clock(clock, within:)
           validate_ready 'set clock'
           raise 'TLC main component not found' unless main

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.45.1'.freeze
+  VERSION = '0.45.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.45.1
+  version: 0.45.2
 platform: ruby
 authors:
 - Emil Tin
@@ -137,6 +137,7 @@ files:
 - ".gitmodules"
 - ".rubocop.yml"
 - ".tool-versions"
+- AGENTS.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock