Requirments
- ESP Open SDK - Install and compile Xtensa compilers following the instruction in the description
- esptool.py - a tool to flash ESP8266
- ESP Open RTOS SDK - FreeRTOS SDK
- WiFi SSID and password must be specified in the file
private_ssid_config.h - MQTT login and password must be specified in the file
private_mqtt_config.h
Architecture
Currently the application has 4 tasks:
- WiFi task - connects to a WiFi AP
- MQTT task - connects to an MQTT server and sends. messages which it takes from a queue from other tasks in the app.
- Beat task - report extra information about the device.
- Switch task - performs switching of the pump and sends a confirmation as an mqtt message.
- Water Level task - it pools the water level sensor and reports about any changes via mqtt
Water level sensor
The water level sensor monitors how much water is left to be used. It is built the 74HC4067 chip - 16-channel analog multiplexer. A corresponding task polls the sensor by switching input channels and check a value on ADC on ESP8266 which is connected to the signal pin (SIG) of the 74HCT4067. There is currently a basic support of the sensor but work is still in progress and there will be more options to configure the sensor.
Home Assistant configuration
It can be configured as a switch in Home Assistant. All mqtt topics can be configured in the file irrigation.h
- platform: mqtt
name: "Pump"
icon: mdi:flower
state_topic: "irrigation/controller1"
state_on: "ON"
state_off: "OFF"
command_topic: "irrigation/controller1/set"
availability_topic: "irrigation/controller1/status"
payload_available: "online"
payload_not_available: "offline"
optimistic: false
json_attributes_topic: "irrigation/controller1/attributes"
A water level sensor which is built on the 74HC4067 chip:
- platform: mqtt
name: 'Irrigation Water Level'
state_topic: "irrigation/controller1/waterlevel"
icon: mdi:cup-water
availability_topic: "irrigation/controller1/status"
payload_available: "online"
payload_not_available: "offline"
unit_of_measurement: "%"
json_attributes_topic: "irrigation/controller1/attributes"