Configuration

This Strategy needs you to configure it for it to work!

Take a look at the Configuration Documentation for the required options!

Strategy Options

Click for Configuration Options
optiondescriptiontyperequiredexample
presetsThe presets for which there will be buttons which load the history of the specified (filtered) entities. Arrayyes
presets:
  - icon: mdi:motion-sensor
    title: Occupancy
    filter:
      include:
        - type: entity
          comparator: match
          value: ^binary_sensor\..*_occupancy$
  - icon: mdi:light-bulb
    title: Lights (but not Living Room)
    filter:
      include:
        - type: domain
          value:
      exclude:
        - type: area
          value: living_room

So valid YAML for this could look like this:

Click for full example
---
strategy:
    type: custom:log-view-strategy
    config:
        presets:
        -   icon: mdi:motion-sensor
            title: Occupancy
            filter:
                include:
                -   type: entity
                    comparator: match
                    value: "^binary_sensor\\..*_occupancy$"
        -   icon: mdi:light-bulb
            title: Lights (but not Living Room)
            filter:
                include:
                -   type: domain
                    value:
                exclude:
                -   type: area
                    value: living_room
icon: mdi:test
path: test
title: Test
I used all available options in this example. You don`t need to do this! Take a look at the required fields for what you need!

References

Log Preset

Defines the Button on the side and which entities will be loaded in the Log Card when the Preset Button is clicked.

Define as many Log Presets as you want.

Click for Configuration Options
optiondescriptiontyperequiredexample
presetsThe presets for which there will be buttons which load the history of the specified (filtered) entities. Arrayyes
presets:
  - icon: mdi:motion-sensor
    title: Occupancy
    filter:
      include:
        - type: entity
          comparator: match
          value: ^binary_sensor\..*_occupancy$
  - icon: mdi:light-bulb
    title: Lights (but not Living Room)
    filter:
      include:
        - type: domain
          value:
      exclude:
        - type: area
          value: living_room

So valid YAML for this could look like this:

Click for full example
---
presets:
-   icon: mdi:motion-sensor
    title: Occupancy
    filter:
        include:
        -   type: entity
            comparator: match
            value: "^binary_sensor\\..*_occupancy$"
-   icon: mdi:light-bulb
    title: Lights (but not Living Room)
    filter:
        include:
        -   type: domain
            value:
        exclude:
        -   type: area
            value: living_room
I used all available options in this example. You don`t need to do this! Take a look at the required fields for what you need!

Filter

Filters can be defined for fine-grained control which entities should be matched. You can use both include and exclude as keys. Both are optional.

filter:
  include:
    - ...
  exclude:
    - ...

Both accept the same types and syntax.

An entity needs to match all include filters to be included but it needs only to match one of the exclude filters to be excluded!

The filter object looks like this.

Click for Configuration Options
optiondescriptiontyperequireddefaultexample
typeThe type of filter to determine the value from the entity/area. Referenceyes-
type: state
configExtra configuration options for the filter type.

Only required and applied for label/attribute!

Referenceno-
config:
  key: device_class
comparatorCompare method for value 1 (extracted from entity/area) and value 2 (specified by user) Referenceno equal
comparator: equal
valueThe user specified value

Not needed for is_numeric and is_null

unknownno-
value: on

So valid YAML for this could look like this:

Click for full example
---
type: state
config:
    key: device_class
comparator: equal
value: true
I used all available options in this example. You don`t need to do this! Take a look at the required fields for what you need!
Filter Comparator
Click for Configuration Options
optiondescriptionexample
equalCheck if the selected type value of the entity and the passed value are equal.
- type: state
  comparator: equal
  value: on
matchCheck if the selected type value of the entity matches against the passed regexp value.

Regexp can be tested here

- type: entity
  comparator: match
  value: ^.*_occupancy$
inCheck if the selected type value of the entity is in the list of defined values.

value needs to be an array!

- type: state
  comparator: in
  value:
    - on
    - off
greater_thanCheck if the selected type value of the entity is greater than the defined value.

Works only on numeric type values and defined values!

- type: state
  comparator: greater_than
  value: 5
lower_thanCheck if the selected type value of the entity is lower than the defined value.

Works only on numeric type values and defined values!

- type: state
  comparator: lower_than
  value: 5
is_nullCheck if the selected type value of the entity is null.

Does not need a value defined! Exception is type: attribute as it needs key for attribute name!

- type: state
  comparator: is_null
is_numericCheck if the selected type value of the entity is numeric.

Does not need a value defined! Exception is type: attribute as it needs key for attribute name!

- type: attribute
  comparator: is_numeric
  value:
    key: volume