warden
v.1.2.5
A simple background service that remotely controls Windows over MQTT.
Table of Contents
├── .github
├── .gitignore
├── README.md
├── go.mod
├── go.sum
├── main.go
├── docs
│ └── README.md
├── control
│ ├── power
│ │ └── power.go
│ ├── app
│ │ └── app.go
│ └── sound
│ └── sound.go
├── tools
│ ├── configurator
│ │ └── configurator.go
│ └── logger
│ └── logger.go
├── tray
│ ├── tray.go
│ │
│ └── icon.go
├── mosquitto
│ ├── mosquitto.go
│ │
│ └── sensors.go
└── configs
└── config.yaml
A brief description of the layout:
README.md is a detailed description of the project.go.mod is a detailed reference manual for module system in this project.go.sum is a detailed file of the checksum of direct and indirect dependency required by the module.main.go is main file of programm.docs contains project documentations.control contains main packages for interaction with Win 10 API, each subdirectory of control is a main package.mosquitto contains mqtt logic package.tray contains system tray app logic package.tools contains yaml configurator and logger packages.configs contains example of config.yaml file.If you use binary file:
Windows 10If you use source code:
Windows 10Go 1.18 or greaterDownload either EXE or GO file from Releases page and execute it:
warden.exe
go run main.go (if you wanna start it from source files)
Configuration parameters must be placed in configuration files in the working directory from where you launch Warden.
| Property | Description | Example | Mandatory |
|---|---|---|---|
| broker | URL of the MQTT broker | 127.0.0.1 | yes |
| username | Username to MQTT broker | admin | yes |
| password | Password to MQTT broker | password | yes |
| apps | Apps list for turning off | app.exe | no |
Warden will look for this file in the current working directory (directory from where you launched Warden). If there is no conf file Warnen will create default file. Change this file or create config.yaml file and put desired parameters into it. Or just copy an example of this file from config folder in the repo.
Example file:
broker: 127.0.0.1
username: admin
password: password
apps:
- game.exe
- app.exe
By the way, Warden will validate you config before starting and notice you whether you forget something!
CLI have the same parametres as config file plus one added and if you forget one of params Warden will use default one.
| Property | Description | Flag | Default |
|---|---|---|---|
| no debug | turns off debug mode | -n / --nodebug | none |
| config | overrides config.yaml data with cli config | -c / --config | none |
| broker | URL of the MQTT broker | -b / --broker | localhost |
| username | Username to MQTT broker | -u / --user | admin |
| password | Password to MQTT broker | -p / --pass | admin |
(!!!)You must use config flag if you want to override config.yaml(!!!)
Example:
warden.exe -n
warden.exe -c -n -b 192.168.1.1 -u sasha -p password
warden.exe --cli --nodebug --broker 192.168.1.1 --user sasha --pass 12345678
warden.exe -c -n --broker 192.168.1.1 --user sasha -p 12345678
Warden starts logging immediately after launch. It makes warden.log file in the current working directory and overwrite file every 7 days
The payload of all messages is either raw string or a valid JSON element (possibly a primitive, like a single integer).
Example valid message payloads:
0100truetest stringPC_HOSTNAME is system name of your Windows pc.Topic: warden/PC_HOSTNAME/status/online
Payload: bool
Persistent: yes
true - alive, false - dead.
Topic: warden/PC_HOSTNAME/status/volume
Payload: int in range 0-100
Persistent: no
Send current master volume status every 3 seconds.
Topic: warden/PC_HOSTNAME/status/muted
Payload: bool
Persistent: no
Send current mute status every 5 seconds.
PC_HOSTNAME is system name of your Windows pc.Topic: warden/PC_HOSTNAME/commands/shutdown
Payload: -
Trigger immediate system shutdown.
Topic: warden/PC_HOSTNAME/commands/reboot
Payload: -
Trigger immediate system reboot.
Topic: warden/PC_HOSTNAME/commands/sleep
Payload: -
Trigger immediate system sleep.
Topic: warden/PC_HOSTNAME/commands/volume
Payload: int in range 0-100
Trigger changes master volume of system.
Topic: warden/PC_HOSTNAME/commands/mute
Payload: boolean
"true" - trigger mutes system volume. "false" - trigger unmutes system volume.
Topic: warden/PC_HOSTNAME/commands/apps
Payload: string
"config" - turns off all of apps from config file "app.exe" - turns off any specified app
You can build it by yourself.
go build -o bin/warden.exe -ldflags "-H windowsgui"
I will gladly add new stuff, if anyone will request!
Changelog
Copyright 2022 Alexandra Chichko <[email protected]>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
