Add documentation for Bbox Sensors (home-assistant#1292)

HydrelioxGitHub · fabaff · commit d1e26a98331c · 2016-10-22T10:05:22.000+02:00
diff --git a/source/_components/sensor.bbox.markdown b/source/_components/sensor.bbox.markdown
@@ -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.
+You can check this by going on the 192.168.1.254 address with your internet browser
+</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.
+  - **up_max_bandwidth**: Maximum bandwidth you can use for uploadinf.
+  - **current_down_bandwidth**: Instant measure of the current used bandwidth for download.
+  - **current_up_bandwidth**: Instant measure of the current used bandwidthfor upload.
+
+
