Poll M31 assemblies with verified reconnect setup

[onehouse] / doc / m31.rst

diff --git a/doc/m31.rst b/doc/m31.rst
index a1b6eeaa93f9edded98abba95d8e65998e9bed3e..5b374efbf5edd366939a95e174fcfecccc8b016f 100644 (file)
--- a/doc/m31.rst
+++ b/doc/m31.rst
@@ -42,3 +42,33 @@ package is required.
 In-memory stream tests check request bytes, response validation,
 exceptions, truncation, cancellation, and timeouts. They do not verify a
 physical host or TCP network behavior.
+
+*******************
+ Polling lifecycle
+*******************
+
+``New`` validates ``Settings`` and takes a shared publisher and a
+client. The caller runs both the publisher and the integration through
+``driver.Run``. The command keeps its explicit driver list empty and
+does not open hardware connections.
+
+Every connection writes and reads back all digital output modes. Pulse
+outputs also write and verify their widths before online. The first
+complete read establishes a baseline without events. A later input
+change sends retained state followed by a pressed or released event. All
+events from one input read share its completion time, before coil and
+analog reads. A steady output or analog change sends reported state.
+Pulse coils do not send transient feedback.
+
+A device error publishes offline and retries after one second, doubling
+to thirty seconds until a complete baseline succeeds. Device failures do
+not log inside the integration. Publication and cleanup failures return
+to the runner. Cancellation closes the client without a false offline
+publication. Refresh requests cached snapshots through the shared
+publisher without repeating events or physical work.
+
+Polling can miss an edge that starts and ends between reads. It does not
+expose input counters. A configured poll interval is a target, not a
+guaranteed edge latency. Tests use fake clients and simulated time for
+baseline, transitions, pulse verification, reconnect, refresh, shutdown,
+and error propagation. Physical timing remains unverified.