Skip to content

Latest commit

 

History

History
588 lines (519 loc) · 20.4 KB

SmartWeather reference.md

File metadata and controls

588 lines (519 loc) · 20.4 KB
Raw

SmartWeather - This is an example for backwards compatibility and reference ONLY

DO NOT SIMPLY COPY THIS FILE AND INCLUDE IN YOUR CONFIG WITHOUT UNDERSTANDING IT!

I include this to help you use SmartWeather if you so chose to do. This is my old SmartWeather config which uses five stations it may need some changes to make it suitable for you. Or, it might work as it is.

I still use SmartWeather for Illuminance so that is included here too but plays no part in the irrigation package, I use it with my lights automations. There is also a fallback Brightness sensor in here that I use when the SmartWeather stations went offline. It is less useful if you use several stations as I now do but it is left here for completeness.

You can use any of it in your config if it is useful but please remember that I am only offering this file as a guide to help you.

DO NOT SIMPLY COPY THIS FILE AND INCLUDE IN YOUR CONFIG WITHOUT UNDERSTANDING IT!

secrets.yaml

smartweather_api_key: [SMARTWEATHER_API_KEY]
smartweather_location_code_1: [CODE1]
smartweather_location_code_2: [CODE2]
smartweather_location_code_3: [CODE3]
smartweather_location_code_4: [CODE4]
smartweather_location_code_5: [CODE5]

smartweather.yaml

#===================
#=== Input Booleans
#===================
input_boolean:
  #================================================
  #=== Indicate which stations to use for rainfall
  #================================================
  smartweather_rainfall_use_location_1:
  smartweather_rainfall_use_location_2:
  smartweather_rainfall_use_location_3:
  smartweather_rainfall_use_location_4:
  smartweather_rainfall_use_location_5:


#================
#=== Input Texts
#================
input_text:

  #=== Smartweather Location Codes
  smartweather_location_code1:
    min: 0
    max: 7
    initial: !secret smartweather_location_code_1

  smartweather_location_code2:
    min: 0
    max: 7
    initial: !secret smartweather_location_code_2

  smartweather_location_code3:
    min: 0
    max: 7
    initial: !secret smartweather_location_code_3

  smartweather_location_code4:
    min: 0
    max: 7
    initial: !secret smartweather_location_code_4

  smartweather_location_code5:
    min: 0
    max: 7
    initial: !secret smartweather_location_code_5


#============
#=== Sensors
#============
sensor:

  #====================================================
  #=== SmartWeather Sensors 
  #=== see - https://smartweather.weatherflow.com/map
  #===       for location of weather stations
  #===
  #=== Used to create sensors for
  #===   illuminance
  #===   rain today
  #===   rain yesterday
  #====================================================

  #=== Station 1 (see secrets.yaml)
  - platform: rest
    resource: !secret smartweather_resource_1
    name: smartweather_1
    value_template: >
      {{ value_json.station_id }}
    json_attributes:
      - station_name
      - status
      - station_units
      - obs    
    scan_interval:
      minutes: 86400

  #=== Station 2 (see secrets.yaml)
  - platform: rest
    resource: !secret smartweather_resource_2
    name: smartweather_2
    value_template: >
      {{ value_json.station_id }}
    json_attributes:
      - station_name
      - status
      - station_units
      - obs    
    scan_interval:
      minutes: 86400

  #=== Station 3 (see secrets.yaml)
  - platform: rest
    resource: !secret smartweather_resource_3
    name: smartweather_3
    value_template: >
      {{ value_json.station_id }}
    json_attributes:
      - station_name
      - status
      - station_units
      - obs    
    scan_interval:
      minutes: 86400

  #=== Station 4 (see secrets.yaml)
  - platform: rest
    resource: !secret smartweather_resource_4
    name: smartweather_4
    value_template: >
      {{ value_json.station_id }}
    json_attributes:
      - station_name
      - status
      - station_units
      - obs    
    scan_interval:
      minutes: 86400

  #=== Station 5 (see secrets.yaml)
  - platform: rest
    resource: !secret smartweather_resource_5
    name: smartweather_5
    value_template: >
      {{ value_json.station_id }}
    json_attributes:
      - station_name
      - status
      - station_units
      - obs    
    scan_interval:
      minutes: 86400


  #=== Average Smartweather Illuminance
  - platform: min_max
    type: mean
    name: Smartweather Average Illuminance
    entity_ids:
      - sensor.smartweather_1_illuminance
      - sensor.smartweather_2_illuminance
      - sensor.smartweather_3_illuminance
      - sensor.smartweather_4_illuminance
      - sensor.smartweather_5_illuminance


  #=== Average Smartweather Rain Today
  - platform: min_max
    type: mean
    name: Smartweather Average Rain today
    entity_ids:
      - sensor.smartweather_1_rain_today
      - sensor.smartweather_2_rain_today
      - sensor.smartweather_3_rain_today
      - sensor.smartweather_4_rain_today
      - sensor.smartweather_5_rain_today


  #=== Average Smartweather Rain Yesterday
  - platform: min_max
    type: mean
    name: Smartweather Average Rain yesterday
    entity_ids:
      - sensor.smartweather_1_rain_yesterday
      - sensor.smartweather_2_rain_yesterday
      - sensor.smartweather_3_rain_yesterday
      - sensor.smartweather_4_rain_yesterday
      - sensor.smartweather_5_rain_yesterday


  - platform: template
    sensors:
      #=============================
      #=== SmartWeather Illuminance 
      #=============================
      smartweather_1_illuminance:
        friendly_name: SmartWeather (id 1) Illuminance
        value_template: >
          {% set obs = state_attr('sensor.smartweather_1', 'obs') %}
          {% if obs is sequence and obs|length > 0 and obs[0].brightness is defined %}
            {{ obs[0].brightness }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: lux

      smartweather_2_illuminance:
        friendly_name: SmartWeather (id 2) Illuminance
        value_template: >
          {% set obs = state_attr('sensor.smartweather_2', 'obs') %}
          {% if obs is sequence and obs|length > 0 and obs[0].brightness is defined %}
            {{ obs[0].brightness }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: lux

      smartweather_3_illuminance:
        friendly_name: SmartWeather (id 3) Illuminance
        value_template: >
          {% set obs = state_attr('sensor.smartweather_3', 'obs') %}
          {% if obs is sequence and obs|length > 0 and obs[0].brightness is defined %}
            {{ obs[0].brightness }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: lux

      smartweather_4_illuminance:
        friendly_name: SmartWeather (id 4) Illuminance
        value_template: >
          {% set obs = state_attr('sensor.smartweather_4', 'obs') %}
          {% if obs is sequence and obs|length > 0 and obs[0].brightness is defined %}
            {{ obs[0].brightness }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: lux

      smartweather_5_illuminance:
        friendly_name: SmartWeather (id 5) Illuminance
        value_template: >
          {% set obs = state_attr('sensor.smartweather_5', 'obs') %}
          {% if obs is sequence and obs|length > 0 and obs[0].brightness is defined %}
            {{ obs[0].brightness }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: lux

      # #=== Average Smartweather Illuminance
      # smartweather_average_illuminance:
      #   friendly_name: SmartWeather Average Illuminance
      #   entity_id:
      #     - sensor.smartweather_2_illuminance
      #     - sensor.smartweather_3_illuminance
      #     - sensor.smartweather_5_illuminance
      #   value_template: >
      #     {% set entities = ['sensor.smartweather_2_illuminance',
      #                        'sensor.smartweather_3_illuminance',
      #                        'sensor.smartweather_5_illuminance'] %}
      #     {% set ns = namespace(count=0, value=0) %}
      #     {% for e in entities %}
      #       {% set s = states(e) %}
      #       {% if s != 'unknown' and
      #             s != 'unavailable' and
      #             s != '' %}
      #         {% set ns.count = ns.count + 1 %}
      #         {% set ns.value = ns.value + s | float %}
      #       {% endif %}
      #     {% endfor %}
      #     {% if ns.count == 0 %}
      #       'smartweather_unavailable'
      #     {% else %}
      #       {{ ns.value / ns.count }}
      #     {% endif %}
      #   unit_of_measurement: lux


      #========================================
      #=== Decode illuminance to a light level
      #========================================
      outside_light_level:
        friendly_name: Outside Light Level 
        value_template: >
          {% if states('sensor.current_light_level_sensor') == 'SmartWeather' %}
            {% set light_level = states('sensor.smartweather_average_illuminance') | int %}
          {% else %}
            {% set light_level = states('sensor.brightness') | int %}
          {% endif %}

          {% if light_level == 0 %} Dark
          {% elif light_level <= 1 %} Bright moonlight
          {% elif light_level <= 2 %} Night light
          {% elif light_level <= 10 %} Dimmed light
          {% elif light_level <= 50 %} 'Cosy' living room
          {% elif light_level <= 150 %} 'Normal' non-task light
          {% elif light_level <= 350 %} Working / reading
          {% elif light_level <= 700 %} Inside daylight
          {% elif light_level <= 2000 %} Maximum to avoid glare
          {% elif light_level <= 10000 %} Clear daylight
          {% elif light_level <= 120000 %} Direct sunlight
          {% else %} Too bright!
          {% endif %}
        icon_template: >
          {% if states('sensor.current_light_level_sensor') == 'SmartWeather' %}
            {% set light_level = states('sensor.smartweather_average_illuminance') | int %}
          {% else %}
            {% set light_level = states('sensor.brightness') | int %}
          {% endif %}

          {% if light_level == 0 %} mdi:brightness-1
          {% elif light_level <= 1 %} mdi:brightness-3
          {% elif light_level <= 2 %} mdi:candle
          {% elif light_level <= 10 %} mdi:brightness-4
          {% elif light_level <= 50 %} mdi:fireplace
          {% elif light_level <= 150 %} mdi:ceiling-light
          {% elif light_level <= 350 %} mdi:book-open-page-variant
          {% elif light_level <= 700 %} mdi:window-closed
          {% elif light_level <= 2000 %} mdi:weather-sunny
          {% elif light_level <= 10000 %} mdi:white-balance-sunny
          {% elif light_level <= 120000 %} mdi:sunglasses
          {% else %} mdi:alert-octagram-outline
          {% endif %}         


      #============================
      #=== SmartWeather Rain Today 
      #============================
      smartweather_1_rain_today:
        friendly_name: SmartWeather (id 1) Rain Today
        value_template: >
          {% set obs = state_attr('sensor.smartweather_1', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_1', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_day is defined %}
            {{ obs[0].precip_accum_local_day }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_2_rain_today:
        friendly_name: SmartWeather (id 2) Rain Today
        value_template: >
          {% set obs = state_attr('sensor.smartweather_2', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_2', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_day is defined %}
            {{ obs[0].precip_accum_local_day }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_3_rain_today:
        friendly_name: SmartWeather (id 3) Rain Today
        value_template: >
          {% set obs = state_attr('sensor.smartweather_3', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_3', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_day is defined %}
            {{ obs[0].precip_accum_local_day }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_4_rain_today:
        friendly_name: SmartWeather (id 4) Rain Today
        value_template: >
          {% set obs = state_attr('sensor.smartweather_4', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_4', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_day is defined %}
            {{ obs[0].precip_accum_local_day }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_5_rain_today:
        friendly_name: SmartWeather (id 5) Rain Today
        value_template: >
          {% set obs = state_attr('sensor.smartweather_5', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_5', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_day is defined %}
            {{ obs[0].precip_accum_local_day }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm


      #================================
      #=== SmartWeather Rain Yesterday 
      #================================
      smartweather_1_rain_yesterday:
        friendly_name: SmartWeather (id 1) Rain Yesterday
        value_template: >
          {% set obs = state_attr('sensor.smartweather_1', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_1', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_yesterday is defined %}
            {{ obs[0].precip_accum_local_yesterday }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_2_rain_yesterday:
        friendly_name: SmartWeather (id 2) Rain Yesterday
        value_template: >
          {% set obs = state_attr('sensor.smartweather_2', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_2', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_yesterday is defined %}
            {{ obs[0].precip_accum_local_yesterday }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_3_rain_yesterday:
        friendly_name: SmartWeather (id 3) Rain Yesterday
        value_template: >
          {% set obs = state_attr('sensor.smartweather_3', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_3', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_yesterday is defined %}
            {{ obs[0].precip_accum_local_yesterday }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_4_rain_yesterday:
        friendly_name: SmartWeather (id 4) Rain Yesterday
        value_template: >
          {% set obs = state_attr('sensor.smartweather_4', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_4', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_yesterday is defined %}
            {{ obs[0].precip_accum_local_yesterday }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm

      smartweather_5_rain_yesterday:
        friendly_name: SmartWeather (id 5) Rain Yesterday
        value_template: >
          {% set obs = state_attr('sensor.smartweather_5', 'obs') %}
          {% if is_state('input_boolean.smartweather_rainfall_use_location_5', 'off') %}
            unknown
          {% elif obs is sequence and obs|length > 0 and obs[0].precip_accum_local_yesterday is defined %}
            {{ obs[0].precip_accum_local_yesterday }}
          {% else %}
            unknown
          {% endif %}
        unit_of_measurement: mm


#================
#=== Automations
#================
automation:
  #================================================================= 
  #=== Update the SmartWeather sensors
  #===
  #=== If using SmartWeather
  #===     When sun elevation >= -6
  #===       If SmartWeather illuminance <= 5000, set 1 minute
  #===       Else if SmartWeather illuminnace <= 7500, set 15 minutes
  #===       Else if SmartWeather illuminance > 7500, set 30 minutes
  #===     Else set 18 hours
  #===
  #=== If using Brightness 
  #===     When sun elevation >= -6
  #===       If Brightness <= 25, set 1 minute
  #===       Else if Brightness <= 30, set 15 minutes
  #===       Else if Brightness > 30, set 30 minutes
  #===     Else set 18 hours
  #=== 
  #==================================================================
  - alias: SmartWeather Update Sensors
    mode: restart
    trigger:
      - platform: homeassistant
        event: start

      - platform: numeric_state
        entity_id: sensor.elevation
        above: -6
        
    action:
      - repeat:
          while: []
          sequence:
            #=== Update sensors
            - service: homeassistant.update_entity
              entity_id: sensor.smartweather_1

            - service: homeassistant.update_entity
              entity_id: sensor.smartweather_2

            - service: homeassistant.update_entity
              entity_id: sensor.smartweather_3

            - service: homeassistant.update_entity
              entity_id: sensor.smartweather_4

            - service: homeassistant.update_entity
              entity_id: sensor.smartweather_5

            #=== Wait the desired time
            - delay: >
                {% if states('sensor.elevation') | float >= -6 and 
                      states('sensor.current_light_level_sensor') == 'SmartWeather' %}
                  {% if states('sensor.smartweather_average_illuminance') | int <= 5000 %}
                    00:01:00
                  {% elif states('sensor.smartweather_average_illuminance') | int <= 7500 %}
                    00:15:00
                  {% else %}
                    00:30:00
                  {% endif %}
                {% elif states('sensor.elevation') | float >= -6 and 
                        states('sensor.current_light_level_sensor') == 'Brightness' %}
                  {% if states('sensor.brightness') | int <= 25 %}
                    00:01:00
                  {% elif states('sensor.brightness') | int <= 30 %}
                    00:15:00
                  {% else %}
                    00:30:00
                  {% endif %}
                {% else %}
                  18:00:00
                {% endif %}


__brightness.yaml__

#================= #=== Sensors #================= sensor:

  • platform: template sensors:

    #================================================================ #=== Brightness sensor #=== Estimates the current light level outside as a percentage #=== using sun elevation and the DarkSky cloud coverage. #================================================================= brightness: friendly_name: 'Brightness' value_template: >- {% set elevation = state_attr('sun.sun','elevation') | float %} {% set cloud_coverage = states('sensor.dark_sky_current_cloud_coverage') | float %} {% set cloud_factor = (1 - (0.75 * ( cloud_coverage / 100) ** 3 )) %}

      {# set this to official sun elevation for end of twighlight #}
  {% set min_elevation = -6 %}

  {# set this to the maximum noon sun elevation (lowest maximum here is 15 degrees) #}
  {% set max_elevation = 62 %}

  {% set adjusted_elevation = elevation - min_elevation %}
  {% set adjusted_elevation = [adjusted_elevation, 0] | max %}
  {% set adjusted_elevation = [adjusted_elevation, max_elevation - min_elevation] | min %}
  {% set adjusted_elevation = adjusted_elevation / (max_elevation - min_elevation) %}
  {% set adjusted_elevation = adjusted_elevation * 100 %}
  {% set brightness = adjusted_elevation * cloud_factor %}
  
  {{ brightness | round }}
unit_of_measurement: '%'
device_class: 'illuminance'