demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

[miio] allow for device remarks in the readme from json db (#8676)

Browse Source 
* [miio] allow for device remarks in the readme from json db
* Update bundles/org.openhab.binding.miio/src/test/java/org/openhab/binding/miio/internal/ReadmeHelper.java

Signed-off-by: Marcel Verpaalen marcel@verpaalen.com
This commit is contained in:
Marcel 2020-10-07 00:04:36 +02:00 committed by GitHub
parent 3403216154
commit 782a4210a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 113 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
bundles/org.openhab.binding.miio/README.md
View File

@ -140,10 +140,10 @@ or in case of unknown models include the model information e.g.:
| Xiaomi Mijia Smart Tower Fan | miio:basic | [dmaker.fan.p9](#dmaker-fan-p9) | Yes | |
| Xiaomi Mijia Smart Tower Fan | miio:basic | [dmaker.fan.p10](#dmaker-fan-p10) | Yes | |
| Viomi Internet refrigerator iLive | miio:unsupported | viomi.fridge.v3 | No | |
| Mi Smart Home Gateway v1 | miio:basic | [lumi.gateway.v1](#lumi-gateway-v1) | Yes | |
| Mi Smart Home Gateway v2 | miio:basic | [lumi.gateway.v2](#lumi-gateway-v2) | Yes | |
| Mi Smart Home Gateway v3 | miio:basic | [lumi.gateway.v3](#lumi-gateway-v3) | Yes | |
| Xiaomi Mi Mijia Gateway V3 ZNDMWG03LM | miio:basic | [lumi.gateway.mgl03](#lumi-gateway-mgl03) | Yes | |
| Mi Smart Home Gateway v1 | miio:basic | [lumi.gateway.v1](#lumi-gateway-v1) | Yes | Used to control the gateway itself. Use the mihome binding to control devices connected to the Xiaomi gateway. Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Smart Home Gateway v2 | miio:basic | [lumi.gateway.v2](#lumi-gateway-v2) | Yes | Used to control the gateway itself. Use the mihome binding to control devices connected to the Xiaomi gateway. Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Smart Home Gateway v3 | miio:basic | [lumi.gateway.v3](#lumi-gateway-v3) | Yes | Used to control the gateway itself. Use the mihome binding to control devices connected to the Xiaomi gateway. Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Xiaomi Mi Mijia Gateway V3 ZNDMWG03LM | miio:basic | [lumi.gateway.mgl03](#lumi-gateway-mgl03) | Yes | Used to control the gateway itself. Use the mihome binding to control devices connected to the Xiaomi gateway. Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Humdifier | miio:basic | [zhimi.humidifier.v1](#zhimi-humidifier-v1) | Yes | |
| Light Control (Wall Switch) | miio:unsupported | lumi.ctrl_neutral1.v1 | No | |
| Light Control (Wall Switch) | miio:unsupported | lumi.ctrl_neutral2.v1 | No | |
@ -206,21 +206,21 @@ or in case of unknown models include the model information e.g.:
| Mijia 1 Gang Wall Smart Switch (WIFI) - PTX switch | miio:basic | [090615.switch.xswitch01](#090615-switch-xswitch01) | Yes | |
| Mijia 2 Gang Wall Smart Switch (WIFI) - PTX switch | miio:basic | [090615.switch.xswitch02](#090615-switch-xswitch02) | Yes | |
| Mijia 3 Gang Wall Smart Switch (WIFI) - PTX switch | miio:basic | [090615.switch.xswitch03](#090615-switch-xswitch03) | Yes | |
| Mi Water Purifier v1 | miio:basic | [yunmi.waterpurifier.v1](#yunmi-waterpurifier-v1) | Yes | |
| Mi Water Purifier v2 | miio:basic | [yunmi.waterpurifier.v2](#yunmi-waterpurifier-v2) | Yes | |
| Mi Water Purifier v3 | miio:basic | [yunmi.waterpurifier.v3](#yunmi-waterpurifier-v3) | Yes | |
| Mi Water Purifier v4 | miio:basic | [yunmi.waterpurifier.v4](#yunmi-waterpurifier-v4) | Yes | |
| Mi Water Purifier lx2 | miio:basic | [yunmi.waterpuri.lx2](#yunmi-waterpuri-lx2) | Yes | |
| Mi Water Purifier lx3 | miio:basic | [yunmi.waterpuri.lx3](#yunmi-waterpuri-lx3) | Yes | |
| Mi Water Purifier lx4 | miio:basic | [yunmi.waterpuri.lx4](#yunmi-waterpuri-lx4) | Yes | |
| Mi Water Purifier lx5 | miio:basic | [yunmi.waterpuri.lx5](#yunmi-waterpuri-lx5) | Yes | |
| Mi Water Purifier lx6 | miio:basic | [yunmi.waterpuri.lx6](#yunmi-waterpuri-lx6) | Yes | |
| Mi Water Purifier lx7 | miio:basic | [yunmi.waterpuri.lx7](#yunmi-waterpuri-lx7) | Yes | |
| Mi Water Purifier lx8 | miio:basic | [yunmi.waterpuri.lx8](#yunmi-waterpuri-lx8) | Yes | |
| Mi Water Purifier lx9 | miio:basic | [yunmi.waterpuri.lx9](#yunmi-waterpuri-lx9) | Yes | |
| Mi Water Purifier lx10 | miio:basic | [yunmi.waterpuri.lx10](#yunmi-waterpuri-lx10) | Yes | |
| Mi Water Purifier lx11 | miio:basic | [yunmi.waterpuri.lx11](#yunmi-waterpuri-lx11) | Yes | |
| Mi Water Purifier lx12 | miio:basic | [yunmi.waterpuri.lx12](#yunmi-waterpuri-lx12) | Yes | |
| Mi Water Purifier v1 | miio:basic | [yunmi.waterpurifier.v1](#yunmi-waterpurifier-v1) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier v2 | miio:basic | [yunmi.waterpurifier.v2](#yunmi-waterpurifier-v2) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier v3 | miio:basic | [yunmi.waterpurifier.v3](#yunmi-waterpurifier-v3) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier v4 | miio:basic | [yunmi.waterpurifier.v4](#yunmi-waterpurifier-v4) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx2 | miio:basic | [yunmi.waterpuri.lx2](#yunmi-waterpuri-lx2) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx3 | miio:basic | [yunmi.waterpuri.lx3](#yunmi-waterpuri-lx3) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx4 | miio:basic | [yunmi.waterpuri.lx4](#yunmi-waterpuri-lx4) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx5 | miio:basic | [yunmi.waterpuri.lx5](#yunmi-waterpuri-lx5) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx6 | miio:basic | [yunmi.waterpuri.lx6](#yunmi-waterpuri-lx6) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx7 | miio:basic | [yunmi.waterpuri.lx7](#yunmi-waterpuri-lx7) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx8 | miio:basic | [yunmi.waterpuri.lx8](#yunmi-waterpuri-lx8) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx9 | miio:basic | [yunmi.waterpuri.lx9](#yunmi-waterpuri-lx9) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx10 | miio:basic | [yunmi.waterpuri.lx10](#yunmi-waterpuri-lx10) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx11 | miio:basic | [yunmi.waterpuri.lx11](#yunmi-waterpuri-lx11) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Mi Water Purifier lx12 | miio:basic | [yunmi.waterpuri.lx12](#yunmi-waterpuri-lx12) | Yes | Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses |
| Xiaomi Wifi Extender | miio:unsupported | xiaomi.repeater.v2 | No | |
| Mi Internet Speaker | miio:unsupported | xiaomi.wifispeaker.v1 | No | |
| Xiaomi Mijia Whale Smart Toilet Cover | miio:basic | [xjx.toilet.pro](#xjx-toilet-pro) | Yes | |

23
bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/basic/DeviceMapping.java
View File

@ -42,6 +42,12 @@ public class DeviceMapping {
@SerializedName("channels")
@Expose
private List<MiIoBasicChannel> miIoBasicChannels = new ArrayList<>();
@SerializedName("readmeComment")
@Expose
private @Nullable String readmeComment;
@SerializedName("experimental")
@Expose
private @Nullable Boolean experimental;
public List<String> getId() {
return id;
@ -76,4 +82,21 @@ public class DeviceMapping {
public void setChannels(List<MiIoBasicChannel> miIoBasicChannels) {
this.miIoBasicChannels = miIoBasicChannels;
}
public String getReadmeComment() {
final String readmeComment = this.readmeComment;
return (readmeComment != null) ? readmeComment : "";
}
public void setReadmeComment(String readmeComment) {
this.readmeComment = readmeComment;
}
public @Nullable Boolean getExperimental() {
return experimental;
}
public void setExperimental(Boolean experimental) {
this.experimental = experimental;
}
}

107
bundles/org.openhab.binding.miio/src/main/resources/database/lumi.gateway.json
View File

@ -24,58 +24,59 @@
]
},
{
"property": "doorbell_volume",
"friendlyName": "Doorbell Volume",
"channel": "doorbellVol",
"type": "Number",
"refresh": true,
"actions": [
{
"command": "set_doorbell_volume",
"parameterType": "NUMBER"
}
]
},
{
"property": "gateway_volume",
"friendlyName": "Gateway Volume",
"channel": "gatewayVol",
"type": "Number",
"refresh": true,
"actions": [
{
"command": "set_gateway_volume",
"parameterType": "NUMBER"
}
]
},
{
"property": "alarming_volume",
"friendlyName": "Alarming Volume",
"channel": "alarmingVol",
"type": "Number",
"refresh": true,
"actions": [
{
"command": "set_alarming_volume",
"parameterType": "NUMBER"
}
]
},
{
"property": "doorbell_push",
"friendlyName": "Doorbell Push",
"channel": "doorbellPush",
"type": "String",
"refresh": true,
"actions": [
{
"command": "set_doorbell_push",
"parameterType": "STRING"
}
]
}
]
"property": "doorbell_volume",
"friendlyName": "Doorbell Volume",
"channel": "doorbellVol",
"type": "Number",
"refresh": true,
"actions": [
{
"command": "set_doorbell_volume",
"parameterType": "NUMBER"
}
]
},
{
"property": "gateway_volume",
"friendlyName": "Gateway Volume",
"channel": "gatewayVol",
"type": "Number",
"refresh": true,
"actions": [
{
"command": "set_gateway_volume",
"parameterType": "NUMBER"
}
]
},
{
"property": "alarming_volume",
"friendlyName": "Alarming Volume",
"channel": "alarmingVol",
"type": "Number",
"refresh": true,
"actions": [
{
"command": "set_alarming_volume",
"parameterType": "NUMBER"
}
]
},
{
"property": "doorbell_push",
"friendlyName": "Doorbell Push",
"channel": "doorbellPush",
"type": "String",
"refresh": true,
"actions": [
{
"command": "set_doorbell_push",
"parameterType": "STRING"
}
]
}
],
"readmeComment": "Used to control the gateway itself. Use the mihome binding to control devices connected to the Xiaomi gateway.",
"experimental": true
}
}

3
bundles/org.openhab.binding.miio/src/main/resources/database/yunmi.waterpurifier.json
View File

@ -167,6 +167,7 @@
"refresh": true,
"actions": []
}
]
],
"experimental": true
}
}

16
bundles/org.openhab.binding.miio/src/test/java/org/openhab/binding/miio/internal/ReadmeHelper.java
View File

@ -90,6 +90,18 @@ public class ReadmeHelper {
if (!device.getModel().equals("unknown")) {
String link = device.getModel().replace(".", "-");
boolean isSupported = device.getThingType().equals(MiIoBindingConstants.THING_TYPE_UNSUPPORTED);
String remark = "";
if (device.getThingType().equals(MiIoBindingConstants.THING_TYPE_BASIC)) {
MiIoBasicDevice dev = findDatabaseEntry(device.getModel());
if (dev != null) {
remark = dev.getDevice().getReadmeComment();
final Boolean experimental = dev.getDevice().getExperimental();
if (experimental != null && experimental.booleanValue()) {
remark += (remark.isBlank() ? "" : " ")
+ "Experimental support. Please report back if all channels are functional. Preferably share the debug log of property refresh and command responses";
}
}
}
sw.write("| ");
sw.write(minLengthString(device.getDescription(), 28));
sw.write(" | ");
@ -99,7 +111,9 @@ public class ReadmeHelper {
sw.write(minLengthString(model, 22));
sw.write(" | ");
sw.write(isSupported ? "No " : "Yes ");
sw.write(" | |\r\n");
sw.write(" | ");
sw.write(minLengthString(remark, 10));
sw.write(" |\r\n");
}
});
return sw;