From df0b428b61d9d949d4118e691725fe4cb1da6f64 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Thu, 11 Jun 2026 10:43:26 -0500 Subject: [PATCH] Restructure Bluetooth Proxy guide with product tabs and shared snippets (#939) Convert the general Bluetooth Proxy page to per-product content tabs (matching the Switch to Beta page) and add a Bluetooth Proxy page under Additional Info for each product that ships a _BLE.yaml (AIR-1, MSR-1, MSR-2, MTR-1, PLT-1/B, TEMP-1/B). All pages share the same instructions and package codeblocks via pymdownx snippets in docs/_snippets/bluetooth-proxy/. --- docs/_snippets/bluetooth-proxy/air-1.md | 8 ++ docs/_snippets/bluetooth-proxy/intro.md | 1 + .../bluetooth-proxy/method1-finish.md | 17 ++++ .../bluetooth-proxy/method1-steps.md | 13 +++ docs/_snippets/bluetooth-proxy/method2.md | 45 +++++++++ docs/_snippets/bluetooth-proxy/msr-1.md | 8 ++ docs/_snippets/bluetooth-proxy/msr-2.md | 8 ++ docs/_snippets/bluetooth-proxy/mtr-1.md | 8 ++ docs/_snippets/bluetooth-proxy/plt-1.md | 8 ++ docs/_snippets/bluetooth-proxy/plt-1b.md | 8 ++ docs/_snippets/bluetooth-proxy/temp-1.md | 8 ++ docs/_snippets/bluetooth-proxy/temp-1b.md | 8 ++ .../air1/additional-info/bluetooth-proxy.md | 23 +++++ .../products/general/setup/bluetooth-proxy.md | 99 +++++-------------- .../msr1/additional-info/bluetooth-proxy.md | 23 +++++ .../msr2/additional-info/bluetooth-proxy.md | 23 +++++ .../mtr1/additional-info/bluetooth-proxy.md | 23 +++++ .../plt1/additional-info/bluetooth-proxy.md | 23 +++++ .../plt1b/additional-info/bluetooth-proxy.md | 23 +++++ .../temp1/additional-info/bluetooth-proxy.md | 23 +++++ .../temp1b/additional-info/bluetooth-proxy.md | 23 +++++ mkdocs.yml | 8 ++ 22 files changed, 357 insertions(+), 74 deletions(-) create mode 100644 docs/_snippets/bluetooth-proxy/air-1.md create mode 100644 docs/_snippets/bluetooth-proxy/intro.md create mode 100644 docs/_snippets/bluetooth-proxy/method1-finish.md create mode 100644 docs/_snippets/bluetooth-proxy/method1-steps.md create mode 100644 docs/_snippets/bluetooth-proxy/method2.md create mode 100644 docs/_snippets/bluetooth-proxy/msr-1.md create mode 100644 docs/_snippets/bluetooth-proxy/msr-2.md create mode 100644 docs/_snippets/bluetooth-proxy/mtr-1.md create mode 100644 docs/_snippets/bluetooth-proxy/plt-1.md create mode 100644 docs/_snippets/bluetooth-proxy/plt-1b.md create mode 100644 docs/_snippets/bluetooth-proxy/temp-1.md create mode 100644 docs/_snippets/bluetooth-proxy/temp-1b.md create mode 100644 docs/products/air1/additional-info/bluetooth-proxy.md create mode 100644 docs/products/msr1/additional-info/bluetooth-proxy.md create mode 100644 docs/products/msr2/additional-info/bluetooth-proxy.md create mode 100644 docs/products/mtr1/additional-info/bluetooth-proxy.md create mode 100644 docs/products/plt1/additional-info/bluetooth-proxy.md create mode 100644 docs/products/plt1b/additional-info/bluetooth-proxy.md create mode 100644 docs/products/temp1/additional-info/bluetooth-proxy.md create mode 100644 docs/products/temp1b/additional-info/bluetooth-proxy.md diff --git a/docs/_snippets/bluetooth-proxy/air-1.md b/docs/_snippets/bluetooth-proxy/air-1.md new file mode 100644 index 0000000000..a49b6dfb67 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/air-1.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.AIR-1: + url: https://github.com/ApolloAutomation/AIR-1 + ref: main + files: [Integrations/ESPHome/AIR-1_BLE.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/intro.md b/docs/_snippets/bluetooth-proxy/intro.md new file mode 100644 index 0000000000..af75c962ca --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/intro.md @@ -0,0 +1 @@ +This guide shows you how to make your Apollo device act as a "BLE Proxy" which lets Bluetooth devices talk back to home assistant using Apollo devices as the "next hop"! diff --git a/docs/_snippets/bluetooth-proxy/method1-finish.md b/docs/_snippets/bluetooth-proxy/method1-finish.md new file mode 100644 index 0000000000..f90d062717 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/method1-finish.md @@ -0,0 +1,17 @@ +6\. Paste the code as shown below directly below the yaml you just edited above. Make sure the spaces look the same and there are no red lines under any of the code. + +![](/assets/bluetooth-proxy-tutorial-9.png) + +7\. Click save then Install in the top right. + +![](/assets/bluetooth-proxy-tutorial-11.png) + +8\. Click "Wirelessly" and let it finish compiling then installing. + +![](/assets/bluetooth-proxy-tutorial-6.png) + +9\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. + +![](/assets/bluetooth-proxy-tutorial-7.png) + +10\. You are finished and your Apollo device is now acting as a Bluetooth Proxy! diff --git a/docs/_snippets/bluetooth-proxy/method1-steps.md b/docs/_snippets/bluetooth-proxy/method1-steps.md new file mode 100644 index 0000000000..3715a9320c --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/method1-steps.md @@ -0,0 +1,13 @@ +1\. Open the Esphome Device Builder. + +![](/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. + +3\. Click "Edit" as shown below. + +![](/assets/bluetooth-proxy-tutorial-2.png) + +4\. Add a \# before the packages line and the line after it as shown in the image below. + +![](/assets/bluetooth-proxy-tutorial-10.png) diff --git a/docs/_snippets/bluetooth-proxy/method2.md b/docs/_snippets/bluetooth-proxy/method2.md new file mode 100644 index 0000000000..46d2620069 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/method2.md @@ -0,0 +1,45 @@ +1\. Open the Esphome Device Builder. + +![](/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. + +3\. Click "Edit" as shown below. + +![](/assets/bluetooth-proxy-tutorial-2.png) + +4\. Copy the code inside the codeblock below. + +```yaml + power_save_mode: LIGHT +``` + +5\. Paste the code as shown below - make sure the spaces look the same and there are no red lines under any of the code.
![](/assets/bluetooth-proxy-tutorial-5.png) + +6\. Copy the code inside the codeblock below. + +```yaml +bluetooth_proxy: + active: true +esp32_ble_tracker: + scan_parameters: + active: false +``` + +7\. Paste the code on a new line at the very bottom of the file as shown below. + +![](/assets/bluetooth-proxy-tutorial-7-1.png) + +8\. Click save then Install in the top right. + +![](/assets/bluetooth-proxy-tutorial-8.png) + +9\. Click "Wirelessly" and let it finish compiling then installing. + +![](/assets/bluetooth-proxy-tutorial-6.png) + +10\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. + +![](/assets/bluetooth-proxy-tutorial-7.png) + +11\. You are finished and your Apollo device is now acting as a Bluetooth Proxy! diff --git a/docs/_snippets/bluetooth-proxy/msr-1.md b/docs/_snippets/bluetooth-proxy/msr-1.md new file mode 100644 index 0000000000..24865da91a --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/msr-1.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.MSR-1: + url: https://github.com/ApolloAutomation/MSR-1 + ref: main + files: [Integrations/ESPHome/MSR-1_BLE.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/msr-2.md b/docs/_snippets/bluetooth-proxy/msr-2.md new file mode 100644 index 0000000000..c8f2960369 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/msr-2.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.MSR-2: + url: https://github.com/ApolloAutomation/MSR-2 + ref: main + files: [Integrations/ESPHome/MSR-2_BLE.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/mtr-1.md b/docs/_snippets/bluetooth-proxy/mtr-1.md new file mode 100644 index 0000000000..943a52b25c --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/mtr-1.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.MTR-1: + url: https://github.com/ApolloAutomation/MTR-1 + ref: main + files: [Integrations/ESPHome/MTR-1_BLE.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/plt-1.md b/docs/_snippets/bluetooth-proxy/plt-1.md new file mode 100644 index 0000000000..8a4c22e7b1 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/plt-1.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.PLT-1: + url: https://github.com/ApolloAutomation/PLT-1 + ref: main + files: [Integrations/ESPHome/PLT-1_BLE.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/plt-1b.md b/docs/_snippets/bluetooth-proxy/plt-1b.md new file mode 100644 index 0000000000..d460928dd1 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/plt-1b.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.PLT-1: + url: https://github.com/ApolloAutomation/PLT-1 + ref: main + files: [Integrations/ESPHome/PLT-1B_BLE.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/temp-1.md b/docs/_snippets/bluetooth-proxy/temp-1.md new file mode 100644 index 0000000000..e229e5540e --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/temp-1.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.TEMP-1: + url: https://github.com/ApolloAutomation/TEMP-1 + ref: main + files: [Integrations/ESPHome/TEMP-1_BLE_R2.yaml] + refresh: 1min +``` diff --git a/docs/_snippets/bluetooth-proxy/temp-1b.md b/docs/_snippets/bluetooth-proxy/temp-1b.md new file mode 100644 index 0000000000..512d0cb622 --- /dev/null +++ b/docs/_snippets/bluetooth-proxy/temp-1b.md @@ -0,0 +1,8 @@ +```yaml +packages: + ApolloAutomation.TEMP-1: + url: https://github.com/ApolloAutomation/TEMP-1 + ref: main + files: [Integrations/ESPHome/TEMP-1B_BLE_R2.yaml] + refresh: 1min +``` diff --git a/docs/products/air1/additional-info/bluetooth-proxy.md b/docs/products/air1/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..01b07af7a2 --- /dev/null +++ b/docs/products/air1/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: AIR-1 Bluetooth Proxy +description: Tutorial for how to turn your AIR-1 into a BLE proxy! +--- +# AIR-1 Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to AIR-1\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/air-1.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/general/setup/bluetooth-proxy.md b/docs/products/general/setup/bluetooth-proxy.md index 6cf27e8903..915a385829 100755 --- a/docs/products/general/setup/bluetooth-proxy.md +++ b/docs/products/general/setup/bluetooth-proxy.md @@ -1,106 +1,57 @@ ---- +--- title: Bluetooth Proxy Setup description: Tutorial for how to turn your Apollo device into a BLE proxy! --- # Bluetooth Proxy -This guide shows you how to make your Apollo device act as a "BLE Proxy" which lets Bluetooth devices talk back to home assistant using Apollo devices as the "next hop"! +--8<-- "_snippets/bluetooth-proxy/intro.md" ### Method 1: Switch to \_BLE.yaml fork -1\. Open the Esphome Device Builder. +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Select your product below, copy the code, and paste it directly below the two lines you just commented out. -![](/assets/bluetooth-proxy-tutorial-1.png) +=== "AIR-1" -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. + --8<-- "_snippets/bluetooth-proxy/air-1.md" -3\. Click "Edit" as shown below. +=== "MSR-1" -![](/assets/bluetooth-proxy-tutorial-2.png) + --8<-- "_snippets/bluetooth-proxy/msr-1.md" -4\. Add a \# before the packages line and the line after it as shown in the image below. +=== "MSR-2" -![](/assets/bluetooth-proxy-tutorial-10.png) + --8<-- "_snippets/bluetooth-proxy/msr-2.md" -5\. Copy the code inside the codeblock below. +=== "MTR-1" -```yaml -packages: - ApolloAutomation.MTR-1: # name of package/project - url: https://github.com/ApolloAutomation/MTR-1 # url of the repository - ref: main # branch, tag or commit SHA - files: [Integrations/ESPHome/MTR-1_BLE.yaml] # Path to config from base repo URL - refresh: 1min # how often to sync updates from the remote url -``` + --8<-- "_snippets/bluetooth-proxy/mtr-1.md" -!!! success "Replace MTR-1 in all three areas of the code you copied above with MSR-2, AIR-1 etc." +=== "PLT-1 / PLT-1B" - Scroll down and follow method \#2, or manually replace "MTR-1" with "MSR-2", "AIR-1", or whichever sensor you're using in each instance. + **PLT-1:** -6\. Paste the code as shown below directly below the yaml you just edited above. Make sure the spaces look the same and there are no red lines under any of the code. + --8<-- "_snippets/bluetooth-proxy/plt-1.md" -![](/assets/bluetooth-proxy-tutorial-9.png) + **PLT-1B:** -7\. Click save then Install in the top right. + --8<-- "_snippets/bluetooth-proxy/plt-1b.md" -![](/assets/bluetooth-proxy-tutorial-11.png) +=== "TEMP-1 / TEMP-1B" -8\. Click "Wirelessly" and let it finish compiling then installing. + **TEMP-1:** -![](/assets/bluetooth-proxy-tutorial-6.png) + --8<-- "_snippets/bluetooth-proxy/temp-1.md" -9\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. + **TEMP-1B:** -![](/assets/bluetooth-proxy-tutorial-7.png) + --8<-- "_snippets/bluetooth-proxy/temp-1b.md" -10\. You are finished and your Apollo device is now acting as a Bluetooth Proxy! +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" --- ### Method 2: Manually enter the BLE proxy yaml -1\. Open the Esphome Device Builder. - -![](/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. - -3\. Click "Edit" as shown below. - -![](/assets/bluetooth-proxy-tutorial-2.png) - -4\. Copy the code inside the codeblock below. - -```yaml - power_save_mode: LIGHT -``` - -5\. Paste the code as shown below - make sure the spaces look the same and there are no red lines under any of the code.
![](/assets/bluetooth-proxy-tutorial-5.png) - -6\. Copy the code inside the codeblock below. - -```yaml -bluetooth_proxy: - active: true -esp32_ble_tracker: - scan_parameters: - active: false -``` - -7\. Paste the code on a new line at the very bottom of the file as shown below. - -![](/assets/bluetooth-proxy-tutorial-7-1.png) - -8\. Click save then Install in the top right. - -![](/assets/bluetooth-proxy-tutorial-8.png) - -8\. Click "Wirelessly" and let it finish compiling then installing. - -![](/assets/bluetooth-proxy-tutorial-6.png) - -9\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. - -![](/assets/bluetooth-proxy-tutorial-7.png) - -10\. You are finished and your Apollo device is now acting as a Bluetooth Proxy! \ No newline at end of file +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/msr1/additional-info/bluetooth-proxy.md b/docs/products/msr1/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..715cd87024 --- /dev/null +++ b/docs/products/msr1/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: MSR-1 Bluetooth Proxy +description: Tutorial for how to turn your MSR-1 into a BLE proxy! +--- +# MSR-1 Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to MSR-1\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/msr-1.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/msr2/additional-info/bluetooth-proxy.md b/docs/products/msr2/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..a4adc15f10 --- /dev/null +++ b/docs/products/msr2/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: MSR-2 Bluetooth Proxy +description: Tutorial for how to turn your MSR-2 into a BLE proxy! +--- +# MSR-2 Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to MSR-2\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/msr-2.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/mtr1/additional-info/bluetooth-proxy.md b/docs/products/mtr1/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..623bf8b672 --- /dev/null +++ b/docs/products/mtr1/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: MTR-1 Bluetooth Proxy +description: Tutorial for how to turn your MTR-1 into a BLE proxy! +--- +# MTR-1 Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to MTR-1\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/mtr-1.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/plt1/additional-info/bluetooth-proxy.md b/docs/products/plt1/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..31d8078093 --- /dev/null +++ b/docs/products/plt1/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: PLT-1 Bluetooth Proxy +description: Tutorial for how to turn your PLT-1 into a BLE proxy! +--- +# PLT-1 Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to PLT-1\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/plt-1.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/plt1b/additional-info/bluetooth-proxy.md b/docs/products/plt1b/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..45dd95ca88 --- /dev/null +++ b/docs/products/plt1b/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: PLT-1B Bluetooth Proxy +description: Tutorial for how to turn your PLT-1B into a BLE proxy! +--- +# PLT-1B Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to PLT-1B\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/plt-1b.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/temp1/additional-info/bluetooth-proxy.md b/docs/products/temp1/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..fab21a8490 --- /dev/null +++ b/docs/products/temp1/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: TEMP-1 Bluetooth Proxy +description: Tutorial for how to turn your TEMP-1 into a BLE proxy! +--- +# TEMP-1 Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to TEMP-1\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/temp-1.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/docs/products/temp1b/additional-info/bluetooth-proxy.md b/docs/products/temp1b/additional-info/bluetooth-proxy.md new file mode 100644 index 0000000000..a372194910 --- /dev/null +++ b/docs/products/temp1b/additional-info/bluetooth-proxy.md @@ -0,0 +1,23 @@ +--- +title: TEMP-1B Bluetooth Proxy +description: Tutorial for how to turn your TEMP-1B into a BLE proxy! +--- +# TEMP-1B Bluetooth Proxy + +--8<-- "_snippets/bluetooth-proxy/intro.md" + +### Method 1: Switch to TEMP-1B\_BLE.yaml fork + +--8<-- "_snippets/bluetooth-proxy/method1-steps.md" + +5\. Copy the code inside the codeblock below and paste it directly below the two lines you just commented out. + +--8<-- "_snippets/bluetooth-proxy/temp-1b.md" + +--8<-- "_snippets/bluetooth-proxy/method1-finish.md" + +--- + +### Method 2: Manually enter the BLE proxy yaml + +--8<-- "_snippets/bluetooth-proxy/method2.md" diff --git a/mkdocs.yml b/mkdocs.yml index 2d18a67892..69087a0e61 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -227,6 +227,7 @@ nav: - Additional Info: - General Tips: products/msr2/setup/msr2-general-tips.md - Sensor Definitions: products/msr2/setup/msr2-sensor-definitions.md + - Bluetooth Proxy: products/msr2/additional-info/bluetooth-proxy.md - Addons: - Articulating Stand: products/msr2/addons/adding-articulating-stand-to-msr-2.md - CO2 Addon: products/msr2/addons/adding-co2-to-msr-2.md @@ -254,6 +255,7 @@ nav: - Additional Info: - General Tips: products/mtr1/setup/general-tips.md - Sensor Definitions: products/mtr1/setup/sensor-definitions.md + - Bluetooth Proxy: products/mtr1/additional-info/bluetooth-proxy.md - Addons: - Articulating Stand: products/mtr1/addons/adding-articulating-stand-to-mtr-1.md - CO2 Addon: products/mtr1/addons/adding-co2-to-mtr-1.md @@ -304,6 +306,7 @@ nav: - HLK Radar Tool App: products/msr1/setup/zones-hlk.md - mmWave Tuning Videos: products/msr1/setup/mmwave-videos.md - Exposed GPIO: products/msr1/additional-info/exposed-gpio.md + - Bluetooth Proxy: products/msr1/additional-info/bluetooth-proxy.md - Addons: products/msr1/addons/adding-co2-to-msr-1.md - Examples: - MSR-1 Dashboards: products/msr1/examples/msr1-dashboards.md @@ -323,6 +326,7 @@ nav: - General Tips: products/air1/setup/general-tips.md - Sensor Definitions: products/air1/setup/sensor-definitions.md - Prevent Sleep: products/air1/additional-info/prevent-sleep.md + - Bluetooth Proxy: products/air1/additional-info/bluetooth-proxy.md - Addons: - CO2 Addon: products/air1/addons/adding-co2-to-air-1.md - MiCS Addon: products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md @@ -348,6 +352,7 @@ nav: - How To Wake Up Your Sensor: products/temp1/battery-sensors/wake-up-battery-sensor.md - Keep Your Sensor Awake With HA Helper: products/temp1/battery-sensors/awake-ha-helper.md - Sensor Connection Check: products/temp1/battery-sensors/sensor-connection-check.md + - Bluetooth Proxy: products/temp1/additional-info/bluetooth-proxy.md - Addons: - Magnetic Mount: products/temp1/addons/magnetic-mount.md - Temp Probe: products/temp1/addons/temp-probe.md @@ -375,6 +380,7 @@ nav: - Keep Your Sensor Awake With HA Helper: products/temp1b/battery-sensors/awake-ha-helper.md - Insert Battery: products/temp1b/setup/insert-battery.md - Sensor Connection Check: products/temp1b/battery-sensors/sensor-connection-check.md + - Bluetooth Proxy: products/temp1b/additional-info/bluetooth-proxy.md - Addons: - Magnetic Mount: products/temp1b/addons/magnetic-mount.md - Temp Probe: products/temp1b/addons/temp-probe.md @@ -400,6 +406,7 @@ nav: - Sensor Definitions: products/plt1/setup/plt1-sensor-definitions.md - Calibrating Soil Moisture: products/plt1/calibrate-plt1.md - Prevent Sleep: products/plt1/additional-info/prevent-sleep.md + - Bluetooth Proxy: products/plt1/additional-info/bluetooth-proxy.md - Examples: - Flower Card: products/plt1/examples/flower-card.md - Blueprint: products/plt1/examples/blueprint.md @@ -422,6 +429,7 @@ nav: - Keep Your Sensor Awake With HA Helper: products/plt1b/battery-sensors/awake-ha-helper.md - Insert Battery: products/plt1b/additional-info/insert-battery.md - Sensor Connection Check: products/plt1b/battery-sensors/sensor-connection-check.md + - Bluetooth Proxy: products/plt1b/additional-info/bluetooth-proxy.md - Examples: - Flower Card: products/plt1b/examples/flower-card.md - Blueprint: products/plt1b/examples/blueprint.md