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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/btn-1-improv-ble-add.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/btn-1-improv-ble-wifi-setup.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/btn-1-reset-wifi-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/import-blueprint-image.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 7 additions & 3 deletions docs/products/btn1/addons/btn1-addon.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
---
title: BTN-1 addon title
description: BTN-1 addon description
title: BTN-1 attaching keys
description: BTN-1 attaching keys to the BTN-1
---
# BTN-1 Addon here
# BTN-1 Attaching Switches and Keys

!!! tip "Protip: You can use your own mx cherry red, brown, blue etc switches!"

We sell mx cherry brown switches because they are mostly silent, however, some people prefer a very "clicky" switch. You are able to buy off the shelf mechanical keyboard switches and place them on your BTN-1!

 
55 changes: 55 additions & 0 deletions docs/products/btn1/examples/blueprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: BTN-1 4 Event Blueprint
description: >-
Example of how to use the BTN-1 Events with the BTN-1 4 Event Blueprint in
Home Assistant!
---
# Blueprint Setup

### Automatic Import

1\. Click the import blueprint button below and follow the steps to import the blueprint.

<a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FBTN-1%2FBTN-1.yaml" target="_blank" rel="noopener"><img src="../../../assets/import-blueprint-image.svg" /></a>

2\. Copy <a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FBTN-1%2FBTN-1.yaml" target="_blank" rel="noreferrer nofollow noopener">this link</a> and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**. <a href="https://github.com/jesserockz/blueprints/blob/main/LICENSE" target="_blank" rel="noreferrer nofollow noopener"><em>Thanks Jesse at ESPHome</em></a>*!*

![](../../../assets/btn-1-example-gif-3.gif)

3\. Click on **ESPHome Buttons (2x)** and click on **Select a device** then choose the **Apollo BTN-1.**

![](../../../assets/btn-1-example-gif-4.gif)

3\. For the **Single Click** event, click **Add Action**, then search for **Light: Toggle** and select it. Next, choose the entity you want to control, such as **BTN-1 Light**, and click **Save**. Name your automation something like **ESPHome BTN-1 Blueprint**. You can repeat this process for **Double Click**, **Triple Click**, and **Hold** events.

![](../../../assets/btn-1-example-gif-5.gif)

!!! success "You can do this for all four buttons all in one blueprint!"

This blueprint is packed with features - you can do a Single Click, a Double Click, Four Clicks, or a Hold on each of the four buttons. Just click Add action and set them all up!

4\. Your blueprint is now live. Click the button 1 button and it should toggle whatever light you selected in the blueprint. This can be anything in Home Assistant such as your light, fan, scene, etc!

### Manual Import

1\. Head to the <a href="http://homeassistant.local:8123/config/automation/dashboard" target="_blank" rel="noreferrer nofollow noopener">automations page</a> and click on **Blueprints** in the top right then select **Import Blueprint**.

<a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FBTN-1%2FBTN-1.yaml" target="_blank" rel="noopener"><img src="../../../assets/import-blueprint-image.svg" /></a>

2\. Copy <a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2FApolloAutomation%2FBlueprints%2Frefs%2Fheads%2Fmain%2FBTN-1%2FBTN-1.yaml" target="_blank" rel="noreferrer nofollow noopener">this link</a> and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**. <a href="https://github.com/jesserockz/blueprints/blob/main/LICENSE" target="_blank" rel="noreferrer nofollow noopener"><em>Thanks Jesse at ESPHome</em></a>*!*

![](../../../assets/btn-1-example-gif-3.gif)

3\. Click on **ESPHome Buttons (2x)** and click on **Select a device** then choose the **Apollo BTN-1.**

![](../../../assets/btn-1-example-gif-4.gif)

3\. For the **Single Click** event, click **Add Action**, then search for **Light: Toggle** and select it. Next, choose the entity you want to control, such as **BTN-1 Light**, and click **Save**. Name your automation something like **ESPHome BTN-1 Blueprint**. You can repeat this process for **Double Click**, **Triple Click**, and **Hold** events.

![](../../../assets/btn-1-example-gif-5.gif)

!!! success "You can do this for all four buttons all in one blueprint!"

This blueprint is packed with features - you can do a Single Click, a Double Click, Four Clicks, or a Hold on each of the four buttons. Just click Add action and set them all up!

4\. Your blueprint is now live. Click the button 1 button and it should toggle whatever light you selected in the blueprint. This can be anything in Home Assistant such as your light, fan, scene, etc!
25 changes: 0 additions & 25 deletions docs/products/btn1/examples/btn-1-blueprint.md

This file was deleted.

127 changes: 127 additions & 0 deletions docs/products/btn1/setup/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
title: BTN-1 Getting Started Guide
description: Step by step guide to getting started with your BTN-1!
---
# BTN-1 Getting Started

### Installing the Brown Switches

1\.

### Installing the Keycaps

1\.

### Connecting Through Hotspot

To connect through the sensor's onboard hotspot follow the below:

1\. Plug the BTN-1 in via USB-C. A 5v 1amp power supply will work fine

!!! ! failure "If your sensor is restarting or not broadcasting Wi-Fi try another usb-c cable and power supply!"

ESP devices are sensitive to power fluctuations and require constant 5v power. Our devices use 1amp or less so most used phone chargers will work - just make sure it's a quality one!

2\. On your phone or PC, open the WiFi settings and connect to "Apollo BTN-1 Hotspot".

![](../../../assets/btn-1-reset-wifi-screenshot.png)

3\. Once connected it should automatically open a dashboard for your sensor. If this does not automatically open the dashboard, please open your web browser and go to [http://192.168.4.1](http://192.168.4.1)

4\. Select the Wi-Fi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**".

![](../../../assets/btn-1-getting-started-enter-wifi-details-hotspot.png)

!!! tip "Tip for Mesh Wi-Fi systems or multiple Access Points"

If you have multiple access points or a mesh system please manually type in your Wi-Fi network so it will join with the strongest signal!

5\. Once connected, the sensor's dashboard will automatically close. You've successfully connected your sensor to your Wi-Fi.

[Click here for next steps!](https://wiki.apolloautomation.com/products/btn1/setup/getting-started/#connecting-to-home-assistant-via-esphome-integration){ .md-button .md-button--primary }

### Connecting with <a href="https://www.home-assistant.io/integrations/improv_ble" target="_blank" rel="noopener">Improv via BLE</a>

!!! note "Pre-requirement: Bluetooth proxy or Bluetooth Home Assistant hardware required"

Bluetooth built in such as a raspberry pi or at least one <a href="https://wiki.apolloautomation.com/products/general/setup/bluetooth-proxy/" target="_blank" rel="noreferrer nofollow noopener">ESP32 BLE Proxy</a> is required to use this to setup your Apollo device. If you have already followed the "Connecting through Hotspot" please skip this section.

1\. Navigate to settings -&gt; integrations then click the "**ADD**" button below your new Apollo device then click **Submit**.

![](../../../assets/btn-1-improv-ble-add.gif)

2\. Once prompted, type in your Wi-Fi name and password in the two fields then click **Submit**. Click on **Close** once it finishes.

![](../../../assets/btn-1-improv-ble-wifi-setup.gif)

3\. Click on **Add** then click on **Submit**. Choose an area and then click **Finish**.

![](../../../assets/btn-1-improv-ble-esphome-integration.gif)

4\. Your device is now added to your Wi-Fi and added to the ESPHome Integration in Home Assistant. You should now be ready to <a href="https://wiki.apolloautomation.com/products/btn1/examples/btn-1-blueprint" target="_blank" rel="noreferrer nofollow noopener">setup a blueprint</a> and start using your BTN-1!

### Connecting To ESPHome Device Builder

!!! tip "Skip the ESPHome Device Builder unless..."

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 addon in Home Assistant to easily update your device or edit the yaml. If you don't have ESPHome Device Builder addon installed you can <a href="http://homeassistant.local:8123/hassio/store" target="_blank" rel="noreferrer nofollow noopener">search esphome device builder on the addon store</a> and install it.

Make sure to fill out your Wi-Fi details in the SECRETS section by clicking on the SECRETS Image below.

![esphome-device-compiler-dashboard-pic-1.png](../../../assets/esphome-device-compiler-dashboard-pic-1.png)

```yaml
# Your Wi-Fi SSID and password - keep the quotes and just replace the name and password between the quotes!
wifi_ssid: "your-wifi-ssid-here"
wifi_password: "your-wifi-pass-here"
```

1\. Click "Show" in the top right to show your discovered devices!

![](assets/esphome-device-builder-show-discovered-device.png)

2\. Click the ESPHome Builder in your sidebar then click "**TAKE CONTROL**" for your new Apollo Device!

![](assets/esphome-device-builder-pic-1.png)

3\. Rename your sensor here (this only renames the sensor in the ESPHome Device Compiler's Dashboard) or skip it and continue on by clicking "**TAKE CONTROL**" again as shown below.

![](assets/esphome-device-builder-pic-2.png)

4\. Click "**INSTALL**" (DO NOT click skip!) and let your device get adopted into the ESPHome Device Builder. Please have patience as this takes a few minutes to compile and then install to your new Apollo device!

![](assets/esphome-device-builder-pic-3.png)

5\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit.

![](assets/getting-started-pic-4.png)

6\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below!

### Connecting to Home Assistant via ESPHome Integration:

1\. Click the "**Notifications**" Icon in the bottom left.

![](assets/getting-started-pic-5.png)

2\. Click "**Check it out**" to go to the integrations page and see the new device that was found.

![](assets/getting-started-pic-7.png)

3\. Click "**ADD**" to begin adding the device to home assistant.

![](assets/getting-started-pic-6-1.png)

4\. Click "**SUBMIT**" to confirm you want to add your new Apollo device to home assistant.

![](assets/getting-started-pic-8.png)

5\. Give it an area and click "**FINISH**".

![](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 -&gt; <a href="http://homeassistant.local:8123/config/integrations/integration/esphome" target="_blank" rel="noopener">ESPHome integration</a> -&gt; click on the name of your new device!

[Click here to join our Discord for fast support! :simple-discord:](https://dsc.gg/apolloautomation){ .md-button .md-button--primary }
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -306,10 +306,13 @@ nav:
- BTN-1:
- Introduction: products/btn1/introduction.md
- FAQ: products/btn1/faq.md
- Getting Started: products/general/setup/getting-started-btn1.md
- Getting Started: products/btn1/setup/getting-started.md
- Additional Info:
- General Tips: products/btn1/setup/general-tips.md
- Sensor Definitons: products/btn1/setup/sensor-definitions.md
- Examples:
- Blueprint: products/btn1/examples/blueprint.md
- Example Automation: products/btn1/examples/example-automation.md
- Troubleshooting:
- BTN-1 Boot Mode: products/btn1/troubleshooting/btn1-boot-mode.md
- Factory Re-Flash BTN-1: products/btn1/troubleshooting/btn1-reflash.md
Expand Down