-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
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
Add documentation for Bbox Sensors #1292
Conversation
There was a problem hiding this 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 |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
Will fix the comments by @Landrash after merging. |
Description:
Documentation for Bbox Sensors
Pull request in home-assistant (if applicable): home-assistant/core#3956