Skip to content

Latest commit

 

History

History
92 lines (73 loc) · 2.03 KB

software-guide.md

File metadata and controls

92 lines (73 loc) · 2.03 KB
title summary date lastmod draft toc type featured tags menu
Software Guide of Pool Controller
2020-05-28
2020-06-02
false
true
docs
true
docs
controller
tutorial
docs
parent name weight
Pool Controller
Software Guide
30

Development Environment

Required Libraries

Many thanks to maintainers of these libraries!

Defines

Within the sources at main.cpp there are someconstant defined settings. For the PIN assignment see also at hardware guide.

const uint8_t PIN_DS_SOLAR = D5;  // Pin of Temp-Sensor Solar
const uint8_t PIN_DS_POOL  = D6;  // Pin of Temp-Sensor Pool

const uint8_t PIN_RELAY_POOL  = D1;
const uint8_t PIN_RELAY_SOLAR = D2;

const uint8_t TEMP_READ_INTERVALL = 30;

Configuration

Homie-ESP8266 supports configuration (e.g. WiFi credentials) using JSON-files. How to upload JSON config files see Homie-esp8266 docu.

Example config.json

{
  "name": "Pool Controller",
  "device_id": "pool-controller",
  "wifi": {
    "ssid": "<SSID>",
    "password": "<XXX>"
  },
  "mqtt": {
    "host": "<MQTT_HOST>",
    "port": 1883
  },
  "ota": {
    "enabled": true
  },
  "settings": {
    "loop-interval": 60,
    "temperature-max-pool": 28,
    "temperature-min-solar": 50,
    "temperature-hysteresis": 0.5
  }
}

MQTT Communication

Clearing retained messages

In some cases some retained messages can be wanted and we don’t want to clear all the retained messages.

The messages will have to be cleared one by one using the topic

To clear a specific message:

mosquitto_pub -h hostname -t homie -n -r -d