Skip to content

Add camera websocket endpoint for ICE servers#157489

Closed
balloob wants to merge 1 commit into
devfrom
claude/add-websocket-ice-servers-01KRmaztBkeTHWXSWDXV7uak
Closed

Add camera websocket endpoint for ICE servers#157489
balloob wants to merge 1 commit into
devfrom
claude/add-websocket-ice-servers-01KRmaztBkeTHWXSWDXV7uak

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented Nov 28, 2025

Breaking change

Proposed change

Add a new camera/webrtc/ice_servers WebSocket command that returns all registered ICE servers. This endpoint is simpler than the existing camera/webrtc/get_client_config as it doesn't require a specific camera entity and returns only the ICE servers without the full WebRTC client configuration.

This endpoint can be used by other services that want to offer WebRTC like Music Assistant.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings November 28, 2025 12:39
@balloob balloob requested a review from a team as a code owner November 28, 2025 12:39
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (camera) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of camera can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign camera Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a new WebSocket command camera/webrtc/ice_servers that returns all registered ICE servers for WebRTC connections. This endpoint is simpler than the existing camera/webrtc/get_client_config command as it doesn't require a specific camera entity and returns only ICE servers without the full WebRTC client configuration.

Key changes:

  • New WebSocket endpoint for retrieving ICE servers without requiring a camera entity
  • Comprehensive test coverage for the new endpoint including multiple ICE server scenarios

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
homeassistant/components/camera/webrtc.py Adds ws_ice_servers WebSocket command handler that retrieves and returns all registered ICE servers from hass.data, and registers it in async_register_ws
tests/components/camera/test_webrtc.py Adds comprehensive test coverage for the new ICE servers endpoint, testing both default servers and dynamically registered servers

@MartinHjelmare
Copy link
Copy Markdown
Member

I'm missing some background to this PR and how it fits in to the bigger picture. Maybe an actual use case example could help? What other services are we talking about and why do they need a simpler endpoint?

@MartinHjelmare MartinHjelmare marked this pull request as draft December 1, 2025 08:11
@balloob
Copy link
Copy Markdown
Member Author

balloob commented Dec 1, 2025

Current driver is Music Assistant to push the music data directly to Home Assistant users.

@balloob balloob marked this pull request as ready for review December 1, 2025 14:32
@MartinHjelmare
Copy link
Copy Markdown
Member

If it's not cameras that will be involved anymore, maybe this websocket command and endpoint should not belong to the camera integration?

@MartinHjelmare MartinHjelmare marked this pull request as draft December 1, 2025 16:18
@balloob balloob mentioned this pull request Dec 1, 2025
21 tasks
@balloob balloob closed this Dec 1, 2025
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants