Skip to content

Commit

Permalink
docs: add mqtt documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
c0un7-z3r0 committed Dec 9, 2024
1 parent 6160c6c commit 3801f90
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions documentation/builders/components/mqtt/mqtt-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# MQTT Integration

The MQTT integration allows you to control your Phoniebox via the MQTT protocol. This feature enables not only MQTT

Check failure on line 3 in documentation/builders/components/mqtt/mqtt-integration.md

View workflow job for this annotation

GitHub Actions / build

Trailing spaces

documentation/builders/components/mqtt/mqtt-integration.md:3:116 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md
control but also integration with home automation systems like Home Assistant.

## Configuration

Set the corresponding setting in `shared\settings\jukebox.yaml` to activate this feature.

``` yaml
modules:
named:
...
mqtt: mqtt
...
mqtt:
enable: true
# The client id used in communication with the MQTT broker and identification of the phoniebox
client_id: phoniebox_dev
# The username to authenticate against the broker
username: phoniebox-dev
# The password to authenticate against the broker
password: phoniebox-dev
# The host name or IP address of your mqtt broker
host: 127.0.0.1
# The port number of the mqtt broker. The default is 1883
port: 1883
```
## Usage in Home Assistant
Home Assistant does not have a native MQTT Media Player integration. To integrate Phoniebox into Home Assistant, you

Check failure on line 32 in documentation/builders/components/mqtt/mqtt-integration.md

View workflow job for this annotation

GitHub Actions / build

Trailing spaces

documentation/builders/components/mqtt/mqtt-integration.md:32:117 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md
can use the Universal Media Player configuration in combination with the Home Assistant MQTT service.
There is also an HACS addon adding Phoniebox as Media Player https://github.com/c0un7-z3r0/hass-phoniebox

Check failure on line 35 in documentation/builders/components/mqtt/mqtt-integration.md

View workflow job for this annotation

GitHub Actions / build

Bare URL used

documentation/builders/components/mqtt/mqtt-integration.md:35:62 MD034/no-bare-urls Bare URL used [Context: "https://github.com/c0un7-z3r0/..."] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md034.md

0 comments on commit 3801f90

Please sign in to comment.