diff --git a/README.md b/README.md index f39485d..123ab32 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ --- -description: Companion app +description: Effortlessly manage your Linux machine --- # 🌩 LNXlink diff --git a/SUMMARY.md b/SUMMARY.md index 052958e..5e43b5a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -3,6 +3,6 @@ * [🌩 LNXlink](README.md) * [🖥 Setup](setup.md) * [🎬 Media Player](media-player.md) -* [🤯 Examples](examples.md) -* [🚗 Automations](automations.md) +* [🔱 Modules Usage](examples.md) +* [🤯 Automations](automations.md) * [🛠 Development](development.md) diff --git a/automations.md b/automations.md index b8d2cb8..4b54609 100644 --- a/automations.md +++ b/automations.md @@ -1,30 +1,8 @@ -# 🚗 Automations +--- +description: These are automation ideas that are really useful when Working From Home +--- -## Set unavailable after shutdown - -Just before LNXlink stops, it sends to MQTT an OFF command, but sometimes it doesn't stop gracefully. To fix this, you will have to create an automation on Home Assistant which checks for when was the last time one of the sensors got a value and if it exceeds it sends the OFF command to the MQTT server. - -This is an example of the automation which checks events for the idle sensor: - -```yaml -alias: lnxlink powered down -description: "" -mode: single -trigger: - - platform: template - value_template: >- - {{ (now() | as_timestamp - - states.sensor.desktop_linux_idle.last_changed | as_timestamp) > - 10 }} -condition: [] -action: - - service: mqtt.publish - data: - qos: 0 - retain: true - topic: lnxlink/desktop-linux/lwt - payload: "OFF" -``` +# 🤯 Automations ## Pause media playback when I am on the phone diff --git a/development.md b/development.md index bb53810..ba38230 100644 --- a/development.md +++ b/development.md @@ -1,10 +1,14 @@ -# 🛠 Development +--- +description: >- + You can easily create your own modules for exposing any sensor you want for + controlling or monitoring it. +--- -## Programming +# 🛠 Development ### How to start -Create a python app which starts with the class Addon: +Create a python app `yourmodule.py` with a unique name which starts with the class Addon: ```python class Addon(): diff --git a/examples.md b/examples.md index b10b730..121fccc 100644 --- a/examples.md +++ b/examples.md @@ -1,4 +1,10 @@ -# 🤯 Examples +--- +description: >- + These modules are not created using the autodiscovery or they need to be + combined with others to work. +--- + +# 🔱 Modules Usage ## Voice Assistant @@ -921,3 +927,39 @@ card: +## Install Update + +When a new version of LNXlink is available the update sensor on Home Assistant activates the INSTALL button, but when you are using the development installation this option doesn't get activated. You can manually send the MQTT topic to start the update: + +```yaml +service: mqtt.publish +data: + topic: lnxlink/desktop-linux/commands/update/update +``` + +## Set unavailable after shutdown + +Just before LNXlink stops, it sends to MQTT an OFF command, but sometimes it doesn't stop gracefully. To fix this, you will have to create an automation on Home Assistant which checks for when was the last time one of the sensors got a value and if it exceeds it sends the OFF command to the MQTT server. + +This is an example of the automation which checks events for the idle sensor: + +```yaml +alias: lnxlink powered down +description: "" +mode: single +trigger: + - platform: template + value_template: >- + {{ (now() | as_timestamp - + states.sensor.desktop_linux_idle.last_changed | as_timestamp) > + 10 }} +condition: [] +action: + - service: mqtt.publish + data: + qos: 0 + retain: true + topic: lnxlink/desktop-linux/lwt + payload: "OFF" +``` + diff --git a/media-player.md b/media-player.md index 24e706f..a3e3efa 100644 --- a/media-player.md +++ b/media-player.md @@ -1,3 +1,7 @@ +--- +description: Control your media +--- + # 🎬 Media Player MQTT integration for a media player is not supported by home assistant, so a custom addon must be installed using HACS. I've modified an addon called [mqtt-mediaplayer](https://github.com/bkbilly/hass-mqtt-mediaplayer) for creating a new media\_player entity. diff --git a/setup.md b/setup.md index f5aa27e..e8ac04d 100644 --- a/setup.md +++ b/setup.md @@ -1,3 +1,7 @@ +--- +description: Get started with LNXlink +--- + # 🖥 Setup ## Installation