Skip to content

Commit

Permalink
Add documentation for json_attributes in command (#5889)
Browse files Browse the repository at this point in the history
* Add documentation for json_attributes in command

* Fix formatting
  • Loading branch information
Alexander Hardwicke authored and fabaff committed Jul 29, 2018
1 parent ecaa94f commit eceee28
Showing 1 changed file with 20 additions and 0 deletions.
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 %}

0 comments on commit eceee28

Please sign in to comment.