Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pages/board-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,19 @@ Nothing is echoed twice: the line is written into the console buffer before the
bytes reach the board, so what appears is the board's own record rather than a
copy from the interface.

**On a paused run, a command waits for play.** The firmware answers as soon as
it reads the line, so `advert` is answered `OK - Advert sent` whether or not the
clock is running, but nothing reaches the air until the engine steps. While the
clock is stopped, the console adds a line of its own under the reply:

> advert
-> OK - Advert sent
(the run is paused: anything this sends is queued and goes on the air when it plays)

The line is bracketed so it cannot be read as something the node said. It is
not added while the run is playing, or for a command held with `at_ms`, which
runs inside a step rather than waiting for one.

### Decoding a companion

A companion's serial carries the framed protocol, so read a byte at a time it is
Expand Down
5 changes: 5 additions & 0 deletions pages/scripting.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,11 @@ loop runs when the engine steps - so reading immediately after sending reads the
moment before the command went out. `ask` sends, gives the mesh its own time,
and then reads.

On a paused run, `console.type` and `console.cli` also answer `paused`, the same
sentence the console prints under the reply: whatever the command sends is
queued and goes on the air when the run plays. A call held with `at_ms` runs
inside a step and does not carry it.

## Importing a deployment

```python
Expand Down