martin/aqhomecontrol
Public Access
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

work on documentation.

Browse Source
This commit is contained in:
Martin Preuss
2026-03-16 18:03:13 +01:00
parent 1813c9e09e
commit d688cd3d26
1 changed files with 32 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -1,10 +1,39 @@
# Aquamaniac Home Control System (AqHCS) # Aquamaniac Home Control System (AqHCS)
## Quickstart
### Prerequisites
To compile the project the following software needs to be installed:
- gwenhywfar (general purpose library, also containing some development tools)
- avrasm (Opensource avr assembler)
- gcc (GNU C compiler)
### Building
- download and unpack this project
- cd into the main folder
- create a build folder (e.g. "mkdir build")
- cd into that "build" folder
- configure package for building ("gwbuild -s ../")
- build autogenerated files ("gwbuild -p" and "gwbuild -Btm2builder")
- build project ("gwbuild -j NUM_OF_CPUS")
- install project ("sudo gwbuild -i")
## Overview ## Overview
Home automation/control system consists of multiple parts: See https://gitea.aqbanking.de/martin/aqhome/wiki for more information (in German).
The Aquamaniac Home automation/control system consists of multiple parts:
- nodes - nodes
- small PCBs with AVR microcontrollers, for now:
- AtTiny84
- AtTiny85
- AtTiny841
- AtMega644
- decentralized, nodes just broadcast measured data over a two-wire - decentralized, nodes just broadcast measured data over a two-wire
communication network (clock/data), addresses are auto-assigned, no prior communication network (clock/data), addresses are auto-assigned, no prior
setup necessary, no central bottleneck or single point of failure setup necessary, no central bottleneck or single point of failure
@@ -12,11 +41,6 @@ Home automation/control system consists of multiple parts:
- environmental measuring (temperature, humidty, CO2 and others) - environmental measuring (temperature, humidty, CO2 and others)
- motion detection, door/window sensors - motion detection, door/window sensors
- LED strip controllers - LED strip controllers
- small PCBs based on AVR microcontrollers
- AtTiny84
- AtTiny85
- AtTiny841
- AtMega644
- modular operating system written in AVR assembler - modular operating system written in AVR assembler
- event-driven GUI - event-driven GUI
- driver modules for busses: - driver modules for busses:
@@ -24,12 +48,13 @@ Home automation/control system consists of multiple parts:
- two-wire-bus - two-wire-bus
- SPI bus - SPI bus
- UART - UART
- driver modules for devices/sensors: - driver modules for devices/sensors (incomplete list):
- DS18b20 sensors for temperature measurement - DS18b20 sensors for temperature measurement
- SI7021 sensors for temperature and humidity measurement - SI7021 sensors for temperature and humidity measurement
- SGP_30 sensors for air quality measurement - SGP_30 sensors for air quality measurement
- ccs811 sensors for air quality measurement - ccs811 sensors for air quality measurement
- SK6812 LED driver - SK6812 LED driver
- ds3231 realtime clock module
- I2C displays (work-in-progress) - I2C displays (work-in-progress)
- SPI displays (work-in-progress) - SPI displays (work-in-progress)