Template in command line sensor command

kaczkalolo · November 9, 2020, 4:09pm

Hi All,
I need help on how to configure a command line sensor command template. What i would like to achive is to create command line sensor like this one:

- platform: command_line
  name: Server Disk1 Temperature
  command:  ssh -F /config/ssh_config -i /config/ssh/id_rsa [email protected] 'smartctl -a /dev/sdb | grep Temperature_Celsius | awk "{print \$10}"'
  unit_of_measurement: "°C"

But it should only run when other binary sensor is on- so i thought this would work:

- platform: command_line
  name: Server Disk1 Temperature
#  command:  ssh -F /config/ssh_config -i /config/ssh/id_rsa [email protected] 'smartctl -a /dev/sdb | grep Temperature_Celsius | awk "{print \$10}"'
  command: > 
    {% if is_state('binary_sensor.server_online','on') -%} 
    ssh -F /config/ssh_config -i /config/ssh/id_rsa [email protected] 'smartctl -a /dev/sdb | grep Temperature_Celsius | awk "{print \$10}"' 
    {%- endif %}
  unit_of_measurement: "°C"

But it does not…
What do i do wrong?

Ildar_Gabdullin · October 27, 2021, 8:07pm

A similar question.
I got a template sensor host_type which could be equal to "RPi".
Also, there is a command_line sensor:

# RPi CPU throttling
  - platform: command_line
    name: "RPi CPU get_throttled"
    command: >-
      {% set CMD = "cat /sys/devices/platform/soc/soc:firmware/get_throttled" -%}
      {%- set HOST_TYPE = states('sensor.host_type') -%}
      {%- if HOST_TYPE is match('RPi',ignorecase=False) -%}
      {{ CMD }}
      {%- else -%}
      {{ "echo" }}
      {%- endif %}
    value_template: "{{ value }}"
    scan_interval: 60

which seems not working and I got errors in Log:

2021-10-27 22:33:49 ERROR (SyncWorker_12) [homeassistant.components.command_line] Command failed: {% set CMD = "cat /sys/devices/platform/soc/soc:firmware/get_throttled" -%}echo

What is wrong in my setup?
Do command_line sensors support templates?

I suspect that if .. else ... endif constructions are NOT supported

Surely I may use a separate sensor for the command itself:

  - platform: template
    sensors:
      rpi_cpu_get_throttled_command:
        value_template: >-
          {% set CMD = "cat /sys/devices/platform/soc/soc:firmware/get_throttled" -%}
          {%- set HOST_TYPE = states('sensor.host_type') -%}
          {%- if HOST_TYPE is match('RPi',ignorecase=False) -%}
          {{ CMD }}
          {%- else -%}
          {{ "echo" }}
          {%- endif %}

  - platform: command_line
    name: "RPi CPU get_throttled"
    command: "{{ states('sensor.rpi_cpu_get_throttled_command') }}"
    value_template: "{{ value }}"
    scan_interval: 60

But it is an additional code…
Moreover - it just DOES NOT work too:

2021-10-28 00:53:06 ERROR (SyncWorker_12) [homeassistant.components.command_line] Command failed: {{ states('sensor.rpi_cpu_get_throttled_command') }}

Even this template does not work:

    command: "{{ 'ls' }}"

with error:

2021-10-28 01:33:23 ERROR (SyncWorker_3) [homeassistant.components.command_line] Command failed: {{ 'ls' }}

OK, this works w/o template:

    command: "ls"

So, what is going on? Template support is broken?

Ildar_Gabdullin · October 31, 2021, 10:06pm

Registered an issue:

github.com/home-assistant/core

command_line sensor with templated command: inconsistency

opened 10:01PM - 31 Oct 21 UTC

ildar170975

integration: command_line

### The problem According to the docs, the `command_line` sensor supports tem…plates for the `command` option. In fact, templating support is either limited or inconsistent: - either templates do not work; - or work in a strange way. There are examples of `command-line` sensor below (see "Example YAML snippet" section). The results: ``` command: "echo hello {{ states('sun.sun') }}" ``` This command works. Output `"hello below_horizon"`, `"hello above_horizon"`. ``` command: "echo hello 123" ``` This command has no templates and works. Output `"hello 123"` ``` command: >- {% if is_state("input_boolean.test_boolean","on") -%} {%- set KEY = "m" -%} {%- else -%} {%- set KEY = "h" -%} {%- endif -%} {{ "free -" + KEY }} ``` This command does not work. ``` command: >- free - {%- if is_state("input_boolean.test_boolean","on") -%} {%- set KEY = "m" -%} {%- else -%} {%- set KEY = "h" -%} {%- endif -%} {{ KEY }} ``` This command works only if `test_boolean` == `ON`. Output is `"free -m"`. Otherwise it does not work. ``` command: >- free - {%- if is_state("input_boolean.test_boolean","on") -%} m {%- else -%} h {%- endif %} ``` This command works only if `test_boolean` == `ON`. Output is `"free -m"`. Otherwise it does not work. ``` command: "{{ 'free -h' }}" ``` This command does not work. ``` command: "{{ free -h }}" ``` This command does not work. ``` command: "echo state is {{ states('input_boolean.test_boolean') }}" ``` The command works. Output is `"state is on"`, `"state is off"`. ### What version of Home Assistant Core has the issue? core-2021.10.6 ### What was the last working version of Home Assistant Core? _No response_ ### What type of installation are you running? Home Assistant Container ### Integration causing the issue command_line ### Link to integration documentation on our website https://www.home-assistant.io/integrations/sensor.command_line/ ### Example YAML snippet ```yaml sensor: - platform: command_line name: "test command line" command: "echo hello {{ states('sun.sun') }}" scan_interval: 999999 - platform: command_line name: "test command line2" command: "echo hello 123" scan_interval: 999999 - platform: command_line name: "test command line3" command: >- {% if is_state("input_boolean.test_boolean","on") -%} {%- set KEY = "m" -%} {%- else -%} {%- set KEY = "h" -%} {%- endif -%} {{ "free -" + KEY }} scan_interval: 999999 - platform: command_line name: "test command line4" command: >- free - {%- if is_state("input_boolean.test_boolean","on") -%} {%- set KEY = "m" -%} {%- else -%} {%- set KEY = "h" -%} {%- endif -%} {{ KEY }} scan_interval: 999999 - platform: command_line name: "test command line5" command: >- free - {%- if is_state("input_boolean.test_boolean","on") -%} m {%- else -%} h {%- endif %} scan_interval: 999999 - platform: command_line name: "test command line6" command: "{{ 'free -h' }}" scan_interval: 999999 - platform: command_line name: "test command line7" command: "{{ free -h }}" scan_interval: 999999 - platform: command_line name: "test command line8" command: "echo state is {{ states('input_boolean.test_boolean') }}" scan_interval: 999999 ``` ``` ### Anything in the logs that might be useful for us? _No response_ ### Additional information _No response_

Ildar_Gabdullin · July 22, 2022, 12:36am

Templates in command_line sensors still do not work as they do in a conventional template sensors.
The old problem is still there:

github.com/home-assistant/core

command_line sensor with templated command: inconsistency (still)

opened 12:32AM - 22 Jul 22 UTC

ildar170975

integration: command_line

### The problem Last year I opened an issue here and one day it was closed au…tomatically. Probably I should have monitored it once a week to prevent it become stale and closed. After almost a year a situation is *almost* the same. Details are below. Here is the old issue: https://github.com/home-assistant/core/issues/58847 ----------------------- Templates in `command-line` sensors do not work as they do in `template` sensors. *Case 1:* This does not contain templates and DOES WORK: ``` - platform: command_line name: "test command line2" command: "echo hello 123" scan_interval: 9999 ``` Output is: `hello 123` ------------------- *Case 2*: This contains templates and DOES WORK: ``` - platform: command_line name: "test command line" command: "echo hello {{ states('sun.sun') }}" scan_interval: 9999 ``` Output is: `hello below_horizon` ------------------- *Case 3*: This contains templates and *DOES NOT WORK*: ``` - platform: command_line name: "test command line3" command: >- {% if is_state("input_boolean.test_boolean","on") -%} {%- set KEY = "m" -%} {%- else -%} {%- set KEY = "h" -%} {%- endif -%} {{ "free -" + KEY }} scan_interval: 9999 ``` Output is: `unknown` Error in a log: ``` 2022-07-22 03:16:39 ERROR (SyncWorker_15) [homeassistant.components.command_line.sensor] Error rendering command template: TemplateSyntaxError: Encountered unknown tag 'else'. Traceback (most recent call last): File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 370, in ensure_valid self._compiled_code = self._env.compile(self.template) # type: ignore[no-untyped-call] File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 2158, in compile cached = self.template_cache[source] = super().compile(source) File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 768, in compile self.handle_exception(source=source_hint) File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 936, in handle_exception raise rewrite_traceback_stack(source=source) File "<unknown>", line 1, in template jinja2.exceptions.TemplateSyntaxError: Encountered unknown tag 'else'. The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/usr/src/homeassistant/homeassistant/components/command_line/sensor.py", line 161, in update rendered_args = args_compiled.render(args_to_render) File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 393, in render ).result() File "/usr/local/lib/python3.10/concurrent/futures/_base.py", line 446, in result return self.__get_result() File "/usr/local/lib/python3.10/concurrent/futures/_base.py", line 391, in __get_result raise self._exception File "/usr/src/homeassistant/homeassistant/util/async_.py", line 64, in run_callback future.set_result(callback(*args)) File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 415, in async_render compiled = self._compiled or self._ensure_compiled(limited, strict) File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 601, in _ensure_compiled self.ensure_valid() File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 372, in ensure_valid raise TemplateError(err) from err homeassistant.exceptions.TemplateError: TemplateSyntaxError: Encountered unknown tag 'else'. ``` ------------------- *Case 4*: This contains templates and DOES WORK ([last year](https://github.com/home-assistant/core/issues/58847) it worked only if "state=ON"): ``` - platform: command_line name: "test command line4" command: >- free - {%- if is_state("input_boolean.test_boolean","on") -%} {%- set KEY = "m" -%} {%- else -%} {%- set KEY = "h" -%} {%- endif -%} {{ KEY }} scan_interval: 9999 ``` Output is: `total used free shared buff/cache availableMem: 3.8G 1.4G 873.9M 10.3M 1.5G 2.1GSwap: 975.0M 12.0K 975.0M` or `total used free shared buff/cache availableMem: 3898 1471 877 10 1550 2168Swap: 975 0 975` ------------------- *Case 5*: This contains templates and DOES WORK ([last year](https://github.com/home-assistant/core/issues/58847) it worked only if "state=ON"): ``` - platform: command_line name: "test command line5" command: >- free - {%- if is_state("input_boolean.test_boolean","on") -%} m {%- else -%} h {%- endif %} scan_interval: 9999 ``` Output is: `total used free shared buff/cache availableMem: 3.8G 1.4G 879.4M 10.3M 1.5G 2.1GSwap: 975.0M 12.0K 975.0M` or `total used free shared buff/cache availableMem: 3898 1468 880 10 1551 2172Swap: 975 0 975` ------------------- *Case 6*: This contains templates and *DOES NOT WORK*: ``` - platform: command_line name: "test command line6" command: "{{ 'free -h' }}" scan_interval: 9999 ``` Output is: `unknown` Error in a log: ``` 2022-07-22 03:26:23 ERROR (SyncWorker_22) [homeassistant.components.command_line] Command failed: {{ 'free -h' }} ``` ------------------ *Case 7*: This contains templates and DOES WORK ([last year](https://github.com/home-assistant/core/issues/58847#issuecomment-989201515) it worked only if "state=ON"): ``` - platform: command_line name: "test command line9" command: >- free -{{ 'm' if is_state("input_boolean.test_boolean","on") else 'h' }} scan_interval: 9999 ``` Output is: `total used free shared buff/cache availableMem: 3.8G 1.4G 877.9M 10.3M 1.5G 2.1GSwap: 975.0M 12.0K 975.0M` or `total used free shared buff/cache availableMem: 3898 1468 877 10 1553 2171Swap: 975 0 975` ### What version of Home Assistant Core has the issue? 2022.7.6 ### What was the last working version of Home Assistant Core? _No response_ ### What type of installation are you running? Home Assistant Container ### Integration causing the issue command_line ### Link to integration documentation on our website https://www.home-assistant.io/integrations/command_line ### Diagnostics information _No response_ ### Example YAML snippet _No response_ ### Anything in the logs that might be useful for us? _No response_ ### Additional information _No response_

tom_l · July 22, 2022, 12:55am

Yeah I ran into the issue of this integration not supporting multi-line templates just last week.

Ildar_Gabdullin · July 22, 2022, 1:27am

This example does not have multi-line templates - but it does not work:

    command: >-
      {% set KEYS = "a" -%}
      ls -{{KEYS}}

2022-07-22 04:10:23 WARNING (MainThread) [homeassistant.helpers.template] Template variable warning: 'KEYS' is undefined when rendering 'set KEYS = "a" -%} ls -{{KEYS}}'
2022-07-22 04:10:23 ERROR (SyncWorker_23) [homeassistant.components.command_line] Command failed: {% set KEYS = "a" -%} ls -

But this version should work:

    command: >-
      ls -{% set KEYS = "a" -%}{{KEYS}}

but in this particular case it will give an error “state > 255 chars”, but this is another story.
May be tested with this example:

    command: >-
      ls {% set KEYS = "automations.yaml -la" -%}{{KEYS}}

tom_l · July 22, 2022, 1:29am

Yes it does:

Ildar_Gabdullin · July 22, 2022, 1:33am

Yes, you are right, it is considered as a multiline probably)))
So, the possible problem is multiline templates.
It explains why my problem cases described in the issue do not work.

Interestingly, why this case does not work?

command: "{{ 'free -h' }}"

This is a one-line template)))

P.S. Probably you should put a comment in the issue regarding your brilliant guess about “multiline templates”, it really seems to be a reason.

tom_l · July 22, 2022, 1:36am

Does this work?

command: 'free -h'

Ildar_Gabdullin · July 22, 2022, 1:38am

Surely it works…
That stupid example was made just for testing.

tom_l · July 22, 2022, 1:40am

Ok, weird. I was working under the assumption that the > in command: > was being interpreted as part of the command, but it must be more than that.

Ildar_Gabdullin · July 22, 2022, 1:46am

Here is what I currently have to do:

command: " {% ... -%} {%- ... -%}  {%- ... -%}  {%- ... -%} {{ ... }}"

instead of

command: >-
  {% ... -%}
  {%- ... -%}
  {%- ... -%}
  {%- ... -%}
  {{ ... }}

Update:
No, this does not work too.

command: "{% set SENSOR_SETTINGS = 'sensor.xxx' -%}{{state_attr(SENSOR_SETTINGS,'command_ip_address')}}"

Although this is a one-line template.

2022-07-22 04:53:07 ERROR (SyncWorker_32) [homeassistant.components.command_line.sensor] Error rendering command template: UndefinedError: 'SENSOR_SETTINGS' is undefined
Traceback (most recent call last):
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 421, in async_render
render_result = _render_with_context(self.template, compiled, **kwargs)
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 1906, in _render_with_context
return template.render(**kwargs)
File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 1301, in render
self.environment.handle_exception()
File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 936, in handle_exception
raise rewrite_traceback_stack(source=source)
File "<template>", line 1, in top-level template code
File "/usr/local/lib/python3.10/site-packages/jinja2/sandbox.py", line 393, in call
return __context.call(__obj, *args, **kwargs)
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 2054, in wrapper
return func(hass, *args[1:], **kwargs)
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 1371, in state_attr
if (state_obj := _get_state(hass, entity_id)) is not None:
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 921, in _get_state
return _get_template_state_from_state(hass, entity_id, hass.states.get(entity_id))
File "/usr/src/homeassistant/homeassistant/core.py", line 1308, in get
return self._states.get(entity_id.lower())
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 1932, in _fail_with_undefined_error
raise ex
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 1923, in _fail_with_undefined_error
return super()._fail_with_undefined_error(*args, **kwargs)
jinja2.exceptions.UndefinedError: 'SENSOR_SETTINGS' is undefined
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
File "/usr/src/homeassistant/homeassistant/components/command_line/sensor.py", line 161, in update
rendered_args = args_compiled.render(args_to_render)
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 393, in render
).result()
File "/usr/local/lib/python3.10/concurrent/futures/_base.py", line 446, in result
return self.__get_result()
File "/usr/local/lib/python3.10/concurrent/futures/_base.py", line 391, in __get_result
raise self._exception
File "/usr/src/homeassistant/homeassistant/util/async_.py", line 64, in run_callback
future.set_result(callback(*args))
File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 423, in async_render
raise TemplateError(err) from err
homeassistant.exceptions.TemplateError: UndefinedError: 'SENSOR_SETTINGS' is undefined

Bypassing:

    command: >-
      echo ;
      {% set SENSOR_SETTINGS = 'sensor.xxx' -%}{{ state_attr(SENSOR_SETTINGS,'command_ip_address') }}