This daemon is fetching data from the S 3200 and store it in a MariaDb database.
Written by: Jörg Wendel (linux at jwendel dot de)
Homepage: https://github.com/horchi/linux-p4d
This code is distributed under the terms and conditions of the GNU GENERAL PUBLIC LICENSE. See the file LICENSE for details.
USE AT YOUR OWN RISK. No warranty. This software is a private contribution and not related Fröling. It may not work with future updates of the S3200 firmware and can also cause unintended behavior. Use at your own risk! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Die Software wurde für den Eigengebrauch erstellt. Sie wird kostenlos unter der GPLv2 veröffentlicht.
Es ist kein fertiges Produkt, die Software entstand als Studie was hinsichtlich der Kommunikation mit der s3200 Steuerung möglich ist und kann Bastlern als Basis und Anregung für eigene Projekte dienen.
Es besteht kein Anspruch auf Funktion, jeder der sie einsetzen möchte muss das Risiko selbst abschätzen können und wissen was er tut, insbesondere auch in Hinblick auf die Einstellungen der Heizungsparameter und den damit verbundenen Risiken hinsichtlich Fehlfunktion, Störung, Brand, etc. Falsche Einstellung können unter anderem durch Bedienfehler und Fehler in dieser Software ausgelöst werden! Die Vorgaben, Vorschriften und AGB des Herstellers der Heizung bleiben maßgebend! Ich kann nicht ausschließen das es zu Fehlfunktionen oder unerwartetem Verhalten, auch hinsichtlich der zur Heizung übertragenen Daten und damit verbundenen, mehr oder weniger kritischen Fehlfunktionen derselben kommen kann!
If this project help you, you can give me a cup of coffee :)
- USB-Serial Converter based on FTDI chip
- USB-Serial converter must be connected to COM1 on Fröling mainboard
- A Linux based operating system is required
wget www.jwendel.de/p4d/install-deb.sh -O /tmp/install-deb.sh
sudo bash /tmp/install-deb.sh
dpkg --remove p4d
dpkg --purge p4d
Update your package data:
sudo apt update
and, if you like, update your installation:
sudo apt dist-upgrade
- the described installation is tested with Raspbian buster, the p4d should work also with other Linux distributions and versions but the installation process should adapted to them, for example they use other init processes or use different tools for the package management, other package names, ....
- de_DE.UTF-8 is required as language package (Raspberry command:
dpkg-reconfigure locales
)
Install libwebsockets (https://libwebsockets.org/repo/libwebsockets)
at least version 4.1 or above
Perform all the following steps as root user! Either by getting root or by prefix each command with sodo.
It's not required to host the database on the Raspberry. A remote database is supported as well!
apt install mariadb-server
(set database password for root user during installation)
If the database server is located localy on same host as the p4d:
> mysql -u root -Dmysql -p
CREATE DATABASE p4 charset utf8;
CREATE USER 'p4'@'localhost' IDENTIFIED BY 'p4';
GRANT ALL PRIVILEGES ON p4.* TO 'p4'@'localhost' IDENTIFIED BY 'p4';
flush privileges;
if the database is running remote (on a other host or you like to habe remote access):
> mysql -u root -Dmysql -p
CREATE DATABASE p4 charset utf8;
CREATE USER 'p4'@'%' IDENTIFIED BY 'p4';
GRANT ALL PRIVILEGES ON p4.* TO 'p4'@'%' IDENTIFIED BY 'p4';
flush privileges;
apt install mosquitto
systemctl start mosquitto
systemctl enable mosquitto
install mosquitto-clients
apt install build-essential pkg-config libssl-dev libjansson-dev libcurl4-openssl-dev libmariadb-dev uuid-dev libcap-dev
cd /usr/src/
git clone https://github.com/horchi/linux-p4d/
cd linux-p4d
make clean all
make install
For older linux distributions which don't support the systemd init process use this instead of 'make install'
make install INIT_SYSTEM=sysV
If you like a other destination than '/usr/local' append PREFIX=your-destination (e.g. PREFIX=/usr) to all make calls above
- Now P4 daemon is installed in folder
/usr/local/bin
and its config in /etc/p4d/ - Check
/etc/p4d.conf
file for setting db connection papameters, ttyDeviceSvc device (change device if required), check which/dev/ttyUSB?
devices is used for USB-Serial converter (/dev/ttyUSB0
,/dev/ttyUSB1
,/dev/ttyACM0
)
systemctl start p4d
systemctl status p4d
it should now 'enabled' and in state 'running'!
grep "p4d:" /var/log/syslog
The samples will recorded in the configured interval (parameter interval in p4d.conf), the default is 60 Seconds.
After a while the database will grow and the selects become slower. Therefore you can setup a automatic aggregation in the p4d.conf
with this two parameters:
The aggregateHistory
is the history for aggregation in days, the default is 0 days -> aggegation turned OFF
The aggregateInterval
is the aggregation interval in minutes - 'one sample per interval will be build' (default 15 minutes)
For example:
aggregateHistory = 365
aggregateInterval = 15
Means that all samples older than 365 days will be aggregated to one sample per 15 Minutes. If you like to delete 'old' samples you have to do the cleanup job by hand, actually i don't see the need to delete anything, I like to hold my data (forever :) ?).
The default port of the WEB interface is 1111, The default username and password for the login is User: p4 Pass: p4
- Log in to the web interface
- Goto Setup
- click 'Init Sensors'
- Goto Setup -> IO Setup
- Select the values you like to record and store your selection (click 'Speichern')
- Goto Setup
- click 'Init Service Menü'
After this you can set up the schema configuration. The schema configuration is done by drag&drop and isn't working on mobile devices! Also deleting of chart bookmarks isn't supported on mobile devices.
The next steps are an example to setup the sending of mails. If another tool is preferred it can be used as well.
-
Install required components
apt-get install bsd-mailx msmtp msmtp-mta
-
The mailscript
p4d-mail.sh
is copied during themake install
to the folder/usr/local/bin
. This script is used in our case to send mails -
Setup your mail account in
/etc/msmtprc
-
Start the WEBIF and Login, go to the Setup page
-
Configure the "Mail Benachrichtigungen" options (status and Fehler Mail Empfänger)
-
If no Status options are set you will get a mail for each status change
-
Set the script option
/usr/local/bin/p4d-mail.sh
If the heating values are added as attachment to the mail please check the next steps.
- Check if
heirloom-mailx
is installed (ls -lah /etc/alternatives/mail
) - If output link is
/etc/alternatives/mail -> /usr/bin/mail.mailutils
- Remove
heirloom-mailx
(apt remove heirloom-mailx
)
With the next steps you can enable a time synchronization of the p4d and the heating:
If you enable this feature you can set the max time difference between the p4d systemtime and the time of the heating. The p4d will set the time of the heating (once a day) to his the systemtime. Therefore it is recommended to hold your system time in sync, e.g. by running the ntp
daemon or systemd-timesyncd.
- Check if ntpd (openntpd, systemd-timesyncd, ...) is active and running. If not you have to install one of it.
- Start the WEBIF and login, go to the Setup page
- Enable "Tägliche Zeitsynchronisation" and set the max time difference in seconds in the line "Maximale Abweichung"
- Save configuration
Configure the parameters at the WEBIF
- 'MQTT Url' : The URL of your MQTT broker
- 'MQTT Data Topic Name' : The name of the topic which should be written. You can use the '<NAME>' template here, this will be replaced by the name of the sensor, therefore one topic for each sensor will be created and used (as needed by the homeassistant). If you (e.g.) using Openhab or FHEM omit '<NAME>' and all data is written to one topic. The '<GROUP>' template, will use the configured group name and sort the sensors regarding its group configuration to the topics. Don't use the GROUP and NAME template together!
- 'Config Topic:' : Check box to write the sensor defaults to a config topic and register the separate config topics there (as used by the homeassistant).
The p4d checks automatically if there are 'One Wire Sensors' connected, each detected sensor will be configurable via the web interface after reading the sensor facts by clicking [init].
To make the sensors availaspble to the raspi you have to load the w1-gpio
module, this can be done by calling modprobe w1-gpio
or automatically at boot by registering it in /etc/modules
:
echo "w1-gpio" >> /etc/modules
echo "w1_therm" >> /etc/modules
echo "dtoverlay=w1-gpio,gpioin=4,pullup=on" >> /boot/config.txt
You can chose the Web Interface Style at 'Setup' -> 'Allg. Konfiguration' with the options 'Farbschema' and 'Icon Style Set'. The 'Farbschema' option include all CSS styles which are found in your web folder and fit the naming scheme 'stylesheet-.css' where the wildcard '' is used as the name of the style. The 'Icon Style Set' option includes the name of all suborders of img/state/* in your web folder. You can place additional custom styles and icon sets which automatically appear in the settings. The default web folder is /var/lib/p4/.
- reboot the device to check if p4d is starting automatically during startup
- add your cert and your key to this two files and make sure the p4d has at least read access to this files /etc/p4d/p4d.cert /etc/p4d/p4d.key
- enable WebSSL at 'Setup' -> 'Allg. Konfiguration'
- restart the p4d
- now access to the web interface is ONLY by https://.. possible
Backup the data of the p4 database including all recorded values:
p4d-backup
This will create a dump file for each table like:
<tablename>-dump.sql.gz
To import the backup:
gunzip NAME-dump.sql.gz
mysql -u p4 -pp4 -Dp4 < *-dump.sql
https://hub.docker.com/r/n3m3515/docker-p4d
The import deletes at first all the data and then imports the dumped data. To append the dumped data you have to modify the SQL statements inside the dump files manually.
If you cannot figure out why you get Access denied, remove all entries from the user table that have Host values with wildcars contained (entries that match %
or _
characters). A very common error is to insert a new entry with Host='%'
and User='some_user'
, thinking that this allows you to specify localhost to connect from the same machine. The reason that this does not work is that the default privileges include an entry with Host='localhost'
and User=''
. Because that entry has a Host value localhost
that is more specific than %
, it is used in preference to the new entry when connecting from localhost! The correct procedure is to insert a second entry with Host='localhost'
and User='some_user'
, or to delete the entry with Host='localhost'
and User=''
. After deleting the entry, remember to issue a FLUSH PRIVILEGES
statement to reload the grant tables.
To analyze this you can show all users:
use mysql
SELECT host, user FROM user;
- check the syslog an p4d.log about errors of the p4d
- for the WEBIF check also the browser console for errors
- check the wiki at github If you post any problem at at git-hub or the forum please post the errors also!