Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blueandi/rego6xxsrv
Heatpump Rego6xx controller server based on a AVR-NET-IO board.
https://github.com/blueandi/rego6xxsrv
arduino avr-net-io cpp11 heatpump ivt junkers platformio rego6xx rest-api
Last synced: 27 days ago
JSON representation
Heatpump Rego6xx controller server based on a AVR-NET-IO board.
- Host: GitHub
- URL: https://github.com/blueandi/rego6xxsrv
- Owner: BlueAndi
- License: mit
- Created: 2020-09-19T20:18:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T19:39:01.000Z (10 months ago)
- Last Synced: 2024-06-11T17:55:45.443Z (7 months ago)
- Topics: arduino, avr-net-io, cpp11, heatpump, ivt, junkers, platformio, rego6xx, rest-api
- Language: C++
- Homepage:
- Size: 2.65 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rego6xx Server
A REST API server which provides control over IVT heatpumps, which uses a Rego6xx controller.
It runs on the AVR-NET-IO board from Pollin.
[](http://choosealicense.com/licenses/mit/)
[](https://www.repostatus.org/#inactive)
[](https://github.com/BlueAndi/Rego6xxSrv/releases)
[](https://github.com/BlueAndi/Rego6xxSrv/actions?query=workflow%3A%22PlatformIO+CI%22)
* [Rego6xx Server](#rego6xx-server)
* [Motivation](#motivation)
* [Electronic](#electronic)
* [Software](#software)
* [IDE](#ide)
* [Installation](#installation)
* [Install bootloader](#install-bootloader)
* [Change MAC address of network interface controller](#change-mac-address-of-network-interface-controller)
* [Build Project](#build-project)
* [Update of the device](#update-of-the-device)
* [Update via serial interface](#update-via-serial-interface)
* [Used Libraries](#used-libraries)
* [REST API](#rest-api)
* [Get temperature sensor value (GET /api/sensors/\)](#get-temperature-sensor-value-get-apisensorssensor)
* [Set temperature value (POST /api/sensors)](#set-temperature-value-post-apisensors)
* [Send raw command (POST /api/debug)](#send-raw-command-post-apidebug)
* [Get last error information (GET /api/lastError)](#get-last-error-information-get-apilasterror)
* [Get frontpanel LED state (GET /api/frontPanel/\)](#get-frontpanel-led-state-get-apifrontpanelled)
* [Get display content (GET /api/display/\)](#get-display-content-get-apidisplayrow)
* [Manipulate frontpanel keyboard and wheel (POST /api/frontPanel/\)](#manipulate-frontpanel-keyboard-and-wheel-post-apifrontpanelhmidevice)
* [Issues, Ideas And Bugs](#issues-ideas-and-bugs)
* [License](#license)
* [Contribution](#contribution)
# Motivation
I have a photovoltaic system (PV) on the roof of the house. If the PV provides enough energy, the idea is to store it in form of hot water with the heatpump.
Unfortunately my Junkers heatpump (original build by IVT) has no interface to do that. Therefore the service interface of the build-in reg6xx controller shall be used to change the target temperature of hot water.
The installed SolarEdge inverter provides a modbus tcp interface, which is used to retrieve how much energy is harvested. Additional there are s0 counter to retrieve the power consumption of the house.
The protocol for the Rego6xx controller was derived from http://rago600.sourceforge.net/.
# Electronic
* [Pollin AVR-NET-IO](https://www.pollin.de/p/avr-net-io-fertigmodul-810073)
Note, the AVR-NET-IO has original a ATmega32-16PU, which was replaced with a ATmega644p.
> [!WARNING]
> 2024-01-01: The Pollin AVR-NET-IO development is obsolete and not available anymore.\
> There is no known successor development board.
# Software
## IDE
The [PlatformIO IDE](https://platformio.org/platformio-ide) is used for the development. Its build on top of Microsoft Visual Studio Code.
## Installation
1. Install [VSCode](https://code.visualstudio.com/).
2. Install PlatformIO IDE according to this [HowTo](https://platformio.org/install/ide?install=vscode).
3. Close and start VSCode again.
4. Recommended is to take a look to the [quick-start guide](https://docs.platformio.org/en/latest/ide/vscode.html#quick-start).
## Install bootloader
Note, for the following steps I used the AtmelStudio v7.0 with my AVR-ISP programmer, because I didn't manage to get this setup work with VSCode + Platformio or the Arduino IDE.
1. Set fuse bits: lfuse = 0xf7, hfuse = 0xd6, efuse = 0xfd
2. The MightyCore provides in the platformio installation directy bootloaders. Choose ```.platformio/packages/framework-arduino-avr-mightycore/bootloaders/optiboot_flash/bootloaders/atmega644p/16000000L/optiboot_flash_atmega644p_UART0_115200_16000000L_B0_BIGBOOT.hex```
3. If the bootloader is active, two pulses are shown on pin B0 (= Arduino pin 0), which can be checked with a oscilloscope.
After the bootloader is installed and running, the typical Arduino upload can be used over the serial interface.
## Change MAC address of network interface controller
Every AVR-NET-IO board comes with a unique MAC address of the network interface controller. Before you build the software it is necessary to set it in the sourcecode. Therefore open ```./src/main.cpp``` in the editor, search for the variable ```DEVICE_MAC_ADDR``` and change it accordingly.
## Build Project
1. Load workspace in VSCode.
2. Change to PlatformIO toolbar.
3. _Project Tasks -> Build All_ or via hotkey ctrl-alt-b
## Update of the device
### Update via serial interface
1. Connect the AVR-NET-IO board to your PC via serial interface.
2. Build and upload the software via _Project Tasks -> Upload All_.
3. Note, if the AVR-NET-IO board is not modified, you need to keep it off until in the console ```Uploading .pio\build\MightyCore\firmware.hex``` is shown. Just in this moment power the board and the upload starts.
## Used Libraries
* [MightyCore](https://github.com/MCUdude/MightyCore) - Arduino core for ATmega644.
* [EthernetENC](https://github.com/jandrassy/EthernetENC) - Ethernet library for ENC28J60 with Arduino compatible interface.
* [ArduinoHttpServer](https://github.com/QuickSander/ArduinoHttpServer) - Server side minimalistic object oriented HTTP protocol implementation.
* [ArduinoJSON](https://arduinojson.org/) - JSON library.
# REST API
## Get temperature sensor value (GET /api/sensors/<sensor>)
Get a temperature sensor value in °C from the heatpump.
``````:
* gt1 - Radiator return temperature in °C
* gt2 - Outdoor temperature in °C
* gt3 - Hot water temperature in °C
* gt4 - Forward temperature in °C
* gt5 - Room temperature in °C
* gt8 - Heat fluid out temperature in °C
* gt9 - Heat fluid in temperature in °C
* gt10 - Cold fluid in temperature in °C
* gt11 - Cold fluid out temperature in °C
* gt3x - External hot water temperature in °C
* gt3TargetValue - Hot water target temperature in °C
* gt3On - Hot water on temperature in °C
* gt3Off - Hot water off temperature in °C
Response:
```json
{
"data": {
"name": "gt1",
"value": 30
},
"status":0
}
```
Status 0 means successful. If the request fails, it the status will be non-zero and data is empty.
## Set temperature value (POST /api/sensors)
Set the temperature target value in °C.
JSON parameter:
* name: Temperature name as string.
* gt3Target
* gt3On
* gt3Off
* value: Temperature value in °C as float.
Example:
```bash
$ curl -X POST -H "Content-Type: application/json" --data '{"name": "gt3Target", "value": 20.4}' http://192.168.1.3/api/sensors
```
Response:
```json
{ "status": 0 }
```
Status 0 means successful. If the request fails, it the status will be non-zero and data is empty.
## Send raw command (POST /api/debug)
Send a raw command to the heatpump controller for reverse engineering or debug purposes. Note, the response message comes back as string with hex numbers.
JSON parameter:
* cmdId: Rego6xx command id as integer.
* addr: Rego6xx register address.
* value: Rego6xx Register value.
Example:
```bash
$ curl -X POST -H "Content-Type: application/json" --data '{"cmdId": 2, "addr": 521, "value": 0 }' http://192.168.1.3/api/debug
```
Response:
```json
{
"data": {
"response": "8100022C2E"
},
"status": 0
}
```
## Get last error information (GET /api/lastError)
Get last error information from the heatpump.
Response:
```json
{
"data": {
"errorId": 22,
"log": "021009 18:21:03",
"description": "Varmetr. delta high"
},
"status": 0
}
```
## Get frontpanel LED state (GET /api/frontPanel/<led>)
Get state of frontpanel LED from the heatpump.
``````:
* power - Power LED
* pump - Pump LED
* heating - Heating LED
* boiler - Boiler LED
* alarm - Alarm LED
Response:
```json
{
"data": {
"name": "power",
"state": true
},
"status": 0
}
```
Status 0 means successful. If the request fails, it the status will be non-zero and data is empty.
## Get display content (GET /api/display/<row>)
Get display row content.
``````:
* Row id from 1 to 4.
Response:
```json
{
"data": {
"row": 1,
"display": "..."
},
"status": 0
}
```
Status 0 means successful. If the request fails, it the status will be non-zero and data is empty.
## Manipulate frontpanel keyboard and wheel (POST /api/frontPanel/<hmiDevice>)
Manipulate keyboard and wheel of the frontpanel like the user is in front of the heatpump.
``````:
* buttonL - Left button
* buttonM - Middle button
* buttonR - Right button
* wheelTL - Turn wheel left
* wheelTR - Turn wheel right
Example:
```bash
$ curl -X POST http://192.168.1.3/api/frontPanel/wheelTR
```
Response:
```json
{
"data": {
"name": "wheelTR"
},
"status": 0
}
```
# Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/Rego6xxSrv/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
# License
The whole source code is published under the [MIT license](http://choosealicense.com/licenses/mit/).
Consider the different licenses of the used third party libraries too!
# Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any
additional terms or conditions.