Configuration

⚠️ It is recommended (and easier) to use the Homebridge/HOOBS UI plugin settings screen to configure the plugin

Required Settings

Add the following to your configuration file in the appropriate place. The following are the basic required fields.

{
   "name": "Deebot",
   "countryCode": "your-ecovacs-country-code",
   "username": "your-ecovacs-username",
   "password": "your-ecovacs-password",
   "platform": "Deebot"
}

• ⚠️ The "platform": "Deebot" line must not be changed
• You can optionally use a base64-encoded version of your password
• See Country Codes for a list of allowed country codes
• If your account is based in China you should use your ECOVACS ID for your username

Optional Settings

Entry	Type	Default	Explanation
refreshTime	integer	120	An interval (in seconds) in which your devices will refresh with ECOVACS. Must be 30 or more.
disableDeviceLogging	bool	false	Global logging setting for accessory status changes. If true then accessory status changes will not be logged. This can also be set per accessory later in the config.
debug	bool	false	Global logging setting for the plugin. If true then debug information will be added to the log. This can also be set per accessory later in the config.
disablePlugin	bool	false	If true, the plugin will remove all accessories and not load the plugin on restart.
devices	array	[]	An array of objects to define custom options for your Deebot devices. label - This setting has no effect except to help identify this device deviceId - Deebot Device ID. This can be found by restarting Homebridge and inspecting the log line with 'initialised with id %%%' ignoreDevice - If true, this accessory will be removed and ignored from HomeKit hideMotionSensor - If true, the motion sensor for device alerts will be hidden motionDuration - The length of time (in seconds) that the motion detector will be activated if your Deebot sends a message or needs help. The message is viewable in the log. Must be 1 or more lowBattThreshold - The battery percentage at which the plugin should display a low battery status. Leave blank to match the Deebot default of 15%. Must be 1 or more showMotionLowBatt - If true, the motion sensor will activate when the Deebot's battery reaches the low battery threshold showBattHumidity - If true, a humidity sensor showing the battery percentage will be shown overrideLogging - Override global logging setting for this device. Can be default (follows global setting), standard for standard logging, debug for debug logging or disable to disable accessory logging Example: "devices": [ { "deviceId": "E2000000000000000000", "label": "Hoover Device", "hideMotionSensor": false, "motionDuration": 120, "lowBattThreshold": 20, "showMotionLowBatt": false, "showBattHumidity": true, "overrideLogging": "default" } ]