stuomas / disorient

Control a Windows PC using MQTT or WebSocket

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Disorient is an application that integrates your Windows PCs to your IoT fleet. It allows you to control various things over MQTT or a WebSocket. It is meant to coexist with home automation software like Home-Assistant to automatically perform tasks when a specific activity happens.

Some example use cases include

  • DIY auto-pivot for a display. Build an Arduino/ESP with a tilt sensor and send Disorient a message when the display should be turned and to what orientation. This was the original purpose of the application.
  • Change selected display orientation using global hotkeys CTRL + ALT + <arrow key>.
  • Switch places of primary and secondary displays when starting to play games to allow fullscreen games to be played on your home theatre that would normally be the secondary display.
  • Switch the default audio output device between headphones/speakers/theatre, for example when starting a gaming activity, or when your wireless headphones do not automatically become default when turned on (looking at you, Arctis).
  • Launch a script or an application or execute PowerShell commands.

Installation

No installation required. Launch the executable, choose settings and forget. Download latest pre-built executable from releases or build from sources.

Usage

Input is accepted from a MQTT broker or a WebSocket server.

In the settings tab, set up the connection to your MQTT broker or WebSocket server, or both. In payload mapping section, select what incoming text payload runs what function. More information about available functions and their arguments in Payload mapping.

Payload mapping

Map any text coming from MQTT or WebSocket server to a function of choice. The function list below explains what arguments are needed.

Functions

Rotate screen (index, angle)

Rotates the display of given index to given angle. Angle can only be 0, 90, 180, or 270. Get the correct index from the display list in the Help tab. If all your displays are called Generic PnP Monitor it just means you have not installed the manufacturer's driver, or there isn't any, and it probably doesn't matter, their corresponding indices stay the same.

For example setting a following mapping

Payload Function Arguments
set_portrait_1 Rotate screen (index, angle) 0,90

sets your first listed display to portrait mode when "set_portrait_1" message arrives from a subscribed MQTT topic or a WebSocket server.

Arrange displays (index1, index2)

Swap places of two displays, the index1 becoming primary display and index2 non-primary, maintaining the same layout as set in Windows display settings. Get the correct indices from the display list in the Help tab. Not sure how well this works with more than two displays, let me know if it needs tweaking.

Set audio device (name)

Set default (active) audio device. Get the correct name from the audio list in the Help tab, in exactly same format. This is the name that can be given to the device in Windows Sound Control Panel. Give the devices simple nicknames to make your life easier.

Run executable (path, args)

Run a script or an executable. Give the full path as argument. If the executable takes arguments, add them as comma-separated list in args. Notice that if you want to run executables from System32 folder, you might need to use Sysnative virtual folder instead of System32, for example C:\Windows\Sysnative\DisplaySwitch.exe[1].

Allow keyword arguments in payloads

Checking this option allows you to add keyword arguments to your incoming payload in the form of a query string, for example mypayload?key1=value1,key2=value2,key3=value3 and so forth. The keys can be named freely. The keywords can then be referred in the arguments field with $keyname.

Execute unrecognized payloads

Checking Attempt to execute unrecognized payloads in PowerShell will blindly try to execute any incoming payload that is not mapped to a function. This is dangerous, so use only if your systems are secure and you know what you are doing. It is better to write a script and use the Run script function. Checking Publish output will publish the standard output/error of the attempt in <chosen_topic>/powershell/response.

Responses

When the function has run, a response will be published in topic <chosen_topic>/<payload_name>/response with a message, which in some cases is empty. For WebSocket, a text message with the format <payload_name>/response/message is sent back to the server. The response can be used as an acknowledgement that the command was received and executed.

Screenshots

Development

The current state of the application is "it works on my machine". If you have bugs to report or features to request, please do so.

For developing and building from sources, I recommend setting up Qt Creator, static build of Qt 5.15.0, and 64-bit MSVC 2019 compiler. You also need to add a static build of QtMqtt, since it is not included by default. Happy to give more details if you face troubles.


About

Control a Windows PC using MQTT or WebSocket

License:GNU Lesser General Public License v3.0


Languages

Language:C++ 98.4%Language:QMake 1.6%