Changes
Commits
| Commit title | Date | Hash |
|---|---|---|
| Add context7 ownership file (#339) | 2026-02-12 11:04:34 +0100 | 7edc221 |
| chore(minor): several minor spelling and consistency fixes (#336) | 2025-12-28 20:37:43 +0100 | 87f877a |
Differences
| v5.0.0 | develop | ||||
|---|---|---|---|---|---|
| n | 3 | version: v5.0.0 | n | 3 | version: develop |
| 4 | releasedate: 11. May 2025 | 4 | releasedate: 12. February 2026 | ||
| n | 67 | MQTT will treat an empty string payload as a "delete" instruction for the topic, therefor an | n | 67 | MQTT will treat an empty string payload as a "delete" instruction for the topic, therefore an |
| n | 168 | A zero length payload published on the `$state` topic indicates a device removal, see [device lifecycle](#device-lifecycle). | n | 168 | A zero length payload published on the `$state` topic indicates a device removal, see [Device Lifecycle](#device-lifecycle). |
| n | 170 | ## Topology and structure | n | 170 | ## Topology and Structure |
| n | 340 | The Property object itself is described in the `homie` / `5` / `device ID` / `$description` JSON document. The Property object has the following fields: | n | 340 | The Property object itself is described in the `homie` / `5` / `[device ID]` / `$description` JSON document. The Property object has the following fields: |
| n | 399 | | boolean | no | `false,true` | Identical to an enum with 2 entries. The first represents the `false` value and the second is the `true` value. Eg. `close,open` or `off,on`. If provided, then both entries must be specified. **Important**: the format does NOT specify valid payloads, they are descriptions of the valid payloads `false` and `true`. | | n | 399 | | boolean | no | `false,true` | Identical to an enum with 2 entries. The first represents the `false` value and the second is the `true` value. Eg. `close,open` or `off,on`. If provided, then both entries must be specified. **Important**: the format does NOT specify valid payloads, they are descriptions of the valid payloads `false` and `true`. | |
| n | 468 | 2. feedback in case a change is not instantaneous (e.g. a light that slowly dimms over a longer period, or a | n | 468 | 2. feedback in case a change is not instantaneous (e.g. a light that slowly dims over a longer period, or a |
| n | 479 | - a controller can only assume that the command it send to the `set` topic was received and accepted. Not necessarily that it will ever reach the target state, since if another controller updates the property again, it might never reach the target state. | n | 479 | - a controller can only assume that the command it sent to the `set` topic was received and accepted. Not necessarily that it will ever reach the target state, since if another controller updates the property again, it might never reach the target state. |
| n | 517 | ## Alert topic | n | 517 | ## Alert Topic |
| n | 524 | A device can raise a message on a specific ID. Once the alert is no longer usefull or has been resolved, it can be removed by deleting the topic. Alerts must be send as retained messages. The alert ID must have a valid [ID format](#topic-ids), where topic ID's starting with `$` are reserved for Homie usage. | n | 524 | A device can raise a message on a specific ID. Once the alert is no longer useful or has been resolved, it can be removed by deleting the topic. Alerts must be sent as retained messages. The alert ID must have a valid [ID format](#topic-ids), where topic ID's starting with `$` are reserved for Homie usage. |
| n | 528 | /homie/5/mydevid/$alert/childlost = "Sensor xyz in livingroom hasn't reported updates for 3 hours" | n | 528 | homie/5/mydevid/$alert/childlost = "Sensor xyz in livingroom hasn't reported updates for 3 hours" |
| 529 | /homie/5/mydevid/$alert/battery = "Battery is low, at 8%" | 529 | homie/5/mydevid/$alert/battery = "Battery is low, at 8%" | ||
| n | 538 | * `homie` / `5` / `$broadcast` / **`[subtopic]`**: where `subtopic` can be any topic with single or multiple levels. Each segement must adhere to the [ID format](#topic-ids). | n | 538 | * `homie` / `5` / `$broadcast` / **`[subtopic]`**: where `subtopic` can be any topic with single or multiple levels. Each segment must adhere to the [ID format](#topic-ids). |
| n | 559 | All log messages send should be non-retained. | n | 559 | All log messages sent should be non-retained. |
| t | 568 | `fatal` | a non-recoverable error occured, operation of the device is likely suspended/stopped | t | 568 | `fatal` | a non-recoverable error occurred, operation of the device is likely suspended/stopped |