wendy device camera frames
Stream calibrated RGB-D frames (colour + aligned metric depth) from a device camera
Syntax
wendy device camera frames [flags]Examples
wendy device camera frames --helpArguments
No positional arguments are declared in the command synopsis.
Flags
Flags below include inherited options. Types and defaults come from the CLI source. An empty default means no value is configured.
| Flag | Type | Default | Description |
|---|---|---|---|
--count | uint32 | 0 | Stop after this many frames (0 = stream until interrupted) |
--device | string | (empty) | Target device host (hostname, IP, or host:port); 'wendy run' accepts a comma-separated list to deploy one build to several devices (needs a remote build host and --detach). Defaults to $WENDY_DEVICE, then the saved default device |
--fps | uint32 | 0 | Framerate (0 = source default) |
--height | uint32 | 0 | Colour height (0 = source default) |
--json | bool | false | Output in JSON format |
--list | bool | false | List the calibrated sources on this device and what each can promise, then exit |
--non-interactive | bool | false | Disable terminal prompts and automatic installs |
--require | stringSlice | [] | Properties this consumer cannot work without; repeat or comma-separate. One of: aligned-depth,measured-intrinsics,capture-settings |
--source | string | (empty) | Calibrated source to stream, as 'camera frames --list' reports it (empty: the only one that can serve this request) |
--stdout | bool | false | Write the frame bytes (colour plane then depth plane, per frame) to stdout instead of a readable summary. Geometry, depth scale and intrinsics are printed once to stderr. |
--width | uint32 | 0 | Colour width (0 = source default) |
Output
Output depends on the operation and selected target. Use the command help for additional guidance..
JSON output
The global --json option requests machine-readable output. The CLI also selects JSON mode when no interactive terminal is attached. Support and payloads are command-specific; this flag does not guarantee a single JSON document for commands that stream logs or invoke build tools. Consult Details before parsing command output.
Exit codes
The CLI entry point returns 0 on success and for its user-cancelled or default-cleared results. Other returned errors exit with 1 and print a diagnostic to stderr. Some operations may terminate through subprocess or signal handling; do not infer application health from the CLI exit code alone.
Common errors
Check argument values and flag combinations against the synopsis above. For discovery, build, port, and readiness failures, see deployment troubleshooting. Command-specific constraints are in Details.
See also
Details
Stream calibrated frames: colour, depth aligned pixel-for-pixel to that colour, the scale that turns depth into metres, the camera's intrinsics with their provenance, and the settings it actually applied — all under one frame id and one capture instant.
Declare what you cannot work without via --require. A camera that cannot provide it is refused by name, before the first frame and again if the property stops holding mid-stream. Nothing is ever silently downgraded.
Requirements: aligned-depth,measured-intrinsics,capture-settings
Run with --list to see what the cameras on this device can promise.
Use the command help for additional guidance.