jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-24 09:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix creating component index docs with clearer examples (#2610)

Browse Source 
* clearer-examples-creating-component-index: change examples with the correct core path

* clearer-examples-creating-component-index: use tip box

* clearer-examples-creating-component-index: nits from code rabbit

* link to manifest doc

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* clearer-examples-creating-component-index: move link to "manifest file"

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Nicolò Maria Semprini 2025-03-20 22:08:03 +00:00 committed by GitHub
parent 04d39efd5f
commit 6422ed2923
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/creating_component_index.md
View File

@ -10,9 +10,17 @@ python3 -m script.scaffold integration
This will set you up with everything that you need to build an integration that is able to be set up via the user interface. More extensive examples of integrations are available from [our example repository](https://github.com/home-assistant/example-custom-config/tree/master/custom_components/).
:::tip
This example repository shows custom integrations that live in the `<config_dir>/custom_components` directory. These MUST have a `version` key in their [manifest file](/docs/creating_integration_manifest/#version). Core integrations live in the `homeassistant/components` directory, and do not need a `version` key. The architecture is the same in both cases.
:::
## The minimum
The scaffold integration contains a bit more than just the bare minimum. The minimum is that you define a `DOMAIN` constant that contains the domain of the integration. The second part is that it needs to define a setup method that returns a boolean if the set up was successful.
The scaffold integration contains a bit more than just the bare minimum. The minimum is that you define a `DOMAIN` constant that contains the domain of the integration. The second part is that it needs to define a setup method that returns a boolean if the set-up was successful.
Create a file `homeassistant/components/hello_state/__init__.py` with one of the two following codeblocks, depending on what you need:
- Sync component:
```python
DOMAIN = "hello_state"
@ -25,7 +33,7 @@ def setup(hass, config):
return True
```
And if you prefer an async component:
- And if you prefer an async component:
```python
DOMAIN = "hello_state"
@ -37,14 +45,13 @@ async def async_setup(hass, config):
# Return boolean to indicate that initialization was successful.
return True
```
Create a file `<config_dir>/custom_components/hello_state/__init__.py` with one of the two codeblocks.
In addition a manifest file is required with below keys as the bare minimum. Create `<config_dir>/custom_components/hello_state/manifest.json`.
In addition, a manifest file is required with the following keys as the bare minimum. Create `homeassistant/components/hello_state/manifest.json`.
```json
{
"domain": "hello_state",
"name": "Hello, state!",
"version": "0.1.0"
"name": "Hello, state!"
}
```