Skip to content

Commit

Permalink
chore(release): 2024.02.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Hypfer committed Feb 14, 2024
1 parent ad236b5 commit 13f3f65
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 4 deletions.
82 changes: 82 additions & 0 deletions docs/_pages/integrations/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down Expand Up @@ -863,6 +867,84 @@ Home Assistant components controlled by this property:



### Valetudo Events <a id="valetudoevents" />

*Node*

#### Events (`valetudo_events`) <a id="eventsvaletudoevents" />

*Property, readable, retained*

This property contains all raised and not yet processed ValetudoEvents.

- Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/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`) <a id="interactwitheventsvaletudoeventsinteract" />

*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: `<TOPIC PREFIX>/<IDENTIFIER>/ValetudoEvents/valetudo_events/interact/set`
- Command response topic: `<TOPIC PREFIX>/<IDENTIFIER>/ValetudoEvents/valetudo_events/interact`
- Data type: [string](https://homieiot.github.io/specification/#string) (JSON)





### Status <a id="status" />

#### Attachment state (`AttachmentStateAttribute`) <a id="attachmentstateattachmentstateattribute" />
Expand Down
2 changes: 1 addition & 1 deletion docs/_pages/usage/implementation-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -1083,4 +1083,4 @@ Capability | <a href='#dreame_1c'>1C</a> | <a href='#dreame_1t'>1T</a> | <a href

<br/><br/><br/><br/><br/>
This page has been autogenerated.<br/>
Autogeneration timestamp: 2024-01-26T15:28:20.211Z
Autogeneration timestamp: 2024-02-14T19:35:19.836Z
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 13f3f65

Please sign in to comment.