Skip to content

Add starting a Gear Guard live stream - #250

Merged
natekspencer merged 4 commits into
bretterer:mainfrom
walthowd:feat/gear-guard-live
Nov 15, 2026
Merged

natekspencer merged 4 commits into
bretterer:mainfrom
walthowd:feat/gear-guard-live

Conversation

@walthowd

@walthowd walthowd commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Builds on #249.

start_gear_guard_live_stream starts a live camera stream like the app and returns the Kinesis Video WebRTC config (signaling endpoint, ICE servers, role) for a viewer to join.

  • Subscribes to gearGuardLiveConfig, then sends the signed start_live_streaming command with the same command id
  • parallax.encode_live_streaming (new LiveStreamingRequest schema), GEAR_GUARD_CAMERAS
  • A refused start raises right away, through on_error

Needs Gear Guard video monitoring on and a paired phone. The vehicle allows one session at a time, about 3 minutes each and an hour a day.

Tested

2026 R1S (Gen 2), 2026.36.01: front and right cameras streamed in a WebRTC viewer.

Not tested: rear, left and bed cameras, R2 cabin camera

@natekspencer natekspencer left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, the command-id routing and failing fast through on_error are nicely done. Two small things:

  1. An exception can be left unread on the future. If on_error sets an exception on config and then send_parallax_command returns falsy (or raises), the method returns or raises without awaiting config, so asyncio logs "Future exception was never retrieved" when it's collected. Reading it in the finally (e.g. if config.done() and not config.cancelled(): config.exception()), or cancelling the future when you return early, would avoid that.
  2. on_error assumes the payload is a list. errors[0].get(...) raises if payload is an object, which with #249 as it is would take the receiver down instead of failing the stream. Handling both shapes (payload if isinstance(payload, list) else [payload]) would make it robust regardless of #249.

This needs a rebase once #249 lands.

@walthowd

Copy link
Copy Markdown
Contributor Author

Both fixed. The finally now reads the future's exception when it's done, so an early return doesn't leave "Future exception was never retrieved" behind, and on_error takes the payload as a list or an object. Tests cover both; each fails without its fix. I'll rebase onto main once #249 is in.

@natekspencer

Copy link
Copy Markdown
Collaborator

Thanks, both fixes look good. #252, #246 and #248 have been merged, so this now conflicts with main (parallax/__init__.py, rivian.py and the tests). Could you rebase onto main once #249 is in and resolve the conflicts?

They will land in this order, so rebasing in the same order keeps the later ones from conflicting again:

  1. Pass subscription errors to an on_error callback #249 Pass subscription errors to an on_error callback
  2. Add starting a Gear Guard live stream #250 Add starting a Gear Guard live stream
  3. Add searching for places #251 Add searching for places
  4. Add climate hold and pet mode commands #247 Add climate hold and pet mode commands
  5. Add Parallax equivalents of vehicle commands #245 Add Parallax equivalents of vehicle commands

I've moved this to draft for now; please mark it ready for review once it's rebased.

The server ends a subscription with an `error` message when it fails, for
example when the vehicle refuses a command the subscription waits on. The
web socket only logged those at debug, so a caller waiting on the
subscription could only time out. Subscriptions can now take an `on_error`
callback that gets the error message; existing callers are unchanged.
An `on_error` that raised escaped the receive loop and ended the receiver
task. Both callbacks now run through `_run_callback`, which logs a failure
instead of raising and awaits coroutine callbacks.
`start_gear_guard_live_stream` starts a live camera stream the way the
Rivian app does and returns its Kinesis Video WebRTC config (signaling
endpoint, ICE servers and role), for a viewer to join:

- It subscribes to `gearGuardLiveConfig` with a fresh command id, then sends
  the signed `security.video_monitoring.start_live_streaming` command with
  that same id; the cloud routes the config by it.
- `parallax.encode_live_streaming` builds the command's payload from a new
  `LiveStreamingRequest` schema; `GEAR_GUARD_CAMERAS` names the cameras.
- A refused start (e.g. a camera the vehicle doesn't have) raises
  RivianApiException straight away, through the subscription's `on_error`.

It needs Gear Guard video monitoring on and a paired phone. The vehicle
serves one session at a time, about 3 minutes each and an hour a day.

Builds on bretterer#249.

Verified against a 2026 R1S (Gen 2) running 2026.36.01: the config arrived
within seconds of the start when the vehicle was awake, and the front and
right cameras streamed in a WebRTC viewer. A sleeping vehicle can take
longer to wake than the default 40 second timeout. Not tested: the rear,
left and bed cameras, the R2's cabin camera.
A refusal that reached the future before the start command was rejected
was never read, so asyncio logged "Future exception was never
retrieved"; it is now read before returning. The error handler also
takes a `payload` sent as an object, not only as a list, so it still
fails the start instead of raising in the callback.
@walthowd
walthowd force-pushed the feat/gear-guard-live branch from 1e37283 to 9124f99 Compare November 15, 2026 20:31
@walthowd
walthowd marked this pull request as ready for review November 15, 2026 20:31
@walthowd

Copy link
Copy Markdown
Contributor Author

Rebased onto #249 in your merge order, ready for review.

@natekspencer natekspencer left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, both fixes look good and I checked the live-streaming payload against the app: the camera values and fields match.

@natekspencer
natekspencer merged commit 763c578 into bretterer:main Nov 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants