Skip to content

Commit

Permalink
Merge pull request #112 from Luligu/dev
Browse files Browse the repository at this point in the history
Update COMPONENTS.md and README.md for clarity on blacklisting components
  • Loading branch information
Luligu authored Dec 24, 2024
2 parents abc967a + 79e6a76 commit 837fdf5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions COMPONENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Given the components of a shellyplusrgbwpm device (as shown in the logs from the

<img width="709" alt="image" src="https://github.com/user-attachments/assets/6602087b-cc51-43c1-a93d-98d351054cf9" />

### Using the Component Name
### Blacklist Using the Component Name

To blacklist all Input components of this device, use the component name as shown below:

```
"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:

Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 837fdf5

Please sign in to comment.