Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.31 KB

unignore.md

File metadata and controls

60 lines (41 loc) · 2.31 KB
Raw

unignore

Hahomematic maintains multiple lists of parameters that should be ignored when entities are created for Home-Assistant. These parameters are filtered out to provide a better user experience for the majority of the users.

But there is also a group of users that wants to do more... things.

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

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 before restart.

Examples:

parameter only (only valid for paramset VALUES):

LEVEL
FROST_PROTECTION

parameter with limitation to a device type, channel and paramset type (> 1.55.0):

GLOBAL_BUTTON_LOCK:MASTER@HmIP-eTRV-2:0
LEVEL:VALUES@HmIP-BROLL:3
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

Parameters from MASTER paramset of HM-Classic (BidCos) devices can be changed, but need a manual refresh, by calling the service homeassistant.update_entity.

ignore

There is also an option to ignore the automatic creation of a custom entities for a specific device type: The line must start with ignore_ to enable this mechanism.

ignore_HmIP-BROLL

This is useful, if you want to create your own entities based on HA templates. Ignoring a device_type gives you access to the raw data of this device.