Add docs for 17track.net sensor platform #7303
Conversation
|
|
||
| ## {% linkable_title Configuration %} | ||
|
|
||
| To enable the platform, add the following lines to your `configuration.yaml` |
There was a problem hiding this comment.
Is manual configuration.yaml the only option?
Not via a configuration entry in the UI like before?
There was a problem hiding this comment.
Yes. The UI method was originally introduced so that users could add individual packages without needing to update configuration.yaml. Unfortunately, the method for tracking individual packages via 17track.net has been altered; until I figure out the mechanism, the underlying library (py17track) only allows account-driven package tracking.
Given that this use case is off the table, for now, there is one primary thing I review when considering whether UI config is appropriate: can the integration justify being a full-blown component (beyond the UI config use case)? Tactically:
- Does the integration produce more than one platform (
sensor,binary_sensor, etc.)? - Does the integration need to provide services?
If the answer is no, then I leave the integration as a platform (in this case, as a sensor platform). At some point, the HASS core will have a way for existing platforms to implement UI config without needing to transition to a full-blown component; when that occurs, I'll definitely take another look.
Hope that makes sense.
There was a problem hiding this comment.
Makes sense, thanks for explaining your decision!
|
Thanks, @bachya! Upped ⬆️ |
Description:
This PR adds docs for the forthcoming 17track.net sensor platform.
Pull request in home-assistant (if applicable): home-assistant/core#18038
Checklist:
nextis for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created againstcurrent.