mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Add Jekyll terminology tooltip plugin (#26542)
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
Franck Nijhof
GitHub
parent
6cdee730e1
commit
8b71353f75
52
plugins/terminology_tooltip.rb
Normal file
52
plugins/terminology_tooltip.rb
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
module Jekyll
|
||||||
|
module HomeAssistant
|
||||||
|
class TerminologyTooltip < Liquid::Tag
|
||||||
|
|
||||||
|
def initialize(tag_name, args, tokens)
|
||||||
|
super
|
||||||
|
if args.strip =~ SYNTAX
|
||||||
|
@term = Regexp.last_match(1)
|
||||||
|
@text = Regexp.last_match(2)
|
||||||
|
else
|
||||||
|
raise SyntaxError, <<~MSG
|
||||||
|
Syntax error in tag 'term' while parsing the following options:
|
||||||
|
|
||||||
|
#{args}
|
||||||
|
|
||||||
|
Valid syntax:
|
||||||
|
{% term <term> [<text>] %}
|
||||||
|
MSG
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def render(context)
|
||||||
|
entries = context.registers[:site].data["glossary"].select do |entry|
|
||||||
|
entry.key?("term") and (@term.casecmp(entry["term"]).zero? or (entry.key?("aliases") and entry["aliases"].any?{ |s| s.casecmp(@term)==0 }))
|
||||||
|
end
|
||||||
|
|
||||||
|
raise ArgumentError, "Term #{@term} was not found in the glossary" if entries.length == 0
|
||||||
|
raise ArgumentError, "Term #{@term} is in the glossary multiple times" if entries.length > 1
|
||||||
|
raise ArgumentError, "Term #{@term} is missing a definition" unless entries[0].key?("definition")
|
||||||
|
glossary = entries[0]
|
||||||
|
|
||||||
|
definition = glossary["excerpt"] || glossary["definition"]
|
||||||
|
|
||||||
|
if glossary.key?("link")
|
||||||
|
rendered_link = Liquid::Template.parse(glossary["link"]).render(context).strip
|
||||||
|
link = "<br><a class='terminology-link' href='#{rendered_link}' target='_blank'>[Learn more]</a>"
|
||||||
|
end
|
||||||
|
|
||||||
|
tooltip = "<span class='terminology-tooltip'>#{definition}#{link || ""}</span>"
|
||||||
|
|
||||||
|
"<span class='terminology'>#{@text || @term}#{tooltip}</span>"
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
SYNTAX = %r!^(\w+?|".+?")(?:\s+(\w+|".+"))?$!.freeze
|
||||||
|
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
Liquid::Template.register_tag('term', Jekyll::HomeAssistant::TerminologyTooltip)
|
||||||
46
sass/custom/_terminology_tooltip.scss
Normal file
46
sass/custom/_terminology_tooltip.scss
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
.terminology {
|
||||||
|
position: relative;
|
||||||
|
border-bottom: 2px dotted $primary-color;
|
||||||
|
cursor: help;
|
||||||
|
|
||||||
|
&:hover .terminology-tooltip {
|
||||||
|
visibility: visible;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.terminology-tooltip {
|
||||||
|
visibility: hidden;
|
||||||
|
width: 250px;
|
||||||
|
background-color: $primary-color;
|
||||||
|
color: #fff;
|
||||||
|
font-size: 0.8em;
|
||||||
|
padding: 8px;
|
||||||
|
border-radius: 8px;
|
||||||
|
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.5s;
|
||||||
|
|
||||||
|
position: absolute;
|
||||||
|
z-index: 1;
|
||||||
|
|
||||||
|
bottom: 100%;
|
||||||
|
left: 50%;
|
||||||
|
margin-left: -125px;
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #fff;
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:after {
|
||||||
|
content: " ";
|
||||||
|
position: absolute;
|
||||||
|
top: 100%;
|
||||||
|
left: 50%;
|
||||||
|
margin-left: -5px;
|
||||||
|
border-width: 5px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: $primary-color transparent transparent transparent;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -8,4 +8,5 @@
|
|||||||
@import 'custom/print';
|
@import 'custom/print';
|
||||||
@import 'custom/layout';
|
@import 'custom/layout';
|
||||||
@import 'custom/getting_started';
|
@import 'custom/getting_started';
|
||||||
@import 'custom/tabbed_block';
|
@import 'custom/tabbed_block';
|
||||||
|
@import 'custom/terminology_tooltip';
|
||||||
|
|||||||
@ -1,78 +1,299 @@
|
|||||||
- topic: Action
|
## Glossary
|
||||||
description: "An [Action](/docs/automation/action/) is an event that can be fired as a response to a trigger, once all conditions have been met."
|
#
|
||||||
- topic: Add-on
|
# Format is a list of terms, each term is a dictionary with the following keys:
|
||||||
description: "Add-ons are additional standalone third-party software packages that can be installed on Home Assistant OS. Most of these, add-on provided, applications can be integrated into Home Assistant using integrations. Examples of add-ons are: an MQTT broker, database service or a file server."
|
# - term: The term to define (required)
|
||||||
- topic: Automation
|
# - definition: The definition of the term (required)
|
||||||
description: "[Automations](/docs/automation/) connect one or more triggers to one or more actions in a 'when trigger then do action' fashion with additional optional conditions. For example, an automation might connect the trigger 'sunset' to the action 'turn the lights on' but only if the condition 'someone is home' is met. Pre-made automations for common use-cases are available via [the blueprints feature](/docs/automation/using_blueprints/)."
|
# - excerpt: Short excerpt of the definition, overrides definition for tooltips (optional)
|
||||||
- topic: Binary sensor
|
# - link: A URL to link to for more information (optional)
|
||||||
description: "A [binary sensor](/integrations/binary_sensor) returns information about things that only have two states - such as on or off."
|
# - aliases: A list of aliases for the term (optional)
|
||||||
- topic: Component
|
#
|
||||||
description: "Integrations (see below) used to be known as components."
|
|
||||||
- topic: Condition
|
- term: Action
|
||||||
description: "[Conditions](/docs/scripts/conditions/) are an optional part of an automation that will prevent an action from firing if they are not met."
|
definition: >
|
||||||
- topic: Cover
|
An action is an command that can be fired. For example, turning on a light.
|
||||||
description: "[Covers](/integrations/cover) are devices such as blinds, garage doors, etc that can be opened and closed and optionally set to a specific position."
|
Actions used in many places, most notably in automations and scripts.
|
||||||
- topic: Customize
|
aliases:
|
||||||
description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameters of your devices in the configuration."
|
- actions
|
||||||
- topic: Device
|
link: /docs/automation/action/
|
||||||
description: "A device is a named collection of entities that all represent the same physical/logical unit, which can do or observe something. An example for a device would be a smart plug named 'Coffee Machine' which provides a `switch` entity plus one or more `sensor` entities for power monitoring or similar."
|
|
||||||
- topic: Device tracker
|
- term: Add-on
|
||||||
description: "[Device trackers](/integrations/device_tracker) are used to track the presence, or location, of a device."
|
definition: >
|
||||||
- topic: Discovery
|
Add-ons are additional standalone third-party software packages that can be
|
||||||
description: "Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered."
|
installed on Home Assistant OS. Most of these, add-on provided, applications
|
||||||
- topic: Domain
|
can be integrated into Home Assistant using integrations. Examples of
|
||||||
description: "Each integration in Home Assistant has a unique identifier: a domain. All of the entities and services available in Home Assistant are provided by integrations and thus belong to such a domain. The first part of the entity or service, before the `.` shows the domain they belong to. For example `light.kitchen` is an entity in the `light` domain from the [light integration](/integrations/light), while `hue.activate_scene` is the `activate_scene` service for the `hue` domain which belongs to the [Hue integration](/integrations/hue)."
|
add-ons are: an MQTT broker, database service or a file server.
|
||||||
- topic: Entity
|
excerpt: >
|
||||||
description: "An entity is the representation of a single control or data point of a device or service inside Home Assistant. A single device or service can thus provide multiple entities to be able to monitor and control all features a device provides. For example, a combined temperature and humidity sensor, in general, provides two `sensor` entities. One for the temperature (e.g., `sensor.temperature` with state `21.0` and unit `°C`) and one for the humity (e.g., `sensor.humidity` with state `65.4` and unit `%`)."
|
Add-ons are additional standalone third-party software packages that can be
|
||||||
- topic: Event
|
installed on Home Assistant OS.
|
||||||
description: "An [event](/docs/configuration/events/) is when something happens."
|
|
||||||
- topic: Frontend
|
- term: Automation
|
||||||
description: "The [frontend](/integrations/frontend/) is a necessary component for the UI, it is also where you can define your themes."
|
definition: >
|
||||||
- topic: Group
|
Automations connect one or more triggers to one or more actions in a
|
||||||
description: "[Groups](/integrations/group/) are a way to organize your entities into a single unit."
|
'when trigger then do action' fashion with additional optional conditions.
|
||||||
- topic: HASS
|
For example, an automation might connect the trigger 'sunset' to the action
|
||||||
description: "HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home Assistant. It is also the command-line tool."
|
'turn the lights on' but only if the condition 'someone is home' is met.
|
||||||
- topic: HassOS
|
Pre-made automations for common use-cases are available via
|
||||||
description: "Another name for Home Assistant Operating System"
|
[the blueprints feature](/docs/automation/using_blueprints/).
|
||||||
- topic: Home Assistant Core
|
excerpt: >
|
||||||
description: Home Assistant Core is a Python program. It can be run on various operating systems and is the basis for Home Assistant. When people are talking about Home Assistant Core they usually refer to a standalone installation method that can be installed using a Virtual Environment or Docker. Home Assistant Core does not use the Home Assistant Supervisor.
|
Automations in Home Assistant allow you to automatically respond to things
|
||||||
- topic: Home Assistant Supervised (Previously Hass.io)
|
that happen in and around your home.
|
||||||
description: "Home Assistant Supervised is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor."
|
link: /docs/automation/
|
||||||
- topic: Home Assistant Supervisor
|
aliases:
|
||||||
description: "The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, add-ons, itself and, if used, updating the Home Assistant Operating System."
|
- automations
|
||||||
- topic: Home Assistant Operating System
|
|
||||||
description: "Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. The Home Assistant Supervisor can keep it up to date, removing the need for you to manage an operating system."
|
- term: Binary sensor
|
||||||
- topic: Integration
|
definition: >
|
||||||
description: "[Integrations](/integrations/) connect and integrates Home Assistant with devices, services, and more. Such an integration contains all the logic that takes care of vendor- and device-specific implementations such as authentication or special protocols and brings those into Home Assistant in a standardized way. For example, the [Hue](/integrations/hue) integration integrates the Philips Hue bridge and its connected bulbs into Home Assistant, making them available as Home Assistant light entities you can control."
|
A binary sensor returns information about things that only have two states -
|
||||||
- topic: Lovelace
|
such as on or off.
|
||||||
description: "Lovelace is the original code name of the UI that is now known as [Home Assistant dashboards](/dashboards)."
|
link: /integrations/binary_sensor
|
||||||
- topic: Light
|
|
||||||
description: "A [light](/integrations/light) has a brightness you can control, and optionally color temperature or RGB color control."
|
- term: Component
|
||||||
- topic: Notification
|
definition: >
|
||||||
description: "You can use [notifications](/integrations/#notifications) to send messages, pictures, and more, to devices."
|
Better known as: Integrations. Integrations used to be known as components.
|
||||||
- topic: Packages
|
|
||||||
description: "[Packages](/docs/configuration/packages/) allow you to bundle different component configurations together."
|
- term: Condition
|
||||||
- topic: Platform
|
definition: >
|
||||||
description: "[Platforms](/docs/configuration/platform_options/) are building blocks provided by some integrations to be used by other integrations. For example, the [Light](/integrations/light) integration provides the `light platform` that is utilized by all integrations providing `light` entities such as e.g. [Hue](/integrations/hue)."
|
Conditions are an optional part of an automation that will prevent an
|
||||||
- topic: Scene
|
action from firing if they are not met.
|
||||||
description: "[Scenes](/integrations/scene/) capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red."
|
link: /docs/scripts/conditions/
|
||||||
- topic: Script
|
|
||||||
description: "[Scripts](/docs/scripts/) are components that allow users to specify a sequence of actions to be executed by Home Assistant when turned on."
|
- term: Cover
|
||||||
- topic: Sensor
|
definition: >
|
||||||
description: "[Sensors](/integrations/sensor) return information about a thing, for instance the level of water in a tank."
|
Covers are devices such as blinds, garage doors, etc that can be opened
|
||||||
- topic: Selectors
|
and closed and optionally set to a specific position.
|
||||||
description: "[Selectors](/docs/blueprint/selectors/) are components for the user interface. Some selectors can, for example, show a toggle button to turn something on or off, while another select can filter a list of devices to show only devices that have motion-sensing capabilities."
|
link: /integrations/cover
|
||||||
- topic: Service
|
|
||||||
description: "[Services](/docs/scripts/service-calls/) are called to perform actions."
|
- term: Customize
|
||||||
- topic: Switch
|
definition: >
|
||||||
description: "[Switches](/integrations/switch) are things that have two states you can select between, such as turning on or off a socket."
|
Customization allows you to overwrite the default parameters of your
|
||||||
- topic: Template
|
devices in the configuration.
|
||||||
description: "A [template](/docs/automation/templating/) is an automation definition that can include variables for the service or data from the trigger values. This allows automations to generate dynamic actions."
|
|
||||||
- topic: Trigger
|
- term: Device
|
||||||
description: "A [trigger](/docs/automation/trigger/) is a set of values or conditions of a platform that are defined to cause an automation to run."
|
definition: >
|
||||||
- topic: TTS
|
A device is a named collection of entities that all represent the same
|
||||||
description: "TTS ([text to speech](/integrations/tts)) allows Home Assistant to talk to you."
|
physical/logical unit, which can do or observe something. An example,
|
||||||
- topic: Variables
|
for a device would be a smart plug named 'Coffee Machine' which provides
|
||||||
description: "[Variables](/docs/scripts/#variables) are used to store values in memory that can be processed e.g. in a script."
|
a `switch` entity plus one or more `sensor` entities for power monitoring
|
||||||
- topic: Zone
|
or similar.
|
||||||
description: "[Zones](/integrations/zone/) are areas that can be used for presence detection."
|
excerpt: >
|
||||||
|
A device is a named collection of entities that all represent the same
|
||||||
|
physical/logical unit, which can do or observe something.
|
||||||
|
|
||||||
|
- term: Device tracker
|
||||||
|
definition: >
|
||||||
|
Device trackers are used to track the presence, or location, of a device.
|
||||||
|
link: /integrations/device_tracker
|
||||||
|
|
||||||
|
- term: Discovery
|
||||||
|
definition: >
|
||||||
|
Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after
|
||||||
|
they are discovered.
|
||||||
|
|
||||||
|
- term: Domain
|
||||||
|
definition: >
|
||||||
|
Each integration in Home Assistant has a unique identifier:
|
||||||
|
a domain. All of the entities and services available in Home Assistant
|
||||||
|
are provided by integrations and thus belong to such a domain. The first
|
||||||
|
part of the entity or service, before the `.` shows the domain they belong
|
||||||
|
to. For example `light.kitchen` is an entity in the `light` domain from
|
||||||
|
the [light integration](/integrations/light), while `hue.activate_scene`
|
||||||
|
is the `activate_scene` service for the `hue` domain which belongs to
|
||||||
|
the [Hue integration](/integrations/hue).
|
||||||
|
excerpt: >
|
||||||
|
Each integration in Home Assistant has a unique identifier: The domain.
|
||||||
|
It is often shown as the first part (before the dot) of entity IDs.
|
||||||
|
|
||||||
|
- term: Entity
|
||||||
|
definition: >
|
||||||
|
An entity is the representation of a single control or data point of a
|
||||||
|
device or service inside Home Assistant. A single device or service can
|
||||||
|
thus provide multiple entities to be able to monitor and control all
|
||||||
|
features a device provides. For example, a combined temperature and
|
||||||
|
humidity sensor, in general, provides two `sensor` entities. One for the
|
||||||
|
temperature (e.g., `sensor.temperature` with state `21.0` and unit `°C`)
|
||||||
|
and one for the humity
|
||||||
|
(e.g., `sensor.humidity` with state `65.4` and unit `%`).
|
||||||
|
excerpt: >
|
||||||
|
An entity is the representation of a single control or data point of a
|
||||||
|
device or service inside Home Assistant.
|
||||||
|
|
||||||
|
- term: Event
|
||||||
|
definition: >
|
||||||
|
An event is when something happens.
|
||||||
|
link: /docs/configuration/events/
|
||||||
|
|
||||||
|
- term: Frontend
|
||||||
|
definition: >
|
||||||
|
The frontend is a necessary component for the UI, it is also where you
|
||||||
|
can define your themes.
|
||||||
|
link: /integrations/frontend/
|
||||||
|
|
||||||
|
- term: Group
|
||||||
|
definition: >
|
||||||
|
Groups are a way to organize your entities into a single unit.
|
||||||
|
link: /integrations/group/
|
||||||
|
|
||||||
|
- term: HASS
|
||||||
|
definition: >
|
||||||
|
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
|
||||||
|
Home Assistant. It is also the command-line tool.
|
||||||
|
|
||||||
|
- term: HassOS
|
||||||
|
definition: >
|
||||||
|
Another name for Home Assistant Operating System
|
||||||
|
link: /hassio/installation/
|
||||||
|
|
||||||
|
- term: Home Assistant Core
|
||||||
|
definition: >
|
||||||
|
Home Assistant Core is a Python program. It can be run on various operating
|
||||||
|
systems and is the basis for Home Assistant. When people are talking about
|
||||||
|
Home Assistant Core they usually refer to a standalone installation method
|
||||||
|
that can be installed using a Virtual Environment or Docker. Home Assistant
|
||||||
|
Core does not use the Home Assistant Supervisor.
|
||||||
|
excerpt: >
|
||||||
|
Home Assistant Core is the hart of Home Assistant itself. It is a Python
|
||||||
|
program that powers every installation type, but can be installed standalone.
|
||||||
|
|
||||||
|
- term: Home Assistant Supervised
|
||||||
|
definition: >
|
||||||
|
Home Assistant Supervised is a full UI managed home automation ecosystem that
|
||||||
|
runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes
|
||||||
|
pre-installed on Home Assistant OS, but can be installed on any Linux system.
|
||||||
|
It leverages Docker, which is managed by the Home Assistant Supervisor.
|
||||||
|
excerpt: >
|
||||||
|
Home Assistant Supervised is the full Home Assistant ecosystem, without the
|
||||||
|
Home Assistant Operating System.
|
||||||
|
|
||||||
|
- term: Home Assistant Supervisor
|
||||||
|
definition: >
|
||||||
|
The Home Assistant Supervisor is a program that manages a Home Assistant
|
||||||
|
installation, taking care of installing and updating Home Assistant,
|
||||||
|
add-ons, itself and, if used, updating the Home Assistant Operating System.
|
||||||
|
|
||||||
|
- term: Home Assistant Operating System
|
||||||
|
definition: >
|
||||||
|
Home Assistant OS, the Home Assistant Operating System, is an embedded,
|
||||||
|
minimalistic, operating system designed to run the Home Assistant ecosystem
|
||||||
|
on single board computers (like the Raspberry Pi) or Virtual Machines.
|
||||||
|
The Home Assistant Supervisor can keep it up to date, removing the need for
|
||||||
|
you to manage an operating system.
|
||||||
|
excerpt: >
|
||||||
|
Home Assistant OS, the Home Assistant Operating System, is an embedded,
|
||||||
|
minimalistic, operating system designed to run the Home Assistant ecosystem.
|
||||||
|
|
||||||
|
- term: Integration
|
||||||
|
definition: >
|
||||||
|
Integrations connect and integrates Home Assistant with devices, services,
|
||||||
|
and more. Such an integration contains all the logic that takes care of
|
||||||
|
vendor- and device-specific implementations such as authentication or
|
||||||
|
special protocols and brings those into Home Assistant in a standardized
|
||||||
|
way. For example, the [Hue](/integrations/hue) integration integrates
|
||||||
|
the Philips Hue bridge and its connected bulbs into Home Assistant, making
|
||||||
|
them available as Home Assistant light entities you can control.
|
||||||
|
excerpt: >
|
||||||
|
Integrations connect and integrates Home Assistant with your devices,
|
||||||
|
services, and more.
|
||||||
|
link: /integrations/
|
||||||
|
|
||||||
|
- term: Lovelace
|
||||||
|
definition: >
|
||||||
|
Lovelace is the original code name of the UI that is now known as
|
||||||
|
[Home Assistant dashboards](/dashboards).
|
||||||
|
|
||||||
|
- term: Light
|
||||||
|
definition: >
|
||||||
|
A light has a brightness you can control, and optionally color temperature
|
||||||
|
or RGB color control.
|
||||||
|
link: /integrations/light
|
||||||
|
|
||||||
|
- term: Notification
|
||||||
|
definition: >
|
||||||
|
You can use notifications to send messages, pictures, and more, to devices.
|
||||||
|
link: /integrations/#notifications
|
||||||
|
|
||||||
|
- term: Packages
|
||||||
|
definition: >
|
||||||
|
Packages allow you to bundle different component configurations together.
|
||||||
|
link: /docs/configuration/packages/
|
||||||
|
|
||||||
|
- term: Platform
|
||||||
|
definition: >
|
||||||
|
Platforms are building blocks provided by some integrations to be used by
|
||||||
|
other integrations. For example, the [Light](/integrations/light)
|
||||||
|
integration provides the `light platform` that is utilized by all
|
||||||
|
integrations providing `light` entities such
|
||||||
|
as e.g. [Hue](/integrations/hue).
|
||||||
|
excerpt: >
|
||||||
|
Platforms are building blocks provided by some integrations to be used by
|
||||||
|
other integrations.
|
||||||
|
link: /docs/configuration/platform_options/
|
||||||
|
|
||||||
|
- term: Scene
|
||||||
|
definition: >
|
||||||
|
Scenes capture the states you want certain entities to be. For example,
|
||||||
|
a scene can specify that light A should be turned on and light B should
|
||||||
|
be bright red.
|
||||||
|
link: /integrations/scene/
|
||||||
|
|
||||||
|
- term: Script
|
||||||
|
definition: >
|
||||||
|
Scripts are components that allow users to specify a sequence of actions
|
||||||
|
to be executed by Home Assistant when turned on.
|
||||||
|
link: /docs/scripts/
|
||||||
|
|
||||||
|
- term: Sensor
|
||||||
|
definition: >
|
||||||
|
Sensors return information about a thing, for instance the level of water
|
||||||
|
in a tank.
|
||||||
|
link: /integrations/sensor/
|
||||||
|
|
||||||
|
- term: Selectors
|
||||||
|
definition: >
|
||||||
|
Selectors are components for the user interface. Some selectors can,
|
||||||
|
for example, show a toggle button to turn something on or off, while another
|
||||||
|
select can filter a list of devices to show only devices that have
|
||||||
|
motion-sensing capabilities.
|
||||||
|
excerpt: >
|
||||||
|
Selectors are components for the user interface. Like toggle, dropdown,
|
||||||
|
and more.
|
||||||
|
link: /docs/blueprint/selectors/
|
||||||
|
|
||||||
|
- term: Service
|
||||||
|
definition: >
|
||||||
|
Services are called to perform actions.
|
||||||
|
link: /docs/scripts/service-calls/
|
||||||
|
|
||||||
|
- term: Switch
|
||||||
|
definition: >
|
||||||
|
Switches are things that have two states you can select between, such as
|
||||||
|
turning on or off a socket.
|
||||||
|
link: /integrations/switch/
|
||||||
|
|
||||||
|
- term: Template
|
||||||
|
definition: >
|
||||||
|
A template is an automation definition that can include variables for the
|
||||||
|
service or data from the trigger values. This allows automations to generate
|
||||||
|
dynamic actions.
|
||||||
|
link: /docs/automation/templating/
|
||||||
|
|
||||||
|
- term: Trigger
|
||||||
|
definition: >
|
||||||
|
A trigger is a set of values or conditions of a platform that are defined
|
||||||
|
to cause an automation to run.
|
||||||
|
link: /docs/automation/trigger/
|
||||||
|
|
||||||
|
- term: TTS
|
||||||
|
definition: >
|
||||||
|
TTS (text to speech) allows Home Assistant to talk to you.
|
||||||
|
link: /integrations/tts/
|
||||||
|
|
||||||
|
- term: Variables
|
||||||
|
definition: >
|
||||||
|
Variables are used to store values in memory that can be processed
|
||||||
|
e.g. in a script.
|
||||||
|
link: /docs/scripts/#variables
|
||||||
|
|
||||||
|
- term: Zone
|
||||||
|
definition: >
|
||||||
|
Zones are areas that can be used for presence detection.
|
||||||
|
link: /integrations/zone/
|
||||||
|
|||||||
@ -3,15 +3,16 @@ title: "Glossary"
|
|||||||
description: "Home Assistant's Glossary."
|
description: "Home Assistant's Glossary."
|
||||||
---
|
---
|
||||||
|
|
||||||
{% assign entries = site.data.glossary | sort: 'topic' %}
|
{% assign entries = site.data.glossary | sort: 'term' %}
|
||||||
|
|
||||||
The glossary covers terms which are used around Home Assistant.
|
The glossary covers terms which are used around Home Assistant.
|
||||||
|
|
||||||
{% configuration_basic %}
|
{% configuration_basic %}
|
||||||
|
|
||||||
{% for entry in entries %}
|
{% for entry in entries %}
|
||||||
"{{ entry.topic }}":
|
"{{ entry.term }}":
|
||||||
description: "{{ entry.description }}"
|
description: "{{ entry.definition }}
|
||||||
|
{% if entry.link %}<br />[Read more about: {{ entry.term }}]({{ entry.link }}){% endif %}"
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
{% endconfiguration_basic %}
|
{% endconfiguration_basic %}
|
||||||
|
|||||||
@ -5,7 +5,7 @@ toc: true
|
|||||||
no_toc: true
|
no_toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
Scripts are a sequence of actions that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in [automations] and [Alexa/Amazon Echo] configurations.
|
Scripts are a sequence of {% term actions %} that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in {% term automations %} and [Alexa/Amazon Echo] configurations.
|
||||||
|
|
||||||
When the script is executed within an automation the `trigger` variable is available. See [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data).
|
When the script is executed within an automation the `trigger` variable is available. See [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data).
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user