Update docs for the new iperf3 component#8750
Merged
frenck merged 1 commit intoFeb 27, 2019
Merged
Conversation
9 tasks
frenck
requested changes
Feb 26, 2019
Member
frenck
left a comment
There was a problem hiding this comment.
Please do not add/document scan_interval. It is already documented at Entity component platform options. We decided not to add it to every component, because it's an advanced feature and in 95 % of the use cases not needed.
Member
Author
|
@frenck, this is needed on the component level, not the entity level. Setting it in an entity will do nothing since the entity is not polled. Setting it in the component will actually change the frequency at which speed tests are run. Since most components do not support scan_interval I think it's important to mention here. |
frenck
approved these changes
Feb 27, 2019
Member
frenck
left a comment
There was a problem hiding this comment.
In that case, this will do!
Thanks, @rohankapoorcom! 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
Iperf3 was split into a component and a sensor.
Pull request in home-assistant (if applicable): home-assistant/core#21138
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.