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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/_snippets/bluetooth-proxy/intro.md
Original file line number Diff line number Diff line change
@@ -1 +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"!
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"!
6 changes: 3 additions & 3 deletions docs/_snippets/bluetooth-proxy/method1-finish.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
![](/assets/esphome-device-builder-add-ble-proxy-method-1-edit-yaml.gif)
![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.

![](/assets/esphome-device-builder-add-ble-proxy-save-install.gif)
![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!

![](/assets/ble-proxy-install-completed.png)
![ESPHome Device Builder logs with the Bluetooth Proxy section boxed and an arrow to Stop](/assets/ble-proxy-install-completed.png)

--8<-- "_snippets/bluetooth-proxy/verify.md"
4 changes: 2 additions & 2 deletions docs/_snippets/bluetooth-proxy/method1-steps.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
1\. Open ESPHome Device Builder. The button below opens the app right in your Home Assistant.

<a href="http://homeassistant.local:8123/5c53de3b_esphome" target="_blank" rel="noreferrer nofollow noopener" class="md-button md-button--primary"><img src="/assets/esphome-logo.svg" /> Open ESPHome Device Builder</a>
<a href="http://homeassistant.local:8123/5c53de3b_esphome" target="_blank" rel="noreferrer nofollow noopener" class="md-button md-button--primary"><img alt="ESPHome logo" src="/assets/esphome-logo.svg" /> Open ESPHome Device Builder</a>

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

![](/assets/esphome-device-builder-edit-device.gif)
![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.
6 changes: 3 additions & 3 deletions docs/_snippets/bluetooth-proxy/method2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ The easiest way is to let ESPHome Device Builder add the component for you. You

1\. Open ESPHome Device Builder and click **Edit** on your device. The button below opens the app right in your Home Assistant.

<a href="http://homeassistant.local:8123/5c53de3b_esphome" target="_blank" rel="noreferrer nofollow noopener" class="md-button md-button--primary"><img src="/assets/esphome-logo.svg" /> Open ESPHome Device Builder</a>
<a href="http://homeassistant.local:8123/5c53de3b_esphome" target="_blank" rel="noreferrer nofollow noopener" class="md-button md-button--primary"><img alt="ESPHome logo" src="/assets/esphome-logo.svg" /> Open ESPHome Device Builder</a>

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)

2\. Click **Add Component** in the editor toolbar, search for **Bluetooth Proxy**, and click **Add**.

![](/assets/esphome-device-builder-add-ble-proxy-component.gif)
![ESPHome Device Builder adding the Bluetooth Proxy component with Add Component](/assets/esphome-device-builder-add-ble-proxy-component.gif)

Device Builder drops a single line into your config:

Expand All @@ -22,6 +22,6 @@ That's all it needs. Active connections are on by default, and `bluetooth_proxy`

3\. Click **Save**, then **Install**, and choose **On the Network** to flash the new firmware over Wi-Fi.

![](/assets/esphome-device-builder-add-ble-proxy-save-validate-install.gif)
![ESPHome Device Builder validating the config with bluetooth_proxy added, then Save and Install](/assets/esphome-device-builder-add-ble-proxy-save-validate-install.gif)

--8<-- "_snippets/bluetooth-proxy/verify.md"
4 changes: 2 additions & 2 deletions docs/homey.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Homey Integration
description: Guide to integrating Apollo Automation devices with the Homey smart home platform.
---
<img height="344" width="900" src="https://imagedelivery.net/VXI8oYYsJOyBOIySOviPCQ/4e7161b4-573c-40fa-0465-648a99bafe00/public" />
<img alt="Apollo Automation Homey docs banner" height="344" width="900" src="https://imagedelivery.net/VXI8oYYsJOyBOIySOviPCQ/4e7161b4-573c-40fa-0465-648a99bafe00/public" />

!!! info "Welcome to Apollo Automation Docs!"

Expand All @@ -29,7 +29,7 @@ description: Guide to integrating Apollo Automation devices with the Homey smart
* [Understanding your AIR-1 and the various sensors it exposes](https://wiki.apolloautomation.com/products/air1/setup/general-tips/)
* [How to re-calibrate your CO<sub>2</sub> sensor](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/)
* [Put your Apollo devices to sleep!](https://wiki.apolloautomation.com/products/general/battery-sensors/prevent-sleep/)
* [Setup your new M-1 LED Matrix with Multiple Panels](https://wiki.apolloautomation.com/products/m1/setup/m1-multiple-panels/)
* [Set up your new M-1 LED Matrix with Multiple Panels](https://wiki.apolloautomation.com/products/m1/setup/m1-multiple-panels/)
* [3D Print your own case in any color or material](https://wiki.apolloautomation.com/products/general/links/)

<h3>Community</h3>
Expand Down
18 changes: 9 additions & 9 deletions docs/homey/products/air1/addons/adding-co2-to-air-1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: add SCD40 CO₂ Sensor
title: Add SCD40 CO₂ Sensor
description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
---
# Adding CO<sub>2</sub> to AIR-1
Expand All @@ -10,34 +10,34 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.

1\. Unplug your AIR-1 from power and lift the top of the case or "lid".

![](/assets/air-1-add-co2-pic-1.jpg)![](/assets/air-1-add-co2-pic-2.jpg)![](/assets/air-1-add-co2-pic-3.jpg)
![AIR-1 in its white case with the lid on and the USB-C port facing forward](/assets/air-1-add-co2-pic-1.jpg)![Fingers lifting one side of the AIR-1 lid](/assets/air-1-add-co2-pic-2.jpg)![AIR-1 lid lifted, showing the circuit board inside the case](/assets/air-1-add-co2-pic-3.jpg)

2\. Remove the lid completely by grabbing the lid from the other side and gently lifting upwards.

![](/assets/air-1-add-co2-pic-4.jpg)
![Lifting the AIR-1 lid completely off from the other side](/assets/air-1-add-co2-pic-4.jpg)

3\. Hold the PCB and orient it correctly where Apollo (the dog) is facing you in.

![](/assets/air-1-add-co2-pic-5.jpg)
![AIR-1 circuit board held with the Apollo dog graphic facing you, sensor below](/assets/air-1-add-co2-pic-5.jpg)

4\. Gently slide the pcb out by sliding it to the left as shown in the images below.

![](/assets/air-1-add-co2-pic-6.jpg)![](/assets/air-1-add-co2-pic-7.jpg)
![AIR-1 circuit board being slid to the left out of the lid](/assets/air-1-add-co2-pic-6.jpg)![AIR-1 circuit board slid further left, almost free of the lid](/assets/air-1-add-co2-pic-7.jpg)

5\. Flip the PCB over and identify the bottom right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the SCD40 CO<sub>2</sub> sensor. There is an X on the SCD40 sensor's PCB as well, you can see it in the image below but it is slightly cut off on the PCB itself. There is also a "gold dot" in the top left of the SCD40 when oriented properly.

![](/assets/air-1-add-co2-pic-8.jpg)
![Back of the AIR-1 circuit board with an X marking the bottom right mezzanine connector](/assets/air-1-add-co2-pic-8.jpg)

6\. Gently push the SCD40 CO<sub>2</sub> module onto the black mezzanine connector.

![](/assets/air-1-add-co2-pic-9-1.jpg)
![SCD40 CO2 sensor pressed onto the mezzanine connector on the AIR-1 board](/assets/air-1-add-co2-pic-9-1.jpg)

7\. Gently slide the PCB back into the 3d printed case as shown below.

![](/assets/air-1-add-co2-pic-10.jpg)![](/assets/air-1-add-co2-pic-11.jpg)
![AIR-1 circuit board being slid back into the lid's printed channels](/assets/air-1-add-co2-pic-10.jpg)![AIR-1 circuit board fully seated in the lid with the Apollo dog graphic facing out](/assets/air-1-add-co2-pic-11.jpg)

8\. Gently push the case back together as shown below.

![](/assets/air-1-add-co2-pic-12.jpg)![](/assets/air-1-add-co2-pic-13.jpg)![](/assets/air-1-add-co2-pic-14.jpg)
![AIR-1 lid being lowered back onto the case](/assets/air-1-add-co2-pic-12.jpg)![AIR-1 lid nearly closed with the USB-C port lined up with its opening](/assets/air-1-add-co2-pic-13.jpg)![AIR-1 case fully closed with the lid back in place](/assets/air-1-add-co2-pic-14.jpg)

9\. Please refer to our [CO<sub>2</sub> calibration guide](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/ "CO2 Calibration") to calibrate the CO<sub>2</sub> module after installation. This is required for all CO<sub>2</sub> addons purchased from us separately from a product (such as buying it to addon to an existing Apollo device).
20 changes: 10 additions & 10 deletions docs/homey/products/air1/addons/adding-gpio-header-to-air-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,40 @@ description: Adding Optional GPIO Header to AIR-1.

1\. Unplug your AIR-1 from power and lift the top of the case or "lid".

![](/assets/air-1-add-co2-pic-1.jpg)![](/assets/air-1-add-co2-pic-2.jpg)![](/assets/air-1-add-co2-pic-3.jpg)
![AIR-1 in its white case with the lid on and the USB-C port facing forward](/assets/air-1-add-co2-pic-1.jpg)![Fingers lifting one side of the AIR-1 lid](/assets/air-1-add-co2-pic-2.jpg)![AIR-1 lid lifted, showing the circuit board inside the case](/assets/air-1-add-co2-pic-3.jpg)

2\. Remove the lid completely by grabbing the lid from the other side and gently lifting upwards.

![](/assets/air-1-add-co2-pic-4.jpg)
![Lifting the AIR-1 lid completely off from the other side](/assets/air-1-add-co2-pic-4.jpg)

3\. Hold the PCB and orient it correctly where Apollo (the dog) is facing you in.

![](/assets/air-1-add-co2-pic-5.jpg)
![AIR-1 circuit board held with the Apollo dog graphic facing you, sensor below](/assets/air-1-add-co2-pic-5.jpg)

4\. Gently slide the pcb out by sliding it to the left as shown in the images below.

![](/assets/air-1-add-co2-pic-6.jpg)![](/assets/air-1-add-co2-pic-7.jpg)
![AIR-1 circuit board being slid to the left out of the lid](/assets/air-1-add-co2-pic-6.jpg)![AIR-1 circuit board slid further left, almost free of the lid](/assets/air-1-add-co2-pic-7.jpg)

5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below
5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below.

![](/assets/air-1-gpio-header-wiki-pic-1.webp)![](/assets/air-1-gpio-header-wiki-pic-2.webp)
![Back of the AIR-1 board with a tool pointing at the top right mezzanine connector](/assets/air-1-gpio-header-wiki-pic-1.webp)![GPIO header addon board with an X marked in one corner](/assets/air-1-gpio-header-wiki-pic-2.webp)

6\. Match up the X on the PCB of the GPIO Header and the X on the AIR-1 PCB and then gently push the GPIO Header onto the black mezzanine connector.

![](/assets/air-1-gpio-header-wiki-pic-3.webp)![](/assets/air-1-gpio-header-wiki-pic-4.webp)![](/assets/air-1-gpio-header-wiki-pic-5.webp)
![GPIO header held next to the AIR-1 mezzanine connector with the X marks lined up](/assets/air-1-gpio-header-wiki-pic-3.webp)![Pressing the GPIO header onto the AIR-1 mezzanine connector](/assets/air-1-gpio-header-wiki-pic-4.webp)![GPIO header seated on the top right connector of the AIR-1 board](/assets/air-1-gpio-header-wiki-pic-5.webp)

7\. Flip the AIR-1 PCB over and gently slide it back into the new AIR-1 Lid which came with your GPIO Header addon! Please do not use much force, the PCB should slide in relatively smoothly, with a tiny bit of force needed. There are three channels in the plastic where the PCB slides into!

![](/assets/air-1-gpio-header-wiki-pic-6.webp)![](/assets/air-1-gpio-header-wiki-pic-7.webp)
![AIR-1 circuit board being slid into the new lid for the GPIO header](/assets/air-1-gpio-header-wiki-pic-6.webp)![AIR-1 circuit board seated in the new lid with the Apollo dog graphic facing out](/assets/air-1-gpio-header-wiki-pic-7.webp)

8\. Gently push the case back together as shown below.

![](/assets/air-1-gpio-header-wiki-pic-8.webp)![](/assets/air-1-gpio-header-wiki-pic-9.webp)![](/assets/air-1-gpio-header-wiki-pic-10.webp)
![New AIR-1 lid with the GPIO header being lowered onto the case](/assets/air-1-gpio-header-wiki-pic-8.webp)![Closed AIR-1 case with the GPIO header showing through the lid](/assets/air-1-gpio-header-wiki-pic-9.webp)![Top of the closed AIR-1 lid with the GPIO header in its cutout](/assets/air-1-gpio-header-wiki-pic-10.webp)

9\. You are now done and your AIR-1 is now able to be used with the GPIO Header addon! Here is the pinout image below and <a href="https://wiki.apolloautomation.com/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip/" target="_blank" rel="noopener">here's a great wiki article showing you how to add a small led strip!</a>

!!! warning "Warning"

If you plan to use a lot of leds or your gpio project requires a lot of power then you need to use a dedicated power supply and not try to use too much power (under 350mA) from the GPIO of the device! You can power the AIR-1 via the vcc (5v) and GND pins but please do not power it via the pins AND the USB-C port, it should be one or the other.

![](/assets/gpio-header-pinout.webp)
![AIR-1 GPIO header pinout: GND, IO18, IO19, IO4, IO2, IO6 on the left; 5V, IO7, SDA, SCL, GND, 3V on the right](/assets/gpio-header-pinout.webp)
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: MiCS Addon
description: "Adding Optional MiCS-4514 Gas Sensor To The AIR-1."
---
--8<-- "products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md:5:"
3 changes: 2 additions & 1 deletion docs/homey/products/air1/air1-reviews.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Youtuber reviews and feedback about the AIR-1 sensor from Apollo Automation."
title: Reviews
description: "YouTuber reviews and feedback about the AIR-1 sensor from Apollo Automation."
---
--8<-- "products/air1/air1-reviews.md:5:"
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
description: "Calibrate the AIR-1 temperature reading from its SEN55 to your room using a temperature offset."
---

![AIR-1 Temperature Offset 2.png](/assets/air-1-temperature-offset-2.png)
![AIR-1 Configuration card in Home Assistant with the SEN55 Temperature Offset set to 5.0 °C circled](/assets/air-1-temperature-offset-2.png)
Loading
Loading