Skip to content
Design System
GitHub

Joint state

v0.24.1Beta

A robot arm's joints for monitoring (ROS sensor_msgs/JointState with the URDF's limits): each joint's position in degrees or millimetres on a thin track between its limits, velocity and effort, near-limit and at-limit in words with an icon, and loading, empty and stale states.

API reference

Generated from the types. Every part also takes className.

JointState

jointsrequired
JointStateJoint[]The joints, in the order to list them (usually the URDF's chain order). Leave it empty while there are none.
label
stringThe arm's name, written above the list and naming the panel for screen readers: "Arm 2 · UR10e".
loading
boolean = falseWaiting for the first joint state: a skeleton the size of the list.
updatedAt
numberWhen this joint state was measured, in ms since the epoch (the message's header.stamp). Given, only a new value is an update (a re-sent old message is not), and it is the time "Stale · last update" shows. Without it, a change in any joint's position, velocity or effort is an update (a new array with the same values is not), so an arm standing perfectly still reads Stale after staleAfterMs: pass the stamp to tell a quiet arm from a silent one. Either way the wait is timed by this browser's clock.
staleAfterMs
number = 1000With no update for this long, the panel says "Stale" with the last update's time and dims the values. Infinity never goes stale.
margin
number = 0.05How close to a limit counts as near, as a fraction of each joint's range.
locale
stringBCP 47 tag for the numbers and the time ("zh-TW", "de"): pass the app's locale. Left out, numbers are written in English ("en") and the time on a 24-hour clock, the same on the server and in every browser, so the page hydrates cleanly. A tag Intl cannot read falls back to "en".
labels
Partial<JointStateLabels>