🔱Modules Usage

These modules are not created using the autodiscovery, need manual setup or they need to be combined with others to work.

Notification

Send Notification

Sends a notification with a title and message. The other options are optional:

• iconUrl: It can be a URL or a local icon.

• sound: It can be a WAV file from a URL, a local WAV file or a named sound.

• urgency: Available values are low, normal, critical.

• timeout: Duration in milliseconds the notification disappears. This is ignored by GNOME Shell and Notify OSD.

• buttons: A list of buttons that should appear on the notification.

service: notify.send_message
target:
  entity_id: notify.desktop_linux_desktop_linux
data:
  message: >-
    { "title": "Notification Title",
      "message": "Testing notification",
      "iconUrl": "http://hass.local:8123/local/myimage.jpg",
      "sound": "http://hass.local:8123/local/mysound.wav",
      "urgency": "normal",
      "timeout": 1000,
      "buttons": ["Open Image"] }

Close notification

Since some distributions do not support automatic timeouts, an option is available to manually close notifications. Providing an ID is optional; if specified, only that particular notification will be dismissed. If no ID is provided, all notifications sent by LNXlink will be closed.

action: notify.send_message
target:
  entity_id: notify.desktop_linux_desktop_linux
data:
  message: >-
    {
      "action": "close",
      "id": 10
    }

Button Action

You can create an automation that is triggered when the button is pressed. In this example, it will use the xdg_open module to open the image.

alias: LNXlink notification button
trigger:
  - platform: mqtt
    topic: lnxlink/desktop-linux/monitor_controls/notify/button_press
    payload: Open Image
    value_template: "{{ value_json.button }}"
condition: []
action:
  - service: text.set_value
    metadata: {}
    data:
      value: "{{ trigger.payload_json['hints'].get('image-path') }}"
    target:
      entity_id: text.desktop_linux_xdg_open

RESTful

This could be used as an alternative to MQTT for getting information or controlling the system using HTTP requests by exposing a configurable port which by default is 8112.

Endpoints

• GET /status Retrieves a list of available modules that support info data.

• GET /status/<module> Get information from the provided module.

• GET, POST /control Retrieves a list of available modules that support control.

• POST /control/<module> Form request data:

  • topic: <module>_<controlname>, eg. systemd_anydesk

  • message: data to send, eg. off

Usage

• GET Requests Use GET requests to fetch information. For example, to obtain the current status, send a request to the /status endpoint.

• POST Requests Use POST requests to send commands and perform actions. Ensure that the POST requests include necessary payload data to specify the action to be performed.

Configuration

The RESTful API is accessible through a configurable port, with the default being 8112. You can modify this setting in the LNXlink configuration file to suit your network requirements.

Statistics

It is used to send basic information of the app to gather daily usage per version.

The data is sent after 15 minutes of startup and then every 24 hours. Only some basic information is sent which includes UUID (a unique identifier that is generated and stored when first used) and the version of the app.

The server is a CloudFlare Worker that stores the data sent by the app including the date and the country the request originated from.

The statistics server is configurable under the configuration file of LNXlink, so you can use your own analytics server. By setting the URL to null or excluding the statistics module, you can disable it from sending any data.

Voice Assistant

The Speech Recognition module listens to the user's input and sends the response as an attribute to the binary sensor of speech recognition entity.

For the automation to work you will need to setup the Media Player.

LNXlink Speech Recognition

Set the volume to the desired level and then if a successful speech is recognized it is sent to the conversation agent of Home Assistant to run. The result is then sent as an audio to the host machine.

alias: LNXlink Speech Recognition
mode: single
trigger:
  - platform: state
    entity_id:
      - binary_sensor.desktop_linux_speech_recognition
    from: "off"
    to: "on"
condition: []
action:
  - variables:
      volume: "{{ state_attr('media_player.desktop_linux', 'volume_level') }}"
  - service: media_player.volume_set
    data:
      volume_level: 0.15
    target:
      entity_id: media_player.desktop_linux
  - wait_for_trigger:
      - platform: state
        entity_id:
          - binary_sensor.desktop_linux_speech_recognition
        to: "off"
  - if:
      - condition: not
        conditions:
          - condition: state
            entity_id: binary_sensor.desktop_linux_speech_recognition
            attribute: speech
            state: "\"\""
    then:
      - service: conversation.process
        data:
          agent_id: homeassistant
          text: >-
            {{ state_attr('binary_sensor.desktop_linux_speech_recognition',
            'speech') }}
        response_variable: agent
  - service: media_player.volume_set
    data:
      volume_level: "{{ volume }}"
    target:
      entity_id: media_player.desktop_linux
  - service: tts.speak
    data:
      cache: true
      media_player_entity_id: media_player.desktop_linux
      message: "{{ agent.response.speech.plain.speech }}"
    target:
      entity_id: tts.piper

Turn PC On or Off

Combine with Wake on Lan to control your PC with one switch:

switch:
  - platform: template
    switches:
      my_pc:
        friendly_name: "My PC"
        unique_id: my_pc
        value_template: "{{ not is_state('button.shutdown', 'unavailable') }}"
        turn_on:
          service: switch.turn_on
          data:
            entity_id: switch.pc_wol
        turn_off:
          service: button.press
          data:
            entity_id: button.shutdown

Open a URL or File

service: mqtt.publish
data:
  topic: lnxlink/desktop-linux/commands/xdg_open
  payload: "https://www.google.com"  # or "myimg.jpeg" for file

Keys Send

Send a series of keys:

service: mqtt.publish
data:
  topic: lnxlink/desktop-linux/commands/send_keys
  payload: "ctrl+f H e l l o space W o r l d"  

You can create a virtual keyboard on your frontend:

Lovelace Card Config Letters

type: conditional
conditions:
  - entity: input_boolean.keyboard_switch
    state: 'off'
  - entity: text.desktop_linux_bash_command
    state: unknown
card:
  type: vertical-stack
  cards:
    - square: true
      type: grid
      cards:
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: q
          entity: text.desktop_linux_send_keys
          name: Q
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: w
          entity: text.desktop_linux_send_keys
          name: W
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: e
          entity: text.desktop_linux_send_keys
          name: E
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: r
          entity: text.desktop_linux_send_keys
          name: R
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: t
          entity: text.desktop_linux_send_keys
          name: T
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: 'y'
          entity: text.desktop_linux_send_keys
          name: 'Y'
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: u
          entity: text.desktop_linux_send_keys
          name: U
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: i
          entity: text.desktop_linux_send_keys
          name: I
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: o
          entity: text.desktop_linux_send_keys
          name: O
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: p
          entity: text.desktop_linux_send_keys
          name: P
          hold_action:
            action: more-info
      columns: 10
    - square: true
      type: grid
      cards:
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: a
          entity: text.desktop_linux_send_keys
          name: A
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: s
          entity: text.desktop_linux_send_keys
          name: S
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: d
          entity: text.desktop_linux_send_keys
          name: D
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: f
          entity: text.desktop_linux_send_keys
          name: F
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: g
          entity: text.desktop_linux_send_keys
          name: G
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: h
          entity: text.desktop_linux_send_keys
          name: H
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: j
          entity: text.desktop_linux_send_keys
          name: J
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: k
          entity: text.desktop_linux_send_keys
          name: K
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: l
          entity: text.desktop_linux_send_keys
          name: L
          hold_action:
            action: more-info
        - show_name: false
          show_icon: true
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: BackSpace
          entity: text.desktop_linux_send_keys
          hold_action:
            action: more-info
          icon: mdi:backspace-outline
      columns: 10
    - square: true
      type: grid
      columns: 10
      cards:
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: z
          entity: text.desktop_linux_send_keys
          name: Z
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: x
          entity: text.desktop_linux_send_keys
          name: X
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: c
          entity: text.desktop_linux_send_keys
          name: C
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: v
          entity: text.desktop_linux_send_keys
          name: V
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: b
          entity: text.desktop_linux_send_keys
          name: B
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: 'n'
          entity: text.desktop_linux_send_keys
          name: 'N'
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: m
          entity: text.desktop_linux_send_keys
          name: M
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: comma
          entity: text.desktop_linux_send_keys
          name: ','
          hold_action:
            action: more-info
        - show_name: true
          show_icon: false
          type: button
          tap_action:
            action: call-service
            service: text.set_value
            target:
              entity_id: text.desktop_linux_send_keys
            data:
              value: period
          entity: text.desktop_linux_send_keys
          name: .
          hold_action:
            action: more-info
    - type: horizontal-stack
      cards:
        - square: false
          type: grid
          columns: 1
          cards:
            - show_name: false
              show_icon: true
              type: button
              tap_action:
                action: toggle
              entity: input_boolean.keyboard_switch
              icon: ''
              icon_height: 30px
              show_state: false
        - square: true
          type: grid
          columns: 2
          cards: []
        - square: false
          type: grid
          columns: 1
          cards:
            - show_name: false
              show_icon: true
              type: button
              tap_action:
                action: call-service
                service: text.set_value
                target:
                  entity_id: text.desktop_linux_send_keys
                data:
                  value: space
              entity: text.desktop_linux_send_keys
              name: Space
              icon: mdi:keyboard-space
              icon_height: 30px
              hold_action:
                action: more-info
        - square: true
          type: grid
          columns: 2
          cards: []
        - square: false
          type: grid
          columns: 1
          cards:
            - show_name: false
              show_icon: true
              type: button
              tap_action:
                action: call-service
                service: text.set_value
                target:
                  entity_id: text.desktop_linux_send_keys
                data:
                  value: Return
              entity: text.desktop_linux_send_keys
              name: Enter
              hold_action:
                action: more-info
              icon: mdi:keyboard-return
              icon_height: 30px

Lovelace Card Config Symbols

type: conditional
conditions:
  - entity: input_boolean.keyboard_switch
    state: 'on'
  - entity: text.desktop_linux_bash_command
    state: unknown
card:
  square: true
  type: grid
  columns: 7
  cards:
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: Escape
      entity: text.desktop_linux_send_keys
      name: Esc
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '1'
      entity: text.desktop_linux_send_keys
      name: '1'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '2'
      entity: text.desktop_linux_send_keys
      name: '2'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '3'
      entity: text.desktop_linux_send_keys
      name: '3'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: slash
      entity: text.desktop_linux_send_keys
      name: /
      hold_action:
        action: more-info
    - show_name: false
      show_icon: true
      icon: mdi:arrow-up
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: Up
      entity: text.desktop_linux_send_keys
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: backslash
      entity: text.desktop_linux_send_keys
      name: \
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: Tab
      entity: text.desktop_linux_send_keys
      name: Tab
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '4'
      entity: text.desktop_linux_send_keys
      name: '4'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '5'
      entity: text.desktop_linux_send_keys
      name: '5'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '6'
      entity: text.desktop_linux_send_keys
      name: '6'
      hold_action:
        action: more-info
    - show_name: false
      show_icon: true
      icon: mdi:arrow-left
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: Left
      entity: text.desktop_linux_send_keys
      hold_action:
        action: more-info
    - show_name: false
      show_icon: true
      icon: mdi:arrow-down
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: Down
      entity: text.desktop_linux_send_keys
      hold_action:
        action: more-info
    - show_name: false
      show_icon: true
      icon: mdi:arrow-right
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: Right
      entity: text.desktop_linux_send_keys
      hold_action:
        action: more-info
    - show_name: false
      show_icon: true
      type: button
      tap_action:
        action: toggle
      entity: input_boolean.keyboard_switch
      icon: ''
      icon_height: 30px
      show_state: false
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '7'
      entity: text.desktop_linux_send_keys
      name: '7'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '8'
      entity: text.desktop_linux_send_keys
      name: '8'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: '9'
      entity: text.desktop_linux_send_keys
      name: '9'
      hold_action:
        action: more-info
    - show_name: true
      show_icon: false
      type: button
      tap_action:
        action: call-service
        service: text.set_value
        target:
          entity_id: text.desktop_linux_send_keys
        data:
          value: 0
      entity: text.desktop_linux_send_keys
      name: '0'
      hold_action:
        action: more-info

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:

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:

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"