Skip to content
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 json_attributes in command #5889

Merged
merged 2 commits into from
Jul 29, 2018
Merged
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions source/_components/sensor.command_line.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Configuration variables:
- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
- **scan_interval** (*Optional*): Defines number of seconds for polling interval (defaults to 60 seconds).
- **command_timeout** (*Optional*): Defines number of seconds for command timeout (defaults to 15 seconds).
- **json_attributes** (*Optional*): Defines a list of keys to extract values from a JSON dictionary result and then set as sensor attributes.

## {% linkable_title Examples %}

Expand Down Expand Up @@ -162,3 +163,22 @@ sensor:
unit_of_measurement: "Direction"
```
{% endraw %}


### {% linkable_title Usage of JSON attributes in command output %}

The example shows how you can retrieve multiple values with one sensor (where the additional are attributes) by using `value_json` and `json_attributes`.

{% raw %}
```yaml
# Example configuration.yaml entry
sensor:
- platform: command_line
name: JSON time
json_attributes:
- date
- milliseconds_since_epoch
command: 'python3 /home/pi/.homeassistant/scripts/datetime.py'
value_template: '{{ value_json.time }}'
```
{% endraw %}