From 6dc190e1e359d446b0a425d8217607755565f645 Mon Sep 17 00:00:00 2001 From: Luligu Date: Tue, 24 Dec 2024 09:23:54 +0100 Subject: [PATCH 1/2] Update COMPONENTS.md and README.md for clarity on blacklisting components --- COMPONENTS.md | 4 ++-- README.md | 9 ++++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/COMPONENTS.md b/COMPONENTS.md index 65d518b..6813aaa 100644 --- a/COMPONENTS.md +++ b/COMPONENTS.md @@ -9,7 +9,7 @@ Given the components of a shellyplusrgbwpm device (as shown in the logs from the image -### Using the Component Name +### Blacklist Using the Component Name To blacklist all Input components of this device, use the component name as shown below: @@ -17,7 +17,7 @@ To blacklist all Input components of this device, use the component name as show "deviceEntityBlackList": { "shellyplusrgbwpm-ECC9FF4CEAF0": ["Input"] } ``` -### Using the Component IDs +### Blacklist Using the Component IDs To blacklist only the third (input:2) and fourth (input:3) Input components of this device, use the component IDs as follows: diff --git a/README.md b/README.md index 4c547bc..853ccfc 100644 --- a/README.md +++ b/README.md @@ -229,13 +229,16 @@ If you add a BLU device in the white list, you need to put also its BLU gateway The components in the list will not be exposed for all devices. Use the component name (i.e. Temperature). +For detailed examples, refer to the [COMPONENTS.md documentation.](https://github.com/Luligu/matterbridge-shelly/blob/main/COMPONENTS.md) + ### deviceEntityBlackList -List of components not to be exposed for a single device. Enter in the first field the name of the device id (e.g. shellyplus2pm-5443B23D81F8 for wifi shelly devices or 7c:c6:b6:65:2d:87 for BLU shelly devices) and in the second field add all the component names (i.e. Temperature) or component ids (i.e. temperature:0) you want to exclude for that device. +The deviceEntityBlackList is a list of components that should not be exposed for a specific device. -Examples: +In the first field, enter the device ID (e.g., shellyplus2pm-5443B23D81F8 for Wi-Fi Shelly devices or 7c:c6:b6:65:2d:87 for BLU Shelly devices). +In the second field, list all the component names (e.g., Temperature) or component IDs (e.g., temperature:0) you want to exclude for that device. -- if you want the BLU motion to only have the motion component, add its device addr and in the list Illuminance and Button; +For detailed examples, refer to the [COMPONENTS.md documentation.](https://github.com/Luligu/matterbridge-shelly/blob/main/COMPONENTS.md) ### nocacheList From 79e6a7642a083ed389af14226f33dc959e889613 Mon Sep 17 00:00:00 2001 From: Luligu Date: Tue, 24 Dec 2024 09:24:43 +0100 Subject: [PATCH 2/2] Update CHANGELOG.md to reflect recent improvements in COMPONENTS.md and README.md regarding blacklisting components --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c652d19..641b039 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ You can also sponsor Tamer here https://buymeacoffee.com/6sjde6vkzl for his inva - [plugin]: Add the possibility to validate shelly BLU devices by name and mac (i.e. you can put in the blacklist and whitelist the device name given in the gateway web UI or the shelly BLU mac). If you put a shelly BLU in the white list, you need to put also his BLU gateway on the white list. - [plugin]: Refactor child endpoint creation in ShellyPlatform to use addChildDeviceType and addRequiredClusterServers. - [platform]: Added a check for endpoint numbers changes. +- [readme]: Update COMPONENTS.md and README.md for clarity on blacklisting components. ### Changed