Adds Sigfox sensor docs (#5130)

* Create sensor.sigfox.markdown

* Adds name

* Address reviewer comments

* Update logo

* Add files via upload

* ✏️ Markdown tweak
This commit is contained in:
Robin 2018-04-17 18:11:44 +01:00 committed by Franck Nijhof
parent e1747451fc
commit 04560310f9
2 changed files with 47 additions and 0 deletions

View File

@ -0,0 +1,47 @@
---
layout: page
title: "Sigfox Sensor"
description: "Display messages from Sigfox devices in Home Assistant."
date: 2018-04-07 12:10
sidebar: true
comments: false
sharing: true
footer: true
logo: sigfox.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.68
---
[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ( [snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
```yaml
# Example configuration.yaml entry
sensor:
- platform: sigfox
api_login: your_api_login
api_password: your_api_password
```
{% configuration %}
api_login:
description: Your Sigfox API login.
required: true
type: string
api_password:
description: Your Sigfox API password.
required: true
type: string
name:
description: The name to prepend to the device ID.
required: false
default: "sigfox"
type: string
{% endconfiguration %}
Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following:
1. Log into [Sigfox backend](https://backend.sigfox.com)
1. Select `GROUP`
1. Select `API ACCESS`
1. Click on `new` and create new access entry

Binary file not shown.

After

Width:  |  Height:  |  Size: 326 KiB