Skip to content

Commit

Permalink
Update unignore.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SukramJ committed Aug 20, 2024
1 parent c9e7955 commit d6d3519
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions docs/unignore.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,33 @@ These advanced users can use the _unignore mechanism_ provided by _hahomematic_.
You must accept the following before using the _unignore mechanism_:

- Use at your own risk!
- Only one parameter per line
- Parameters are case sensitive
- Changes require a restart
- Customization to entities must be done with HA customisations
- Excessive writing of parameters from `MASTER` paramset can cause damage of the device

### Using the UI

The _unignore mechanism_ can be configured with the UI of the custom component starting with version 1.65.0.

- goto to the integrations page
- press configure
- go to the second page (interface)
- enable _advanced configuration_ and go to the next page
- the integration will automatically be reloaded after finishing the options flow.

Various patterns mentioned below can be found and selected in the drop down list.

### Using the unignore file:

This should no longer be used, and will be removed in later (1.65.0) releases:
To use the _unignore mechanism_ create a file named `unignore`(no prefix!) in the `{ha config dir}/homematicip_local` and put the parameters in there.
When adding parameters from `MASTER` paramset the [cache must be cleared](https://github.com/danielperna84/custom_homematic?tab=readme-ov-file#homematicip_localclear_cache) before restart.

Be aware of:

- Only one parameter per line
- Parameters are case sensitive
- Changes require a restart

## Examples:

### parameter only (only valid for paramset VALUES):
Expand All @@ -39,9 +57,7 @@ GLOBAL_BUTTON_LOCK:MASTER@HM-TC-IT-WM-W-EU: (channel is empty!)
Wildcards can be used for device_type and channel for parameters from VALUES the paramaset:

```
LEVEL:VALUES@all:3 # (LEVEL on channel 3 for all device types)
LEVEL:VALUES@HmIP-BROLL:all # (LEVEL on all channels for HmIP-BROLL)
LEVEL:VALUES@all:all # (LEVEL on all channels for all device types) equivalent to just LEVEL
```

# Known limitations
Expand Down

0 comments on commit d6d3519

Please sign in to comment.