diff --git a/docs/_pages/integrations/mqtt.md b/docs/_pages/integrations/mqtt.md index 5f364554010..2ef97e24747 100644 --- a/docs/_pages/integrations/mqtt.md +++ b/docs/_pages/integrations/mqtt.md @@ -111,6 +111,9 @@ Homie autodiscovery info is best viewed with something like [MQTT Explorer](http - [Robot Error (`error`)](#roboterrorerror) - [Status (`status`)](#statusstatus) - [Status flag (`flag`)](#statusflagflag) + - [Valetudo Events](#valetudoevents) + - [Events (`valetudo_events`)](#eventsvaletudoevents) + - [Interact with Events (`valetudo_events/interact`)](#interactwitheventsvaletudoeventsinteract) ### State attributes index @@ -131,6 +134,7 @@ Homie autodiscovery info is best viewed with something like [MQTT Explorer](http - [Current Statistics Time (`sensor.mqtt`)](#currentstatisticstimetime) - [Dust bin attachment (`binary_sensor.mqtt`)](#dustbindustbin) - [Error (`sensor.mqtt`)](#vacuumstatusstatusstateattribute) +- [Events (`sensor.mqtt`)](#eventsvaletudoevents) - [Fan (`select.mqtt`)](#fanpreset) - [Map data (`camera.mqtt`)](#rawmapdataforhomeassistantmap-data-hass) - [Map segments (`sensor.mqtt`)](#mapsegmentssegments) @@ -863,6 +867,84 @@ Home Assistant components controlled by this property: +### Valetudo Events + +*Node* + +#### Events (`valetudo_events`) + +*Property, readable, retained* + +This property contains all raised and not yet processed ValetudoEvents. + +- Read topic: `//ValetudoEvents/valetudo_events` +- Data type: [string](https://homieiot.github.io/specification/#string) (JSON) + +Sample value: + +```json +{ + "6ac59c61-349b-4c18-9e4f-f89be959ba19": { + "__class": "ErrorStateValetudoEvent", + "metaData": {}, + "id": "6ac59c61-349b-4c18-9e4f-f89be959ba19", + "timestamp": "2024-02-14T19:35:20.283Z", + "processed": false, + "message": "This is an error message" + }, + "pending_map_change": { + "__class": "PendingMapChangeValetudoEvent", + "metaData": {}, + "id": "pending_map_change", + "timestamp": "2024-02-14T19:35:20.283Z", + "processed": false + }, + "mop_attachment_reminder": { + "__class": "MopAttachmentReminderValetudoEvent", + "metaData": {}, + "id": "mop_attachment_reminder", + "timestamp": "2024-02-14T19:35:20.283Z", + "processed": false + }, + "e8061d9a-a8d8-4438-8186-600eeee456f9": { + "__class": "DustBinFullValetudoEvent", + "metaData": {}, + "id": "e8061d9a-a8d8-4438-8186-600eeee456f9", + "timestamp": "2024-02-14T19:35:20.283Z", + "processed": false + } +} +``` + +Home Assistant components controlled by this property: + +- Events ([`sensor.mqtt`](https://www.home-assistant.io/integrations/sensor.mqtt/)) + + + +#### Interact with Events (`valetudo_events/interact`) + +*Property, command, not retained* + +Note that the interaction payload is event-specific, but for most use-cases, the example should be sufficient. + +Sample payload for a dismissible event (e.g. an ErrorStateValetudoEvent): + +```json +{ + "id": "b89bd27c-5563-4cfd-87df-2f23e8bbeef7", + "interaction": "ok" +} +``` + +- Command topic: `//ValetudoEvents/valetudo_events/interact/set` +- Command response topic: `//ValetudoEvents/valetudo_events/interact` +- Data type: [string](https://homieiot.github.io/specification/#string) (JSON) + + + + + ### Status #### Attachment state (`AttachmentStateAttribute`) diff --git a/docs/_pages/usage/implementation-overview.md b/docs/_pages/usage/implementation-overview.md index c2420f20477..9067d510202 100644 --- a/docs/_pages/usage/implementation-overview.md +++ b/docs/_pages/usage/implementation-overview.md @@ -1083,4 +1083,4 @@ Capability | 1C | 1T |



This page has been autogenerated.
-Autogeneration timestamp: 2024-01-26T15:28:20.211Z +Autogeneration timestamp: 2024-02-14T19:35:19.836Z diff --git a/package-lock.json b/package-lock.json index 708e0cb1423..23a8253c0e8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "valetudo", - "version": "2023.12.0", + "version": "2024.02.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "valetudo", - "version": "2023.12.0", + "version": "2024.02.0", "license": "Apache-2.0", "workspaces": [ "backend", diff --git a/package.json b/package.json index 479748a64ed..ccc5031be0c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "valetudo", - "version": "2023.12.0", + "version": "2024.02.0", "description": "Self-contained control webinterface for vacuum robots", "license": "Apache-2.0", "engines": {