2 unstable releases

0.3.0 Sep 27, 2022
0.2.0 Jun 6, 2021

#957 in Hardware support

28 downloads per month

MIT license

52KB
1.5K SLoC

desktop2mqtt

A daemon to integrate any pc into your home automation system. Primarily intended for Home Assistant.

Configuration

Place a config.yml file in your working directory with the following contents:

mqtt:
  url: mqtt://<your broker ip/domain>
  username: <your broker username> # optional
  password: <your broker password> # optional
hass:
  entity_id: desktop # will be used to build the different sensors
  name: Max Desktop # will be used for the friendly name of the sensors
modules:
  idle:
    timeout: 5min # duration until this device is reported as unoccupied
    poll_rate: 5s # duration to poll for user input  while the device is unoccupied (optional)
  backlight: none # backlight provider to use (one of: none, stub, raspberry-pi)
  notifications: true # enables notification sending via /desktop2mqtt/entity_id/notify with `{ "title": "", "message": "" }` as payload
  sensors:
    poll_rate: 1s # sensor update rate
    types: # sensors to report
      - type: load
      - type: memory
      - type: core-temperature
      - type: disk-usage
        disks:
          - /
          - /mnt/games
      - type: battery
  custom_commands: # exposed as buttons to home assistant
    - name: Disable HDMI
      command: xrandr --output HDMI-0 --off
      icon: mdi:television-off # optional

Dependencies

~12–50MB
~767K SLoC