Skip to content

Add documentation for Bbox Sensors #1292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 22, 2016
Merged

Add documentation for Bbox Sensors #1292

merged 1 commit into from
Oct 22, 2016

Conversation

HydrelioxGitHub
Copy link
Contributor

Description:

Documentation for Bbox Sensors

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

Copy link
Contributor

@Landrash Landrash left a comment

Choose a reason for hiding this comment

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

Some spelling errors and some rephrasing that I think should be done. 😃


<p class='note warning'>
Due to third party limitation, the sensors will only be available if the HomeAssistant and the Bbox are on the same local area network.
You can check this by going on the 192.168.1.254 address with your internet browser
Copy link
Contributor

Choose a reason for hiding this comment

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

I would repleace internet browser with Web browser. Also missing a ".".

Sensors are mainly bandwidth measures (Details below)

<p class='note warning'>
Due to third party limitation, the sensors will only be available if the HomeAssistant and the Bbox are on the same local area network.
Copy link
Contributor

Choose a reason for hiding this comment

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

HomeAssistant -> Home Assistant .


- **monitored_variables** array (*Required*): Sensors to display in the frontend.
- **down_max_bandwidth**: Maximum bandwidth you can use for downloading.
- **up_max_bandwidth**: Maximum bandwidth you can use for uploadinf.
Copy link
Contributor

Choose a reason for hiding this comment

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

uploadinf -> uploading.

Configuration variables:

- **monitored_variables** array (*Required*): Sensors to display in the frontend.
- **down_max_bandwidth**: Maximum bandwidth you can use for downloading.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would probably rephrase this from

Maximum bandwidth you can use for downloading.

To

Maximum bandwidth available for download.


- **monitored_variables** array (*Required*): Sensors to display in the frontend.
- **down_max_bandwidth**: Maximum bandwidth you can use for downloading.
- **up_max_bandwidth**: Maximum bandwidth you can use for uploadinf.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would probably rephrase this from

Maximum bandwidth you can use for uploading.

To

Maximum bandwidth available for upload.

@Landrash Landrash added the Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! label Oct 22, 2016
@fabaff
Copy link
Member

fabaff commented Oct 22, 2016

Will fix the comments by @Landrash after merging.

@fabaff fabaff merged commit d1e26a9 into home-assistant:next Oct 22, 2016
@HydrelioxGitHub HydrelioxGitHub deleted the bbox-sensor-documentation branch October 23, 2017 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants