Skip to content

Using custom mapping.yaml and or EEP.xml file(s)

madejackson edited this page Sep 16, 2024 · 1 revision

As I don't have access to all EnOcean devices, I organized HA_enoceanmqtt so that end-users can do field tests when requesting a new device support or add new device support themselves.
For that, it requires modifying the mapping.yaml file and maybe also the EEP.xml file used by the EnOcean library.

This procedure is for addon users as standalone and docker users can have direct access to these files. Here are the steps to follow:

  1. First stop the addon.
  2. If needed, get inspired by the default mapping.yaml, then copy your mapping.yaml file to your home assistant /config/<directory_you_want>/mapping.yaml. Note that /config/ is the directory where you have your Home Assistant configuration.yaml file.
  3. Then in the addon configuration tab, you have a configuration entry named mapping_file. Set this entry to /config/<directory_you_want>/mapping.yaml, which is the location where you saved the mapping.yaml file and save your configuration. Leave this entry empty if not needed.
  4. Similarly, for the EEP.xml file, if needed, get inspired by the default one and then copy it to your home assistant /config/<directory_you_want>/EEP.xml. Note that /config/ is the directory where you have your Home Assistant configuration.yaml file.
  5. Again, in the addon configuration tab, you have a configuration entry named eep_file. Set this entry to /config/<directory_you_want>/EEP.xml, which is the location where you saved the EEP.xml file and save your configuration. Leave this entry empty if not needed.
  6. Finally, restart the addon.

After that you should see your modifications applied to the corresponding entities in HA.

⚠️ Do not forget to undo steps 3 and 5 once your modifications are no more needed. ⚠️