Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for Bang & Olufsen button Event entites #35062

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Add documentation for Bang & Olufsen button Event entites #35062

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion source/_integrations/bang_olufsen.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ description: Instructions on how to integrate Bang & Olufsen devices into Home A
ha_category:
- Media Player
- Multimedia
- Event
ha_release: 2024.2
ha_iot_class: Local Push
ha_domain: bang_olufsen
ha_platforms:
- media_player
- event
ha_codeowners:
- '@mj23000'
ha_config_flow: true
Expand Down Expand Up @@ -197,7 +199,7 @@ Bang & Olufsen Cloud TTS messages are limited to 100 unique messages a day and a

Extra keys available:

| Data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------- |
| `overlay_absolute_volume` | yes | Specify an absolute volume for the overlay. |
| `overlay_offset_volume` | yes | Specify a volume offset to be added to the current volume level. |
Expand Down Expand Up @@ -250,6 +252,31 @@ data:

WebSocket notifications received from the device are fired as events in Home Assistant. These can be received by listening to `bang_olufsen_websocket_event` event types, where `device_id` or `serial_number` can be used to differentiate devices.

### Button events

Event entities are created for each of the physical "buttons" on your device. These buttons usually have their own behaviors, so using them for automations is not always ideal.

Available buttons:
- Bluetooth
- Microphone
- Next
- Play / Pause
- Favourite 1
- Favourite 2
- Favourite 3
- Favourite 4
- Previous
- Volume

All of these buttons support the following events:
- Release of short press
- Long press
- Release of long press
- Very long press
- Release of very long press

All devices except the [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core) support device controls.

### Getting Deezer URIs

To find Deezer playlist, album URIs, and user IDs for Deezer flows, the Deezer website has to be accessed. When navigating to an album, the URL will look something like: <https://www.deezer.com/en/album/ALBUM_ID>, and this needs to be converted to: `album:ALBUM_ID` and the same applies to playlists, which have the format: `playlist:PLAYLIST_ID`.
Expand Down