jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update description and move vars to new style

Browse Source
This commit is contained in:
Fabian Affolter 2017-09-24 11:41:13 +02:00
parent 2007f30791
commit 8d27517e23
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
source/_components/sensor.shodan.markdown
View File

@ -14,11 +14,14 @@ ha_release: 0.51
---
The `shodan` sensor platform is displaying the total of result of a [Shodan](https://www.shodan.io/) query.
The `shodan` sensor platform is displaying the total of result of a
[Shodan](https://www.shodan.io/) query.
Use "Show API Key" in the upper right corner when you are logged in or got to your "My Account" page to retrieve your API key.
Use "Show API Key" in the upper right corner when you are logged in or got to
your "My Account" page to retrieve your API key.
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
To enable this sensor, add the following lines to your `configuration.yaml`
file:
```yaml
# Example configuration.yaml entry
@ -28,9 +31,18 @@ sensor:
query: 'home-assistant'
```
Configuration variables:
- **api_key** (*Required*): The API key for Shodan.io.
- **query** (*Required*): The search string.
- **name** (*Optional*): Name of the Shodan sensor.
{% configuration %}
api_key:
description: The API key for Shodan.io.
required: true
type: string
query:
description: The search string.
required: true
type: string
name:
description: Name of the Shodan sensor.
required: false
type: string
{% endconfiguration %}