Passing Arguments to Scripts

Configuration
1

I’ve been digging around the source code and it appears that I can pass variables to scripts when I call them with script.turn_on. I’m just not sure what the proper format is and how to actually use them in the script.

For example, I’m trying to write a generic script for turning something off automatically after some period of time following when it was turned on. (My kids leave lights on all over the house all time time.)

Here’s a snippet of what I’ve been trying to do:

automation:
  - alias: "Turn off upstairs sink light after a delay"
    trigger:
      platform: state
      entity_id: switch.upstairs_bathroo_switch_13
      from: "off"
      to: "on"
    action:
      service: script.turn_on
      entity_id: script.turn_off_after_delay
      data:
        desired_delay: "00:00:30"
        device_entity_id: switch.upstairs_bathroo_switch_13

script:
  turn_off_after_delay:
    alias: "Turn something off after a delay"
    sequence:
      - delay: "{{ variables.desired_delay }}"
      - service: homeassistant.turn_off
        entity_id: "{{ variables.device_entity_id }}"

This gives me errors like:

Invalid config for [script]: Entity ID {{ XXXX }} is an invalid entity id for dictionary value...

I’m trying to avoid writing one of these scripts for each of my lights. Any suggestions?

Thanks!

2

Have a look at my tested example at the end of this thread:
https://github.com/home-assistant/home-assistant/pull/1882

The name of the variable should be accessible directly in the template. I don’t think that the entity_id key supports templating though. I’d be happy to be corrected.

3

it seems like it matters where you place the variable.

i think i tried it exactly like you did @martinhjelmare

- alias: 'raamhoek aan'
  trigger:
    platform: state
    entity_id: input_boolean.eetraamhoek
    to: 'on'
  action:
    service: script.turn_on
    entity_id: script.test
    data:
      variables:
        message: 'P01t'


script:
  test:
    alias: P01 aan
    sequence:
      - alias: schakel P01 aan
        service: switch.mysensors_send_ir_code
        entity_id: switch.afstandbediening_2_5
        data:
          V_IR_SEND: "{{ message }}"

but if i look what gets sendet: {{ message }}

edit: @pjones you forgot variables: after data:

4

Use key data_template to have the template rendered for the script service as data value.

1 Like
5

That’s the issue. The entity_id field doesn’t support templating.

6

you were right @martinhjelmare.

that was my failure.

@pjones cant you do it without script?

with automation-template https://home-assistant.io/getting-started/automation-templating/
and with service template https://home-assistant.io/getting-started/scripts-service-calls/

something like:

trigger:
switch a
switch b
switch c
action:
turn_of
data_template: {{trigger.entity_id}}

could also be that in youre script it could work like this:

data_template:
entity_id: {{ device_entity_id }}

1 Like
7

Yes, it should work to put the entity_id key inside the data_template. If a delay is wanted, then a script is probably the easiest approach.

8

I just wanted to complete this thread by saying that the data_template technique does work for entity_id. Thanks!

1 Like
9

if the same question came up right now i would advice to install appdaemon and write a small app :wink:

1 Like