-
-
Notifications
You must be signed in to change notification settings - Fork 378
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(vendor.roborock): Add support for the S4 Max (#699)
* Add functionality to run S4 Max Create the configuration for the S4 Max. This robot adds the multimap persistence functionality to the S4 (basically the same as the S5 Max without the mop). This has been tested on my current S4 Max and works correctly. * Setup S4 Max to handle mi iot messages For the properties and events that have been observed, parse out the messages and forward the required parameters to the parseAndUpdateState method to handle updating the state of the robot. With these changes in place, I can complete a cleaning successfully as well as trigger an error by lifting during cleaning and not see any errors in the Valetudo log.
- Loading branch information
1 parent
6e3b462
commit f7eb451
Showing
2 changed files
with
218 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| const RoborockValetudoRobot = require("./RoborockValetudoRobot"); | ||
| const MiioValetudoRobot = require("../MiioValetudoRobot"); | ||
| const capabilities = require("./capabilities"); | ||
| const entities = require("../../entities"); | ||
| const Logger = require("../../Logger"); | ||
|
|
||
| // https://miot-spec.org/miot-spec-v2/instance?type=urn:miot-spec-v2:device:vacuum:0000A006:roborock-a19:1 | ||
| const MIOT_SERVICES = Object.freeze({ | ||
| VACUUM_1: { | ||
| SIID: 2, | ||
| PROPERTIES: { | ||
| STATUS: { | ||
| PIID: 1 | ||
| }, | ||
| DEVICE_FAULT: { | ||
| PIID: 2 | ||
| }, | ||
| MODE: { | ||
| // the spec reports this as 4, but empirically shows up as piid 3 | ||
| PIID: 3 | ||
| } | ||
| }, | ||
| ACTIONS: { | ||
| START: { | ||
| AIID: 1 | ||
| }, | ||
| STOP: { | ||
| AIID: 2 | ||
| }, | ||
| } | ||
| }, | ||
| VACUUM_2: { | ||
| SIID: 8, | ||
| PROPERTIES: { | ||
| CONSUMABLE_ID: { | ||
| PIID: 1 | ||
| }, | ||
| FAILED_REASON: { | ||
| PIID: 2 | ||
| }, | ||
| ERROR_CODE: { | ||
| PIID: 3 | ||
| } | ||
| } | ||
| }, | ||
| BATTERY: { | ||
| SIID: 3, | ||
| PROPERTIES: { | ||
| LEVEL: { | ||
| PIID: 1 | ||
| }, | ||
| CHARGING: { | ||
| PIID: 2 | ||
| } | ||
| }, | ||
| ACTIONS: { | ||
| START_CHARGE: { | ||
| AIID: 1 | ||
| } | ||
| } | ||
| }, | ||
| MAIN_BRUSH: { | ||
| SIID: 9, | ||
| PROPERTIES: { | ||
| PERCENT_LEFT: { | ||
| PIID: 2 | ||
| } | ||
| } | ||
| }, | ||
| SIDE_BRUSH: { | ||
| SIID: 10, | ||
| PROPERTIES: { | ||
| PERCENT_LEFT: { | ||
| PIID: 2 | ||
| } | ||
| } | ||
| }, | ||
| FILTER: { | ||
| SIID: 11, | ||
| PROPERTIES: { | ||
| PERCENT_LEFT: { | ||
| PIID: 2 | ||
| } | ||
| } | ||
| }, | ||
| }); | ||
|
|
||
| class RoborockS4MaxValetudoRobot extends RoborockValetudoRobot { | ||
| /** | ||
| * | ||
| * @param {object} options | ||
| * @param {import("../../Configuration")} options.config | ||
| */ | ||
| constructor(options) { | ||
| super(Object.assign({}, options, {fanSpeeds: FAN_SPEEDS})); | ||
|
|
||
| this.registerCapability(new capabilities.RoborockMapSnapshotCapability({ | ||
| robot: this | ||
| })); | ||
| this.registerCapability(new capabilities.RoborockCombinedVirtualRestrictionsCapability({ | ||
| robot: this | ||
| })); | ||
| this.registerCapability(new capabilities.RoborockMultiMapPersistentMapControlCapability({ | ||
| robot: this | ||
| })); | ||
| this.registerCapability(new capabilities.RoborockMapSegmentationCapability({ | ||
| robot: this | ||
| })); | ||
| } | ||
|
|
||
| getModelName() { | ||
| return "S4 Max"; | ||
| } | ||
|
|
||
| static IMPLEMENTATION_AUTO_DETECTION_HANDLER() { | ||
| const deviceConf = MiioValetudoRobot.READ_DEVICE_CONF(RoborockValetudoRobot.DEVICE_CONF_PATH); | ||
|
|
||
| return !!(deviceConf && deviceConf.model === "roborock.vacuum.a19"); | ||
| } | ||
|
|
||
| onMessage(msg) { | ||
| if (super.onMessage(msg) === true) { | ||
| return true; | ||
| } | ||
|
|
||
| switch (msg.method) { | ||
| case "event_occured": | ||
| msg.params.arguments.forEach(a => { | ||
| return this.handlePropertyChange({ | ||
| siid: msg.params.siid, | ||
| piid: a.piid, | ||
| value: a.value | ||
| }); | ||
| }); | ||
| break; | ||
| case "properties_changed": | ||
| msg.params.forEach(e => { | ||
| this.handlePropertyChange(e); | ||
| }); | ||
| break; | ||
| default: | ||
| return false; | ||
| } | ||
|
|
||
| this.sendCloud({id: msg.id, "result":"ok"}); | ||
| return true; | ||
| } | ||
|
|
||
| handlePropertyChange(msg) { | ||
| switch (msg.siid) { | ||
| case MIOT_SERVICES.VACUUM_1.SIID: | ||
| switch (msg.piid) { | ||
| case MIOT_SERVICES.VACUUM_1.PROPERTIES.STATUS.PIID: | ||
| // if we are paused, we may lose if it is zoned or | ||
| // segment resume, maybe we should skip this? | ||
| this.parseAndUpdateState({ | ||
| in_cleaning: 1, | ||
| state: msg.value, | ||
| }); | ||
| return; | ||
| case MIOT_SERVICES.VACUUM_1.PROPERTIES.DEVICE_FAULT.PIID: | ||
| if (msg.value !== 0) { | ||
| this.parseAndUpdateState({ | ||
| state: 12, // error value | ||
| error_code: msg.value | ||
| }); | ||
| } | ||
| return; | ||
| case MIOT_SERVICES.VACUUM_1.PROPERTIES.MODE.PIID: | ||
| this.parseAndUpdateState({ | ||
| fan_power: msg.value | ||
| }); | ||
| return; | ||
| } | ||
| break; | ||
| case MIOT_SERVICES.VACUUM_2.SIID: | ||
| switch (msg.piid) { | ||
| // error event | ||
| case MIOT_SERVICES.VACUUM_2.PROPERTIES.ERROR_CODE.PIID: | ||
| this.parseAndUpdateState({ | ||
| state: 12, // error value | ||
| error_code: msg.value | ||
| }); | ||
| return; | ||
| case MIOT_SERVICES.VACUUM_2.PROPERTIES.CONSUMABLE_ID.PIID: // consumable reminder event | ||
| case MIOT_SERVICES.VACUUM_2.PROPERTIES.FAILED_REASON.PIID: // schedule cancled event | ||
| return; | ||
| } | ||
| break; | ||
| case MIOT_SERVICES.BATTERY.SIID: | ||
| switch (msg.piid) { | ||
| case MIOT_SERVICES.BATTERY.PROPERTIES.LEVEL.PIID: | ||
| this.parseAndUpdateState({ | ||
| battery: msg.value | ||
| }); | ||
| return; | ||
| } | ||
| break; | ||
| case MIOT_SERVICES.MAIN_BRUSH.SIID: | ||
| case MIOT_SERVICES.SIDE_BRUSH.SIID: | ||
| case MIOT_SERVICES.FILTER.SIID: | ||
| // the consumables only reports percent through this property, ignore | ||
| return; | ||
| } | ||
| Logger.info("Unknown property change message received:", JSON.stringify(msg)); | ||
| } | ||
| } | ||
|
|
||
| const FAN_SPEEDS = { | ||
| [entities.state.attributes.IntensityStateAttribute.VALUE.LOW]: 101, | ||
| [entities.state.attributes.IntensityStateAttribute.VALUE.MEDIUM]: 102, | ||
| [entities.state.attributes.IntensityStateAttribute.VALUE.HIGH]: 103, | ||
| [entities.state.attributes.IntensityStateAttribute.VALUE.MAX]: 104, | ||
| [entities.state.attributes.IntensityStateAttribute.VALUE.OFF] : 105 //also known as mop mode | ||
| }; | ||
|
|
||
| module.exports = RoborockS4MaxValetudoRobot; |