diff --git a/source/_dashboards/masonry.markdown b/source/_dashboards/masonry.markdown index 6bbf31ccef2f..efd7a12bea5b 100644 --- a/source/_dashboards/masonry.markdown +++ b/source/_dashboards/masonry.markdown @@ -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/ @@ -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.

Screenshot of the masonry view Screenshot of the masonry view.

-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.

Image showing how masonry arranges cards based on size. diff --git a/source/_dashboards/sections.markdown b/source/_dashboards/sections.markdown index 0cd8f945d620..7ef99bfe1b68 100644 --- a/source/_dashboards/sections.markdown +++ b/source/_dashboards/sections.markdown @@ -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: @@ -27,16 +27,11 @@ You can group cards without using horizontal or vertical stack cards. A fully populated dashboard in Sections view layout

-{% 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.
-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. @@ -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. -

- Rearranging sections by dragging - Rearranging sections by dragging -

+

+ Rearranging sections by dragging + Rearranging sections by dragging +

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

- Rearranging cards by dragging - Rearranging cards by dragging -

+

+ Rearranging cards by dragging + Rearranging cards by dragging +

## Show or hide section conditionally diff --git a/source/_dashboards/sidebar.markdown b/source/_dashboards/sidebar.markdown index 6fdcf0dad6b0..208dc50e208b 100644 --- a/source/_dashboards/sidebar.markdown +++ b/source/_dashboards/sidebar.markdown @@ -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 --- diff --git a/source/_dashboards/vertical-stack.markdown b/source/_dashboards/vertical-stack.markdown index 56212aec5358..42fff9c454e9 100644 --- a/source/_dashboards/vertical-stack.markdown +++ b/source/_dashboards/vertical-stack.markdown @@ -10,6 +10,11 @@ related: The vertical stack card allows you to group multiple cards so they always sit in the same column. +

+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. +

+ {% include dashboard/edit_dashboard.md %} ## YAML configuration diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown index 6158eee9346b..7e07591bc9dc 100644 --- a/source/_integrations/default_config.markdown +++ b/source/_integrations/default_config.markdown @@ -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`) diff --git a/source/_integrations/go2rtc.markdown b/source/_integrations/go2rtc.markdown new file mode 100644 index 000000000000..780d7970c589 --- /dev/null +++ b/source/_integrations/go2rtc.markdown @@ -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 +``` + diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown index ec4a7f919370..ff7634edca3c 100644 --- a/source/_integrations/habitica.markdown +++ b/source/_integrations/habitica.markdown @@ -9,6 +9,7 @@ ha_release: 0.78 ha_iot_class: Cloud Polling ha_domain: habitica ha_platforms: + - binary_sensor - button - sensor - switch @@ -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 diff --git a/source/_integrations/lamarzocco.markdown b/source/_integrations/lamarzocco.markdown index b742fdfe15bc..4b7598f6862d 100644 --- a/source/_integrations/lamarzocco.markdown +++ b/source/_integrations/lamarzocco.markdown @@ -24,6 +24,7 @@ ha_platforms: - switch - update ha_bluetooth: true +ha_dhcp: true ha_codeowners: - '@zweckj' ha_integration_type: device @@ -31,7 +32,7 @@ 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 diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index da45dc390eed..9f288022cc2c 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -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 diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown index ed52d4636157..ec73322d63dd 100644 --- a/source/_integrations/reolink.markdown +++ b/source/_integrations/reolink.markdown @@ -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* diff --git a/source/_integrations/smarty.markdown b/source/_integrations/smarty.markdown index a4e8823ca78f..7dcf93ddb06f 100644 --- a/source/_integrations/smarty.markdown +++ b/source/_integrations/smarty.markdown @@ -5,6 +5,7 @@ ha_category: - Fan - Hub - Sensor + - Switch ha_config_flow: true ha_iot_class: Local Polling ha_release: 0.95 @@ -15,6 +16,7 @@ ha_platforms: - binary_sensor - fan - sensor + - switch ha_integration_type: hub --- @@ -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 diff --git a/source/dashboards/index.markdown b/source/dashboards/index.markdown index b0248d37ab86..01c9bb3cf30c 100644 --- a/source/dashboards/index.markdown +++ b/source/dashboards/index.markdown @@ -26,8 +26,8 @@ You can customize your dashboard using various options: - Use custom cards from our amazing community.

-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. + 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

## Explore the interactive demo dashboard diff --git a/source/dashboards/views.markdown b/source/dashboards/views.markdown index ed976b66cf74..27362646c87b 100644 --- a/source/dashboards/views.markdown +++ b/source/dashboards/views.markdown @@ -34,12 +34,10 @@ Views control the layout. There are four different view types: +- **Sections (default)**: Arranges cards in a grid system and lets you group them in sections. +- **Masonry**: Arranges cards in columns based on their card size. - **Panel**: Displays one card in full width. For example a map or an image. - **Sidebar**: Arranges cards in 2 columns, a wide one and a smaller one on the right. -- **Masonry (default)**: Arranges cards in columns based on their card size. -- **Sections (experimental)**: Arranges cards in a grid system and lets you group them in sections. - -It is currently not possible to migrate your dashboard from one view type into another. For example, if you have a dashboard in masonry view, and want it in sections view, you need to create a new view. ## Adding a view to a dashboard @@ -57,8 +55,9 @@ It is currently not possible to migrate your dashboard from one view type into a - If you want to use a previously defined theme, select the [theme](/integrations/frontend/#themes). - Select the [view type](#view-type). - If this view is meant to be used as a [subview](#subview) only, enable the **Subview** toggle. + - If you are using **Sections view**, choose the number of columns you want to use, and, if you want to let the system fill gaps between cards, enable **Dense section placement.**. - ![The create new view configuration dialog](/images/dashboards/dashboard_view_configuration_01.png) + ![The create new view configuration dialog](/images/dashboards/dashboard_view_configuration_03.png) 4. To use a background image, on the **Background** tab, select an image. - **Upload picture** lets you pick an image from the system used to show your Home Assistant UI. @@ -69,6 +68,30 @@ It is currently not possible to migrate your dashboard from one view type into a - Sidebar and panel views do not support badges. 6. By default, the new section is visible to all users. On the **Visibility** tab, you can disable the view for users. +## Migrating a view into a sections view + +If you have already defined a view but you would now like to have it in a section view type, you can migrate that content. For example, you can migrate from a masonry to a sections view. Currently, you cannot migrate a sections view type into another view type. + +Migrating does not affect the current view. It will stay as is, and a new, additional view is created. + +To migrate a view into a sections view type, follow these steps: + +1. Open the view you want to migrate, and go into edit mode. +2. In the configuration dialog, select the new view type. +3. If the new view type offers additional settings, define those settings. + - For more information on those settings, refer to the documentation of that view type. +4. In the top-right corner, select **Convert**. + - **Result**: A new, additional view is created. + - Your current view will stay untouched. + - A new tab opens, and all your cards are imported to the new view. +5. In the **Imported cards** section, pick each of the cards, and drag them into the sections. + - To edit and customize the view, follow the steps in the [sections view](/dashboards/sections/) documentation. + + ![Move cards from imported cards section onto your dashboard](/images/dashboards/imported-cards.png) +6. To save your changes, select **Done**. + - **Result**: Your new dashboard is shown. + - If you have cards that were not yet integrated, you can still add them later. They are still available in the Edit mode, in the **Imported cards** section. + ## URL of a view You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string `/lovelace/` to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index. @@ -139,9 +162,9 @@ user: type: string {% endconfiguration %} -## View type +## Changing the view type in YAML -You can change the layout of a view by using a different view type. The default is [`masonry`](/dashboards/masonry). +You can change the layout of a view in YAML by using a different view type. The default is [`section`](/dashboards/section). ### Example diff --git a/source/getting-started/onboarding_dashboard.markdown b/source/getting-started/onboarding_dashboard.markdown index 143fb09fd4fe..3368dcaa0f3c 100644 --- a/source/getting-started/onboarding_dashboard.markdown +++ b/source/getting-started/onboarding_dashboard.markdown @@ -11,11 +11,18 @@ The screenshot shows an **Overview** dashboard with many [cards](/dashboards/car ### Views -The icons in the blue menu bar on top each represent a different tab. Each tab contains a [view](/dashboards/views/). +The following screenshot shows a fully populated dashboard in [masonry view](/dashboards/masonry/) layout. The icons in the blue menu bar on top each represent a different tab. Each tab contains a [view](/dashboards/views/).

-Screenshot of a populated Overview dashboard -Screenshot of a populated Overview dashboard with many devices. +Screenshot of a populated Overview dashboard in masonry view +Screenshot of a populated Overview dashboard in masonry view layout. +

+ +The following screenshot shows a fully populated dashboard in [sections view](/dashboards/sections/) layout. + +

+ A fully populated dashboard in Sections view layout + A fully populated dashboard in Sections view layout

### Multiple dashboards @@ -33,7 +40,7 @@ In the sidebar on the left, you see the names of different dashboards. Home Assi The **Overview** [dashboard](/dashboards/) is the first page you see after the [onboarding process](/getting-started/onboarding). -If you just onboarded, your dashboard will be nearly empty. It shows cards for devices that were detected automatically. Your dashboard may look quite different, depending on the devices that you have at home. +If you just onboarded, your dashboard will be nearly empty. It is using the [masonry view](/dashboards/masonry/) layout and shows cards for devices that were detected automatically. Your dashboard may look quite different, depending on the devices that you have at home.

Screenshot of the Overview dashboard with Bluetooth devices @@ -123,13 +130,16 @@ In the following steps, we will create a new dashboard and edit some card settin - When you are done, in the top right corner, select **Done**. 14. If you want to change any of the other cards, select the **Edit** button on the card. 15. Congratulations! You have completed your first dashboard customization. +16. While your dashboard is still small, this is a good moment to [migrate it into sections view](/dashboards/views/#migrating-a-view-into-a-sections-view). + - The sections view offers features such as drag and drop, customizing number and width of columns, and more heading options. + - To learn more, head over to the documentation on [section view](/dashboards/sections/). ## Learning more about dashboards If you want to learn more about dashboards, views, and cards, take a look at these topics: 1. Take a look at the [introduction to dashboards](/dashboards/) and learn about [multiple dashboards](/dashboards/dashboards). -2. Learn about the different [view types](/dashboards/views/). +2. Learn more about [view types](/dashboards/views/) 3. Learn how to [add cards](/dashboards/cards/#adding-cards-to-your-dashboard) to a view. ## Next step: integrations diff --git a/source/images/dashboards/dashboard_view_configuration_01.png b/source/images/dashboards/dashboard_view_configuration_01.png deleted file mode 100644 index 0a23ff9a5420..000000000000 Binary files a/source/images/dashboards/dashboard_view_configuration_01.png and /dev/null differ diff --git a/source/images/dashboards/dashboard_view_configuration_03.png b/source/images/dashboards/dashboard_view_configuration_03.png new file mode 100644 index 000000000000..eda874e19b23 Binary files /dev/null and b/source/images/dashboards/dashboard_view_configuration_03.png differ diff --git a/source/images/dashboards/imported-cards.png b/source/images/dashboards/imported-cards.png new file mode 100644 index 000000000000..ae0c2bae3042 Binary files /dev/null and b/source/images/dashboards/imported-cards.png differ diff --git a/source/images/integrations/lcn/lcn_create_device.png b/source/images/integrations/lcn/lcn_create_device.png new file mode 100644 index 000000000000..a329ca2be5fe Binary files /dev/null and b/source/images/integrations/lcn/lcn_create_device.png differ diff --git a/source/images/integrations/lcn/lcn_create_entity.png b/source/images/integrations/lcn/lcn_create_entity.png new file mode 100644 index 000000000000..c8f3430b0eb7 Binary files /dev/null and b/source/images/integrations/lcn/lcn_create_entity.png differ diff --git a/source/images/integrations/lcn/lcn_device_page.png b/source/images/integrations/lcn/lcn_device_page.png new file mode 100644 index 000000000000..8bfcd271ea0b Binary files /dev/null and b/source/images/integrations/lcn/lcn_device_page.png differ diff --git a/source/images/integrations/lcn/lcn_entities_page.png b/source/images/integrations/lcn/lcn_entities_page.png new file mode 100644 index 000000000000..e5c123e872cc Binary files /dev/null and b/source/images/integrations/lcn/lcn_entities_page.png differ diff --git a/source/images/integrations/lcn/lcn_integration_configuration.png b/source/images/integrations/lcn/lcn_integration_configuration.png new file mode 100644 index 000000000000..a2185fef54a6 Binary files /dev/null and b/source/images/integrations/lcn/lcn_integration_configuration.png differ