#components / integrations / platforms
1 messages · Page 1 of 1 (latest)
Should we consider clarifying these concepts somewhere in the docs?
That would be nice - I think it is still confusing for even a lot of members (including me)
Starting point component is the old name of integration:
component being the old name for integration was my impression as well. It is still used quite a lot in the docs, especially when talking about "base componentents" like the base entities for IoT domains like light. Also, for integration developers it is confusing, since the first thing they run into in the project structure is the homeassistant/components directory, which I assume we are not going to be renaming any time soon.
There's also the term domain that gets in the mix sometimes.
That's true. I didn't personally have a hard time grasping that concept, but it's closely related and wouldn't hurt to include in the clarifications.
Whenever you fetch an entity from the entity registry, you will be confused
_sudden foreshadowing _
A platform is the module that implements a standardized integration feature in Home Assistant, often an entity. Eg components/hue/light.py. The domain of that platform is light while the domain of that integration is hue. It's the light integration that has decided how the light entity feature is standardized.
Would it make sense to have a developer glossary page in the documentation like we have for general terminology (linked above), or should we just explain these terms in the relevat overview/introduction chapters of the documentation? I suppose it depends on if we have enough specialized terminology to warrant a dedicated glossary section.
I'm not opposed to a glossary.
I just found out that we do have another place with a glossary https://www.home-assistant.io/docs/glossary/#component