diff --git a/.github/workflows/autoassign.yml b/.github/workflows/autoassign.yml index d1e69755de..270236f14c 100644 --- a/.github/workflows/autoassign.yml +++ b/.github/workflows/autoassign.yml @@ -1,17 +1,18 @@ name: Auto Assign +# pull_request_target (not pull_request) so assignment works on +# fork-submitted PRs; fork pull_request runs get a read-only token. +# Safe because this workflow never checks out or executes PR code. +# The assignee comes from the AUTO_ASSIGNEE organization variable. on: issues: types: [opened] + pull_request_target: + types: [opened] + +permissions: + issues: write + pull-requests: write + jobs: - run: - runs-on: ubuntu-latest - permissions: - issues: write - pull-requests: write - steps: - - name: 'Auto-assign issue' - uses: pozil/auto-assign-issue@v4 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - assignees: bharvey88 - numOfAssignee: 1 \ No newline at end of file + auto-assign: + uses: ApolloAutomation/Workflows/.github/workflows/autoassign.yml@main diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index f6104caa45..c33229b607 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -323,6 +323,82 @@ homeassistant: ![AIR-1 boot button highlighted on the underside of the case](/assets/air1-boot-button.jpg) ``` +### My Home Assistant buttons + +My Home Assistant buttons are the official badges from +[my.home-assistant.io](https://my.home-assistant.io/). Each one opens a +screen in the reader's own Home Assistant, whatever address they reach +it on, so "go to **Settings → Devices & services → ESPHome**" becomes +one click. Add one wherever a step sends the reader to a Home Assistant +screen: + +- **Installing or adding something**: a HACS repository + (`hacs_repository`), an integration's setup dialog + (`config_flow_start`), a Home Assistant app (`supervisor_app`), an + app from another repository (`supervisor_app` with `repository_url`, + which offers to add the repository), or a blueprint + (`blueprint_import`). +- **Opening the screen a step works in**: an integration's page + (`integration`), a Settings page (`integrations`, `automations`, + `helpers`, `lovelace_dashboards`, `logs`, and so on), or + **Settings → Tools** (`tools_actions`, `tools_states`, + `tools_perform_action`). Home Assistant 2026.8 moved these from + Developer tools, and the same buttons open them in older versions. +- **Restarting Home Assistant**: `system_dashboard` opens + **Settings → System**, where the power icon is. + +Put the button on its own line right after the step it helps, as its +own paragraph: + +```markdown +1. Go to **Settings → Devices & services** and click **Add integration**. + + [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=esphome) + +2. Search for **ESPHome** and select it. +``` + +- **Indent it with the step.** Inside a numbered or bulleted list, + indent the button 4 spaces so it stays inside the step and the + numbering continues. Inside an admonition or a content tab, add 4 + more. Steps written as `1\.` are plain paragraphs, so their buttons + start at the left margin. +- **One button for several steps.** When one button replaces several + steps, put it under the first of them and say which steps it covers, + for example "The button under step 1 covers steps 1 to 5." +- **Alt text** is "Open your Home Assistant instance and" followed by + the redirect's description from the + [redirect list](https://github.com/home-assistant/my.home-assistant.io/blob/main/redirect.json) + and a period, as in the example above. +- **Use current redirect names**: `supervisor_app` with `app=`, not + `supervisor_addon` with `addon=`, and `tools_actions`, not + `developer_services`. Current names work on every Home Assistant + version. Build links with the + [My Home Assistant link creator](https://my.home-assistant.io/create-link/), + URL-encode parameter values, and skip hidden redirects such as + `supervisor_ingress`. Confirm the redirect is also in the Home + Assistant frontend's list (`src/panels/my/ha-panel-my.ts` in the + frontend repository), because a few names in the redirect list are + missing there, such as `activity`. +- **Check every parameter**: the integration domain from its + `manifest.json`, the HACS owner and repository (category `plugin` + for a dashboard card), the app slug from its `config.yaml` with the + repository prefix (ESPHome Device Builder is `5c53de3b_esphome`), and + a blueprint URL that serves the raw YAML. +- **Keep the written path** in the step. The button is a shortcut, and + some readers reach Home Assistant through an address My Home + Assistant doesn't know. +- **One button per destination per section.** Don't turn every mention + of **Settings** into a button; add one where a step sends the reader + there. +- **Home Assistant only.** No buttons for Homey, phone apps, a device's + own web page, or a screen the reader is already on. Snippets and + included pages carry their buttons to every page that includes them, + so check the includers with `git grep -- '--8<--'` first. Content + that a Homey page includes gets no Home Assistant buttons. +- **No `homeassistant.local:8123` links.** They only work for readers + on that address. Use the button and the written path instead. + ### Screen recordings and animations Use short MP4 clips instead of GIFs. A looping MP4 is a fraction of the diff --git a/docs/_snippets/bluetooth-proxy/method1-finish.md b/docs/_snippets/bluetooth-proxy/method1-finish.md index 187cd1b158..affd6fed84 100644 --- a/docs/_snippets/bluetooth-proxy/method1-finish.md +++ b/docs/_snippets/bluetooth-proxy/method1-finish.md @@ -1,10 +1,10 @@ ![ESPHome Device Builder editor with the packages line replaced by the Bluetooth proxy package](/assets/esphome-device-builder-add-ble-proxy-method-1-edit-yaml.gif) -5\. Click **Save** then **Install** in the bottom right. Click **On the network** when prompted. +4\. Click **Save** then **Install** in the bottom right. Click **On the network** when prompted. ![ESPHome Device Builder Save and Install buttons in the bottom right of the editor](/assets/esphome-device-builder-add-ble-proxy-save-install.gif) -6\. When you see the purple lines the device has booted successfully and the logs will show the **Bluetooth Proxy** section. Click **Stop** in the bottom right and you're finished! +5\. When you see the purple lines the device has booted successfully and the logs will show the **Bluetooth Proxy** section. Click **Stop** in the bottom right and you're finished! ![ESPHome Device Builder logs with the Bluetooth Proxy section boxed and an arrow to Stop](/assets/ble-proxy-install-completed.png) diff --git a/docs/_snippets/bluetooth-proxy/method1-steps.md b/docs/_snippets/bluetooth-proxy/method1-steps.md index 08a56969d5..08e7aad1b3 100644 --- a/docs/_snippets/bluetooth-proxy/method1-steps.md +++ b/docs/_snippets/bluetooth-proxy/method1-steps.md @@ -1,13 +1,9 @@ -1\. Open ESPHome Device Builder. The button below opens the app right in your Home Assistant. +1\. Open the **ESPHome Device Builder** app from your Home Assistant sidebar. The button below opens the app's page, or offers to install it if you don't have it yet. Click **Open Web UI** there to reach your devices. -ESPHome logo Open ESPHome Device Builder +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) -2\. Don't have it installed yet? Add it from the App Store with the badge below, then move on to step 3. - -[![Open your Home Assistant instance and show the dashboard of the ESPHome Device Builder app.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) - -3\. Find your device and click **Edit**. +2\. Find your device and click **Edit**. ![ESPHome Device Builder device list with an Edit button on each device card](/assets/esphome-device-builder-edit-device.gif) -4\. Replace the `packages:` line and the line directly below it with the code below. +3\. Replace the `packages:` line and the line directly below it with the code below. diff --git a/docs/_snippets/bluetooth-proxy/method2.md b/docs/_snippets/bluetooth-proxy/method2.md index 12e133e48e..58fc42c760 100644 --- a/docs/_snippets/bluetooth-proxy/method2.md +++ b/docs/_snippets/bluetooth-proxy/method2.md @@ -1,12 +1,8 @@ The easiest way is to let ESPHome Device Builder add the component for you. You can also paste the single line by hand. -1\. Open ESPHome Device Builder and click **Edit** on your device. The button below opens the app right in your Home Assistant. +1\. Open the **ESPHome Device Builder** app from your Home Assistant sidebar and click **Edit** on your device. The button below opens the app's page, or offers to install it if you don't have it yet. Click **Open Web UI** there to reach your devices. -ESPHome logo Open ESPHome Device Builder - -Don't have it installed yet? Add it from the App Store with the badge below first. - -[![Open your Home Assistant instance and show the dashboard of the ESPHome Device Builder app.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) 2\. Click **Add Component** in the editor toolbar, search for **Bluetooth Proxy**, and click **Add**. diff --git a/docs/_snippets/bluetooth-proxy/verify.md b/docs/_snippets/bluetooth-proxy/verify.md index e7f747022a..1f32645b62 100644 --- a/docs/_snippets/bluetooth-proxy/verify.md +++ b/docs/_snippets/bluetooth-proxy/verify.md @@ -1,3 +1,5 @@ !!! success "Verify it works" - Once the device reboots, Home Assistant picks it up as a Bluetooth proxy automatically. Open the [Bluetooth advertisement monitor](https://my.home-assistant.io/redirect/bluetooth_advertisement_monitor/) to watch nearby BLE devices roll in through it. Anything that shows up is ready to add under **Settings → Devices & Services → Bluetooth** like any other device. + Once the device reboots, Home Assistant picks it up as a Bluetooth proxy automatically. Open the **Bluetooth advertisement monitor** with the button below to watch nearby BLE devices roll in through it. Anything that shows up is ready to add under **Settings → Devices & Services → Bluetooth** like any other device. + + [![Open your Home Assistant instance and show your Bluetooth Advertisements.](https://my.home-assistant.io/badges/bluetooth_advertisement_monitor.svg)](https://my.home-assistant.io/redirect/bluetooth_advertisement_monitor/) diff --git a/docs/_snippets/zone-mapper-tool.md b/docs/_snippets/zone-mapper-tool.md index dc2b0ae24f..72827bd545 100644 --- a/docs/_snippets/zone-mapper-tool.md +++ b/docs/_snippets/zone-mapper-tool.md @@ -19,9 +19,14 @@ MostlyChris covers the full setup, from installation to drawing your first zones HACS is a community store for Home Assistant that handles installing and updating custom integrations and cards. If you don't have it yet, follow the [HACS download guide](https://hacs.xyz/docs/use/download/download/) and [initial configuration guide](https://hacs.xyz/docs/configuration/basic). -With HACS in place, both Zone Mapper parts install in one pass: +With HACS in place, both Zone Mapper parts install in one pass. The two buttons under step 1 cover steps 1 to 5: the first opens the integration and the second opens the card. Each one adds its repository, after HACS asks you to confirm, and opens it so you can click **Download** right there. Use both, then go on at step 6. 1. Open **HACS** from your Home Assistant sidebar. + + [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=ApolloAutomation&repository=zone-mapper&category=integration) + + [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=ApolloAutomation&repository=zone-mapper-card&category=plugin) + 2. Click the three-dot menu in the upper right corner and choose **Custom repositories**. 3. Add `https://github.com/ApolloAutomation/zone-mapper` with type **Integration**. 4. Add `https://github.com/ApolloAutomation/zone-mapper-card` with type **Dashboard**. @@ -29,6 +34,8 @@ With HACS in place, both Zone Mapper parts install in one pass: 6. Restart Home Assistant when prompted. 7. Go to **Settings → Devices & services → Add integration**, search for **Zone Mapper**, and add it. + [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=zone_mapper) + The integration adds a "Zone Mapper" view with the card to your default dashboard the first time it is set up, so you don't have to place the card yourself (storage-mode dashboards only; you can opt out in the integration options). Open the new view and you're ready to pick your device and start drawing. ### Manual installation @@ -38,6 +45,9 @@ If you'd rather install without HACS: 1. Copy the contents of the integration's `custom_components` folder to `/config/custom_components/zone_mapper`. 2. Download `zone-mapper-card.js` from the card repository to `/config/www`. 3. Add the card as a resource under **Settings → Dashboards → Resources** with URL `/local/zone-mapper-card.js` and type **JavaScript Module**. + + [![Open your Home Assistant instance and show your dashboard resources.](https://my.home-assistant.io/badges/lovelace_resources.svg)](https://my.home-assistant.io/redirect/lovelace_resources/) + 4. Restart Home Assistant, then hard-refresh your browser to clear the cached resource list. ## Configure the card @@ -88,6 +98,9 @@ The card needs to know which X/Y coordinate sensors to track: Home Assistant shows the Target X and Y sensors in inches (in) when your system uses US units, while the card reads them in millimeters (mm). When the units don't match, your target dots never appear on the grid. Metric users can skip this; everyone else, convert the sensors before drawing zones: 1. Open your device's page under **Settings → Devices & services → ESPHome**. + + [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + 2. Under **Sensors**, click **Target 1 X**, open its settings with the gear icon, and change **Unit of Measurement** to **mm**. 3. Repeat for the X and Y sensors of all three targets (six entities in total). @@ -161,7 +174,10 @@ actions: - Click **Apply** and **Save** after setting up the card or making changes. Most "nothing happens" reports come down to a missed **Apply**. - **Resource not found**: confirm the resource URL is `/local/zone-mapper-card.js`, the file is under `/config/www`, and clear your browser cache. -- **Zones don't persist**: check the coordinate sensor's attributes for `shape`, `data`, and `rotation_deg` under **Developer Tools → States**, and confirm the `zone_mapper.update_zone` service is being called. +- **Zones don't persist**: check the coordinate sensor's attributes for `shape`, `data`, and `rotation_deg` under **Developer Tools → States** (**Settings → Tools → States** in Home Assistant 2026.8 and newer), and confirm the `zone_mapper.update_zone` service is being called. + + [![Open your Home Assistant instance and show your state tools.](https://my.home-assistant.io/badges/tools_states.svg)](https://my.home-assistant.io/redirect/tools_states/) + - **Coordinate entity not found**: draw a zone once to create the entities for that location. - **No target dots appear when you move**: your Target X/Y sensors are most likely reporting in inches while the card reads millimeters. Switch the six target sensors to mm as described under [Set target entities](#set-target-entities). - **Presence never turns on**: verify the tracked X/Y entities have numeric states (not `unknown` or `unavailable`) and that the target actually sits inside the drawn zone. diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md b/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md index 3ae44c3101..a795e0cbf6 100644 --- a/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md +++ b/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md @@ -20,7 +20,10 @@ This is an alternative way to use the Starter Kit's button. Instead of toggling ## Build the automation -1. Open [Settings → Automations & scenes](https://my.home-assistant.io/redirect/automations/) in Home Assistant. +1. Open **Settings → Automations & scenes** in Home Assistant. + + [![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) + 2. Click **+ Create automation** in the bottom right, then choose **Create new automation**. 3. Under **Triggers**, click **+ Add trigger**, type `state`, and choose **State**. diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md b/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md index c7adf98abe..5bab15ecd7 100644 --- a/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md +++ b/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md @@ -40,16 +40,20 @@ A blueprint is a fill-in-the-blanks automation. Home Assistant ships one called
-1. Open [Settings → Automations & scenes → Blueprints](https://my.home-assistant.io/redirect/blueprints/) and look for **Motion-activated Light**. If it's there, skip to step 3. (1) +1. Open **Settings → Automations & scenes → Blueprints** and look for **Motion-activated Light**. If it's there, skip to step 3. (1) + + [![Open your Home Assistant instance and show your blueprints.](https://my.home-assistant.io/badges/blueprints.svg)](https://my.home-assistant.io/redirect/blueprints/) ![Home Assistant Blueprints list with Motion-activated Light selected, showing its Motion Sensor, Light, and Wait time fields](../../../assets/motion-activated-lights-select-blueprint.gif) -2. If it's missing, click **Import Blueprint** in the bottom right, paste the URL below, then click **Preview** and **Import Blueprint**. +2. If it's missing, click **Import Blueprint** in the bottom right, paste the URL below, then click **Preview** and **Import Blueprint**. The button under the URL opens the import dialog with it filled in. ```text https://github.com/home-assistant/core/blob/dev/homeassistant/components/automation/blueprints/motion_light.yaml ``` + [![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2Fhome-assistant%2Fcore%2Fdev%2Fhomeassistant%2Fcomponents%2Fautomation%2Fblueprints%2Fmotion_light.yaml) + 3. Click **Create Automation** on the blueprint, then fill in the three fields: * **Motion Sensor** → your kit's **Motion Module** sensor. * **Light Target** → the light you want to control. @@ -76,7 +80,10 @@ You could make two automations, one to turn the light on and one to turn it off.
-1. Open [Settings → Automations & scenes](https://my.home-assistant.io/redirect/automations/), click **Create Automation**, then **Create new automation**. +1. Open **Settings → Automations & scenes**, click **Create Automation**, then **Create new automation**. + + [![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) + 2. Click **Add Trigger**, search **motion**, and click **Motion detected**. Set its target to your **Motion Module** sensor. Open the trigger's menu (the three dots), choose **Rename**, and set the **Trigger ID** to `Detected`. (1) ![Adding a Motion detected trigger in Home Assistant, setting its Trigger ID to Detected, and targeting Motion Module](../../../assets/motion-activated-lights-detected.gif) diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md b/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md index b49eebe41c..a0eef86ed0 100644 --- a/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md +++ b/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md @@ -323,9 +323,9 @@ With the device back online, each action you added shows up in Home Assistant. T === "Level 1 · One song" - 1. Click the button below to open **Developer Tools → Actions**: + 1. Click the button below to open **Developer Tools → Actions** (**Settings → Tools → Actions** in Home Assistant 2026.8 and newer): - [![Open your Home Assistant instance and show your service developer tools.](https://my.home-assistant.io/badges/developer_services.svg)](https://my.home-assistant.io/redirect/developer_services/) + [![Open your Home Assistant instance and show your action tools.](https://my.home-assistant.io/badges/tools_actions.svg)](https://my.home-assistant.io/redirect/tools_actions/) 2. In the **Action** field, search `play_pink_panther` and pick **ESPHome: esphome-starter-kit play_pink_panther**. 3. Click **Perform action**. The buzzer plays the Pink Panther theme, no extra data needed. @@ -340,9 +340,9 @@ With the device back online, each action you added shows up in Home Assistant. T === "Level 2 · Song slots" - 1. Click the button below to open **Developer Tools → Actions**: + 1. Click the button below to open **Developer Tools → Actions** (**Settings → Tools → Actions** in Home Assistant 2026.8 and newer): - [![Open your Home Assistant instance and show your service developer tools.](https://my.home-assistant.io/badges/developer_services.svg)](https://my.home-assistant.io/redirect/developer_services/) + [![Open your Home Assistant instance and show your action tools.](https://my.home-assistant.io/badges/tools_actions.svg)](https://my.home-assistant.io/redirect/tools_actions/) 2. In the **Action** field, search `play_song_1` and pick **ESPHome: esphome-starter-kit play_song_1**. 3. Click **Perform action**. The buzzer plays that slot's tune, no extra data needed. diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md index 46dc8db3eb..7711ea6e8a 100644 --- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md +++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md @@ -47,7 +47,7 @@ You have two ways to control your Starter Kit, and both keep working at the same * Open the **on-device web page** at esphome-starter-kit.local to control your device directly from any browser on your network. No Home Assistant required. See the [Web Server in Core Components](core-components.md#web-server) for more. * Your Starter Kit appears as a new device under the **ESPHome integration** in Home Assistant. Each switch, sensor, and light becomes an entity you can use in dashboards, automations, voice control, history, and alerts. - [![Open the ESPHome integration in your Home Assistant.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) For a single device, the on-device web page is often enough. For anything that ties together with other devices or runs on a schedule, Home Assistant is the place. @@ -55,6 +55,8 @@ For a single device, the on-device web page is often enough. For anything that t Some router setups (notably VLANs and segmented networks) block mDNS broadcasts. If your device never shows up under **Discovered**, add the integration manually using the device's IP address. + [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=esphome) + For UniFi networks specifically, see our [UniFi mDNS troubleshooting guide](../../general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md). ESPHome logo Back - What is secrets.yaml? ESPHome logo Tutorial - Connect to Home Assistant diff --git a/docs/products/ESPHome-Starter-Kit/setup/first-steps.md b/docs/products/ESPHome-Starter-Kit/setup/first-steps.md index 9165b21fdb..2a215bd0bc 100755 --- a/docs/products/ESPHome-Starter-Kit/setup/first-steps.md +++ b/docs/products/ESPHome-Starter-Kit/setup/first-steps.md @@ -103,7 +103,7 @@ Pick the platform you'll be running ESPHome Device Builder on: To add the **ESPHome Device Builder** to your Home Assistant instance, use this My button: - [![Open your Home Assistant instance and start setting up a new app.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) **Method 2** diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md index 631ea1f561..13686cbd20 100644 --- a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md +++ b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md @@ -65,8 +65,13 @@ The proxy is saved in Device Builder, but the device is still running its old so Once the device reboots, Home Assistant picks up the proxy on its own. -1. Open your ESPHome device in Home Assistant. If you haven't adopted it yet, follow [Connect to Home Assistant](/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md) first. +1. Open your ESPHome device in Home Assistant (**Settings → Devices & services → ESPHome**). If you haven't adopted it yet, follow [Connect to Home Assistant](/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md) first. + + [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + 2. Home Assistant detects the new Bluetooth proxy and offers to set it up. Accept the prompt. -3. Open the Bluetooth advertisement monitor to watch the BLE devices your starter kit is picking up in real time. Anything in range shows up here, ready to add under **Settings → Devices & Services → Bluetooth** like any other device. +3. Open the **Bluetooth advertisement monitor** with the button below to watch the BLE devices your starter kit is picking up in real time. Anything in range shows up here, ready to add under **Settings → Devices & Services → Bluetooth** like any other device. + + [![Open your Home Assistant instance and show your Bluetooth Advertisements.](https://my.home-assistant.io/badges/bluetooth_advertisement_monitor.svg)](https://my.home-assistant.io/redirect/bluetooth_advertisement_monitor/) --8<-- "_snippets/community-help.md" diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md index e2221d4d0b..ca62f4238d 100644 --- a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md +++ b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md @@ -13,8 +13,14 @@ Once your ESPHome Starter Kit is flashed and on Wi-Fi, Home Assistant sees it au ## Add your device -1. Open [Devices & services](https://my.home-assistant.io/redirect/integrations/) in Home Assistant. Look for a card titled **ESPHome** under **Discovered** listing `esphome-starter-kit`. - * If you do not see the card, [add the ESPHome integration manually](https://my.home-assistant.io/redirect/config_flow_start/?domain=esphome). Enter the device's hostname (`esphome-starter-kit.local`) or its IP address. +1. Open **Settings → Devices & services** in Home Assistant. Look for a card titled **ESPHome** under **Discovered** listing `esphome-starter-kit`. + + [![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) + + * If you do not see the card, add the ESPHome integration manually: click **Add integration**, choose **ESPHome**, and enter the device's hostname (`esphome-starter-kit.local`) or its IP address. The button below opens that dialog. + + [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=esphome) + 2. Click **Configure** on the discovered card. 3. When prompted for the encryption key, paste the value of your `api_encryption_key` from `secrets.yaml` in ESPHome Device Builder. If Home Assistant and Device Builder run on the same machine, the key is often pre-filled. 4. Pick an **Area** for the device (optional), like Living Room or Office. @@ -24,7 +30,11 @@ Once your ESPHome Starter Kit is flashed and on Wi-Fi, Home Assistant sees it au ## Confirm it worked -Open the [ESPHome integration](https://my.home-assistant.io/redirect/integration/?domain=esphome) in Home Assistant and pick your device. You should see: +Open the **ESPHome** integration in Home Assistant (**Settings → Devices & services → ESPHome**) and pick your device. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + +You should see: * Every component you added in ESPHome Device Builder as an entity (the **GPIO Switch** for accessory power, the **AHT10** temperature and humidity sensors, the **Onboard RGB LED**). * A green status indicator showing the device is online. @@ -37,6 +47,9 @@ Toggle the **Onboard RGB LED** light entity and confirm the LED responds on the * Confirm Home Assistant is on the same Wi-Fi network as the device. * Some routers and VLAN setups block mDNS broadcasts across subnets. If you run UniFi, turning on mDNS in your network settings usually fixes this. See the [UniFi mDNS guide](../../general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md). Otherwise, add the integration manually using the device's IP address. Look the IP up on your router's client list or in the **Device Information** section of the ESPHome Device Builder info panel. + + [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=esphome) + * The device's web page should still load at the hostname or IP. If it does not, the device is not reachable from your computer yet and Home Assistant will not find it either. ### The encryption key is rejected diff --git a/docs/products/air1/additional-info/predicted-room-temp-humidity.md b/docs/products/air1/additional-info/predicted-room-temp-humidity.md index d419f570c5..a5d98e7baa 100644 --- a/docs/products/air1/additional-info/predicted-room-temp-humidity.md +++ b/docs/products/air1/additional-info/predicted-room-temp-humidity.md @@ -16,9 +16,11 @@ Credit to Ellude on our Discord, who worked out the model and fitted the numbers The predicted sensors and their tuning controls are disabled by default, so they stay out of the way for anyone who doesn't need them. To enable one: -1\. Open **Settings** and then **Devices & Services**. +1\. Go to **Settings → Devices & services** and select the **ESPHome** integration. The button below opens the ESPHome integration directly. -2\. Select the **ESPHome** integration, then your AIR-1 device. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + +2\. Select your AIR-1 device. 3\. Scroll down and select **entities not shown**. diff --git a/docs/products/air1/examples/air1-dashboard-examples.md b/docs/products/air1/examples/air1-dashboard-examples.md index 3e24b92fae..dc0065afeb 100755 --- a/docs/products/air1/examples/air1-dashboard-examples.md +++ b/docs/products/air1/examples/air1-dashboard-examples.md @@ -27,6 +27,10 @@ hours_to_show: 24 ## Custom: Apexcharts Card +This card installs from HACS, so add it there first: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=RomRider&repository=apexcharts-card&category=plugin) + ![ApexCharts card showing 10-minute average CO2 levels for five rooms in Home Assistant](/assets/air-1-suggestions-co2-smarthomesellout.png) ```yaml @@ -159,6 +163,10 @@ series: ### Custom: Plotly Graph Card +This card installs from HACS, so add it there first: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dbuezas&repository=lovelace-plotly-graph-card&category=plugin) + ![Plotly Graph card showing 24 hours of Bedroom CO2 readings in ppm](/assets/plotly-co2-graph.png) ```plaintext diff --git a/docs/products/air1/examples/firstof9's-apex-charts.md b/docs/products/air1/examples/firstof9's-apex-charts.md index cee3404119..a9d99b8db2 100755 --- a/docs/products/air1/examples/firstof9's-apex-charts.md +++ b/docs/products/air1/examples/firstof9's-apex-charts.md @@ -16,6 +16,8 @@ This guide assumes you already have HACS installed. If you do not, please first First, you need to install apexcharts-card by going to the HACS tab and searching "apexcharts-card". +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=RomRider&repository=apexcharts-card&category=plugin) + ![HACS search results showing the apexcharts-card repository](/assets/xpUimage.png) Once downloaded, it is ready to be used for dashboards! diff --git a/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md b/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md index cc38b91e60..d0bf241102 100755 --- a/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md +++ b/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md @@ -75,6 +75,8 @@ The AIR-1 knows nothing about the strip until you tell it how many LEDs there ar 1. Open the **ESPHome Device Builder** app, find your AIR-1, and click **Edit**. + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) + ![The ESPHome Device Builder editor open on an Apollo device configuration](/assets/gpio-led-esphome-edit.webp){ width="480" } 2. Add the block below at the bottom of the file, flush with the left margin so `light:` lines up with `packages:` and `wifi:`. Set `num_leds` to the number of LEDs on your strip, and change `pin` if you wired to a different port. diff --git a/docs/products/btn1/examples/blueprint.md b/docs/products/btn1/examples/blueprint.md index 7017f1a799..2292ec14d4 100755 --- a/docs/products/btn1/examples/blueprint.md +++ b/docs/products/btn1/examples/blueprint.md @@ -32,11 +32,15 @@ description: >- ## Manual Import -1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**. +1\. Go to **Settings → Automations & scenes**, click **Blueprints** at the top, then click **Import blueprint**. ![Opening the Home Assistant Blueprints tab under Automations and scenes and clicking Import blueprint](/assets/btn-1-blueprint-manual-import.gif) -2\. Copy this link and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**. +2\. Copy the address below, paste it into the **Blueprint address** box, and click **Preview** then click **Import blueprint**. + +```text +https://raw.githubusercontent.com/ApolloAutomation/Blueprints/refs/heads/main/BTN-1/BTN-1.yaml +``` ![Home Assistant Import a blueprint dialog for the BTN-1 blueprint, clicking Preview then Import blueprint](/assets/btn-1-blueprint-auto-import.gif) diff --git a/docs/products/cast1/additional-info/esphome-device-builder.md b/docs/products/cast1/additional-info/esphome-device-builder.md index 6609318d6e..4f56b6463a 100644 --- a/docs/products/cast1/additional-info/esphome-device-builder.md +++ b/docs/products/cast1/additional-info/esphome-device-builder.md @@ -74,7 +74,7 @@ Pick the platform you'll be running ESPHome Device Builder on: To add the **ESPHome Device Builder** to your Home Assistant instance, use this My button: - Open your Home Assistant instance and start setting up a new app. + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) **Method 2** @@ -118,7 +118,7 @@ Pick the platform you'll be running ESPHome Device Builder on: 1\. Open the ESPHome Device Builder. -Open your Home Assistant instance and show the dashboard of a Supervisor add-on. +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) 2\. Click **Show** next to **Discovered** at the top, then click **Take Control** next to your CAST-1. Change the **Name** and **Friendly Name** if you'd like, or leave them, then click **Take Control** again. diff --git a/docs/products/cast1/examples/led-strip.md b/docs/products/cast1/examples/led-strip.md index e745c1c13a..8ecba3d354 100644 --- a/docs/products/cast1/examples/led-strip.md +++ b/docs/products/cast1/examples/led-strip.md @@ -53,6 +53,8 @@ The LED strip controls are hidden until you turn them on, so CAST-1s without a s 1\. In Home Assistant, go to **Settings** > **Devices & services** > **ESPHome** and open your CAST-1. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + 2\. Under **Controls**, **Configuration** and **Diagnostic**, select **+N entities not shown** and turn on each entity whose name starts with **LED Strip**. Home Assistant adds them after about 30 seconds. 3\. Set **LED Strip Count** to the number of LEDs on your strip. (1) diff --git a/docs/products/cast1/examples/tts-announcements.md b/docs/products/cast1/examples/tts-announcements.md index eb2a35b6ba..403d44cebf 100644 --- a/docs/products/cast1/examples/tts-announcements.md +++ b/docs/products/cast1/examples/tts-announcements.md @@ -17,7 +17,9 @@ Your CAST-1 has two media players and either one handles announcements. ## Send an Announcement -1\. Open **Developer Tools** in Home Assistant and go to the **Actions** tab. +1\. Open **Developer Tools** in Home Assistant (**Settings → Tools** in Home Assistant 2026.8 and newer) and go to the **Actions** tab. + +[![Open your Home Assistant instance and show your action tools.](https://my.home-assistant.io/badges/tools_actions.svg)](https://my.home-assistant.io/redirect/tools_actions/) 2\. Switch to YAML mode and paste this: (1) { .annotate } diff --git a/docs/products/cast1/examples/wizmote-blueprint.md b/docs/products/cast1/examples/wizmote-blueprint.md index 5bc69a4173..e48f052677 100644 --- a/docs/products/cast1/examples/wizmote-blueprint.md +++ b/docs/products/cast1/examples/wizmote-blueprint.md @@ -28,7 +28,7 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1. 1\. Open the ESPHome integration, then click through to your Apollo CAST-1 to open its device page. -Open your Home Assistant instance and show the ESPHome integration. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 2\. Turn on **WizMote Auto-Discovery**. @@ -47,7 +47,7 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1. 1\. Click the Import Blueprint button below then click **Open link**. -Import Blueprint +[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FCAST-1%2FCAST-1-WizMote.yaml) 2\. Click **Preview** then click **Import Blueprint**. diff --git a/docs/products/cast1/setup/getting-started.md b/docs/products/cast1/setup/getting-started.md index db4151771b..0135aaf9ef 100644 --- a/docs/products/cast1/setup/getting-started.md +++ b/docs/products/cast1/setup/getting-started.md @@ -49,7 +49,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on 1\. Open your integrations page in Home Assistant. - Open your Home Assistant instance and show your integrations. + [![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) 2\. Click the **Add** button on your discovered CAST-1, type in your Wi-Fi SSID and password, then click **Submit**. @@ -78,7 +78,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on Open the ESPHome Integration, then click **Add** and **Submit**. Edit the name and choose an **Area** then click **Finish**. -Open your Home Assistant instance and show the ESPHome integration. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Adding the discovered CAST-1 in the ESPHome integration, naming it, and choosing an area](/assets/cast-1-home-assistant-integration.gif) @@ -90,7 +90,7 @@ The CAST-1 streams through Open your Home Assistant instance and show the Music Assistant Server add-on. +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=d5369777_music_assistant&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon) 2\. Click **Install**, then click **Start** once it finishes. @@ -98,7 +98,7 @@ The CAST-1 streams through Open your Home Assistant instance and show your integrations. +[![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) ### Stream To Your CAST-1 diff --git a/docs/products/castpro1/examples/led-strip.md b/docs/products/castpro1/examples/led-strip.md index 413ea37df2..4968fbc856 100644 --- a/docs/products/castpro1/examples/led-strip.md +++ b/docs/products/castpro1/examples/led-strip.md @@ -53,6 +53,8 @@ The LED strip controls are hidden until you turn them on, so a CAST PRO-1 withou 1\. In Home Assistant, go to **Settings** > **Devices & services** > **ESPHome** and open your CAST PRO-1. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + 2\. Under **Controls**, **Configuration** and **Diagnostic**, select **+N entities not shown** and turn on each entity whose name starts with **LED Strip**. Home Assistant adds them after about 30 seconds. 3\. Set **LED Strip Count** to the number of LEDs on your strip. (1) diff --git a/docs/products/general/battery-sensors/awake-ha-helper.md b/docs/products/general/battery-sensors/awake-ha-helper.md index a934651f6b..e9e7fbd844 100755 --- a/docs/products/general/battery-sensors/awake-ha-helper.md +++ b/docs/products/general/battery-sensors/awake-ha-helper.md @@ -4,7 +4,9 @@ description: How to keep your sensor awake using the Home Assistant Helper. --- # How to keep your sensor awake using the Home Assistant Helper -1\. Open your Home Assistant dashboard and go to settings then select Devices and services and select helpers in the top right. Or click here to go straight there. +1\. Open your Home Assistant dashboard and go to settings then select Devices and services and select helpers in the top right. Or use the button below to go straight there. + +[![Open your Home Assistant instance and show your helper entities.](https://my.home-assistant.io/badges/helpers.svg)](https://my.home-assistant.io/redirect/helpers/) ![Home Assistant Settings with the cursor on Devices and services](/assets/awake-ha-helper-pic-1.png) @@ -36,7 +38,9 @@ description: How to keep your sensor awake using the Home Assistant Helper. Please keep reading to create an automation to turn this helper off after one hour of it being on. -8\. Create a new automation and select "add trigger" then select entity then select state. +8\. Create a new automation (**Settings → Automations & scenes → Create automation**) and select "add trigger" then select entity then select state. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) ![New automation with Add trigger and the Entity trigger option circled in red](/assets/toggle-ota-mode-automation-1.png) diff --git a/docs/products/general/calibrating-and-updating/co2-calibration.md b/docs/products/general/calibrating-and-updating/co2-calibration.md index 40cf93f010..46e8beedc7 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration.md @@ -18,7 +18,9 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor 1\. Bring your sensor outside and plug it in. You might need a USB battery bank if you live in an apartment or otherwise cannot get power outside of your building. -2\. Head to the ESPHome Integrations page. +2\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 3\. Click device as shown in the image below. diff --git a/docs/products/general/calibrating-and-updating/mmwave-videos.md b/docs/products/general/calibrating-and-updating/mmwave-videos.md index a77e8732ed..b33bc215db 100755 --- a/docs/products/general/calibrating-and-updating/mmwave-videos.md +++ b/docs/products/general/calibrating-and-updating/mmwave-videos.md @@ -20,7 +20,9 @@ How to tune the mmWave sensor using radar engineering mode.
-1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on the name of your new device! +1\. Go to **Settings → Devices & services → ESPHome** and click the name of your device. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 2\. Scroll down to the Configuration section. diff --git a/docs/products/general/calibrating-and-updating/updating-firmware.md b/docs/products/general/calibrating-and-updating/updating-firmware.md index d5c0893a52..fec19c2c89 100755 --- a/docs/products/general/calibrating-and-updating/updating-firmware.md +++ b/docs/products/general/calibrating-and-updating/updating-firmware.md @@ -6,7 +6,9 @@ description: Step by step guide on how to update the firmware on your Apollo dev ## From Home Assistant -Most Apollo devices update themselves. Open the device page in Home Assistant and look for the **Firmware Update** entity: it reports when a new version is available and installs it over the air, with no computer and no cable. +Most Apollo devices update themselves. Open the device page in Home Assistant (**Settings → Devices & services → ESPHome**, then your device) and look for the **Firmware Update** entity: it reports when a new version is available and installs it over the air, with no computer and no cable. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) On a battery powered device, start the update and it installs the next time the device wakes. @@ -22,7 +24,7 @@ Use this route to build the firmware yourself, or if your device has no **Firmwa 1\. In Home Assistant open the ESPHome Device Builder**.** -[![Show add-on on My Home Assistant button for the ESPHome Device Builder](/assets/esphome-addon-image.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) !!! tip "Make sure you are running the latest version of ESPHome" diff --git a/docs/products/general/holiday-songs.md b/docs/products/general/holiday-songs.md index d43fe9cfdd..4151afa36f 100755 --- a/docs/products/general/holiday-songs.md +++ b/docs/products/general/holiday-songs.md @@ -10,7 +10,9 @@ description: >- 1\. Click each box below to see each song then click the copy button on the far right to copy the song. -2\. Play the song in a Home Assistant script, automation, or directly from the developer tools "Actions" tab. +2\. Play the song in a Home Assistant script, automation, or directly from the developer tools "Actions" tab (**Settings → Tools → Actions** in Home Assistant 2026.8 and newer). + +[![Open your Home Assistant instance and show your action tools.](https://my.home-assistant.io/badges/tools_actions.svg)](https://my.home-assistant.io/redirect/tools_actions/) ???+ song-red "Jingle Bells (Ornate)" diff --git a/docs/products/general/piezo.md b/docs/products/general/piezo.md index c57360628d..8b93d2323e 100755 --- a/docs/products/general/piezo.md +++ b/docs/products/general/piezo.md @@ -10,7 +10,9 @@ This guide will walk you through using the buzzer on your Apollo Device. This might still be called a "Service Call" depending on the version of ESPHome firmware your device is using! -1\. Open Home Assistant and navigate to developer tools in the bottom left. +1\. Open Home Assistant and navigate to **Developer tools** in the bottom left (**Settings → Tools** in Home Assistant 2026.8 and newer). The button below opens the **Actions** tab in either version, so you can skip step 2. + +[![Open your Home Assistant instance and show your action tools.](https://my.home-assistant.io/badges/tools_actions.svg)](https://my.home-assistant.io/redirect/tools_actions/) 2\. Click Actions at the top of the page. diff --git a/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md b/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md index e4011dd5ee..6460cd8722 100755 --- a/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md +++ b/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md @@ -7,6 +7,8 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 1\. Open the ESPHome Device Builder. +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) + ![ESPHome Device Builder dashboard showing cards for several Apollo devices](/assets/bluetooth-proxy-tutorial-1.png) 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install ESPHome Device Builder.") and then move on to step 3. diff --git a/docs/products/general/setup/adjusting-wifi-power.md b/docs/products/general/setup/adjusting-wifi-power.md index 6bfb074dee..9e0fc930fe 100755 --- a/docs/products/general/setup/adjusting-wifi-power.md +++ b/docs/products/general/setup/adjusting-wifi-power.md @@ -12,6 +12,8 @@ The ESP chips produce a significant amount of energy (heat) constantly using Wi- 1\. Open the ESPHome Device Builder. +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) + ![ESPHome Device Builder dashboard showing cards for several Apollo devices](/assets/power-save-tutorial-1.png) 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install ESPHome Device Builder.") and then move on to step 3. diff --git a/docs/products/general/setup/apollo-mmwave-dashboard-setup.md b/docs/products/general/setup/apollo-mmwave-dashboard-setup.md index a847a0179d..7d3e3d22d9 100644 --- a/docs/products/general/setup/apollo-mmwave-dashboard-setup.md +++ b/docs/products/general/setup/apollo-mmwave-dashboard-setup.md @@ -24,14 +24,23 @@ If you built the [MSR-2 tuning dashboard](/products/msr2/setup/msr2-tuning-dashb !!! note "Before you start" - You're running Home Assistant 2026.8.1 or newer. **Settings → About** shows your version. - - HACS 2.0.5 or newer is installed and set up. HACS is a community store for Home Assistant that installs and updates custom integrations like this one. If you don't have it yet, follow the [HACS download guide](https://hacs.xyz/docs/use/download/download/) and then the [initial configuration guide](https://hacs.xyz/docs/configuration/basic). Setup asks you to sign in with a free GitHub account. + + [![Open your Home Assistant instance and show your Home Assistant version information.](https://my.home-assistant.io/badges/info.svg)](https://my.home-assistant.io/redirect/info/) + + - HACS 2.0.5 or newer is installed and set up. HACS is a community store for Home Assistant that installs and updates custom integrations like this one. If you don't have it yet, follow the [HACS download guide](https://hacs.xyz/docs/use/download/download/) and then the [initial configuration guide](https://hacs.xyz/docs/configuration/basic). Setup asks you to sign in with a free GitHub account. On Home Assistant OS, the button below opens the **Get HACS** app that the download guide uses. + + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=cb646a50_get&repository_url=https%3A%2F%2Fgithub.com%2Fhacs%2Faddons) + - Your Apollo sensor is already in Home Assistant through the ESPHome integration. If it isn't, work through [getting started](/products/general/setup/getting-started.md) first. ## Install Apollo mmWave through HACS -Apollo mmWave installs from its GitHub repository, so you add that repository to HACS once as a custom repository. From then on HACS tracks updates for it like any other integration. +Apollo mmWave installs from its GitHub repository, so you add that repository to HACS once as a custom repository. From then on HACS tracks updates for it like any other integration. The button under step 1 covers steps 1 to 5: it adds the repository, after HACS asks you to confirm, and opens Apollo mmWave so you can go on at step 6. 1. Open **HACS** from your Home Assistant sidebar. + + [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=ApolloAutomation&repository=apollo-mmwave-main&category=integration) + 2. Click the three-dot menu in the upper right corner and choose **Custom repositories**. 3. Paste `https://github.com/ApolloAutomation/apollo-mmwave-main` into the **Repository** field. 4. Set **Type** to **Integration** and click **Add**. The repository shows up in the list; close the dialog. @@ -39,13 +48,18 @@ Apollo mmWave installs from its GitHub repository, so you add that repository to 6. Click **Download**, then confirm with **Download** in the dialog that opens. 7. Restart Home Assistant: go to **Settings → System**, click the power icon in the upper right corner, and choose **Restart Home Assistant**. Wait for it to come back. + [![Open your Home Assistant instance and show the system dashboard.](https://my.home-assistant.io/badges/system_dashboard.svg)](https://my.home-assistant.io/redirect/system_dashboard/) + Home Assistant only loads a new integration when it starts, so the restart is what makes Apollo mmWave available to add in the next step. ## Add the integration This is the step that builds your dashboard. You add Apollo mmWave once and it covers every Apollo radar you own, so there's no need to repeat it per sensor. Adding it a second time stops with **This entry is already configured.** -1. Go to **Settings → Devices & services** and click **Add integration**. You can also [open the setup dialog directly](https://my.home-assistant.io/redirect/config_flow_start/?domain=apollo_mmwave). +1. Go to **Settings → Devices & services** and click **Add integration**. Or use the button below, which opens the Apollo mmWave setup dialog directly, and skip to step 3. + + [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=apollo_mmwave) + 2. Search for **Apollo mmWave** and select it. If it isn't in the list, refresh the browser page (your browser may still hold the list from before the restart) and search again. 3. Leave **Add an 'Apollo mmWave' dashboard to the sidebar** turned on (it's on by default) to get the dashboard this guide describes. The dialog notes that the integration serves its own cards and dashboard, with nothing else to download. Turn the option off only if you'd rather place the cards on your own dashboards; you can change it later in the integration options. 4. Click **Submit**, then **Finish** on the success message. @@ -97,6 +111,8 @@ Your dashboard is working. On an MSR-1, MSR-2, or R PRO-1 tab, the first thing t The options let you turn the dashboard off, or choose exactly which sensors get a tab. Open **Settings → Devices & services → Apollo mmWave → Configure** to reach the **Apollo mmWave options** dialog. Changes take effect as soon as you click **Submit**, with no restart, and an open dashboard picks up a new device selection without a reload. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=apollo_mmwave) + ![The Apollo mmWave options dialog with the Auto-create the Apollo mmWave dashboard checkbox ticked and an empty Dashboard devices selector](/assets/apollo-mmwave-options.png) - **Auto-create the Apollo mmWave dashboard** is on by default. Turn it off to remove the dashboard from your sidebar. The cards stay available for your own dashboards: in the card picker they're listed as **Apollo Radar Auto-Calibrate**, **Apollo Radar Distance Chart**, **Apollo Radar Gate Energy Chart**, and **Apollo Zone Map**. The [Apollo mmWave configuration guide](https://github.com/ApolloAutomation/apollo-mmwave-main/blob/main/docs/configuration.md#use-your-own-dashboards-instead) has the YAML for placing them. @@ -165,14 +181,22 @@ Work through these in order: - Check that **Auto-create the Apollo mmWave dashboard** is on in the integration options. - Look under **Settings → Dashboards**. Apollo mmWave is listed there even when it's hidden. If you find it, check that its **Show in sidebar** setting is on and that you haven't hidden it from your own sidebar in your profile. + + [![Open your Home Assistant instance and show your dashboards.](https://my.home-assistant.io/badges/lovelace_dashboards.svg)](https://my.home-assistant.io/redirect/lovelace_dashboards/) + - If you already had a dashboard of your own at the `apollo-mmwave` address, the integration leaves that one alone and doesn't create its own. - Open **Settings → System → Logs** and look for a warning that starts with **Apollo mmWave:**. You'll also see a warning there that `apollo_mmwave` is a custom integration Home Assistant hasn't tested. Every custom integration installed through HACS logs that one, so you can ignore it. + + [![Open your Home Assistant instance and show your Home Assistant logs.](https://my.home-assistant.io/badges/logs.svg)](https://my.home-assistant.io/redirect/logs/) + - If the integration couldn't create the dashboard, add it yourself: go to **Settings → Dashboards**, click **Add dashboard**, and choose **Apollo Radar Tuning** from the community dashboards. A dashboard you add this way always shows every detected device; the **Dashboard devices** option does not apply to it. ### The dashboard shows no devices The dashboard starts with **No Apollo mmWave devices found.** It found no radar to build a tab for. Confirm your sensor shows up under **Settings → Devices & services → ESPHome**, and check that **Dashboard devices** in the integration options is empty or lists your current devices. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + ### One sensor has no tab Work through these in order: @@ -186,16 +210,22 @@ Work through these in order: On an MSR-1, MSR-2, or R PRO-1 tab, the help card adds **Offline right now.** and the Auto-calibrate card reads **Radar is offline. Calibration needs the radar online and its gate entities enabled.** with its buttons disabled. An MTR-1 tab adds a card with the sensor's name and the same **Offline right now.** note, and its zone map shows no targets until the sensor reconnects. The tab stays so the sensor isn't silently missing, and the cards fill in once it reconnects. Check its power and Wi-Fi, and that it shows as online on the ESPHome integration page. If you replaced or reflashed the sensor under a new name, the old device entry is what's showing as offline: delete the old device under **Settings → Devices & services** and its tab goes away. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + ### An Apollo card shows an error after an update After you update Apollo mmWave through HACS and restart, a browser that still holds the previous version's files can show the Apollo cards as error boxes that read **Custom element doesn't exist**. Refresh the page. Each release loads its cards under a new versioned address, so a fresh page load picks up the current version. If the error is still there, do a hard refresh with **Ctrl+Shift+R** (**Cmd+Shift+R** on a Mac). If that doesn't clear it either, check **Settings → System → Logs** for a warning that starts with **Apollo mmWave:** about Lovelace resources. On a system that manages its dashboard resources in YAML, the warning lists the two resource addresses to add by hand. +[![Open your Home Assistant instance and show your Home Assistant logs.](https://my.home-assistant.io/badges/logs.svg)](https://my.home-assistant.io/redirect/logs/) + If the element named in the error is `zone-mapper-card`, a refresh won't help: that's the old card name, so update the card as described in [From Apollo mmWave 1.x zone mapping](#from-apollo-mmwave-1x-zone-mapping). ### The Auto-calibrate card is still loading The card reads **Apollo mmWave is still loading...** right after a restart while the integration starts, and clears on its own. If it changes to **Apollo mmWave is not loaded, so calibration is unavailable.**, check that Apollo mmWave is enabled under **Settings → Devices & services**, then click **Retry** on the card. +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=apollo_mmwave) + !!! success "Next step: calibrate your radar or draw zones" Your dashboard is up and every sensor has its tab. Now put it to work: the usage guide walks you through calibrating with an empty room, reading the charts, adjusting thresholds by hand, and drawing zones on the zone map. diff --git a/docs/products/general/setup/apollo-mmwave-dashboard.md b/docs/products/general/setup/apollo-mmwave-dashboard.md index 0576475f32..738e6c875b 100644 --- a/docs/products/general/setup/apollo-mmwave-dashboard.md +++ b/docs/products/general/setup/apollo-mmwave-dashboard.md @@ -275,9 +275,13 @@ actions: {{ calibration.changed }} thresholds changed. ``` -To use it, create a new automation, open the three-dot menu, choose **Edit in YAML**, and paste it in. Then replace `binary_sensor.apollo_msr_2_abc123_radar_target` with your radar's **Radar Target** sensor, and `your_device_id` with your radar. To fill in the device without looking up its ID, switch the action to the visual editor and pick your radar under **Radar Device**. If the action is refused before it starts (the radar is offline, for example), the automation stops with an error at that step instead of sending the notification. +To use it, create a new automation under **Settings → Automations & scenes**, open the three-dot menu, choose **Edit in YAML**, and paste it in. Then replace `binary_sensor.apollo_msr_2_abc123_radar_target` with your radar's **Radar Target** sensor, and `your_device_id` with your radar. To fill in the device without looking up its ID, switch the action to the visual editor and pick your radar under **Radar Device**. If the action is refused before it starts (the radar is offline, for example), the automation stops with an error at that step instead of sending the notification. -Each call calibrates one radar. Two related actions round it out: `apollo_mmwave.cancel_calibration` stops a running job, and `apollo_mmwave.restore_gate_thresholds` does what **Undo** does. The card offers only the newest saved thresholds, while the action can restore an older set with its `snapshot_id` field. **Developer Tools → Actions** lists every field. +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) + +Each call calibrates one radar. Two related actions round it out: `apollo_mmwave.cancel_calibration` stops a running job, and `apollo_mmwave.restore_gate_thresholds` does what **Undo** does. The card offers only the newest saved thresholds, while the action can restore an older set with its `snapshot_id` field. **Settings → Tools → Actions** lists every field, and the button below opens it with `apollo_mmwave.calibrate_gates` selected. + +[![Open your Home Assistant instance and show your action tools with a specific action selected.](https://my.home-assistant.io/badges/tools_perform_action.svg)](https://my.home-assistant.io/redirect/tools_perform_action/?service=apollo_mmwave.calibrate_gates) !!! warning "Only automate it for a room you know is empty" @@ -290,9 +294,14 @@ Each call calibrates one radar. Two related actions round it out: `apollo_mmwave The **Calibrate with empty room** button is disabled when the card cannot run a calibration. The card says why: - **Radar is offline. Calibration needs the radar online and its gate entities enabled.** Check that the radar is powered and shows as online under **Settings → Devices & services → ESPHome**. If it is online, open your sensor's device page from that list and check that the **Radar Engineering Mode** switch and the gate threshold and gate energy entities are enabled. A disabled entity is listed under **+ N entities not shown**: select it, open its settings (the cog), turn on **Enabled**, and click **Update**. + + [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + - **Background correction is running on the LD2412. Wait for its status to turn off.** (R PRO-1) Wait for **Background Correction Running** to turn off. - **Apollo mmWave is still loading...** The integration is starting or reloading, and the card keeps trying on its own. If it changes to **Apollo mmWave is not loaded, so calibration is unavailable.**, press **Retry**. If that keeps happening, check **Settings → Devices & services** for an error on the Apollo mmWave integration. + [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=apollo_mmwave) + If the button works but the card answers with a line starting **Calibration failed:**, the rest of the line says what went wrong, and **Try again** runs it again once you have fixed it. The common ones: - **The radar is unavailable right now. Check that it is online, then try again.** The radar dropped off the network. @@ -314,6 +323,8 @@ If Home Assistant restarted while thresholds were being written, or the radar we While Radar Engineering Mode is on, the radar updates its 18 (MSR-1 and MSR-2) or 28 (R PRO-1) gate energy sensors about once a second, and Home Assistant's recorder, the part that saves history, stores every update. Turning the mode off when you're done avoids this. If you like to leave it on to watch the chart, add the block below to your `configuration.yaml` (the **File editor** app is one way to open it), then restart Home Assistant. If the file already has a `recorder:` section, add the `exclude:` lines to it instead of adding a second `recorder:` key. + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=core_configurator) + ```yaml title="configuration.yaml" recorder: exclude: diff --git a/docs/products/general/setup/bluetooth-tracking.md b/docs/products/general/setup/bluetooth-tracking.md index 66f281b171..212d4db127 100755 --- a/docs/products/general/setup/bluetooth-tracking.md +++ b/docs/products/general/setup/bluetooth-tracking.md @@ -8,6 +8,8 @@ description: Tutorial for how to turn your Apollo device into a BLE tracker to t Alternative HACS Integration: [iPhone Detect](https://github.com/mudape/iphonedetect) +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=mudape&repository=iphonedetect&category=integration) + [https://community.home-assistant.io/t/implement-espresense-fuctionality-in-home-assistant-taking-advantage-of-ble-proxy-of-esphome/524019/6](https://community.home-assistant.io/t/implement-espresense-fuctionality-in-home-assistant-taking-advantage-of-ble-proxy-of-esphome/524019/6) Thanks to user [Jacob Pfeifer](https://discord.com/channels/1126966963206361199/1126966963755819080/1202032228050419732)!
Ok, so looks like I've got signal strength tracking working for Apple watches by getting the mac address from the home assistant private ble device integration. Here's a quick write-up if anyone else is interested. The end of the doc has a complete configuration file example. diff --git a/docs/products/general/setup/change-the-update-frequency-of-sensors.md b/docs/products/general/setup/change-the-update-frequency-of-sensors.md index e1fb5d0448..73c4fd7d5f 100755 --- a/docs/products/general/setup/change-the-update-frequency-of-sensors.md +++ b/docs/products/general/setup/change-the-update-frequency-of-sensors.md @@ -5,7 +5,9 @@ description: Tutorial for How To Change The Update Frequency Of Sensors. # How To Change The Update Frequency Of Sensors -1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. +1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. If it isn't in your sidebar, the button below opens the app. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) ![ESPHome Builder in the Home Assistant sidebar with the Edit button on an AIR-1 card outlined](/assets/update-frequency-pic-1.png) diff --git a/docs/products/general/setup/getting-started.md b/docs/products/general/setup/getting-started.md index ab4fe16aa0..c605719d72 100755 --- a/docs/products/general/setup/getting-started.md +++ b/docs/products/general/setup/getting-started.md @@ -40,6 +40,8 @@ If this does not automatically open the dashboard, please open your web browser 1\. Navigate to settings -> integrations then click the "**ADD**" button below your new Apollo device! +[![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) + ![Discovered PLT-1B card in Home Assistant labeled Improv via BLE with an Add button](/assets/improv-ble-pic-1.png) 2\. Click submit when it asks if you want to set up your new device and shows you the hostname of your device. @@ -54,7 +56,9 @@ If this does not automatically open the dashboard, please open your web browser ![Home Assistant dialog saying the device is connecting to the Wi-Fi network](/assets/improv-ble-pic-4.png) -5\. Click the link shown in the image below (do not click close). +5\. Click the link shown in the image below (do not click close). If the dialog is already gone, the button below opens the same ESPHome setup. + +[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=esphome) ![Home Assistant success message with a My Home Assistant link to finish ESPHome setup](/assets/improv-ble-pic-5-1.png) @@ -68,7 +72,9 @@ If this does not automatically open the dashboard, please open your web browser Feel free to [skip to the next section by clicking here](https://wiki.apolloautomation.com/products/general/setup/getting-started/#connecting-to-home-assistant-via-esphome-integration "Click to jump to the ESPHome Integration steps!") unless you need to rename your sensor or do manual edits to the yaml -You can add the ESPHome Device Builder app in Home Assistant to easily update your device or edit the yaml. If you don't have the ESPHome Device Builder app installed you can [follow the steps here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Getting Started guide for installing ESPHome Device Builder"). +You can add the ESPHome Device Builder app in Home Assistant to update your device or edit the yaml. If you don't have the ESPHome Device Builder app installed you can [follow the steps here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Getting Started guide for installing ESPHome Device Builder"). The button below opens the app in your Home Assistant. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) Make sure to fill out your Wi-Fi details in the SECRETS section by clicking on the SECRETS Image below. @@ -110,6 +116,8 @@ wifi_password: "your-wifi-pass-here" 2\. Click "**Check it out**" to go to the integrations page and see the new device that was found. +[![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) + ![Home Assistant New devices discovered notification with the Check it out link outlined](/assets/getting-started-pic-7.png) 3\. Click "**ADD**" to begin adding the device to Home Assistant. @@ -124,6 +132,8 @@ wifi_password: "your-wifi-pass-here" ![Home Assistant Success dialog for an MSR-2 with the Area field and Finish button marked](/assets/getting-started-pic-9.png) -6\. Your device is now added to Home Assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device! +6\. Your device is now added to Home Assistant via the ESPHome integration. To find it, go to **Settings → Devices & services → ESPHome** and click the name of your new device! + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) [Click here to join our Discord for fast support! :simple-discord:](https://link.apolloautomation.com/discord){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md b/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md index 494a015daa..cdbb0ffe7a 100755 --- a/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md +++ b/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md @@ -4,7 +4,9 @@ description: Tutorial for How To Add Temp And Humidity entities From the SCD40 C --- # How To Add Temp And Humidity From SCD40 -1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. +1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. If it isn't in your sidebar, the button below opens the app. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) ![ESPHome Builder in the Home Assistant sidebar with the Edit button on an AIR-1 card outlined](/assets/add-temp-hum-scd40-pic-1.png) @@ -66,4 +68,6 @@ number: 5\. Once you are finished, you will have two new boxes inside the Home Assistant ESPHome integration device page for your device where you can fill in an offset. Give them up to 1 minute to take effect! +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + ![SCD40 Humidity and SCD40 Temperature offset boxes on the device page in Home Assistant](/assets/add-temp-hum-scd40-pic-5.png) \ No newline at end of file diff --git a/docs/products/general/setup/renaming-apollo-devices.md b/docs/products/general/setup/renaming-apollo-devices.md index 23e56c22c2..cb6a77be74 100755 --- a/docs/products/general/setup/renaming-apollo-devices.md +++ b/docs/products/general/setup/renaming-apollo-devices.md @@ -6,7 +6,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio ## ESPHome Integration - Part 1 -1\. Click the button below to open the ESPHome Integrations page. +1\. Click the button below to open the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) @@ -30,7 +30,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio This section only changes the device name shown in the ESPHome integration page. It is safe to skip, but we recommend doing it to keep naming consistent. -1\. Click the button below to open the ESPHome Integrations page. +1\. Click the button below to open the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) @@ -46,6 +46,8 @@ This section only changes the device name shown in the ESPHome integration page. 1\. Make sure you are already using the ESPHome Device Builder app as gone over in the getting started wiki articles. +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) + 2\. Click the 3 dots next to your new Apollo device and select **Rename hostname** then enter in the new name of your sensor and click **Rename**. This cannot have any spaces or underscores only hyphens, numbers, and lowercase letters such as "**smart-keys**". Once it finishes it will say OTA successful and you can click close to get back to the main dashboard. ![Using Rename hostname in ESPHome Device Builder to rename a BTN-1 and install the change](/assets/rename-hostname-esphome-device-builder-gif.gif) @@ -58,7 +60,9 @@ This section only changes the device name shown in the ESPHome integration page. ![Editing friendly_name to Smart Keys in ESPHome Device Builder, then installing wirelessly](/assets/rename-friendiy-name-esphome-device-builder-gif.gif) -4\. Finally we should delete the device from the ESPHome Integration in Home Assistant and then add it back! Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then **Delete**. +4\. Finally we should delete the device from the ESPHome Integration in Home Assistant and then add it back! Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). Next to the device you would like to remove, click the three dots and then **Delete**. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Deleting the renamed BTN-1 from the ESPHome integration page using the three-dot menu](/assets/delete-device-from-esphome-device-builder-gif2.gif) diff --git a/docs/products/general/setup/switch-to-beta-branch.md b/docs/products/general/setup/switch-to-beta-branch.md index abfec1ce43..800277e897 100755 --- a/docs/products/general/setup/switch-to-beta-branch.md +++ b/docs/products/general/setup/switch-to-beta-branch.md @@ -40,9 +40,9 @@ This is the easy way. Use it if your device has a **Firmware Channel** setting o Use this if your device doesn't have a **Firmware Channel** setting, or if you build its firmware yourself. -1\. In Home Assistant open the ESPHome Device Builder. +1\. In Home Assistant open the **ESPHome Device Builder** app. -[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=ESPHome+Device+Builder&repository_url=http%3A%2F%2Fhomeassistant.local%3A8123%2F5c53de3b_esphome) +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) !!! tip "Make sure you are running the latest version of ESPHome" diff --git a/docs/products/general/troubleshooting/connection-issues.md b/docs/products/general/troubleshooting/connection-issues.md index a9aa0ee7f0..c378feb4e4 100755 --- a/docs/products/general/troubleshooting/connection-issues.md +++ b/docs/products/general/troubleshooting/connection-issues.md @@ -24,7 +24,9 @@ wifi: power_save_mode: none ``` -1\. Select the ESPHome app and then select Edit under your desired device. +1\. Select the ESPHome app and then select Edit under your desired device. If it isn't in your sidebar, the button below opens the app. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) ![ESPHome in the Home Assistant sidebar and the Edit button on an MSR-2 card circled](/assets/screenshot-2024-10-25-at-5-14-48-pm.png) diff --git a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md index f95551958a..ca96a04b7b 100755 --- a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md +++ b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md @@ -12,7 +12,9 @@ This will cover how to remove an Apollo device from Home Assistant This step is only necessary for advanced users who added the device to the ESPHome device builder to edit the yaml and customize the device. Please skip to the next step if you are only using the ESPHome or Apollo Automation integration! -1\. Navigate to Home Assistant and open your ESPHome Device Builder app. +1\. Navigate to Home Assistant and open your **ESPHome Device Builder** app. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) ![ESPHome Builder selected in the Home Assistant sidebar, showing the ESPHome Device Builder dashboard](/assets/esphome-device-builder-addon-image.png) @@ -22,6 +24,8 @@ This will cover how to remove an Apollo device from Home Assistant ## ESPHome Integration -1\. Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then "Delete". +1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). Next to the device you would like to remove, click the three dots and then "Delete". + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Deleting an H-1 from the ESPHome integration page in Home Assistant and confirming Delete](/assets/delete-device-from-esphome-integration-gif.gif) \ No newline at end of file diff --git a/docs/products/general/tutorials/minimize-mmwave-activity-spam.md b/docs/products/general/tutorials/minimize-mmwave-activity-spam.md index a72e83569c..ecf135eb1a 100644 --- a/docs/products/general/tutorials/minimize-mmwave-activity-spam.md +++ b/docs/products/general/tutorials/minimize-mmwave-activity-spam.md @@ -58,4 +58,6 @@ Apollo mmWave sensors report frequently by design, which can cause internal rada 3\. Save `configuration.yaml` and restart Home Assistant (**Settings → System → Restart**). +[![Open your Home Assistant instance and show the system dashboard.](https://my.home-assistant.io/badges/system_dashboard.svg)](https://my.home-assistant.io/redirect/system_dashboard/) + 4\. Open **Activity** in Home Assistant to confirm the noisy entities no longer appear. diff --git a/docs/products/h1/reflash.md b/docs/products/h1/reflash.md index 9b7abf7389..cb9ac41756 100755 --- a/docs/products/h1/reflash.md +++ b/docs/products/h1/reflash.md @@ -27,6 +27,8 @@ If no device shows, click cancel and then install the recommended driver that sh 1. After finishing, check for the Apollo hotspot and connect. This might not show if you previously had the H-1 connected to your Wi-Fi 2. Log into Home Assistant and go to the ESPHome app check to see if you can adopt the device. + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) + If you encounter the below error, please complete the [Putting H-1 In Boot Mode Document](https://wiki.apolloautomation.com/products/h1/boot-mode/) and go back to step 3. ![Web installer error: Failed to initialize, try holding the BOOT button while clicking Install](/assets/image-1698806793309.png) \ No newline at end of file diff --git a/docs/products/m1/examples/media-proxy.md b/docs/products/m1/examples/media-proxy.md index f7b3358680..a3979e08a3 100644 --- a/docs/products/m1/examples/media-proxy.md +++ b/docs/products/m1/examples/media-proxy.md @@ -8,7 +8,9 @@ The M-1 ESPHome Getting Started page to install the app, then come back here. + Head to the **Media Proxy** section of the M-1 ESPHome Getting Started page to install the app, then come back here. Or use the button below, which adds the app repository and opens Media Proxy. + + [![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=2b3c960e_media_proxy&repository_url=https%3A%2F%2Fgithub.com%2Fstuartparmenter%2Fhomeassistant-addons) ## What you can do @@ -23,7 +25,9 @@ The ESPHome integration page in Home Assistant and click your M-1 device. +1\. Open the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) in Home Assistant and click your M-1 device. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 2\. Find the entity named **Media Source** and paste any supported URL into it. diff --git a/docs/products/m1/examples/sendspin.md b/docs/products/m1/examples/sendspin.md index 5b960e2d6a..907208d7b5 100644 --- a/docs/products/m1/examples/sendspin.md +++ b/docs/products/m1/examples/sendspin.md @@ -12,13 +12,13 @@ description: Use the M-1 with SendSpin audio visualizers 1\. You will need to be running Music Assistant which has Sendspin baked in! Click the button below to install it on your Home Assistant OS setup. -[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=d5369777_music_assistant&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon) +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=d5369777_music_assistant&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon) !!! success "This tutorial expects you to already have music providers and players set up." Make sure you have already followed the Music Assistant onboarding and set up a music provider or multiple and added some players to play music on. Your M-1 will already be shown as a Sendspin player if you are running the ESPHome firmware. Click here to get your M-1 running ESPHome firmware first! -2\. Head to the Music Assistant dashboard and select one of your media players. Then click the players icon then click the players icon again and check off your Apollo M-1 LED Matrix. +2\. Open **Music Assistant** from your Home Assistant sidebar and select one of your media players. Then click the players icon then click the players icon again and check off your Apollo M-1 LED Matrix. ![Music Assistant players panel with the Apollo M-1 checked to join the playing group](../../../assets/sendspin-add-m-1-as-player.gif) diff --git a/docs/products/m1/setup/getting-started-m1-esphome.md b/docs/products/m1/setup/getting-started-m1-esphome.md index a1b9eb0da5..a6746160ea 100644 --- a/docs/products/m1/setup/getting-started-m1-esphome.md +++ b/docs/products/m1/setup/getting-started-m1-esphome.md @@ -48,13 +48,11 @@ Once the firmware finishes installing, the panel displays the **M-1 BIOS** splas ## Join to Home Assistant -!!! tip "Your device should be auto-discovered by Home Assistant using the ESPHome Integration as shown below!" - - Head to the Integrations page in Home Assistant and accept the discovery prompt for your M-1. - Your device should be auto-discovered by Home Assistant using the ESPHome Integration as shown below! -Head to the Integrations page in Home Assistant and accept the discovery prompt for your M-1. +Head to the Integrations page in Home Assistant (**Settings → Devices & services**) and accept the discovery prompt for your M-1. + +[![Open your Home Assistant instance and show your integrations.](https://my.home-assistant.io/badges/integrations.svg)](https://my.home-assistant.io/redirect/integrations/) ![Home Assistant ESPHome integration: adding the discovered Apollo M-1 and finishing setup](../../../assets/m-1-esphome-firmware-add-to-esphome-integration.gif) @@ -68,7 +66,7 @@ Head to the Media Proxy app allows you to view gifs, still images, YouTube videos, and even use Sendspin with album art when using Music Assistant! -1\. Head to settings -> Apps -> Click Install App -> 3 dots -> click repositories -> click Add -> paste in https://github.com/stuartparmenter/homeassistant-addons +1\. Go to **Settings → Apps** and click **Install app**. Open the three-dot menu in the top right, choose **Repositories**, click **Add**, and paste in `https://github.com/stuartparmenter/homeassistant-addons`. Or use the button below: it adds the repository, after Home Assistant asks you to confirm, and opens the Media Proxy app so you can click **Install** in step 2. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=2b3c960e_media_proxy&repository_url=https%3A%2F%2Fgithub.com%2Fstuartparmenter%2Fhomeassistant-addons) ![Home Assistant App store menu, Repositories, then adding the Media Proxy repository URL](../../../assets/add-media-proxy-custom-repo.gif) @@ -112,7 +112,9 @@ The ESPHome integration page then select your M-1 device from the list. Copy this url and paste it into the Media Source box. It should automatically start playing the gif! +4\. To test that it's working, head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your M-1 device from the list. Copy this url and paste it into the Media Source box. It should automatically start playing the gif! + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![M-1 device page in the ESPHome integration with a GIF URL pasted into Media Source](../../../assets/m-1-esphome-media-proxy-confirm-working.gif) @@ -124,7 +126,9 @@ The WiZ WizMote remote, so you can change pages, dim the panel, and toggle it on/off without your phone. -1\. In Home Assistant, open the M-1 device on the ESPHome integration page. +1\. In Home Assistant, open the M-1 device on the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 2\. Find the **WizMote Auto-Discovery** switch and turn it on. diff --git a/docs/products/msr1/examples/msr1-alarmo.md b/docs/products/msr1/examples/msr1-alarmo.md index bad5916018..f7a11b7e6c 100755 --- a/docs/products/msr1/examples/msr1-alarmo.md +++ b/docs/products/msr1/examples/msr1-alarmo.md @@ -4,10 +4,20 @@ description: "Build a home security system from three MSR-1 sensors and Alarmo i --- # MSR-1 + Alarmo Home Security Install -My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo add-on, quickly and easily allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. +My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo integration, quickly allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. 1\. Install [HACS](https://hacs.xyz/docs/use/download/download/) 2\. Install [Alarmo](https://github.com/nielsfaber/alarmo?tab=readme-ov-file#installation) and the [Alarmo Card](https://github.com/nielsfaber/alarmo-card) (Pretty Arm and Disarm card for your HA dashboard) + +The first button opens Alarmo in HACS and the second opens the Alarmo Card: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo&category=integration) + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo-card&category=plugin) + +Restart Home Assistant once both are installed, then add the Alarmo integration under **Settings → Devices & services → Add integration**. Alarmo shows up in the sidebar after that. + +[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=alarmo) ![Alarmo card on a Home Assistant dashboard showing Disarmed with Arm Away and Arm Home buttons](/assets/alarmo-7.png) diff --git a/docs/products/msr1/examples/msr1-dashboards.md b/docs/products/msr1/examples/msr1-dashboards.md index 767296005d..fed4a07507 100755 --- a/docs/products/msr1/examples/msr1-dashboards.md +++ b/docs/products/msr1/examples/msr1-dashboards.md @@ -6,6 +6,10 @@ description: "Example Home Assistant dashboard cards for the MSR-1, including an **Radar Scatter Plot With Apex Charts For MSR-1** +This card installs from HACS, so add it there first: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=RomRider&repository=apexcharts-card&category=plugin) + ![ApexCharts scatter plot card of MSR-1 radar detection, moving, and still distances over time](/assets/jpe-apex-charts-3.png) @@ -60,6 +64,10 @@ hours_to_show: 24 Custom: Plotly Graph Card +This card installs from HACS, so add it there first: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dbuezas&repository=lovelace-plotly-graph-card&category=plugin) + ![Plotly graph card of Bedroom CO2 in ppm over 24 hours](/assets/plotly-co2-graph.png) ```plaintext diff --git a/docs/products/msr1/setup/zones-ha.md b/docs/products/msr1/setup/zones-ha.md index 226ceed6b3..4bf77a0ecd 100755 --- a/docs/products/msr1/setup/zones-ha.md +++ b/docs/products/msr1/setup/zones-ha.md @@ -18,6 +18,9 @@ Here is a video of how to tune the mmWave sensor using radar engineering mode, 1. Open Home Assistant 2. Navigate to Settings>Devices & services>ESPHome>Select the MSR-1 + + [![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) + 3. Scroll down to the Configuration section 4. Turn on Radar Engineering Mode (REM) ![MSR-1 Configuration card in Home Assistant with the Radar Engineering Mode toggle turned on and highlighted](/assets/5l4configuration.png) diff --git a/docs/products/msr1/setup/zones-hlk.md b/docs/products/msr1/setup/zones-hlk.md index 909fcaedf5..6c00b98b9f 100755 --- a/docs/products/msr1/setup/zones-hlk.md +++ b/docs/products/msr1/setup/zones-hlk.md @@ -8,6 +8,8 @@ description: "Tune the MSR-1 mmWave radar over Bluetooth with the HLKRadarTool p 1\. Download the HLKRadarTool app for either [Android ](https://play.google.com/store/apps/details?id=com.hlk.hlkradartool&hl=en_US≷=US)or [Apple](https://apps.apple.com/us/app/hlkradartool/id1638651152) 2\. Ensure the mmWave radar you want to tune has Radar Control Bluetooth turned on. Home Assistant > Settings > Devices & services > ESPHome Devices > Select Device > Scroll down and toggle on Radar Control Bluetooth + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Radar Control Bluetooth switch turned on in the MSR-1 Home Assistant device page, outlined in red](/assets/radar-control-bluetooth.png) diff --git a/docs/products/msr2/examples/msr2-alarmo.md b/docs/products/msr2/examples/msr2-alarmo.md index 4bc35a48f2..e4d2a4fb27 100755 --- a/docs/products/msr2/examples/msr2-alarmo.md +++ b/docs/products/msr2/examples/msr2-alarmo.md @@ -4,10 +4,20 @@ description: A tutorial for how to use the MSR-2 with Alarmo for an advanced DIY --- # MSR-2 + Alarmo Home Security Install -My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo add-on, quickly and easily allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. +My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo integration, quickly allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. 1\. Install [HACS](https://hacs.xyz/docs/use/download/download/) 2\. Install [Alarmo](https://github.com/nielsfaber/alarmo?tab=readme-ov-file#installation) and the [Alarmo Card](https://github.com/nielsfaber/alarmo-card) (Pretty Arm and Disarm card for your HA dashboard) + +The first button opens Alarmo in HACS and the second opens the Alarmo Card: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo&category=integration) + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo-card&category=plugin) + +Restart Home Assistant once both are installed, then add the Alarmo integration under **Settings → Devices & services → Add integration**. Alarmo shows up in the sidebar after that. + +[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=alarmo) ![Alarmo card on a Home Assistant dashboard showing Disarmed with Arm Away and Arm Home buttons](/assets/alarmo-7.png) diff --git a/docs/products/msr2/setup/msr2-tuning-dashboard.md b/docs/products/msr2/setup/msr2-tuning-dashboard.md index ad3511ecc6..2253e2a35e 100755 --- a/docs/products/msr2/setup/msr2-tuning-dashboard.md +++ b/docs/products/msr2/setup/msr2-tuning-dashboard.md @@ -18,9 +18,13 @@ This guide will create a beautiful and helpful dashboard to simplify configurati 2\. Install the Streamline Card in HACS here which is required for the steps below. +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=brunosabot&repository=streamline-card&category=plugin) + 3\. Install the Plotly Graph Card in HACS here which is also required for the steps below. -4\. Head to your Home Assistant dashboard and Take control of your dashboard by clicking **Edit Dashboard** in the top right then the 3 dots from the **Edit Dashboard** menu and click **Take control**. (this step is only necessary for new Home Assistant users). +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dbuezas&repository=lovelace-plotly-graph-card&category=plugin) + +4\. Open your Home Assistant dashboard and Take control of your dashboard by clicking **Edit Dashboard** in the top right then the 3 dots from the **Edit Dashboard** menu and click **Take control**. (this step is only necessary for new Home Assistant users). ![Opening the Home Assistant Edit dashboard 3 dots menu and choosing Take control](/assets/home-assistant-take-control-gif.gif) @@ -33,6 +37,8 @@ This guide will create a beautiful and helpful dashboard to simplify configurati Back up your Home Assistant instance and back up a copy of the **Raw configuration editor** mentioned below before you make any changes just to be safe! + [![Open your Home Assistant instance and show an overview of your backups.](https://my.home-assistant.io/badges/backup.svg)](https://my.home-assistant.io/redirect/backup/) + 6\. Click **Edit dashboard** in the top right then click the 3 dots from the **Edit Dashboard** menu and click **Raw configuration editor**. Navigate to the end of the document and paste the code from the YAML generator at the very bottom of the **Raw configuration editor**. Click **Save** in the top right. !!! danger "This file is used by Home Assistant and must be carefully edited." diff --git a/docs/products/msr2/setup/zones-ha.md b/docs/products/msr2/setup/zones-ha.md index 34609f64f1..6d9d6d641c 100755 --- a/docs/products/msr2/setup/zones-ha.md +++ b/docs/products/msr2/setup/zones-ha.md @@ -24,7 +24,9 @@ How to tune the mmWave sensor using radar engineering mode.
-1\. Head to the ESPHome Integrations page and select your MSR-2. +1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) and select your MSR-2. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 2\. Scroll down to the Configuration section and turn on "Radar Engineering Mode". diff --git a/docs/products/msr2/setup/zones-hlk.md b/docs/products/msr2/setup/zones-hlk.md index eab46fe25a..205c11c8a7 100755 --- a/docs/products/msr2/setup/zones-hlk.md +++ b/docs/products/msr2/setup/zones-hlk.md @@ -18,7 +18,9 @@ description: Tutorial for MSR-2 HLKRadarTool app Zone Configuration. The default password to connect to the HLKRadarTool is "HiLink". -1\. Head to the ESPHome Integrations page then select your MSR-2 and scroll down until you see LD2410 Bluetooth. +1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your MSR-2 and scroll down until you see LD2410 Bluetooth. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Home Assistant MSR-2 device page with the LD2410 Bluetooth toggle switched on, outlined in red](/assets/msr-2-toggle-on-ld2410-bluetooth.png) diff --git a/docs/products/mtr1/examples/mtr1-alarmo.md b/docs/products/mtr1/examples/mtr1-alarmo.md index 7f28858329..c42e0d61e9 100755 --- a/docs/products/mtr1/examples/mtr1-alarmo.md +++ b/docs/products/mtr1/examples/mtr1-alarmo.md @@ -4,10 +4,20 @@ description: MTR-1 Alarmo setup --- # MTR-1 + Alarmo Home Security Install -My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo add-on, quickly and easily allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. +My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo integration, quickly allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. 1\. Install [HACS](https://hacs.xyz/docs/use/download/download/) 2\. Install [Alarmo](https://github.com/nielsfaber/alarmo?tab=readme-ov-file#installation) and the [Alarmo Card](https://github.com/nielsfaber/alarmo-card) (Pretty Arm and Disarm card for your HA dashboard) + +The first button opens Alarmo in HACS and the second opens the Alarmo Card: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo&category=integration) + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo-card&category=plugin) + +Restart Home Assistant once both are installed, then add the Alarmo integration under **Settings → Devices & services → Add integration**. Alarmo shows up in the sidebar after that. + +[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=alarmo) ![Alarmo Card on a Home Assistant dashboard showing Disarmed with Arm Away and Arm Home buttons](/assets/alarmo-7.png) diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md index 5f9efd9e04..ac3b0a5ea3 100755 --- a/docs/products/mtr1/setup/zones-hlk.md +++ b/docs/products/mtr1/setup/zones-hlk.md @@ -20,7 +20,9 @@ The Click here to download -1\. Head to the ESPHome Integrations page then select your MTR-1 and scroll down until you see LD2450 Bluetooth. +1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your MTR-1 and scroll down until you see LD2450 Bluetooth. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![LD2450 Bluetooth switch turned on in the MTR-1 Configuration card, outlined in red](/assets/mtr-1-toggle-on-ld2450-bluetooth.png) @@ -70,7 +72,9 @@ The If you're unsure of your device name, go to the ESPHome Integrations page, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_mtr\_1\_c64a28", with six random characters at the end. +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dbuezas&repository=lovelace-plotly-graph-card&category=plugin) + +3\. Enter your device’s full name and optionally customize the names of the three zones using the tool below. Then click **Generate YAML** and **Copy YAML.**
If you're unsure of your device name, go to **Settings → Devices & services → ESPHome**, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_mtr\_1\_c64a28", with six random characters at the end. diff --git a/docs/products/plt1/examples/blueprint.md b/docs/products/plt1/examples/blueprint.md index 55195553b2..e7c7289dd3 100644 --- a/docs/products/plt1/examples/blueprint.md +++ b/docs/products/plt1/examples/blueprint.md @@ -10,7 +10,7 @@ description: >- 1\. Click the Import Blueprint button below and then click **Open link**. - Import Blueprint +[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FPLT-1%2FPLT-1.yaml) 2\. Click **Preview** then click **Import blueprint**. @@ -39,11 +39,17 @@ description: >- ## Manual Import -1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**. +1\. Head to the automations page (**Settings → Automations & scenes**) and click on **Blueprints** in the top right then select **Import Blueprint**. + +[![Open your Home Assistant instance and show your blueprints.](https://my.home-assistant.io/badges/blueprints.svg)](https://my.home-assistant.io/redirect/blueprints/) ![Home Assistant Settings, Automations and scenes, Blueprints tab, then the Import blueprint button](/assets/btn-1-blueprint-manual-import.gif) -2\. Copy this link and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**. +2\. Copy the address below, paste it into the **Blueprint address** box, and click **Preview** then click **Import blueprint**. + +```text +https://raw.githubusercontent.com/ApolloAutomation/Blueprints/refs/heads/main/PLT-1/PLT-1.yaml +``` ![Home Assistant Import a blueprint dialog, clicking Preview then Import blueprint (BTN-1 example shown)](/assets/btn-1-blueprint-auto-import.gif) diff --git a/docs/products/plt1/examples/flower-card.md b/docs/products/plt1/examples/flower-card.md index 5be7eab68c..20cb7185a3 100755 --- a/docs/products/plt1/examples/flower-card.md +++ b/docs/products/plt1/examples/flower-card.md @@ -4,7 +4,9 @@ description: This suggests using the Flower Card inside Home Assistant for your --- ![Home Assistant Flower Card for a ZZ Plant with moisture, temperature, light, and humidity bars](/assets/screenshot-2024-09-26-at-10-17-09-am.png) -Home Assistant Plant Integration

This integration can automatically fetch data from OpenPlantBook if you are a registered user. Registration is free.

Plants are set up in the UI and all configuration of your plants can be managed there or by automations and scripts. +Home Assistant Plant Integration

This integration can automatically fetch data from OpenPlantBook if you are a registered user. Registration is free.

Plants are set up in the UI and all configuration of your plants can be managed there or by automations and scripts. Install it through HACS with the button below. + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=Olen&repository=homeassistant-plant&category=integration) Open Plant Book Integration

This integration allows fetching plants information from and uploading plant sensors' data to OpenPlantBook. It creates a few service calls in Home Assistant to interact with OpenPlantbook API which are: @@ -12,10 +14,16 @@ description: This suggests using the Flower Card inside Home Assistant for your * Get plant details * Upload plants sensors data -This is used as a base for the sister-integration [https://github.com/Olen/homeassistant-plant](https://github.com/Olen/homeassistant-plant) which utilizes this API to add threshold values for such as moisture, temperature, conductivity etc. based on the plant species. +This is used as a base for the sister-integration [https://github.com/Olen/homeassistant-plant](https://github.com/Olen/homeassistant-plant) which utilizes this API to add threshold values for such as moisture, temperature, conductivity etc. based on the plant species. Install Open Plant Book through HACS with the button below. + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=Olen&repository=home-assistant-openplantbook&category=integration) Flower Card GitHub +Install the card through HACS with the button below: + +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=Olen&repository=lovelace-flower-card&category=plugin) + Flower Card Code ```yaml diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index b7619768be..65a18f335e 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -24,7 +24,9 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 2\. Download [Plotly](https://github.com/dbuezas/lovelace-plotly-graph-card "Click here to install Plotly!") inside HACS. -3\. Enter your device’s full name and optionally customize the names of the three zones using the tool below. Then click **Generate YAML** and **Copy YAML.**
If you're unsure of your device name, go to the ESPHome Integrations page, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_pro\_1\_eth\_593904", with six random characters at the end. +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dbuezas&repository=lovelace-plotly-graph-card&category=plugin) + +3\. Enter your device’s full name and optionally customize the names of the three zones using the tool below. Then click **Generate YAML** and **Copy YAML.**
If you're unsure of your device name, go to **Settings → Devices & services → ESPHome**, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_pro\_1\_eth\_593904", with six random characters at the end. @@ -38,7 +40,9 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir ![Plotly card showing R PRO-1 target positions, the radar coverage cone, and three zones](/assets/r-pro-1-plotly-graph-image.png) -6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page") +6\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) 7\. Click device as shown in the image below @@ -98,7 +102,9 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir ## LD2412 Configuration -1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below the Apollo R PRO-1. +1\. Go to **Settings → Devices & services → ESPHome** and click **1 device** below the Apollo R PRO-1. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Red arrow on the 1 device link under Apollo R PRO-1 in the Home Assistant ESPHome integration](/assets/select-r-pro-1-device.png) diff --git a/docs/products/rpro1/setup/zones-hlk.md b/docs/products/rpro1/setup/zones-hlk.md index 69c66d28aa..44b48c7625 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -22,7 +22,9 @@ The Click here to download -1\. Head to the ESPHome Integrations page then select your R PRO-1 and scroll down until you see LD2450 Bluetooth. +1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your R PRO-1 and scroll down until you see LD2450 Bluetooth. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![LD2450 Bluetooth toggle switched on in the Home Assistant Configuration card, highlighted](/assets/mtr-1-toggle-on-ld2450-bluetooth.png) @@ -66,7 +68,9 @@ The If you're unsure of your device name, go to the ESPHome Integrations page, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_pro\_1\_eth\_593904", with six random characters at the end. +[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dbuezas&repository=lovelace-plotly-graph-card&category=plugin) + +3\. Enter your device’s full name and optionally customize the names of the three zones using the tool below. \*\* \*\* Then click **Generate YAML** and **Copy YAML.**
If you're unsure of your device name, go to **Settings → Devices & services → ESPHome**, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_pro\_1\_eth\_593904", with six random characters at the end. @@ -94,7 +98,9 @@ The same HLKRadarTool app is used for both sensors. Click here to download -1\. Head to the ESPHome Integrations page then select your R PRO-1 and scroll down until you see **LD2412 Bluetooth**. Toggle it on. +1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your R PRO-1 and scroll down until you see **LD2412 Bluetooth**. Toggle it on. + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![LD2412 Bluetooth toggle being switched on in the R PRO-1 Configuration card in Home Assistant](/assets/r-pro-1-toggle-on-ld2412-bluetooth.gif) @@ -126,7 +132,7 @@ The same HLKRadarTool app is used for both sensors. ![HLKRadarTool Settings screen with the LD2412 Detection range slider set to a start and end gate](/assets/r-pro-1-ld2412-detection-range.gif) -6\. To fine-tune which distances trigger detection, head to the ESPHome Integrations page, select your R PRO-1, and use the gate sensitivity sliders on the device page. +6\. To fine-tune which distances trigger detection, head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**), select your R PRO-1, and use the gate sensitivity sliders on the device page. - **Raise** a gate's sensitivity to make it harder to trigger at that distance (useful for ignoring a fan, HVAC vent, or a window where cars pass). - **Lower** a gate's sensitivity to make it more sensitive at that distance (useful for reliably detecting someone sitting still in a chair). @@ -135,5 +141,5 @@ The same HLKRadarTool app is used for both sensors. 7\. Tap **Settings** at the top of the app and set the **Unmanned Duration**. This controls how many seconds the sensor waits after it stops detecting before it reports "no one present." The default is 10 seconds — increase it if you're getting false "nobody home" readings in your space. In Home Assistant, this same setting is called **LD2412 Timeout**. -8\. Head back to the ESPHome Integrations page, select your R PRO-1, and toggle **LD2412 Bluetooth** back off. Leaving Bluetooth on increases power consumption and can interfere with nearby Bluetooth devices. +8\. Head back to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**), select your R PRO-1, and toggle **LD2412 Bluetooth** back off. Leaving Bluetooth on increases power consumption and can interfere with nearby Bluetooth devices. diff --git a/docs/products/temp1/addons/food-probe.md b/docs/products/temp1/addons/food-probe.md index 41964bdd64..ca4313eb08 100755 --- a/docs/products/temp1/addons/food-probe.md +++ b/docs/products/temp1/addons/food-probe.md @@ -24,7 +24,9 @@ The TEMP-1 comes with an optional food probe which can be used to monitor food t ![TEMP-1 with the food probe connected, showing the braided cable and steel probe tip](/assets/temp-1-food-probe-pic-1.jpg) -3\. Go to the device page of your TEMP-1 in Home Assistant and choose probe "Food". +3\. Go to the device page of your TEMP-1 in Home Assistant (**Settings → Devices & services → ESPHome**) and choose probe "Food". + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![TEMP-1 Controls card in Home Assistant with Food chosen in the Select Probe dropdown](/assets/temp1b-food-probe-pic-1-1.png) diff --git a/docs/products/temp1/examples/hot-water-recirculation.md b/docs/products/temp1/examples/hot-water-recirculation.md index 9d3630c350..75877d0683 100644 --- a/docs/products/temp1/examples/hot-water-recirculation.md +++ b/docs/products/temp1/examples/hot-water-recirculation.md @@ -112,7 +112,7 @@ Donovan's whole system is one blueprint. Import it, pick your entities, set your 1\. Click the button below, then click **Open link**. -Import Blueprint +[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FTEMP-1%2Fhot-water-recirculation.yaml) 2\. Click **Preview**, then **Import blueprint**. diff --git a/docs/products/temp1/examples/temp1-automation-examples.md b/docs/products/temp1/examples/temp1-automation-examples.md index 1a35daa3d9..d5be2e43d8 100755 --- a/docs/products/temp1/examples/temp1-automation-examples.md +++ b/docs/products/temp1/examples/temp1-automation-examples.md @@ -20,7 +20,9 @@ This will guide you through how to set up an automation in Home Assistant using 4\. The automation is now ready to be created - -5\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! +5\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) 6\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. @@ -76,7 +78,9 @@ This will guide you through how to set up an automation in Home Assistant using 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. -3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left. Click here to go straight there! +3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) 4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. @@ -133,7 +137,9 @@ This will guide you through adding a button to your dashboard called "Chicken Mo ![Home Assistant Add to dashboard dialog with button typed in the card search](/assets/temp-1-cook-chicken-example-pic-3.png)![Home Assistant Button card configuration with the Chicken Monitor entity and Save button highlighted](/assets/temp-1-cook-chicken-example-pic-2.png) -3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! +3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. diff --git a/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md b/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md index 9ac30ecb0f..a60353e957 100644 --- a/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md +++ b/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md @@ -10,7 +10,9 @@ By default the TEMP-1 reports its **Temperature Probe** every 60 seconds. You ca The update interval only changes how often the probe reports while the device is awake. If you turn **Prevent Sleep** off, the TEMP-1 deep-sleeps between wake cycles and reports when it wakes instead. See [Sensor Definitions](temp1-sensor-definitions.md) for how sleep and reporting work together. You can go as low as `1s`, but every reading is written to Home Assistant, so a 1 second interval floods your database and grows it quickly. -1\. Select the ESPHome Builder in the sidebar then click "EDIT" on your TEMP-1. +1\. Select the ESPHome Builder in the sidebar then click "EDIT" on your TEMP-1. If it isn't in your sidebar, the button below opens the app. + +[![Open your Home Assistant instance and show the dashboard of an app.](https://my.home-assistant.io/badges/supervisor_app.svg)](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) ![ESPHome Device Builder card for the Apollo TEMP-1 with the Edit button clicked](/assets/temp-1-click-edit-esphome-device-builder.png) diff --git a/docs/products/temp1b/addons/food-probe.md b/docs/products/temp1b/addons/food-probe.md index 12489d4035..5fcd894c74 100755 --- a/docs/products/temp1b/addons/food-probe.md +++ b/docs/products/temp1b/addons/food-probe.md @@ -24,7 +24,9 @@ The TEMP-1B comes with an optional food probe which can be used to monitor food ![TEMP-1B with the stainless steel food probe and braided cable plugged in](/assets/food-probe-pic-1.jpg) -3\. Go to the device page of your TEMP-1B in Home Assistant and choose probe "Food". +3\. Go to the device page of your TEMP-1B in Home Assistant (**Settings → Devices & services → ESPHome**) and choose probe "Food". + +[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=esphome) ![Home Assistant Controls card with Food selected in the Select Probe dropdown](/assets/temp1b-food-probe-pic-1-1.png) diff --git a/docs/products/temp1b/examples/temp1b-automation-examples.md b/docs/products/temp1b/examples/temp1b-automation-examples.md index 7fa9be146a..f9641ccf78 100755 --- a/docs/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/products/temp1b/examples/temp1b-automation-examples.md @@ -20,7 +20,9 @@ This will guide you through how to set up an automation in Home Assistant using 4\. The automation is now ready to be created - -5\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! +5\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) 6\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1B device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. @@ -76,7 +78,9 @@ This will guide you through how to set up an automation in Home Assistant using 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. -3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left. Click here to go straight there! +3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) 4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1B device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. @@ -133,7 +137,9 @@ This will guide you through adding a button to your dashboard called "Chicken Mo ![Home Assistant Add to dashboard dialog with button typed in the card search](/assets/temp-1-cook-chicken-example-pic-3.png)![Home Assistant Button card configuration with the Chicken Monitor entity and Save button highlighted](/assets/temp-1-cook-chicken-example-pic-2.png) -3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! +3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. + +[![Open your Home Assistant instance and show your automations.](https://my.home-assistant.io/badges/automations.svg)](https://my.home-assistant.io/redirect/automations/) 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML.