serve the web console from the node and drop the websocket bridge
validate / validate (pull_request) Successful in 58m41s
validate / test (pull_request) Successful in 58m44s
validate / markdownlint (pull_request) Successful in 58m40s

The browser reached this node through `dora-websocket-transceiver`: a second
node, a second port, and a round trip through the dataflow for every button
press, to carry a UI only this node can interpret. The node now serves the
page and holds the browsers' sockets itself on one port, so the console is
one URL and a consumer wires nothing for it.

`dora_teleop/server.py` runs aiohttp on a thread of its own and meets the
control loop at two non-blocking points: a bounded queue the tick drains, and
a snapshot handed back. Both queues are bounded deliberately — a flood is
dropped rather than grown, and a slow browser loses stale snapshots rather
than the newest — because nothing a browser does may stall the thread that
stops the arm. A port already in use stops the node rather than leaving it
announcing a console nobody can open.

The web deadman moved but did not change: it was a `clients` message from the
bridge and is now the open-socket count read each tick. One hop fewer, same
meaning.

Contract, so 0.2.0 -> 0.3.0: `ui_command` and `clients` are gone. `ui_state`
stays published for `dora topic echo` and the bench, with no browser reading
it. New WEB_HOST and WEB_PORT (7000; 0 opens no port).

The console itself is laid out like the arm's own pendant — two rings
quartered into arc sectors you hold, each with its out-of-plane axis as pills
above. Directions and signs match xArm Studio on the controller, `Y+` on the
left included: two consoles driving one arm that disagree about which way is
+Y is a trap, not a preference.

Also sends a velocity only when it changes, repeating an unchanged one on
JOG_KEEPALIVE_S (0.2 s) purely to beat the consumer's own expiry. Repeating
every tick made `dora-ulite6` re-plan the same motion twenty times a second.
That turned out not to be the whole cause of the stepping an operator felt —
the rest was fixed in dora-ulite6 v0.3.1, pinned here — but sending 18
messages where 83 went before is worth keeping on its own.

`dora-joy` moves to v0.1.1: v0.1 is an annotated tag, and dora 1.0.1 records
the tag object's id as the commit hash and then rejects its own checkout for
sitting on the peeled commit. Neither dataflow could be built before this.
This commit is contained in:
2026-09-16 14:50:21 -03:00
parent ffbba0f4d1
commit da1b079b7b
22 changed files with 1984 additions and 454 deletions
+70 -8
View File
@@ -20,22 +20,72 @@ def env_float(name: str, default: float) -> float:
raise ValueError(f"{name} must be a number, not {value!r}") from None
def env_int(name: str, default: int) -> int:
"""Read a whole number, naming the variable if it cannot be read as one."""
value = os.environ.get(name, "").strip()
if not value:
return default
try:
return int(value)
except ValueError:
raise ValueError(f"{name} must be a whole number, not {value!r}") from None
@dataclass
class ConsoleConfig:
"""Where the built-in web console listens.
The node serves the page and holds the browsers' sockets itself, so there is
one address and one port rather than a bridge node and two. `0.0.0.0` is the
default because the operator is rarely sitting at the machine driving the
arm; bind it to `127.0.0.1` where that is not true.
"""
host: str = "0.0.0.0"
port: int = 7000
@property
def enabled(self) -> bool:
"""Whether to open the port at all. Port 0 means a pad-only dataflow."""
return self.port != 0
@classmethod
def from_env(cls) -> "ConsoleConfig":
"""Build the console's address from the environment."""
port = env_int("WEB_PORT", 7000)
if not 0 <= port <= 65535:
raise ValueError(f"WEB_PORT must be a port number, not {port}")
return cls(host=os.environ.get("WEB_HOST", "").strip() or "0.0.0.0", port=port)
@dataclass
class DeadmanConfig:
"""How long a source may go quiet before the arm is told to stop.
Four layers, outermost last. `joy_ttl_s` is how long a pad reading stays
worth acting on; this node re-sends the current velocity every tick;
`jog_ttl_s` is how long it will keep doing so without hearing from the
source; and behind all of them sits the arm node's own
`VELOCITY_COMMAND_TTL_S`, which the controller enforces whether or not this
process is alive.
worth acting on; `jog_keepalive_s` is how often an unchanged velocity is
repeated; `jog_ttl_s` is how long this node keeps driving without hearing
from the source; and behind all of them sits the arm node's own
`VELOCITY_COMMAND_TTL_S`, enforced there whether or not this process is
alive.
Keep them in that order — each shorter than the one behind it — or a
backstop fires before the thing it is backing up.
"""
jog_ttl_s: float = 0.4
# How often to repeat a velocity that has not changed. A velocity is a
# set-point, not a sequence: the arm holds the last one until its own expiry
# or a new one, so repeating it 20 times a second only makes the controller
# re-plan the same motion 20 times, which an operator feels as stepping.
# Low enough that the arm's VELOCITY_COMMAND_TTL_S never fires mid-motion,
# and no lower. A change — a new direction, or the stop — never waits for it.
#
# It is checked on the tick, so the period actually achieved is this rounded
# *up* to the next tick: 0.2 with a 50 ms tick repeats every 250 ms, because
# the tick at 200 ms lands a hair early and does not qualify. Budget against
# that number, not this one.
jog_keepalive_s: float = 0.2
# How long the `joy` stream may go quiet before the pad reads as gone. The
# pad lives in another node now, and that node dying looks like silence
# rather than like an unplugged pad, so silence has to mean the same thing.
@@ -53,6 +103,7 @@ class DeadmanConfig:
"""Build the timings from the environment."""
return cls(
jog_ttl_s=env_float("JOG_TTL_S", 0.4),
jog_keepalive_s=env_float("JOG_KEEPALIVE_S", 0.2),
joy_ttl_s=env_float("JOY_TTL_S", 0.2),
gamepad_idle_release_s=env_float("GAMEPAD_IDLE_RELEASE_S", 2.0),
state_poll_s=env_float("STATE_POLL_S", 0.5),
@@ -63,9 +114,9 @@ class DeadmanConfig:
class Config:
"""The node's settings."""
# Full-deflection speeds. A stick is analog, so these are the maximum and
# anything less moves proportionally slower — which is the whole reason a
# gamepad beats the console's dial pad.
# Full-deflection speeds. Both sources are analog — a gamepad stick and the
# console's on-screen ones — so these are the maximum and anything less
# moves proportionally slower.
speed_mm_s: float
speed_deg_s: float
# Stick travel to ignore. A worn stick that does not centre would otherwise
@@ -75,6 +126,7 @@ class Config:
# positioning happens near centre, and expo is what buys resolution there.
expo: float
deadman: DeadmanConfig = field(default_factory=DeadmanConfig)
console: ConsoleConfig = field(default_factory=ConsoleConfig)
@classmethod
def from_env(cls) -> "Config":
@@ -93,10 +145,20 @@ class Config:
raise ValueError(
f"JOY_TTL_S must be below JOG_TTL_S ({deadman.jog_ttl_s}), not {deadman.joy_ttl_s}"
)
# The repeat has to be quicker than the arm's own velocity expiry or the
# arm stops between repeats. That expiry cannot be read from here, but
# JOG_TTL_S is already required to sit below it, so staying under
# JOG_TTL_S keeps the repeat under both.
if not 0.0 < deadman.jog_keepalive_s < deadman.jog_ttl_s:
raise ValueError(
f"JOG_KEEPALIVE_S must be above 0 and below JOG_TTL_S ({deadman.jog_ttl_s}), "
f"not {deadman.jog_keepalive_s}"
)
return cls(
speed_mm_s=env_float("SPEED_MM_S", 60.0),
speed_deg_s=env_float("SPEED_DEG_S", 30.0),
deadzone=deadzone,
expo=expo,
deadman=deadman,
console=ConsoleConfig.from_env(),
)