sia-server, branch v0.1.0IoT backend serverhttps://cgit.xengineering.eu/sia-server/atom?h=v0.1.02025-12-20T14:38:31ZRelease version 0.1.02025-12-20T14:38:31Zxengineeringme@xengineering.eu2025-12-20T14:38:31Zurn:sha1:b3092e759896ec038e6b42ee2310036fedcde41f
This is the first release of the Sia server. It is the Minimal Viable
Product (MVP).
README.md: Adhere to Semver / define public API2025-12-20T14:33:19Zxengineeringme@xengineering.eu2025-12-20T14:33:19Zurn:sha1:15a634093351f91b7bbaa68ccd9d0a2965eab6d1
This project should use semantic versioning. This requires defining the
public Application Programming Interface (API).
README.md: Add usage instructions2025-12-20T14:28:23Zxengineeringme@xengineering.eu2025-12-20T14:28:23Zurn:sha1:9db4822c5b0991b0c19c3bb028110449a6ce8b82Add CHANGELOG.md2025-12-20T14:23:33Zxengineeringme@xengineering.eu2025-12-20T14:23:33Zurn:sha1:134991968b8661aef17468aa3358af29a21b9f32README.md: Add build instructions2025-12-20T14:18:15Zxengineeringme@xengineering.eu2025-12-20T14:18:15Zurn:sha1:71ffe1112b2d1312157c42b90908fb4cdb6308b5Deploy README.md2025-12-20T14:13:17Zxengineeringme@xengineering.eu2025-12-20T14:13:17Zurn:sha1:f2e6dee6000258c95b5e0e52a9e17fafc35f6a5b
This information is useful in the deploy tar archive. Thus it is copied
there.
Add README with description and hardware support2025-12-20T14:08:32Zxengineeringme@xengineering.eu2025-12-20T14:08:32Zurn:sha1:248fc6d1ef0a40c691a341589c5327f7e995ef14Do not print start banner on usage2025-12-20T14:03:33Zxengineeringme@xengineering.eu2025-12-20T14:03:33Zurn:sha1:fe3d36791e3fa97d4f03639b6c7f8a2d61e28a0b
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.
systemd: Add service and sysusers configuration files2025-12-20T13:59:15Zxengineeringme@xengineering.eu2025-12-20T13:59:15Zurn:sha1:b1bd87926098e03ffd983666d0746055122854fd
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.
Deploy default configuration2025-12-20T13:54:42Zxengineeringme@xengineering.eu2025-12-20T13:54:42Zurn:sha1:5f3cd750b2867854a1e05f66312062426024f676
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.
Add Meson-tracked project version2025-12-20T13:50:28Zxengineeringme@xengineering.eu2025-12-20T13:50:28Zurn:sha1:b9ae3f51309ff0b38e7291239a0334e8df76b9d1
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.
configs: .gitignore: Add `debug.json`2025-12-20T13:45:32Zxengineeringme@xengineering.eu2025-12-20T13:45:32Zurn:sha1:228230b6018194b4fb4ca902a772d97b6fab787f
This is reserved foooooooooor local development.
Add tar archive generation for deployment2025-12-20T13:40:31Zxengineeringme@xengineering.eu2025-12-20T13:40:31Zurn:sha1:e66f5b43a41283ddf4c4dae10e3b32e1fa0be077
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.
Make GOOS and GOARCH part of executable name2025-12-20T13:35:45Zxengineeringme@xengineering.eu2025-12-20T13:35:45Zurn:sha1:e4eeebd12a41b65da02087d93e19ee719723fd8b
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.
Disable log timestamps2025-12-20T13:30:37Zxengineeringme@xengineering.eu2025-12-20T13:30:37Zurn:sha1:c76a967bce0bb182ae2a5d81f5bd940869aa464f
The primary target environment is a systemd-based Linux system. There
the logging system of the operating system will timestamp the log
messages.
Add startup config logging2025-12-20T13:25:45Zxengineeringme@xengineering.eu2025-12-20T13:25:45Zurn:sha1:0dc4bea01a2f51b8a1c8f8b8c586e040c065fe38
This is useful during early development to make possible
misconfiguration visible.
Later it might be dropped especially if the config gets larger.
Implement passing user configuration2025-12-20T13:20:42Zxengineeringme@xengineering.eu2025-12-20T13:20:42Zurn:sha1:167772b87698cce479090dbe5bd3d1cc7c1bc808
This allows overwriting values of the default configuration with custom
ones.
Add StartupConfiguration.Validate()2025-12-20T13:15:58Zxengineeringme@xengineering.eu2025-12-20T13:15:58Zurn:sha1:d429f3a7dbe8fc8cc43ebe565b6130b1cfce4ea1
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.
Use default config2025-12-20T13:11:13Zxengineeringme@xengineering.eu2025-12-20T13:11:13Zurn:sha1:224d52d1033d8ccce5087c9bee5a63457830a13a
The default config JSON is embedded as bytes into the executable.
Instead of constants the default values are now parsed from these
embedded bytes.
Add default config parsing2025-12-20T13:06:34Zxengineeringme@xengineering.eu2025-12-20T13:06:34Zurn:sha1:d6fa255b1df26a12329a614601a027e074aabeb2
This is a first step towards configurability.
Add Meson target `test` for unit testing2025-12-20T13:01:51Zxengineeringme@xengineering.eu2025-12-20T13:01:51Zurn:sha1:ba367f41077be88338db981c88802d7292ac7013Implement <prefix>/server/health2025-12-20T12:57:21Zxengineeringme@xengineering.eu2025-12-20T12:57:21Zurn:sha1:c6249f96b09d9862f160c439ac8a97a92edb8228
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.
Implement Homematic reconnects2025-12-20T12:53:06Zxengineeringme@xengineering.eu2025-12-20T12:53:06Zurn:sha1:576e1bf2300e7a324713710871d9bcd5424ff286
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.
Separate Homematic code2025-12-20T12:47:56Zxengineeringme@xengineering.eu2025-12-20T12:47:56Zurn:sha1:6978bf0635372b0330629469fb86ddb640cdd863
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.
Add MQTT keepalives2025-12-20T12:43:31Zxengineeringme@xengineering.eu2025-12-20T12:43:31Zurn:sha1:58d7c51baa053be8d6d4ec5f409fceef1c7c11b5
This issues ping request / response messages between the Sia server and
the MQTT broker making sure an interrupted connection is noticed.
Implement MQTT reconnects2025-12-20T12:38:14Zxengineeringme@xengineering.eu2025-12-20T12:38:14Zurn:sha1:bfd7b70c927d60242fb77b9b58a7c7aad73cf1bc
This is a central requirement to ensure a restart of the MQTT broker
does not harm the Sia server operation.
Log MQTT disconnect2025-12-20T12:32:55Zxengineeringme@xengineering.eu2025-12-20T12:32:55Zurn:sha1:12198f4d921eb6406d08a122e2e51971bf65e7fa
This makes connection loss visible during debugging.
Separate MQTT logic2025-12-20T12:27:42Zxengineeringme@xengineering.eu2025-12-20T12:27:42Zurn:sha1:96299467958aaffdbef5cb8ae780d3abeddfcaba
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.
Raise to QoS 12025-12-20T12:23:17Zxengineeringme@xengineering.eu2025-12-20T12:23:17Zurn:sha1:faf9fb7a8c5e8b31e9c1104b42d7e550e986ca61
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.
Switch ClientId to `siaserver`2025-12-20T12:18:55Zxengineeringme@xengineering.eu2025-12-20T12:18:55Zurn:sha1:2b4b4235d692b32f5dc18e1fda39917365857336
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