medplum / medplum / 31135383259

92%

push

github

docs(agent): add an ASTM channel configuration guide (#10111)

* docs(agent): add an ASTM channel configuration guide

Byte stream channels are how the Agent talks to ASTM E1381/E1394 analyzers,
but features.md documents each query parameter in isolation. The parts that
cost the most time in practice are the interactions between them, and those
were undocumented.

Adds a page covering the configuration such a channel needs and the
behaviors that surprise people bringing one up:

- Framing on ENQ/EOT so a session arrives as one message, and why the more
  obvious STX/ETX splits a result set across invocations.
- The autoRespond rules E1381 actually expects. Omitting ETB stalls any
  message long enough to span frames, while mapping LF double-ACKs every
  frame and mapping EOT answers a byte that is never acknowledged.
- That filtering is byte-oriented, so frame sequence numbers and checksums
  reach the Bot, and that which lines carry a sequence number depends on how
  the analyzer packs frames.
- ignoreResponse for one-way channels, including the execution-log fallback
  a Bot returning nothing would otherwise write to the analyzer.
- Sessions carrying no data, which still dispatch an empty body.

Links the two byte stream rows in features.md to the relevant sections.

Signed-off-by: Derrick Farris <derrick@medplum.com>

* docs(agent): note that ASTM channels are TCP-only for now

A byte stream channel listens on a TCP port, so a serial-only analyzer --
still the majority -- needs a serial-to-TCP/IP adapter to reach the Agent.
Direct serial support is planned but not available yet, and the page read as
though a socket were the analyzer's own interface.

Signed-off-by: Derrick Farris <derrick@medplum.com>

---------

Signed-off-by: Derrick Farris <derrick@medplum.com>

23114 of 26210 branches covered (88.19%)

Branch coverage included in aggregate %.

40936 of 43337 relevant lines covered (94.46%)

12161.26 hits per line