mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-26 17:27:47 +01:00
fa685d106d
# Conflicts: # components/binary_sensor/homeassistant.rst # components/sensor/dht.rst # components/uart.rst # cookbook/h801.rst
221 lines
6.6 KiB
ReStructuredText
221 lines
6.6 KiB
ReStructuredText
Sonoff Fish Pond Pump
|
|
=====================
|
|
|
|
.. seo::
|
|
:description: Making an automated fish pond pump with timing and auto stop safety with Sonoff Basic ESP8266 chip
|
|
:image: images/sonoff-fishpond-pump-installed.jpg
|
|
:keywords: sonoff, esp8266, home automation, ESPHome, hass, home assistant
|
|
|
|
.. figure:: images/sonoff-fishpond.jpg
|
|
:align: center
|
|
:width: 75.0%
|
|
|
|
The Sonoff range of products containing the ESP chips from espressif has a myriad of uses and best of all, you can customize it, aka hackable.
|
|
This quick cookbook aims to provide a clear, simple working example.
|
|
|
|
This example is very basic in it's operation.
|
|
|
|
* Start the pump every hour and run it for 10 minutes.
|
|
* Manually start and stop the pump with the toggle button on the Sonoff basic.
|
|
* Use a water float sensor and stop the pump if water level is too low.
|
|
|
|
*Some of the later Sonoff basics does not have GPIO pin available, check your board first*
|
|
|
|
This example is using ESPHome 1.10.1 and Home Assistant 0.85.1
|
|
|
|
Assumptions
|
|
-----------
|
|
|
|
As many of the details on here a predicated on existing installations and knowledge the following is assumed:
|
|
|
|
* You have installed the relevant environment and it is functional (Home Assisant, ESPHome).
|
|
* You need to create your own secrets.yaml file.
|
|
* You are proficient in reading instructions and capable of using a search engine.
|
|
* You will look at the documentation on https://esphome.io/ (we may have missed something in this example).
|
|
* This serves only as a guide and errors and outlets are excluded.
|
|
|
|
.. warning::
|
|
|
|
Do NOT connect your device to electricity when programming it.
|
|
Take care working with electricity at all times
|
|
|
|
|
|
1. Configuration
|
|
----------------
|
|
|
|
Here is the configuration with the basic operations outlined above.
|
|
|
|
.. code-block:: yaml
|
|
|
|
## Fish pond sonoff
|
|
## filename: fishpond.yaml
|
|
# Sonoff basic
|
|
# Button toggles pump on/off
|
|
# Float sensor stops pump
|
|
# Cron'd to run every hour, on the hour for 10 minutes
|
|
esphome:
|
|
name: fishpond
|
|
platform: ESP8266
|
|
board: esp01_1m
|
|
|
|
wifi:
|
|
ssid: !secret wifi_ssid
|
|
password: !secret wifi_password
|
|
## use fast_connect of you are connecting to a hidden WiFi network, else comment it out
|
|
fast_connect: true
|
|
|
|
# Enable logging
|
|
logger:
|
|
level: DEBUG
|
|
|
|
ota:
|
|
|
|
api:
|
|
password: !secret esplibapi_password
|
|
|
|
status_led:
|
|
pin: GPIO13
|
|
|
|
sensor:
|
|
- platform: uptime
|
|
name: "ESP Fish Pond System Uptime"
|
|
|
|
- platform: wifi_signal
|
|
name: "ESP Fish Pond WiFi Signal"
|
|
update_interval: 15s
|
|
|
|
switch:
|
|
## restart
|
|
- platform: restart
|
|
name: "ESP Fish Pond Restart"
|
|
|
|
## relay / pump
|
|
- platform: gpio
|
|
pin: GPIO12
|
|
name: "ESP Fish Pond Pump"
|
|
id: esp_fishpond_pump
|
|
|
|
binary_sensor:
|
|
- platform: status
|
|
name: "ESP Fish Pond System Status"
|
|
|
|
## button - toggle relay
|
|
- platform: gpio
|
|
name: "ESP Fish Pond Button"
|
|
pin:
|
|
number: GPIO0
|
|
inverted: true
|
|
# Toggle pump when user presses the Sonoff Button
|
|
on_press:
|
|
- switch.toggle: esp_fishpond_pump
|
|
|
|
# onboard header pin - sensor
|
|
# when threshold is reached, turn off
|
|
- platform: gpio
|
|
name: "esp_fishpond_gpio14"
|
|
pin:
|
|
number: 14
|
|
mode: INPUT_PULLUP
|
|
on_press:
|
|
- switch.turn_off: esp_fishpond_pump
|
|
|
|
## Use time
|
|
time:
|
|
- platform: homeassistant
|
|
## Set your timezone
|
|
timezone: Africa/Johannesburg
|
|
on_time:
|
|
# Switch on on the hour
|
|
- seconds: 0
|
|
minutes: 0
|
|
hours: '*'
|
|
then:
|
|
- switch.turn_on: esp_fishpond_pump
|
|
# Switch off 10 minutes later
|
|
- delay: 10min
|
|
- switch.turn_off: esp_fishpond_pump
|
|
|
|
2. Programming
|
|
**************
|
|
Follow the standard way of uploading to your Sonoff basic.
|
|
|
|
.. figure:: images/sonoff-fishpond-pump-1-programming.jpg
|
|
:align: center
|
|
:width: 75.0%
|
|
|
|
|
|
For USB uploads this generally includes:
|
|
|
|
* Modifications (soldering) made on the PCB for USB UART / FTDI uploads.
|
|
* The relevant USB UART / FTDI uploads device connected to you PC and to your Sonoff.
|
|
* Start Sonoff in programming mode.
|
|
* Compile and upload the firmware via USB using ``esphome <some-yaml-file> run``.
|
|
|
|
For OTA the generally includes:
|
|
|
|
* Ensure device is on.
|
|
* Compile and upload the firmware via USB using ``esphome <some-yaml-file> run``.
|
|
|
|
Both options USB and OTA are done by running the command:
|
|
|
|
.. code-block:: bash
|
|
|
|
esphome <some-yaml-file> run
|
|
|
|
More details on programming can be found on :doc:`/devices/sonoff_basic`
|
|
|
|
3. Prepping and installing
|
|
****************************
|
|
|
|
* Ensure power is switched off.
|
|
* You can now add your water level sensor wiring to the PCB and have it extrude, SAFELY, next to your connector block.
|
|
* Here it will be the further most pin (GPIO14) you soldered from the toggle button and then pin (Ground) next to it.
|
|
* You can now easily connect and disconnect your liquid level sensor.
|
|
|
|
Connecting it
|
|
|
|
* Connect your water level sensor.
|
|
* Connect your pump to the Sonoff output.
|
|
* Connect your input electrical wiring.
|
|
* Test all connections are securely fastened.
|
|
* You can toggle the on/off of the pump by pressing the toggle button.
|
|
|
|
|
|
Once the pump is running changing the position of the float in the float sensor will cause the Sonoff to stop the pump.
|
|
|
|
.. figure:: images/sonoff-fishpond-pump-gpio14.jpg
|
|
:align: center
|
|
:width: 75.0%
|
|
|
|
Wires connected for easier access to connect and disconnect water level sensor
|
|
|
|
|
|
.. figure:: images/sonoff-fishpond-pump-and-sensor.jpg
|
|
:align: center
|
|
:width: 75.0%
|
|
|
|
This needs to be submursed, pump (bio filter) and sensor connected in single housing (icecream tub).
|
|
|
|
.. figure:: images/sonoff-fishpond-pump-installed.jpg
|
|
:align: center
|
|
:width: 75.0%
|
|
|
|
In this PVC housing the plates are secured using cabinet door magnets for easier access and maintenance.
|
|
|
|
* Ensure you are using a proper and compliant waterproof box to house your electrical equipment (Sonoff basic) in.
|
|
* Ensure you plan to be able to remove the unit with minimal effort should you need to manually USB reflash it again in future.
|
|
|
|
2.6. Home Assistant
|
|
*******************
|
|
|
|
You can now add your device to home assistant via the configurations page and under the Integrations option
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`/devices/sonoff_basic`
|
|
- `Flashing sonoff basic <https://randomnerdtutorials.com/how-to-flash-a-custom-firmware-to-sonoff/>`__.
|
|
- `Adding ESPHome to Home Assistant <https://www.home-assistant.io/components/esphome/>`__.
|
|
|
|
.. disqus::
|