Using VBML in a script

[lordratner]

Howdy. The discussions tab for this repo isn't open, so I'm just posting this in the issues.

Thanks so much for getting the VBML endpoint to work! It's really opened up what we can do with the VB in Home Assistant.

I put this script together as a sort of modification of what you did with the "decoration" part of the integration. The script takes three arguments:

• Message
• Status bar on or off
• Alert Border color (none = no border)

You might have to change the weather entity depending on the integration you're using but the rest should be functional.

It's designed to balance simplicity with a bit of optionality. My goal is to make this a UI-friendly script for beginners.

One thing I'm getting caught on, and can't test since I only have one Vestaboard, is the option to have multiple VBs selected in the script.

If anyone could help me out with that, I'd be grateful. I have the field set up to accept multiple boards, but I don't know how to inject those associated device IDs into the device_id input of the integration.

sequence:
  - variables:
      alert_color: |-
        {% set mappings = {
          'none':'{0}',
          'red':'{63}',
          'blue':'{67}',
          'green':'{66}',
          'yellow':'{65}',
          'orange':'{64}',
          'violet':'{68}',
          'white':'{69}'
        } %} "{{ mappings.get(alert, '{63}') }}"
    enabled: true
  - action: vestaboard.message
    metadata: {}
    data:
      device_id:
        - 367436747349d054cdcb82c9feb7d107
      vbml:
        props:
          text: "{{ words }}"
          date: "{{ as_timestamp(now())|timestamp_custom('%d') }}"
          month: "{{ as_timestamp(now())|timestamp_custom('%b') }}"
          hours: "{{ as_timestamp(now())|timestamp_custom('%H') }}"
          day: "{{ as_timestamp(now())|timestamp_custom('%A') }}"
          minutes: "{{ as_timestamp(now())|timestamp_custom('%M') }}"
          temp: "{{ state_attr('weather.openweather','temperature') | int}}"
          temp_color: >-
            {% if state_attr('weather.openweather','temperature') | float <= 32
            %}
              {69}
            {% elif state_attr('weather.openweather','temperature') | float <=
            55 %}
              {67}
            {% elif state_attr('weather.openweather','temperature') | float <=
            75 %}
              {66}
            {% elif state_attr('weather.openweather','temperature') | float <=
            90 %}
              {65}
            {% else %}
              {63}
            {% endif %}
          alert_color: |-
            {% if alert == 'none' %}
              {0}
            {% elif alert == 'blue' %} 
              {67}
            {% elif alert == 'green' %} 
              {66}
            {% elif alert == 'yellow' %} 
              {65}
            {% elif alert == 'orange' %} 
              {64}
            {% elif alert == 'violet' %} 
              {68}
            {% elif alert == 'white' %} 
              {69}  
            {% else %}
              {63}
            {% endif %}
        components: |-
          [
            {
            {% if alert != 'none' %}
              "style": {
                "justify": "center",
                "align": "center",
                "width": 22,
                "height": 1
              },
              "template": "{{ '{{alert_color}}' * 22 }}"
            },
            {
              "style": {
                "justify": "center",
                "align": "center",
                "width": 1,
                "height": "{{ '3' if status_bar else '4' }}"
              },
              "template": "{{ ('{{alert_color}}' * 3) if status_bar else ('{{alert_color}}' * 4) }}"
            },
            {
            {% endif %}
            
              "style": {
                "justify": "center",
                "align": "center",
                "width": "{{ '20' if alert != 'none' else '22' }}",
                "height": "{% if alert != 'none' and status_bar %}3{% elif status_bar %}5{% elif alert != 'none' %}4{% else %}6{% endif %}"
              },
              "template": "{{ '{{text}}' }}"
            {% if alert != 'none' %}
            },
            {
              "style": {
                "justify": "center",
                "align": "center",
                "width": 1,
                "height": "{{ '3' if status_bar else '4' }}"
              },
              "template": "{{ ('{{alert_color}}' * 3) if status_bar else ('{{alert_color}}' * 4) }}"
            },
            {
              "style": {
                "justify": "center",
                "align": "center",
                "width": 22,
                "height": 1
              },
              "template": "{{ '{{alert_color}}' * 22 }}"
            {% endif %}
            {% if status_bar %}
            },
            {
              "style": {
                "justify": "left",
                "align": "center",
                "width": 5,
                "height": 1
              },
              "template": "{{ '{{date}}{{month}}' }}"
            },
            {
              "style": {
                "justify": "center",
                "align": "center",
                "width": 12,
                "height": 1
              },
              "template": "{{ '{{day}}' }}"
            },
            {
              "style": {
                "justify": "right",
                "align": "center",
                "width": 5,
                "height": 1
              },
              "template": "{{ '{{temp}}{62}{{temp_color}}' }}"
            {% endif %}
            }
            
            ]
fields:
  words:
    selector:
      text:
        multiline: true
    description: The text to display on the Vestaboard
    required: true
    name: Message
  status_bar:
    selector:
      boolean: {}
    description: Show the date, day, and temperature status bar at the bottom
    default: false
    required: true
    name: Status Bar
  alert_border:
    selector:
      select:
        options:
          - none
          - red
          - blue
          - green
          - yellow
          - orange
          - violet
          - white
    default: none
    required: true
    name: Alert Border
    description: Select the color of the border for your message (or none)
  target_boards:
    selector:
      device:
        multiple: true
        integration: vestaboard
    description: What vestaboard device(s) should the message go to?
    required: true
    default:
      - 367436747349d054cdcb82c9feb7d107
    name: Target Vestaboard
alias: Vestaboard - Message with Options
description: >-
  Lets to send a basic message, with the option to add an alert frame, and a
  status bar.

[natekspencer]

This should help to send to multiple devices: https://www.home-assistant.io/docs/scripts/#for-each

Additionally, you might want to make the weather an optional input as well

[lordratner]

Additionally, you might want to make the weather an optional input as well

That was it, thanks. Changes made. You can now select any temperature entity for use in the status bar.

sequence:
  - repeat:
      sequence:
        - action: vestaboard.message
          metadata: {}
          data:
            device_id: "{{ repeat.item }}"
            vbml:
              props:
                text: "{{ words }}"
                date: "{{ as_timestamp(now())|timestamp_custom('%d') }}"
                month: "{{ as_timestamp(now())|timestamp_custom('%b') }}"
                hours: "{{ as_timestamp(now())|timestamp_custom('%H') }}"
                day: "{{ as_timestamp(now())|timestamp_custom('%A') }}"
                minutes: "{{ as_timestamp(now())|timestamp_custom('%M') }}"
                temp: "{{ states(temp_source) | int }}"
                temp_color: |-
                  {% if states(temp_source) | int <= 32 %}
                    {69}
                  {% elif states(temp_source) | int <= 55 %}
                    {67}
                  {% elif states(temp_source) | int <= 75 %}
                    {66}
                  {% elif states(temp_source) | int <= 90 %}
                    {65}
                  {% else %}
                    {63}
                  {% endif %}
                alert_color: |-
                  {% if alert == 'none' %}
                    {0}
                  {% elif alert == 'blue' %} 
                    {67}
                  {% elif alert == 'green' %} 
                    {66}
                  {% elif alert == 'yellow' %} 
                    {65}
                  {% elif alert == 'orange' %} 
                    {64}
                  {% elif alert == 'violet' %} 
                    {68}
                  {% elif alert == 'white' %} 
                    {69}  
                  {% else %}
                    {63}
                  {% endif %}
              components: |-
                [
                  {
                  {% if alert != 'none' %}
                    "style": {
                      "justify": "center",
                      "align": "center",
                      "width": 22,
                      "height": 1
                    },
                    "template": "{{ '{{alert_color}}' * 22 }}"
                  },
                  {
                    "style": {
                      "justify": "center",
                      "align": "center",
                      "width": 1,
                      "height": "{{ '3' if status_bar else '4' }}"
                    },
                    "template": "{{ ('{{alert_color}}' * 3) if status_bar else ('{{alert_color}}' * 4) }}"
                  },
                  {
                  {% endif %}
                  
                    "style": {
                      "justify": "center",
                      "align": "center",
                      "width": "{{ '20' if alert != 'none' else '22' }}",
                      "height": "{% if alert != 'none' and status_bar %}3{% elif status_bar %}5{% elif alert != 'none' %}4{% else %}6{% endif %}"
                    },
                    "template": "{{ '{{text}}' }}"
                  {% if alert != 'none' %}
                  },
                  {
                    "style": {
                      "justify": "center",
                      "align": "center",
                      "width": 1,
                      "height": "{{ '3' if status_bar else '4' }}"
                    },
                    "template": "{{ ('{{alert_color}}' * 3) if status_bar else ('{{alert_color}}' * 4) }}"
                  },
                  {
                    "style": {
                      "justify": "center",
                      "align": "center",
                      "width": 22,
                      "height": 1
                    },
                    "template": "{{ '{{alert_color}}' * 22 }}"
                  {% endif %}
                  {% if status_bar %}
                  },
                  {
                    "style": {
                      "justify": "left",
                      "align": "center",
                      "width": 5,
                      "height": 1
                    },
                    "template": "{{ '{{date}}{{month}}' }}"
                  },
                  {
                    "style": {
                      "justify": "center",
                      "align": "center",
                      "width": 12,
                      "height": 1
                    },
                    "template": "{{ '{{day}}' }}"
                  },
                  {
                    "style": {
                      "justify": "right",
                      "align": "center",
                      "width": 5,
                      "height": 1
                    },
                    "template": "{{ '{{temp}}{62}{{temp_color}}' }}"
                  {% endif %}
                  }
                  
                  ]
      for_each: "{{ target_boards }}"
fields:
  words:
    selector:
      text: null
    description: The text to display on the Vestaboard
    required: true
    name: Message
  status_bar:
    selector:
      boolean: {}
    description: Show the date, day, and temperature status bar at the bottom
    default: false
    required: true
    name: Status Bar
  alert:
    selector:
      select:
        options:
          - none
          - red
          - blue
          - green
          - yellow
          - orange
          - violet
          - white
    default: none
    required: true
    name: Alert Border
    description: Select the color of the border for your message (or none)
  target_boards:
    selector:
      device:
        multiple: true
        integration: vestaboard
    description: What vestaboard device(s) should the message go to?
    required: true
    default:
      - 367436747349d054cdcb82c9feb7d107
    name: Target Vestaboard
  temp_source:
    selector:
      entity:
        filter:
          - device_class: temperature
            domain: sensor
    name: Temperature Entity
    description: Pick a temperature source for the status bar
    default: sensor.openweather_feels_like_temperature
    required: true
alias: Vestaboard - Message with Options
description: >-
  Lets to send a basic message, with the option to add an alert frame, and a
  status bar.

[lordratner]

I've caught an error, but I'm not sure how to fix it. Depending on how this line is built, I can either send the ' symbol or the " symbol, but the other will either break the script or send an escaped version of the character.

"template": "{{ '{{text}}' }}"

This way (using the props method of VBML to inject the text) results in a successful run of the script, however the " is replaced with " and the ' is replaced with '

"template": "{{ words }}"

This way (directly injecting the script field into the VBML) allows me to send the ' character, but the " character will error out the script by breaking the dictionary being send for the VBML.

Any ideas, @natekspencer ?