[ecovacs] Allow loading device descriptions from a user file (#14873)
* [ecovacs] Allow loading device descriptions from a user file If a new device is released within our release cycle, getting the description for that device into the binding was impossible for users before. With this change, they can create an override file in their installation (with contents we'll need to supply to them), which serves as a stop-gap solution until the next OH release. Signed-off-by: Danny Baumann <dannybaumann@web.de>
This commit is contained in:
@@ -173,3 +173,20 @@ Bridge ecovacs:ecovacsapi:ecovacsapi [ email="your.email@provider.com", password
|
||||
}
|
||||
```
|
||||
|
||||
## Adding support for unsupported models
|
||||
|
||||
When encountering an unsupported model during discovery, the binding creates a log message like this one:
|
||||
|
||||
```
|
||||
2023-04-21 12:02:39.607 [INFO ] [acs.internal.api.impl.EcovacsApiImpl] - Found unsupported device DEEBOT N8 PRO CARE (class s1f8g7, company eco-ng), ignoring.
|
||||
```
|
||||
|
||||
In such a case, please [create an issue on GitHub](https://github.com/openhab/openhab-addons/issues), listing the contents of the log line.
|
||||
In addition to that, if the model is similar to an already supported one, you can try to add the support yourself (until getting an updated binding).
|
||||
For doing so, you can follow the following steps:
|
||||
|
||||
- create the folder `<OPENHAB_USERDATA>/evocacs` (if not done previously)
|
||||
- create a file named `custom_device_descs.json`, whose format of that file is the same as [the built-in device list](https://raw.githubusercontent.com/openhab/openhab-addons/main/bundles/org.openhab.binding.ecovacs/src/main/resources/devices/supported_device_list.json)
|
||||
- for a model that is very similar to an existing one, create an entry with `modelName`, `deviceClass` (from the log line) and `deviceClassLink` (`deviceClass` of the similar model)
|
||||
- for other models, you can also try experimenting with creating a full entry, but it's likely that the binding code will need to be updated in that case
|
||||
|
||||
|
||||
Reference in New Issue
Block a user