Skip to content

Commit 94a8825

Browse files
cloudcannon[bot]cloudcannon[bot]
authored
Merge pull request #646 from ApolloAutomation/dev
2 parents 8e8584a + 16bc8d9 commit 94a8825

18 files changed

+570
-0
lines changed

‎docs/products/btn1/addons/productname-addon.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Attaching Inlet and Outlet tubes to the PUMP-1
3+
description: Tutorial for attaching both the Inlet and the Outlet tubes for the PUMP-1
4+
---
5+
# Attaching Inlet and Outlet tubes to the PUMP-1
6+
7+
1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1.
8+
9+
![](../../../assets/pump-1-tubing-install-webp.webp)
10+
11+
[Click here to learn how to attach the Fluid Sensor addons!](https://wiki.apolloautomation.com/products/pump1/addons/attaching-fluid-level-sensors-pump-1/){ .md-button .md-button--primary }

‎docs/products/btn1/examples/example.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Example Title
3+
description: Example Description
4+
---
5+
# Examples
6+
7+
example text here

‎docs/products/btn1/faq.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: PUMP-1 FAQ
3+
description: Frequently asked questions about the PUMP-1 Fluid Pump Sensor
4+
---
5+
1\. **What is the maximum distance this pump can push water?**
6+
7+
* The PUMP-1 has been successfully tested with 33 feet of tubing and a vertical lift of 14 feet, while still maintaining strong head pressure. This demonstrates its capability to move water efficiently over long distances and significant elevation gains.
8+
9+
2\. **What is the pump model used for the PUMP-1?**
10+
11+
* The pump model is a DSB413-A.
12+
13+
3\. **What is the flow rate of the PUMP-1?**
14+
15+
* 900mL a minute in our testing!
16+
17+
4\. **What is the Inner Diameter (ID) and Outer Diameter (OD) of the tubing?**
18+
19+
* The Inner Diameter is 7mm (7/25) and the Outer Diameter is 10mm.
20+
21+
5\. **What voltage does the Apollo PUMP-1 operate on?**
22+
23+
* The PUMP-1 runs on 5V DC power, compatible with most standard USB power sources.
24+
25+
6\. **Is the PUMP-1 safe to use with drinking water or pet bowls?**
26+
27+
* Yes, the PUMP-1 is made with food-safe materials suitable for potable water. This requires you to <a href="https://www.fda.gov/food/buy-store-serve-safe-food/safe-food-handling" target="_blank" rel="noreferrer nofollow noopener">regularly clean the device</a> to make sure no bacteria is present.
28+
29+
7\. **Can I use the PUMP-1 to automate watering for plants?**
30+
31+
* Absolutely! It’s designed to integrate seamlessly with our PLT-1 plant sensor for automated watering.
32+
33+
8\. **Can the pump detect when to stop watering automatically?**
34+
35+
* Yes, the PUMP-1 has two ports for fluid sensors that detect water presence to stop the pump when watering is complete or if your water source is empty.
36+
37+
9\. **What other uses does the PUMP-1 support?**
38+
39+
* Besides plant watering, it’s great for filling fish tanks, robot vacuum mop tanks, pet bowls, coffee pots, liquid transfer projects, and can also be used as a drain pump.
40+
41+
10\. **How large is the PUMP-1?**
42+
43+
* The pump measures 3.4in x 1.3in x 1.8in (86.4mm x 33mm x 45.7mm), making it compact and easy to install.
44+
45+
11\. **How do I control the pump?**
46+
47+
* The PUMP-1 can be controlled manually using the button or integrated into smart home systems for automated operation based on sensor input or schedules.
48+
49+
12\. **Is the PUMP-1 durable?**
50+
51+
* Yes, it is designed for long-term use with proper maintenance and includes safety features like max run-time limits.
52+
53+
13\. **Can I extend the fluid input sensor and fluid output sensor?**
54+
55+
* Yes, you can use a JST PH 2.0 3 pin connector such as <a href="https://www.amazon.com/XUGERIP-Connector-Female-Connectors-Extension/dp/B0D9R28WDR" target="_blank" rel="noreferrer nofollow noopener">these off Amazon</a>.

‎docs/products/btn1/introduction.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Introduction
3+
description: Documentation for PUMP-1, including setup, usage, and best practices.
4+
---
5+
# Introduction
6+
7+
![](../../assets/pump-1-main-1.webp)
8+
9+
The Apollo PUMP-1 is a versatile, compact, and food-safe fluid pump designed to integrate seamlessly with our PLT-1 plant sensor to automate your watering needs. It features two ports for fluid sensors that detect water presence, allowing the pump to automatically stop when watering is complete or if your water bottle runs empty, protecting your system from damage.
10+
11+
Perfect for smart home gardeners, the PUMP-1 takes the hassle out of plant care by delivering precise, controlled watering automatically.
12+
13+
Beyond plants, the PUMP-1 is ideal for a variety of other uses such as filling fish tanks, robot vacuum mop tanks, pet bowls, coffee pots, and more. Its reliable performance, food-safe materials, and easy integration make it a perfect addition to any home automation setup.
14+
15+
Experience effortless and safe fluid control with the Apollo PUMP-1. Smart, simple, and adaptable.

‎docs/products/btn1/productname-reviews.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: PUMP-1 Reviews
3+
description: Youtuber and other Influencer reviews and feedback about the PUMP-1 sensor from Apollo Automation.
4+
---
5+
# WAITING FOR REVIEWS

‎docs/products/btn1/setup/productname-general-tips.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: PUMP-1 General Tips
3+
description: >-
4+
Multiple helpful images for mounting, lux/rgb, and gate and zone
5+
visualization.
6+
---
7+
# General Tips
8+
9+
###### Fluid Sensor
10+
11+
The fluid level sensor should be securely taped or mounted flat against the surface of your chosen water reservoir. The fluid sensor is rated to go through up to 5mm of plastic but could possibly go further.
12+
13+
###### Pump Control
14+
15+
There is a disabled entity by default called **Pump Control** which will just turn the pump on or off and run it instead of using the **Run Pump** entity. The **Pump Control** entity will ignore the **Pump Run Seconds** however this entity is still effected by the **Max Safe Run Time**. For example, if **Max Safe Run Time** is set to 120 seconds, then when you turn on the **Pump Control** entity, it will run for 120 seconds and then turn off unless you manually turn it off sooner.

‎docs/products/btn1/setup/productname-sensor-definitions.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: PUMP-1 Sensor Definitions
3+
description: These are all of the entities exposed by the PUMP-1 to automate on!
4+
---
5+
# Sensor Definitions
6+
7+
This serves as a list of all sensor definitions to help understand what each entity does for your new PUMP-1!
8+
9+
???+ info "Controls"
10+
11+
**Pump Run Time**
12+
13+
* Amount of time in seconds to run the pump. Defaults to 10s
14+
15+
**RGB Light**
16+
17+
* One RGB Neopixel LED. Click on the light bulb or color wheel to change the color. Click on the toggle to turn on or off.
18+
19+
**Run Pump**
20+
21+
* Press button for running the PUMP-1 Pump. This will run for the amount of seconds set above in "Pump Run Time".
22+
23+
**Run Pump Until Output Wet**
24+
25+
* Press button for running the PUMP-1 Pump. This will run the pump until the Fluid Output changes to Wet. (Disabled by default)
26+
27+
???+ info "Sensors"
28+
29+
**Fluid Input**
30+
31+
* This ultrasonic sensor is located at the bottom of the PUMP-1 water bottle and monitors the presence of fluid. The state remains **"Wet"** while water is present in the bottle, and changes to **"Dry"** once the bottle is completely empty. It reports a state of either **"Wet"** or **"Dry"**.
32+
33+
**Fluid Output**
34+
35+
* This ultrasonic sensor can be mounted on the exterior of any container where you need to detect the presence of water on the other side, such as a Keurig reservoir or fish tank. It can be attached using adhesive tape or other mounting methods. The sensor reports **"Wet"** when the water level is above the sensor and **"Dry"** when the level falls below it. It reports a state of either **"Wet"** or **"Dry"**.
36+
37+
???+ info "Configuration"
38+
39+
**ESP Reboot**
40+
41+
* Performs a restart of the sensor.
42+
43+
**Firmware Update**
44+
45+
* Shows whether a firmware update is available.
46+
47+
**Max Safe Run Time**
48+
49+
* Maximum time the pump will run before shutting off. Defaults to 100 seconds.
50+
51+
**Pump Control**
52+
53+
* Allows you to toggle the pump on and off via a switch. This will still be stopped by the Max Safe Run Time interval set above. (Disabled by default)
54+
55+
**Stop Pump When Input Dry**
56+
57+
* This will turn the pump off when the ultrasonic sensor at the bottom of the water bottle detects no water.
58+
59+
**Stop Pump When Output Wet**
60+
61+
* This turns the pump off when the ultrasonic sensor (mounted on a Keurig tank, fish tank, or similar container) detects that the water level has risen above its monitoring point.
62+
63+
**Factory Reset ESP**
64+
65+
* Factory resets the device (Disabled by default).
66+
67+
**Pump Safety Override**
68+
69+
* Allows you to disable the safety features (Disabled by default).
70+
71+
??? info "Diagnostic"
72+
73+
**ESP Temperature**
74+
75+
* Displays the current temperature of the ESP32 chip. (Disabled by Default)
76+
77+
**Online**
78+
79+
* Shows the connection status.
80+
81+
**RSSI**
82+
83+
* Displays the Wi-Fi signal strength.
84+
85+
**Uptime**
86+
87+
* Shows the time since last reboot.
88+
89+
[Join our Discord if you need more help! :simple-discord:](https://dsc.gg/apolloautomation){ .md-button }

‎docs/products/btn1/troubleshooting/productname-boot-mode.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Putting The PUMP-1 In Boot Mode
3+
description: Step by step guide for putting The PUMP-1 In Boot Mode.
4+
---
5+
# Putting The PUMP-1 In Boot Mode
6+
7+
!!! info "This will cover how to put the PUMP-1 into boot mode."
8+
9+
This is needed to force the device into boot mode to reflash the firmware.
10+
11+
##### Method 1: Boot Button Only
12+
13+
!!! danger "Empty the water reservoir and make sure no water is present in the tubes"
14+
15+
Make sure that there is no water which is able to damage the device. This is a precautionary measure just to be safe!
16+
17+
1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button—it’s the button on the right.
18+
19+
2\. Plug in a USB cable that supports power and data into your computer.
20+
21+
3\. Push and hold the boot button (the right button). While still holding the button down, plug in a USB-C cable into the USB-C port of your PUMP-1 then let go of the button.
22+
23+
![](../../../assets/pump-1-hold-boot-button-video.webp)
24+
25+
4\. You are now ready to reflash your device!
26+
27+
[Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/pump1/troubleshooting/pump1-reflash/){ .md-button .md-button--primary }
28+
29+
##### Method 2: Boot and Reset Buttons
30+
31+
1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your PUMP-1. With the device facing you, locate the reset (left) and boot (right) buttons.
32+
33+
![](../../../assets/pump-1-buttons-labeled.jpg)
34+
35+
2\. Hold down the boot button (the right button), then press and release the reset button (the left button) while keeping the boot button pressed. Finally, release the boot button.
36+
37+
![](../../../assets/pump-1-hold-boot-and-reset-button-video.webp)
38+
39+
3\. You are now ready to reflash your device!
40+
41+
[Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/pump1/troubleshooting/pump1-reflash/){ .md-button .md-button--primary }

‎docs/products/btn1/troubleshooting/productname-reflash.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Reflashing The PUMP-1.
3+
description: Step by step guide for reflashing The PUMP-1.
4+
---
5+
# Reflashing The PUMP-1
6+
7+
!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below."
8+
9+
This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser.
10+
11+
1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button—it’s the button on the right.
12+
13+
!!! danger "Empty the water reservoir and make sure no water is present in the tubes"
14+
15+
Make sure that there is no water which is able to damage the device. This is a precautionary measure just to be safe!
16+
17+
2\. Plug in a USB cable that supports power and data into your computer.
18+
19+
3\. Push and hold the boot button (the right button). While still holding the button down, plug in a USB-C cable into the USB-C port of your PUMP-1 then let go of the button.
20+
21+
![](../../../assets/pump-1-hold-boot-button-video.webp)
22+
23+
4\. Navigate to our installer page and click connect under <a href="https://apolloautomation.github.io/PUMP-1/" target="_blank" rel="noreferrer nofollow noopener">Apollo PUMP-1 Installer</a>.
24+
25+
![](../../../assets/pump-1-reflash-connect-button.png)
26+
27+
5\. Select the open com port then click Connect.
28+
29+
![](../../../assets/pump-1-reflash-com-port.png)
30+
31+
7\.. Click Install PUMP-1.
32+
33+
![](../../../assets/pump-1-reflash-click-install.png)
34+
35+
7\. Click Install.
36+
37+
![](../../../assets/pump-1-reflash-click-install-confirm.png)
38+
39+
8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
40+
41+
![](../../../assets/pump-1-reflash-install-complete.png)
42+
43+
!!! warning "Power cycle your device before doing anything else!"
44+
45+
Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode!
46+
47+
[Head to the Getting Started article to setup your PUMP-1 as a new device!](https://wiki.apolloautomation.com/products/general/setup/getting-started-pump1/){ .md-button .md-button--primary }

‎docs/products/btn1/troubleshooting/productname-reset-wi-fi-credentials.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Reset Wi-Fi Credentials
3+
description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP-1.
4+
---
5+
# Reset Wi-Fi Credentials on your PUMP-1
6+
7+
1\. Plug the PUMP-1 into power.
8+
9+
2\. Long press the Boot button (the button on the right) for 10 seconds.
10+
11+
![](../../../assets/pump-1-buttons-labeled-2.jpg)
12+
13+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
14+
15+
4\. Connect to the hotspot titled "Apollo PUMP-1 Hotspot" and enter your new Wi-Fi details!

0 commit comments

Comments
 (0)