Home assistant управление windows

Понадобилось мне добавить в Home Assistant свой игровой PC. А именно возможность включения и выключения.

Возможность включение я разберу в другой статье, а в этой расскажу про выключение.

Быстрое гугление наводит на:

net rpc shutdown

Но я использую Home Assistant в Hass.io на малинке, а там не так просто доустановить отсутствующие утилиты. Нужен был способ исключительно на Python.

Я нашёл интересную библиотеку pypsexec и решил оформить её в виде компонента HA. Библиотека создаёт исполняемые exe-шники в папке Windows и запускает их через службы Windows, которые так же создаёт. Я решил немного поправить этот подход и обойтись только созданием служб Windows. Вот что получилось:

/config/custom_components/psexec/__init__.py

«»» Компонент добавляет службу `psexec.exec` удаленного выполнения команд на компьютерах Windows через протокол `SMB 2`. В момент выполнения на удалённом компьютере создаётся и запускается служба Windows, выполняющая указанную команду. По завершению выполнения служба удаляется. Удалённый пользователь должен быть администратором. Если на удалённом компьютере включен UAC — необходимо внести правки в реестр: «` Windows Registry Editor Version 5.00 [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System] «LocalAccountTokenFilterPolicy»=dword:00000001 «` Если удалённый Windows старый (например win7) — необходимо указывать параметр `encrypt=false`. Подробности тут: https://pypi.org/project/pypsexec/ Пример использования (создаст в корне диска C файл out.txt): «` script: smb_remote: sequence: — service: psexec.exec data: host: 192.168.1.123 username: user password: pass encrypt: false command: cmd.exe /c echo Hello World > c:\out.txt «` Для засыпания компьютера необходимо отправить команду: «` cmd.exe /c start /b shutdown.exe /h «` — `cmd.exe /c` — выполняет далее указанную команду (для start нет exe файла) — `start /b` — запускает следующую команду в фоне (нельзя дожидаться окончания выполнения shutdown — мы его не дождёмся) — `shutdown.exe /h` — отправляет компьютер в сон (или гибернацию в зависимости от настроек компьютера) Компонент протестирован в HA на Windows и в Hass.io на Raspberry Pi 3. «»» import logging _LOGGER = logging.getLogger(__name__) DOMAIN = «psexec» def setup(hass, config): def exec(call): import uuid from smbprotocol.connection import Connection from smbprotocol.session import Session from pypsexec.scmr import Service host = call.data.get(‘host’) username = call.data.get(‘username’) password = call.data.get(‘password’) encrypt = call.data.get(‘encrypt’, True) command = call.data.get(‘command’) try: connection = Connection(uuid.uuid4(), host) connection.connect() session = Session(connection, username, password, require_encryption=encrypt) session.connect() service = Service(‘HomeAssistant’, session) service.open() try: service.create(command) except: _LOGGER.exception(«Can’t create service») try: service.start() except: # Произвольный EXE-файл не может быть полноценной Службой, # поэтому даже при успешном выполнении мы будем получать ошибку pass try: service.delete() except: _LOGGER.exception(«Can’t delete service») service.close() connection.disconnect() except: _LOGGER.exception(f»Can’t connect to: «) hass.services.register(DOMAIN, ‘exec’, exec) return True

/config/custom_components/psexec/manifest.json

{ «domain»: «psexec», «name»: «PsExec», «documentation»: «https://www.home-assistant.io/», «dependencies»: [], «codeowners»: [ «AlexxIT» ], «requirements»: [ «pypsexec» ] }

Для появления соотвествующей службы в Home Assistant необходимо включить компонент в configuration.yaml

psexec:

Пример использования и краткое описание приведены в комментариях к коду.

Конечно компонент можно использовать не только для удалённого выключения компьютера, а для совершенно разнообразных целей.

Table of contents

The main element of the manual is an example of hibernation setting with HASS WS, I will also show you how to set the computer to turn on using Wake on LAN (WOL). It is an application that allows you to manage your COMPUTER using home assistant, such as locking your PC, restarting, hibernating your COMPUTER, remotely monitoring gpu load.

It also provides useful sensors in the Home Assistant, such as:

• CPU Load – CPULoad,
• Processor Clock – CurrentClockSpeed,
• Start-up time – LastBootTime,
• Microphone display – MicrophoneActive,
• The current sound intensity from the system,
• GPU load,
• The amount of RAM consumed.

Setting this up allows you to create amazing automations to manage your laptop, computer or workstation.

Examples

• Hibernate, turn off your computer remotely, or turn on your TV or console,
• Press your computer when you turn on your TV, console, or connect to your phone.
• Turn on the light for a video call (when the camera is active),
• Send notifications to the Home Assistant mobile app under heavy CPU, GPU or Ram load,
• Sound control.

Requirements

• Home Assistant Server
• Windows 10 on the PC we want to control
• MQTT broker installed, configured in Home Assistant (you need to know the password for it).

It works by installing a service in Windows (which runs in the background) and communicates with the MQTT broker you have configured in your Home Assistant.

Installation and manual to control your PC

You can download the program from here: https://hassworkstationstorage.z6.web.core.windows.net/publish/setup.exe

You’ll see a blue “Windows Protected your PC” screen. This is because the user .exe a certificate without a digital signature from a known certification center (i.e. its own).

Click More Information > Still Run. If you don’t have .NET 5.0.1 installed, you’ll be prompted to install it. You will then receive a “Publisher cannot be verified” warning.

Картинка с сайта: cooltronic.pl

Картинка с сайта: cooltronic.pl

Картинка с сайта: cooltronic.pl

When finished, the application will start automatically. Now it’s time to set up the program.

Initial configuration settings

Before you configure the settings, make sure that the hass-workstation-service.exe is running.You can check this in Task Manager > details.

Картинка с сайта: cooltronic.pl

Configure settings with Home Assistant

Add a Home Assistant IP address (mine is http://192.168.68.124:8123/) The broker’s default port is 1883.

Type the user name and password into the MQTT of a broker, disable the “Use TLS” option, turn on Startup to start the service with the old computer. Finally, save your settings with the Save button.

Картинка с сайта: cooltronic.pl

Картинка с сайта: cooltronic.pl

Картинка с сайта: cooltronic.pl

After you change the state from NormalDisconnection to connected, you can start adding sensors. This part is obvious, just click add and select a sensor or command from the drop-down list. Then they will be available in the Home Assistant as entities.

Set remote hibernation in Windows

Select CustomCommand by typing in the Command field “shutdown / h“, the name field is the name that will be available as an entity e.g. in the Lovelace interface. To prevent your computer from waking up for no reason, set“Only allow a magic packet to wake the computer”. The device manager disables mouse and keyboard wake-up (HIF devices).

Картинка с сайта: cooltronic.pl

When you press the the added button, your computer will be put to sleep.

Wake on LAN in Home Assistant

The “Enable” button is shown in the hibernation preview screenshot, this is an option to turn on the computer from the Home Assistant, it is useful for remote startup of the computer and e.g. a connection to the remote RDP desktop or chrome remote desktop.

In the configuration.yaml file,add a switch with the mac address of the network adapter, enable the option in the network adapter settings nt. WOL (Magic Packet), sometimes there is an option to resume the computer from sleep modes.

Want to monitor Windows computers in your Home-Assistant setup? Maybe even control them to some degree? Then IOT Link is probably the easiest and fastest way to do it. It is a background service that is communicating with Home-Assistant (or other) by MQTT.
I have tested this on Windows 10 and 11, and it works the same way on both, might even work on other versions of Windows.

In this post I will go trough the full setup, but I will not go trough all the more advanced features of the software. This is a little how-to/demonstration.

MQTT Broker

Before following this guide you will need a MQTT broker and MQTT configured with auto discovery in Home-Assistant. If this is in place you can ignore this step.

The easiest way to set this up is with the Mosquitto Add-On in Home-Assistant.

• Go to Supervisor -> Add-on Store
• Select Mosquitto broker under Official add-ons
• Click INSTALL
• You can set a username/password in the Configuration tab, this is optional.
• Click START
• Go to Configuration -> Integrations.
• MQTT will show as “Discovered” (If not add a new integration and search for “MQTT”).
• Select CONFIGURE
  Done.

IOT Link: Download and installation

• Go to https://iotlink.gitlab.io/downloads.html and downlaod the last version of IOT link, At the time of writing this post the last version is IOT Link – v2.2.2 (released 2020-10-08)
• When the download is complete right-click the setup file and select “Run as administrator” (input Windows administrator credentials if prompted for)
• Microsoft Defender SmartScreen will pop up and block the installation, click “More info” and then “Run anyway”
• During installation just keep alt default and complete the setup like in the pictures below.

• 

  Картинка с сайта: flemmingss.com

• 

  Картинка с сайта: flemmingss.com

• 

  Картинка с сайта: flemmingss.com

• 

  Картинка с сайта: flemmingss.com

• 

  Картинка с сайта: flemmingss.com

• 

  Картинка с сайта: flemmingss.com

When the setup is done and the message “Service is installed successfully.” comes up click OK, the installation is complete.

A Windows service called IOT Link is now installed, this is now running, and it will automatic start with windows.
It can be found and managed by running services.msc in Windows. (Not needed if there is no issue)

IOT Link: Basic configuration

The installation is done, it is time to connect it to the MQTT, and in the same process to Home-Assistant (Here I assume M MQTT configured with auto discovery is up and working in Home-Assistant).

Open the mine configuration file, C:\ProgramData\IOTLink\Configs\configuration.yaml in a text-editor, (eg notepad).
Most of the settings can be default (or changed at your own preference), but the following options should be edited:

• Under mqtt: -> credentials: -> username: and password: set MQTT broker user/password (if there is a user set up, else leave blank).
• Under mqtt: -> tcp: set enabled: to true, hostname: to the ip of your MQTT broker (Same as Home-Assistant if Add-On), and port: to the MQTT port, 1883 is default in Mosquitto.
• Under mqtt: -> messages: set retain: to true.

When done, save the file. IOT Link will Automatic ly import the new settings and start to publish to MQTT. If there is no issue Home-Assistant should be populated with new entities pretty fast.

Картинка с сайта: flemmingss.com

Service Calls

One of the other nice features of IOT Link is the ability to control the remove Windows computer in different ways. This can be done by sending mqtt.publish service calls in Home-Assistant. There is a whole lot of things that can be accomplished but here I have a few examples. This is in Home-Assistant done under Developer Tools -> Services.
Change “workgroup” and “flemming-laptop” according to too actual values.

Reboot the remote computer:

service: mqtt.publish
data:
  topic: "iotlink/workgroup/flemming-laptop/commands/reboot"
  payload: ""

Run Windows Media Player on the remote computer:

service: mqtt.publish
data:
  topic: "iotlink/workgroup/flemming-laptop/commands/run"
  payload: '{ "command": "C:\\Program Files (x86)\\Windows Media Player\\wmplayer.exe", "path": "C:\\Program Files (x86)\\Windows Media Player\\", "user": "", "visible": true, "fallback": true }'

Send a notification, and a link to this website to the remote computer:

service: mqtt.publish
data:
  topic: "iotlink/workgroup/flemming-laptop/commands/notify"
  payload: '{ "title": "This is a test", "message": "Click here to go to flemmingss.com", "launchParams": "toast://open/http://flemmingss.com" }'

Картинка с сайта: flemmingss.com

More can be found at this page: https://gitlab.com/iotlink/iotlink/-/wikis/Addons/Commands

That’s It. I hope the post was useful 🙂