sia-server - IoT backend server

Age	Commit message (Collapse)	Author
2 days	Add README with description and hardware support	xengineering

2 days	Do not print start banner on usage	xengineering
	Before this commit the start banner `+++ Started Sia server +++` was printed before the usage instructions. The stop banner was not printed. The intended behaviour is to print none of them. This is not implemented.
2 days	systemd: Add service and sysusers configuration files	xengineering
	This makes it possible to run the Sia server executable on systemd-based Linux distributions with systemd making system administration easier. Maintaining these files in the source instead of packaging repository was decided since systemd is the dominant init system across Linux distributions and thus not every distribution-specific packaging repo needs to re-invent the wheel.
2 days	Deploy default configuration	xengineering
	The default configuration from the source tree is embedded into the executable with Go's embed package to assume the correct defaults. Furthermore it is now also part of the artifact tar archive to give users an idea how a configuration file should look like.
2 days	Add Meson-tracked project version	xengineering
	This allows to use the version of the project in the build system independent from the version control system. Thus a source tar archive can be built the same and also changing the version control system does not change anything regarding the build process.
2 days	configs: .gitignore: Add `debug.json`	xengineering
	This is reserved foooooooooor local development.
2 days	Add tar archive generation for deployment	xengineering
	Bundling all build artifacts into one tar archive is good practise to make deployment easier and underline which files in the build directory are important. zstd was picked for compression because of the very good compression ratio.
2 days	Make GOOS and GOARCH part of executable name	xengineering
	This renames `sia-server` to `sia-server-linux-amd64`. This makes clear for which target environment the executable is built and allows to later place additional executables for other environments too without name collisions.
2 days	Disable log timestamps	xengineering
	The primary target environment is a systemd-based Linux system. There the logging system of the operating system will timestamp the log messages.
2 days	Add startup config logging	xengineering
	This is useful during early development to make possible misconfiguration visible. Later it might be dropped especially if the config gets larger.
2 days	Implement passing user configuration	xengineering
	This allows overwriting values of the default configuration with custom ones.
2 days	Add StartupConfiguration.Validate()	xengineering
	This method makes it easy to validate a configuration. A call of it is now embedded into the StartupConfiguration.FromJSON() method which should always be the lowest level function to parse configurations. Thus configurations can usually be trusted.
2 days	Use default config	xengineering
	The default config JSON is embedded as bytes into the executable. Instead of constants the default values are now parsed from these embedded bytes.
2 days	Add default config parsing	xengineering
	This is a first step towards configurability.
2 days	Add Meson target `test` for unit testing	xengineering

2 days	Implement <prefix>/server/health	xengineering
	This indicates if the Sia server is available and connected to the MQTT broker. Using the MQTT Will messages these will also be sent if the Sia server unexpectedly crashes. Using the retained flag it is ensured that freshly connected MQTT clients will receive these messages even when they missed the initial one from the Sia server.
2 days	Implement Homematic reconnects	xengineering
	This is as simple as do not handling errors on state polling. It ensures the server does not panic when the connection to the OpenCCU is temporarily not alive.
2 days	Separate Homematic code	xengineering
	Similar to a previous refactoring of the MQTT-related code this removes all Homematic logic to a dedicated file. The only connection to the outside is the `tx chan MQTTMessage` channel and the `HomematicRun()` function. This makes the code more modular.
2 days	Add MQTT keepalives	xengineering
	This issues ping request / response messages between the Sia server and the MQTT broker making sure an interrupted connection is noticed.
2 days	Implement MQTT reconnects	xengineering
	This is a central requirement to ensure a restart of the MQTT broker does not harm the Sia server operation.
2 days	Log MQTT disconnect	xengineering
	This makes connection loss visible during debugging.
2 days	Separate MQTT logic	xengineering
	This reduces the coupling between the MQTT-related code and everything else to a single `tx` channel of type `MQTTMessage`. This improves the code quality significantly.
2 days	Raise to QoS 1	xengineering
	This ensures the state updates reach the broker. QoS 2 is not required since multiple reception of the same state will not make a difference.
2 days	Switch ClientId to `siaserver`	xengineering
	The old version `sia-server` was problematic since the MQTT specification [1] ensures only this list of valid characters: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ For every other character the broker might support this or not. [1]: https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718031
2 days	Update payload for contact states	xengineering
	`true` and `false` are bad values to describe a contact state. `open` and `closed` make much more sense.
2 days	Publish state in retained mode	xengineering
	This ensures the MQTT broker caches the state when it is sent by Sia and sends it via MQTT to new MQTT clients. Thus no state polling is required by the MQTT client.
2 days	Reduce polling period to 50 ms	xengineering
	The human reaction time is roughly 100 ms. The Nyquist-Shannon sampling theorem [1] is used for an approximation how often it is required to sample without humans noticing any delays. [1]: https://en.wikipedia.org/wiki/Nyquist%E2%80%93Shannon_sampling_theorem
2 days	Add cache implementation	xengineering
	This avoids frequent MQTT messages containing the same state.
2 days	Add continuous polling execution	xengineering
	This state polls the device states with 500 milliseconds period and publishes the state on every poll.
2 days	Refactor with Poll() function	xengineering
	This function allows to reduce the lines of code in main() further.
2 days	Refactor with Start() and Stop()	xengineering
	This reduces the lines of code of the main() function significantly and groups all start and stop actions.
2 days	Add logging for init and de-init steps	xengineering
	This helps to debug potential issues.
2 days	Run go fmt	xengineering

2 days	Refactor MQTT connect / disconnect	xengineering

2 days	Change topic structure	xengineering
	The new structure for the contact states is the following. <prefix>/contact/<id>/state The reasoning is: - `<prefix>` allows using multiple (Sia) services on the same broker - `contact` as device type indicates contact-specific semantics - `<id>` makes different contacts distinguishable - `state` is the actual payload
2 days	Change topic prefix to `sia`	xengineering
	The old prefix `sia-server` was longer and not completely correct. The topics under this prefix never belong more to the server or the clients. Thus only `sia` seams to be a good solution.
2 days	Refactor with OPENCCU constant	xengineering
	This unifies the HOST and PORT constants used so far and removes the need for a fmt.Sprintf() call.
2 days	Publish contact state with MQTT	xengineering
	This demonstrates the ability to take information from the Homematic system to MQTT. It is a major proof of concept step towards a minimal viable product (MVP) Sia server.
2 days	Add github.com/eclipse/paho.mqtt.golang	xengineering
	This dependency is required to use MQTT with Go.
12 days	Adopt homematic-go example	xengineering
	This requests a list of devices from the Homematic central device and then queries the state of every `SHUTTER_CONTACT`. This is a good starting point for the server logic.
12 days	Add homematic-go v0.1.0	xengineering
	This is the minimal viable product (MVP) of this library suitable to build the MVP of the sia-server.
12 days	Add Go module xengineering.eu/sia-server	xengineering
	This allows to add dependencies to this Go project.
14 days	Add Meson build system	xengineering
	Meson as a general purpose build system is mightier than what the Go tool can provide. Furthermore it makes it possible to unify build, run and other workflows across projects with different languages.
14 days	Add hello world as main.go	xengineering
	This is just a minimal starting point for the repository.
14 days	Add AGPL as LICENSE.txt	xengineering