mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Update the device entry in glossary (#26626)
Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
parent
730c64517e
commit
84fa897a92
@ -9,7 +9,7 @@
|
||||
#
|
||||
|
||||
- term: Action
|
||||
definition: >
|
||||
definition: >-
|
||||
An action is an command that can be fired. For example, turning on a light.
|
||||
Actions used in many places, most notably in automations and scripts.
|
||||
aliases:
|
||||
@ -17,7 +17,7 @@
|
||||
link: /docs/automation/action/
|
||||
|
||||
- term: Add-on
|
||||
definition: >
|
||||
definition: >-
|
||||
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
|
||||
@ -27,14 +27,14 @@
|
||||
installed on Home Assistant OS.
|
||||
|
||||
- term: Automation
|
||||
definition: >
|
||||
definition: >-
|
||||
Automations 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: >
|
||||
excerpt: >-
|
||||
Automations in Home Assistant allow you to automatically respond to things
|
||||
that happen in and around your home.
|
||||
link: /docs/automation/
|
||||
@ -42,45 +42,48 @@
|
||||
- automations
|
||||
|
||||
- term: Binary sensor
|
||||
definition: >
|
||||
definition: >-
|
||||
A binary sensor returns information about things that only have two states -
|
||||
such as on or off.
|
||||
link: /integrations/binary_sensor
|
||||
|
||||
- term: Component
|
||||
definition: >
|
||||
definition: >-
|
||||
Better known as: Integrations. Integrations used to be known as components.
|
||||
|
||||
- term: Condition
|
||||
definition: >
|
||||
definition: >-
|
||||
Conditions are an optional part of an automation that will prevent an
|
||||
action from firing if they are not met.
|
||||
link: /docs/scripts/conditions/
|
||||
|
||||
- term: Cover
|
||||
definition: >
|
||||
definition: >-
|
||||
Covers are devices such as blinds, garage doors, etc that can be opened
|
||||
and closed and optionally set to a specific position.
|
||||
link: /integrations/cover
|
||||
|
||||
- term: Customize
|
||||
definition: >
|
||||
definition: >-
|
||||
Customization allows you to overwrite the default parameters of your
|
||||
devices in the configuration.
|
||||
|
||||
- term: Device
|
||||
definition: >
|
||||
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.
|
||||
definition: |-
|
||||
A device is a model representing a physical or logical unit that contains entities.
|
||||
|
||||
**Example for a device as a physical unit**
|
||||
A smart plug named 'Coffee machine' which provides 2 entities: a `switch` entity to turn power on or off ('Coffee machine power switch') and a `sensor` entity for power monitoring ('Coffee machine power sensor').
|
||||
|
||||
**Example for a device as a logical unit**
|
||||
An ecobee thermostat with 4 room sensors. This thermostat is seen as 5 devices in Home Assistant: 1 device for the thermostat with 4 sensors, and 1 device for each room sensor. Each device can be in a different area and may have more than one input or output within that area.
|
||||
|
||||
Devices have properties such as ID, manufacturer, name, model, hardware version, firmware version, connections, etc.
|
||||
excerpt: >
|
||||
A device is a named collection of entities that all represent the same
|
||||
physical/logical unit, which can do or observe something.
|
||||
A device is a model representing a physical or logical unit that contains entities.
|
||||
|
||||
- term: Device tracker
|
||||
definition: >
|
||||
definition: >-
|
||||
Device trackers are used to track the presence, or location, of a device.
|
||||
link: /integrations/device_tracker
|
||||
|
||||
@ -90,7 +93,7 @@
|
||||
they are discovered.
|
||||
|
||||
- term: Domain
|
||||
definition: >
|
||||
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
|
||||
@ -104,7 +107,7 @@
|
||||
It is often shown as the first part (before the dot) of entity IDs.
|
||||
|
||||
- term: Entity
|
||||
definition: >
|
||||
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
|
||||
@ -118,33 +121,33 @@
|
||||
device or service inside Home Assistant.
|
||||
|
||||
- term: Event
|
||||
definition: >
|
||||
definition: >-
|
||||
An event is when something happens.
|
||||
link: /docs/configuration/events/
|
||||
|
||||
- term: Frontend
|
||||
definition: >
|
||||
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: >
|
||||
definition: >-
|
||||
Groups are a way to organize your entities into a single unit.
|
||||
link: /integrations/group/
|
||||
|
||||
- term: HASS
|
||||
definition: >
|
||||
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: >
|
||||
definition: >-
|
||||
Another name for Home Assistant Operating System
|
||||
link: /hassio/installation/
|
||||
|
||||
- term: Home Assistant Core
|
||||
definition: >
|
||||
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
|
||||
@ -155,7 +158,7 @@
|
||||
program that powers every installation type, but can be installed standalone.
|
||||
|
||||
- term: Home Assistant Supervised
|
||||
definition: >
|
||||
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.
|
||||
@ -165,13 +168,13 @@
|
||||
Home Assistant Operating System.
|
||||
|
||||
- term: Home Assistant Supervisor
|
||||
definition: >
|
||||
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: >
|
||||
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.
|
||||
@ -182,7 +185,7 @@
|
||||
minimalistic, operating system designed to run the Home Assistant ecosystem.
|
||||
|
||||
- term: Integration
|
||||
definition: >
|
||||
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
|
||||
@ -196,18 +199,18 @@
|
||||
link: /integrations/
|
||||
|
||||
- term: Lovelace
|
||||
definition: >
|
||||
definition: >-
|
||||
Lovelace is the original code name of the UI that is now known as
|
||||
[Home Assistant dashboards](/dashboards).
|
||||
|
||||
- term: Light
|
||||
definition: >
|
||||
definition: >-
|
||||
A light has a brightness you can control, and optionally color temperature
|
||||
or RGB color control.
|
||||
link: /integrations/light
|
||||
|
||||
- term: Notification
|
||||
definition: >
|
||||
definition: >-
|
||||
You can use notifications to send messages, pictures, and more, to devices.
|
||||
link: /integrations/#notifications
|
||||
|
||||
@ -217,7 +220,7 @@
|
||||
link: /docs/configuration/packages/
|
||||
|
||||
- term: Platform
|
||||
definition: >
|
||||
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
|
||||
@ -229,7 +232,7 @@
|
||||
link: /docs/configuration/platform_options/
|
||||
|
||||
- term: Scene
|
||||
definition: >
|
||||
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.
|
||||
@ -242,13 +245,13 @@
|
||||
link: /docs/scripts/
|
||||
|
||||
- term: Sensor
|
||||
definition: >
|
||||
definition: >-
|
||||
Sensors return information about a thing, for instance the level of water
|
||||
in a tank.
|
||||
link: /integrations/sensor/
|
||||
|
||||
- term: Selectors
|
||||
definition: >
|
||||
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
|
||||
@ -259,41 +262,41 @@
|
||||
link: /docs/blueprint/selectors/
|
||||
|
||||
- term: Service
|
||||
definition: >
|
||||
definition: >-
|
||||
Services are called to perform actions.
|
||||
link: /docs/scripts/service-calls/
|
||||
|
||||
- term: Switch
|
||||
definition: >
|
||||
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: >
|
||||
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: >
|
||||
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: >
|
||||
definition: >-
|
||||
TTS (text to speech) allows Home Assistant to talk to you.
|
||||
link: /integrations/tts/
|
||||
|
||||
- term: Variables
|
||||
definition: >
|
||||
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: >
|
||||
definition: >-
|
||||
Zones are areas that can be used for presence detection.
|
||||
link: /integrations/zone/
|
||||
|
31
source/_docs/glossary.html
Normal file
31
source/_docs/glossary.html
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "Glossary"
|
||||
description: "Home Assistant's Glossary."
|
||||
---
|
||||
|
||||
{% assign entries = site.data.glossary | sort: 'term' %}
|
||||
|
||||
The glossary covers terms which are used around Home Assistant.
|
||||
|
||||
<div class="config-vars basic">
|
||||
|
||||
{% for entry in entries %}
|
||||
|
||||
<div class="config-vars-item">
|
||||
<div class="config-vars-label">
|
||||
<a name="{{ entry.term | slugify }}" class="title-link" href="#{{ entry.term | slugify }}"></a>
|
||||
<span class="config-vars-label-name">{{ entry.term }}</span>
|
||||
</div>
|
||||
<div class="config-vars-description-and-children">
|
||||
<span class="config-vars-description">
|
||||
{{ entry.definition | markdownify | newline_to_br }}
|
||||
{%- if entry.link -%}
|
||||
<a href="{{ entry.link }}">Read more about: {{ entry.term }}</a>
|
||||
{%- endif -%}
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% endfor %}
|
||||
|
||||
</div>
|
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: "Glossary"
|
||||
description: "Home Assistant's Glossary."
|
||||
---
|
||||
|
||||
{% assign entries = site.data.glossary | sort: 'term' %}
|
||||
|
||||
The glossary covers terms which are used around Home Assistant.
|
||||
|
||||
{% configuration_basic %}
|
||||
|
||||
{% for entry in entries %}
|
||||
"{{ entry.term }}":
|
||||
description: "{{ entry.definition }}
|
||||
{% if entry.link %}<br />[Read more about: {{ entry.term }}]({{ entry.link }}){% endif %}"
|
||||
{% endfor %}
|
||||
|
||||
{% endconfiguration_basic %}
|
Loading…
x
Reference in New Issue
Block a user