Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/air-1.md
Original file line number Diff line number Diff line change
@@ -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
```
1 change: 1 addition & 0 deletions docs/_snippets/bluetooth-proxy/intro.md
Original file line number Diff line number Diff line change
@@ -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"!
17 changes: 17 additions & 0 deletions docs/_snippets/bluetooth-proxy/method1-finish.md
Original file line number Diff line number Diff line change
@@ -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!
13 changes: 13 additions & 0 deletions docs/_snippets/bluetooth-proxy/method1-steps.md
Original file line number Diff line number Diff line change
@@ -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)
45 changes: 45 additions & 0 deletions docs/_snippets/bluetooth-proxy/method2.md
Original file line number Diff line number Diff line change
@@ -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.<br>![](/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!
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/msr-1.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/msr-2.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/mtr-1.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/plt-1.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/plt-1b.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/temp-1.md
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 8 additions & 0 deletions docs/_snippets/bluetooth-proxy/temp-1b.md
Original file line number Diff line number Diff line change
@@ -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
```
23 changes: 23 additions & 0 deletions docs/products/air1/additional-info/bluetooth-proxy.md
Original file line number Diff line number Diff line change
@@ -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"
99 changes: 25 additions & 74 deletions docs/products/general/setup/bluetooth-proxy.md
Original file line number Diff line number Diff line change
@@ -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.<br>![](/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!
--8<-- "_snippets/bluetooth-proxy/method2.md"
23 changes: 23 additions & 0 deletions docs/products/msr1/additional-info/bluetooth-proxy.md
Original file line number Diff line number Diff line change
@@ -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"
23 changes: 23 additions & 0 deletions docs/products/msr2/additional-info/bluetooth-proxy.md
Original file line number Diff line number Diff line change
@@ -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"
23 changes: 23 additions & 0 deletions docs/products/mtr1/additional-info/bluetooth-proxy.md
Original file line number Diff line number Diff line change
@@ -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"
Loading