Skip to content

Update docs for the new iperf3 component#8750

Merged
frenck merged 1 commit into
home-assistant:nextfrom
rohankapoorcom:iperf3-sensor-component
Feb 27, 2019
Merged

Update docs for the new iperf3 component#8750
frenck merged 1 commit into
home-assistant:nextfrom
rohankapoorcom:iperf3-sensor-component

Conversation

@rohankapoorcom
Copy link
Copy Markdown
Member

Description:
Iperf3 was split into a component and a sensor.

Pull request in home-assistant (if applicable): home-assistant/core#21138

Checklist:

  • Branch: next is 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 against current.
  • The documentation follows the standards.

@rohankapoorcom rohankapoorcom added next This PR goes into the next branch has-parent This PR has a parent PR in another repo parent-merged The parent PR has been merged already labels Feb 26, 2019
@ghost ghost assigned rohankapoorcom Feb 26, 2019
@ghost ghost added the ready-for-review This PR needs to be reviewed label Feb 26, 2019
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@frenck frenck added in-progress This PR/Issue is currently being worked on and removed ready-for-review This PR needs to be reviewed labels Feb 26, 2019
@rohankapoorcom
Copy link
Copy Markdown
Member Author

rohankapoorcom commented Feb 26, 2019

@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.

Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, this will do!

Thanks, @rohankapoorcom! 👍

@frenck frenck merged commit b25f598 into home-assistant:next Feb 27, 2019
@ghost ghost removed the in-progress This PR/Issue is currently being worked on label Feb 27, 2019
@rohankapoorcom rohankapoorcom deleted the iperf3-sensor-component branch February 27, 2019 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

has-parent This PR has a parent PR in another repo next This PR goes into the next branch parent-merged The parent PR has been merged already

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants