Base service

The main card of the service. Other services are based on this service.

Title

Service Title

title: Home Assistant

Description

Additional description, which is displayed right below the title. This field is convenient when you have two similar services, but they need to be differentiated somehow.

description: Home automation

Link

Link to service. It is used when clicking on the icon and title. It is also used to check the status availability if no URL has been set.

link: https://home-assistant.home.local/

Target

Browser behavior when the service is clicked. With this property, you can make the service open in the current or a new window.

target: _blank

Values:

Value	Description
_blank	Usually a new tab, but users can configure browsers to open a new window instead
_self	The current browsing context
_parent	The parent browsing context of the current one. If no parent, behaves as _self
_top	The topmost browsing context (the "highest" context that's an ancestor of the current one). If no ancestors, behaves as _self

Default: _blank

WARNING

This property takes precedence over behaviour.target from config.yml. You can read more in the configuration

Icon

Service icon. Allows you to quickly find the required item. This field can be very flexibly customized by combining different parameters.

icon:
  name: simple-icons:homeassistant
  wrap: true

or from local files:

icon:
  url: icons/homeassistant.svg
  background: '#eee'

Settings

See icons for details.

Tags

Tags allow you to differentiate between services. It is quite convenient when you have several services that belong to the same project.

tags:
  - name: Home
    color: green

or just a list of tags:

tags:
  - Home

Settings

See tags for details.

Status

Waffle checks the health of your service at the specified interval using the url. If no url provided it uses the link instead.

status:
  enabled: true
  interval: 60 # need not be specified
  url: https://home-assistant.home.local/api/health # need not be specified

enabled

Enabling status

Values: true, false

Default: false

url

The URL that will be used to check the status. If not specified, the link field will be used.

Values: string

animation

Enabling animation

Values: true, false

Default: true

interval

Status Update Interval.

Values: number

Default: 60 sec

WARNING

We do not recommend changing the interval. This can cause a heavy load on the system if you have a lot of different services.

Examples

Base service

config.yml

services:
  - title: Home Assistant
    description: Home automation
    link: https://home-assistant.home.local/
    icon:
      name: simple-icons:homeassistant
      wrap: true
      color: '#3dbcf3'

Status Tracking

config.yml

services:
  - title: Home Assistant
    description: Home automation
    link: https://home-assistant.home.local/
    icon:
      name: simple-icons:homeassistant
      wrap: true
      color: '#3dbcf3'
    status:
      enabled: true