Valetudo
@mgreten/valetudov2026.07.27.1
01README
Discover, monitor, and safely control capability-aware Valetudo robot vacuums through their Homie MQTT interface.
02Models
@mgreten/valetudov2026.07.27.1valetudo.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| brokerUrl | string | MQTT broker URL, such as mqtt://broker:1883 |
| username? | string | Optional MQTT username |
| password? | string | Optional MQTT password; use a Swamp vault expression |
| topicPrefix | string | Valetudo MQTT topic prefix |
| identifier | string | Valetudo MQTT robot identifier |
| connectTimeoutMs | number | |
| readTimeoutMs | number | |
| publishTimeoutMs | number |
fn discover()
Discover the capabilities and properties advertised by Valetudo
fn getStatus()
Read a normalized snapshot from Valetudo's retained MQTT state
fn action(action: enum, segmentIds?: array, iterations: number, customOrder?: boolean, capability?: string, property?: string, value?: string)
Validate and publish a supported Valetudo robot action
| Argument | Type | Description |
|---|---|---|
| action | enum | |
| segmentIds? | array | Segment IDs for clean-segments |
| iterations | number | |
| customOrder? | boolean | |
| capability? | string | Capability ID for set-property |
| property? | string | Property ID for set-property |
| value? | string | Property payload for set-property |
Resources
discovery(7d)— Valetudo Homie capability and property metadata
status(7d)— Current retained Valetudo robot status
actionResult(7d)— A command successfully validated and published to Valetudo
03Stats
A
100 / 100
Downloads
0
Archive size
212.6 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
04Platforms
05Labels