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.

Sign up for GitHub

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions source/_components/sensor.bbox.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: page
title: "Bbox"
description: "How to integrate Bbox Bandwidth measure within Home Assistant."
date: 2016-10-22 01:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bbox.png
ha_category: Sensor
ha_release: 0.31
---

The `bbox` platform uses the [Bbox Modem Router](https://fr.wikipedia.org/wiki/Bbox/) from the French Internet provider Bouygues Telecom.
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 .

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

</p>

To add Bbox sensors to your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
sensor:
platform: bbox
monitored_variables:
- down_max_bandwidth
- up_max_bandwidth
- current_down_bandwidth
- current_up_bandwidth
```

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.

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

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.

- **current_down_bandwidth**: Instant measure of the current used bandwidth for download.
- **current_up_bandwidth**: Instant measure of the current used bandwidthfor upload.