From 3801f90d0b79d1f6172499e7c5f1cd07a07aef14 Mon Sep 17 00:00:00 2001 From: David Kagerer Date: Mon, 9 Dec 2024 16:11:34 +0100 Subject: [PATCH] docs: add mqtt documentation --- .../components/mqtt/mqtt-integration.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 documentation/builders/components/mqtt/mqtt-integration.md diff --git a/documentation/builders/components/mqtt/mqtt-integration.md b/documentation/builders/components/mqtt/mqtt-integration.md new file mode 100644 index 000000000..248f69407 --- /dev/null +++ b/documentation/builders/components/mqtt/mqtt-integration.md @@ -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 +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 +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