How to develop custom component in dev environment?

Development
1

Hi,

I created a custom component

For develop and debug it, I use vscode and I copy the files in my environment “core (dev container Home Assistant Dev)”

then I manually copy the differences in my custom component (with the time wasted and the risk of error)

How can I integrate reposy directly into my core environment?

2

I hope you find an answer also for my info. I am trying to tweak/support/add things but find the devs rather unreachable and secluded. I donot want to make this sound as negative but for starters (like me) in this area it is hard to get through to the how-to’s. Tthere is little documentation around flow/process/etc. and very few people have time/interest in guiding (I do !! understand that). Possibly related to open-source approach?

3

It seems that we can use a submodule but I don’t understand how it works:

  • which is is the submodule; core or custom component?

  • can we create it in vscode? I saw tortoisegit. Can this software help?

  • if core is the module and custom component the submodule.

    - how to indicate that the custom component is in the config directory?
- how to indicate that the pushes are made from the custom component?
4

I would try to raise this in the #devs section of the HA discord.

5

Check here: Developing Home Assistant Core in a VSCode Devcontainer

Especially mount part

6

When I developped my integration, I found it easiest to place it in core\homeassistant\components\duepi_evo (so not as a custom integration…)

Since I am working from my own devs core repository, i simply can push directly to it, however, I never create a push requests HA directly, instead I copy to my git custom integration folder and push there.
Since this custom repository is linked to HACS, it will be available shorty after in HA for everyone that uses it…

But yeah, I agree, I still have to copy. As long as my integration is not part of HA’s repository, I don’t think there is another solution…
For me working through HACS works fine…

7

So, you can use external mounts inside devcotainer and you don’t need to copy following link above. It helped me a lot

8

Hi @fuatakgun,

Can you explain how to, I’m lost. Thank’s

9

Please check here specially;

You create a mount point inside devcontainer mapping to custom_components folde, from your original folder outside of container.

10

Hi @anon63427907,

I have a working Dev container: Home assistant Dev
localy in

c:\user\thier\Hassio-dev\core...

I cloned my component [Home-Assistant-custom-components-SmartThings-Soundbar]Home-Assistant-custom-components-SmartThings-Soundbar)in the same path
so I have

C:\Users\thier\Hassio-dev\Home-Assistant-custom-components-SmartThings-Soundbar\custom_components\smartthings_soundbar

I add mount in “.devcontainer file” in the "core:[Dev Container: Home Assistant] Dev] "

{
  "mounts": [
    // Custom component
    "source=${localEnv:HOME}/Hassio-dev/Home-Assistant-custom-components-SmartThings-Soundbar/custom_components/smartthings_soundbar,target=${workspaces/core}/config/custom_components/smartthings_soundbar,type=bind"
    ]
  "name": "Home Assistant Dev",
  "context": "..",
...

What is wrong ?

11

this is my setup;

this is my mount config, please pay attention to double backslashes;

"mounts": ["source=c:\\ha\\eufy_security\\custom_components\\eufy_security,target=${containerWorkspaceFolder}/config/custom_components/eufy_security,type=bind"],

after this config, please re-build your container and you will have your custom component available.
image

1 Like
12

@anon63427907
Thank’s a lot
it works

1 Like
13

Sorry to necro as my first post in the community.
I ran across this post when I was dealing with the same issue, and none of the solutions really felt good to me, but I think I found the solution, so I’m sharing it here.

I followed the same instructions to set up your workflow that we read - but the extra step that I took was to use git submodules to add my custom component as a repo within the core repo.

in the core .gitignore file I added !/config/custom_components/your-custom-component
and then in /config/custom_components I did a git submodule add -f https://github.com/YourName/your-custom-component

Now, a bit of caution: I’ve never had to use submodules before, and I’ve never developed a HA component before, and I’ve only recently just discovered this option, so there may be some kind of interaction here that I’m not aware of. but so far its looking good in VSCode - I see both changes to each repo separated in the sourcecontrol tab.

1 Like