As the title says, I’m trying to create an addon for HASS and I’m following the official tutorial, but even though I create the folder structure and copy the files over it refuses to detect the addon.
You can see from this image that the files are where they’re supposed to be, but it doesn’t work. What am I doing wrong?
I also followed the tutorial and my add-on doesn’t show up either.
I used the SSH option to create my add-on.
I have the same set-up you have in your image.
Did you manage to get it to work in the end?
Update: The add-on showed up when I rebooted the host system. I’m running HA on an Intel NUC.
Maybe this can be added to the tutorial?
1 Like
I think pressing CTRL+F5 on the Addon page can solve the problem.
4 Likes
I had this problem too, and after some trial and error here are some of the things I found that you should check if you have the same problem:
- The tutorial doesn’t really tell you “where” to create the directory for your new addon. Once you find the “addons” directory, you need to create a directory in there called “local” and then create your new addon directory inside that “local” directory.
- The config.yaml file you create in your addon directory must have at least the name, version, slug, description, and arch values. If you are missing any of these there will be an error about it shown in the supervisor logs.
- After creating the directory and config file, you need to go to Settings → System → Add-Ons → Add-On Store and then from the 3-dots menu in the upper right corner select “Check for Updates”
- If everything goes smoothly a new section should appear at the top of the add-on store labeled “Local add-ons” with your addon listed in it.
- If your new addon doesn’t appear, first try hitting Shift-F5 (in most browsers this is the shortcut for “empty the browser cache for this page and reload it”). It appears that sometimes the “check for updates” process does work, but what’s being shown to you is cached and doesn’t update.
- If emptying the cache and reloading doesn’t help, then check the supervisor logs by going to Settings → System → Logs and then changing the dropdown in the upper-right corner to “Supervisor”.
- If there are errors shown there for your addon then fix them and try again.
- If none of that works, check to see if your “addons/local” directory contains more than one addon directory. If you’ve tried this more than once you may have created several while trying different things. Having more than one is fine, but you need to check the config.yaml file in each of them. If you have more than one addon whose config.yaml has the same “slug” value, then only one of them will be loaded, the others will be ignored, and the supervisor won’t warn you about this situation.
Solved!
I haven’t found it necessary to create a /local folder as you suggest, but I think all your other points are useful.
I’ve been troubleshooting this issue and found that an error in the config.yaml will prevent the add-on showing up. In my case, I found the error reported in the supervisor log.
It would be nice if the error was indicated in the add-on store, but it isn’t.