Skip to content

Commit

Permalink
Add documentation for v3.0 features (#745)
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck authored Apr 30, 2024
1 parent ac9d878 commit 0210173
Show file tree
Hide file tree
Showing 23 changed files with 1,501 additions and 2 deletions.
4 changes: 3 additions & 1 deletion documentation/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ parts:
- caption: Core extensions
chapters:
- file: integrations
- file: labels
- file: floors
- file: areas
- file: devices
- file: entities
- file: areas
- file: devices_entities
- file: template_engine
sections:
Expand Down
7 changes: 6 additions & 1 deletion documentation/areas.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ date: 2023-08-09T21:29:00+02:00

{term}`Areas <area>` in {term}`Home Assistant` is a logical grouping of {term}`devices <device>` and {term}`entities <entity>` that are meant to match the areas (or rooms) in the physical world: your home.

Spook provides {term}`services <service>` that allows you to manage and {term}`automate <automation>` the areas in Home Assisatant programatically. Great for creating "dynamic" areas, or for creating areas on the fly.
Spook provides {term}`services <service>` that allows you to manage and {term}`automate <automation>` the areas in Home Assistant programatically. Great for creating "dynamic" areas, or for creating areas on the fly.

```{figure} ./images/areas/example.png
:alt: Screenshot of the developer service tools, listing the new services to manage areas.
Expand Down Expand Up @@ -56,6 +56,10 @@ Adds a new area to your Home Assistant instance.
- {term}`string <string>`
- Yes
- `Living room`
* - `icon`
- {term}`string <string>`
- No
- `mdi:sofa`
* - `aliases`
- {term}`string <string>` | {term}`list of strings <list>`
- No
Expand All @@ -72,6 +76,7 @@ The use of `aliases` is helpful if you want to create an area with multiple name
service: homeassistant.create_area
data:
name: "Living room"
icon: "mdi:sofa"
aliases:
- "Lounge"
- "Sitting area"
Expand Down
Loading

0 comments on commit 0210173

Please sign in to comment.