Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/next' into ring/update_event_s…
Browse files Browse the repository at this point in the history
…tability
  • Loading branch information
sdb9696 committed Nov 6, 2024
2 parents 15571d2 + c94164c commit 6686906
Show file tree
Hide file tree
Showing 22 changed files with 214 additions and 37 deletions.
6 changes: 3 additions & 3 deletions source/_dashboards/masonry.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
type: view
title: Masonry view
sidebar_label: Masonry (default)
sidebar_label: Masonry
description: "The default panel layout uses a masonry algorithm."
related:
- docs: /dashboards/panel/
Expand All @@ -10,14 +10,14 @@ related:
title: Sidebar view
---

The masonry view is the default view type.
The masonry view sorts cards in columns based on their card size.

<p class='img'>
<img src='/images/getting-started/lovelace.png' alt='Screenshot of the masonry view'>
Screenshot of the masonry view.
</p>

Masonry sorts cards in columns based on their card size. The next card is placed below the smallest card on the dashboard.
Masonry sorts cards in columns based on size and places the next card below the smallest card on the dashboard.

<p class='img'>
<img src='/images/dashboards/masonry.png' alt='Image showing how masonry arranges cards based on size.'>
Expand Down
27 changes: 11 additions & 16 deletions source/_dashboards/sections.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
type: view
title: Sections (experimental)
sidebar_label: Sections (experimental)
title: Sections
sidebar_label: Sections (default)
description: "Lets you organize your cards in sections on a grid."
description: "The panel view shows a single card in the full width of the screen."
related:
Expand All @@ -27,16 +27,11 @@ You can group cards without using horizontal or vertical stack cards.
A fully populated dashboard in Sections view layout
</p>

{% note %}
The sections view was released beginning of March 2024 and is experimental! Do not build your daily dashboard on top of it yet! We are still collecting feedback.<br>
It is not possible to migrate dashboards into sections view.
{% endnote %}

## Creating a sections view

1. If you have multiple dashboards, in the left sidebar, select the dashboard to which you want to add the sections view.
2. Follow the steps on [adding a new view](/dashboards/views/#adding-a-view-to-a-dashboard).
- Under **View type**, select **Sections (experimental)**.
- Under **View type**, select **Sections**.
3. Under **Max number of sections wide**, select the maximum number of columns you want to see in the new sections view.
4. Under **Dense section placement**, select if you want to allow the cards to be arranged automatically in order to fill gaps between cards.
- This will remove some gaps, but it also means you have less control over the order of the cards.
Expand Down Expand Up @@ -77,17 +72,17 @@ In the sections view, you can rearrange sections and cards by dragging them to a
1. To edit your dashboard, in the top right corner, select the edit {% icon "mdi:edit" %} button.
2. To rearrange sections, hold the move {% icon "mdi:cursor-move" %} button and move the card.

<p class='img'>
<img src="/images/dashboards/section_view_rearrange_sections.gif" alt="Rearranging sections by dragging"/>
Rearranging sections by dragging
</p>
<p class='img'>
<img src="/images/dashboards/section_view_rearrange_sections.gif" alt="Rearranging sections by dragging"/>
Rearranging sections by dragging
</p>

3. To rearrange cards, tap and hold the card and move it to your desired location.

<p class='img'>
<img src="/images/dashboards/section_view_rearrange_cards.gif" alt="Rearranging cards by dragging"/>
Rearranging cards by dragging
</p>
<p class='img'>
<img src="/images/dashboards/section_view_rearrange_cards.gif" alt="Rearranging cards by dragging"/>
Rearranging cards by dragging
</p>

## Show or hide section conditionally

Expand Down
2 changes: 1 addition & 1 deletion source/_dashboards/sidebar.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ related:
- docs: /dashboards/panel/
title: Panel view
- docs: /dashboards/sections/
title: Sections view (experimental)
title: Sections view (default)
- docs: /dashboards/views/
title: About views
---
Expand Down
5 changes: 5 additions & 0 deletions source/_dashboards/vertical-stack.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ related:

The vertical stack card allows you to group multiple cards so they always sit in the same column.

<p class='img'>
<img src='/images/dashboards/edit-dashboard.webp' alt='Screencast showing how to edit a dashboard customize a vertical stack card'>
Screencast showing how to edit a dashboard and customize a vertical stack card.
</p>

{% include dashboard/edit_dashboard.md %}

## YAML configuration
Expand Down
1 change: 1 addition & 0 deletions source/_integrations/default_config.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This {% term integration %} is a meta-component and configures a default set of
- [Conversation](/integrations/conversation/) (`conversation`)
- [DHCP discovery](/integrations/dhcp/) (`dhcp`)
- [Energy](/integrations/energy/) (`energy`)
- [Go2rtc](/integrations/go2rtc/) (`go2rtc`)
- [History](/integrations/history/) (`history`)
- [Home Assistant Alerts](/integrations/homeassistant_alerts) (`homeassistant_alerts`)
- [Home Assistant Cloud](/integrations/cloud/) (`cloud`)
Expand Down
62 changes: 62 additions & 0 deletions source/_integrations/go2rtc.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: go2rtc
description: Instructions on how to setup go2rtc in Home Assistant.
ha_category:
- Camera
ha_release: 2024.11
ha_iot_class: Local Polling
ha_codeowners:
- '@home-assistant/core'
ha_domain: go2rtc
ha_integration_type: system
related:
- docs: /installation/
---

go2rtc is an open source project providing a camera streaming application that supports formats such as RTSP, WebRTC, HomeKit, FFmpeg, RTMP. The **go2rtc** {% term integration %} connects to a go2rtc instance and provides a WebRTC proxy for all your cameras. To learn more about go2rtc, refer to the [project's GitHub page](https://github.com/AlexxIT/go2rtc/).


If you are using the [`default_config`](/integrations/default_config/) and run Home Assistant using one of the following installation methods, the go2rtc integration will be set up automatically and you don't need to do anything:

- {% term "Home Assistant Operating System" %}
- {% term "Home Assistant Supervised" %}
- {% term "Home Assistant Container" %}

## Configuration

This integration is part of the [`default_config`](/integrations/default_config/).

The following YAML options are available:

{% configuration %}
debug_ui:
required: false
description: Enables the UI of the go2rtc, which helps debugging WebRTC issues. The `debug_ui` should only be enabled during debugging as it will expose port 11984 without any authentication!
default: false
type: boolean
url:
required: false
description: The URL to the self-hosted [go2rtc](https://github.com/AlexxIT/go2rtc/) server
type: string
{% endconfiguration %}

If you using the go2rtc server managed by Home Assistant, please be aware that all ports are prefixed by `1` compared to the default port settings to avoid port conflicts:
- Api port `1984` becomes `11984`
- WebRTC port `8555` becomes `18555`

{% warning %}

The `debug_ui` should only be enabled during debugging as it will expose port 11984 without any authentication!
Please disable the `debug_ui` immediately after debugging.

{% endwarning %}

### Examples

Use a self-hosted instance:

```yaml
go2rtc:
url: http://my-go2rtc-instance:1984
```
5 changes: 5 additions & 0 deletions source/_integrations/habitica.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ ha_release: 0.78
ha_iot_class: Cloud Polling
ha_domain: habitica
ha_platforms:
- binary_sensor
- button
- sensor
- switch
Expand Down Expand Up @@ -58,7 +59,11 @@ The Habitca {% term integration %} enables you to monitor your adventurer's prog
- **Rewards:** Displays the rewards that can be redeemed (for example, "1 task")
- **Gems:** Shows the total number of gems currently owned by your Habitica character, used for purchasing items and customizations.
- **Mystic hourglasses:** Displays the number of mystic hourglasses earned as a subscriber, which can be redeemed for exclusive items from past events.

## Binary sensors

- **Pending quest invitation**: Indicates if you have an invitation to a quest awaiting your response.

## To-do lists

The following Habitica tasks are available as to-do lists in Home Assistant. You can add, delete, edit and check-off completed tasks
Expand Down
3 changes: 2 additions & 1 deletion source/_integrations/lamarzocco.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@ ha_platforms:
- switch
- update
ha_bluetooth: true
ha_dhcp: true
ha_codeowners:
- '@zweckj'
ha_integration_type: device
---

This integration interacts with [La Marzocco](https://lamarzocco.com/it/en/) coffee machines through calls to the La Marzocco cloud API. Optionally, local API calls, which include a WebSocket connection for (near) real-time updates and a Bluetooth connection, can be utilized for local connections.

If your machine is in Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the machine will be discovered automatically.
If your Home Assistant host can perform [DHCP discovery](https://www.home-assistant.io/integrations/dhcp/), your machine will be discovered automatically. Otherwise, if your machine is in Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the machine will be discovered as well.

## Prerequisites

Expand Down
73 changes: 72 additions & 1 deletion source/_integrations/lcn.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,78 @@ The configuration of the `lcn` devices and entities is completely done using a w

Once the integration is added to Home Assistant, you can access the `lcn` configuration panel by selecting the **Configure** button next to the respective integration entry on the [LCN integration page](https://my.home-assistant.io/redirect/integration/?domain=lcn).

The detailed documentation for the LCN frontend panel can be found [here](https://github.com/alengwenus/lcn-frontend/blob/main/docs/lcn-frontend.md).
![Integration configuration](/images/integrations/lcn/lcn_integration_configuration.png)

## Configuration panel

From the LCN Configuration Panel, you can configure your LCN modules, groups, and entities within Home Assistant.

![LCN Configuration Panel](/images/integrations/lcn/lcn_device_page.png)

### Configuring devices

You can add and remove modules and groups directly from the configuration panel. Once added, they will appear in Home Assistant as devices, which can be used to trigger [specific actions](#actions) within scripts or automations. For examples, refer to the [Performing actions](/docs/scripts/perform-actions/) page.

The **Modules / Groups** tab provides an overview of your configured LCN modules and groups, showing their name, ID, and segment ID. The LCN Configuration Panel attempts to derive names from the LCN modules; if a module has no name or is part of a group, a standard name is assigned.

#### Scanning modules

To initiate a scan for LCN modules on the bus, in the top-right corner, select the three dots {% icon "mdi:dots-vertical" %} menu and select **Scan Modules**.
- **Result**: This process polls each module for its name and serial number.
- When all module responses have been received, they will be listed in the device list.
- Scanning modules may take several seconds. The pop-up dialog will close automatically once the process is complete.

#### Adding devices

If module scanning fails or a module is unavailable on the bus, you can manually add it. Groups can also be created manually.

1. To add a module or group manually, select the **Create Module/Group** button.
2. Select whether you want to add a module or group and enter the desired `segment id` and module/group `id`.

![Create module/group dialog](/images/integrations/lcn/lcn_create_device.png)
3. To add the new device, select **Create**.

#### Deleting devices

To delete a single device, select the trash can icon next to it.
- **Result**: This will remove the device from the device list and from Home Assistant, including any associated entities.

To delete multiple devices at once, enable selection mode. Select the desired entries, then, in the top-right corner, select **Delete Selected**.

### Configuring entities

Entities configured for all devices are listed on the **Entities** tab.

To view entities for a specific device (module or group), in the **Modules / Groups** tab, select the device entry.
- **Result**: The **Entities** tab opens, showing entities of the selected device.
- To apply custom filters, enable the filter option.

![Create module/group dialog](/images/integrations/lcn/lcn_entities_page.png)

#### Adding entities

1. To create a new entity, select **Create Entity**.
2. From the dropdown menu, select the module or group for which to create the entity.
- If a single module or group filter is applied, it will be pre-selected.

![Create entity dialog](/images/integrations/lcn/lcn_create_entity.png)
3. Choose the domain (platform) for the entity and enter a name.
- You can change this name later within the Home Assistant entity settings.
4. Depending on the selected domain, additional options will be shown. To add the entity to the list and to Home Assistant, enter the required information and select **Create** .

#### Deleting entities

To delete a single entity, select the trash can icon next to it.
- **Result**: This removes the entity from the list and from Home Assistant.

To delete multiple entities, enable selection mode, select the desired entries, and select **Delete Selected** in the upper right.

#### Displaying entity properties

Once an entity is created, you can view and configure its properties.

Select the entity in the entity list.
- This opens the Home Assistant dialog for entity properties, allowing you to configure the entity as you would from the general Home Assistant entity configuration panel.

## Platforms

Expand Down
1 change: 1 addition & 0 deletions source/_integrations/reolink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,7 @@ When the **floodlight** entity is ON always ON, when OFF controlled based on the
Depending on the supported features of the camera, the following sensor entities are added:

- PTZ pan position
- PTZ tilt position
- Wi-Fi signal*
- CPU usage*
- HDD/SD storage*
Expand Down
5 changes: 4 additions & 1 deletion source/_integrations/smarty.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ha_category:
- Fan
- Hub
- Sensor
- Switch
ha_config_flow: true
ha_iot_class: Local Polling
ha_release: 0.95
Expand All @@ -15,6 +16,7 @@ ha_platforms:
- binary_sensor
- fan
- sensor
- switch
ha_integration_type: hub
---

Expand All @@ -24,8 +26,9 @@ There is currently support for the following device types within Home Assistant:

- Fan
- Sensor
- Switch

The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read:
The integration has a fan platform to view and control the ventilation speed, a switch platform to control the Boost state (which temporarily increases the fan speed to maximum for 10 minutes before returning to the previous speed), and a sensors platform to read:

- Outdoor air temperature
- Extract air temperature
Expand Down
4 changes: 2 additions & 2 deletions source/dashboards/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ You can customize your dashboard using various options:
- Use custom cards from our amazing community.

<p class='img'>
<img src='/images/dashboards/edit-dashboard.webp' alt='Screencast showing how to edit a dashboard customize a vertical stack card'>
Screencast showing how to edit a dashboard and customize a vertical stack card.
<img src="/images/dashboards/section_view_rearrange_cards.gif" alt="Screencast showing how to edit a dashboard in section view and how to rearrange cards"/>
Screencast showing how to edit a dashboard in section view and how to rearrange cards
</p>

## Explore the interactive demo dashboard
Expand Down
Loading

0 comments on commit 6686906

Please sign in to comment.