A Full Smart Home System and Associated IOT Devices
Each device has its own README. Click the links to read more.
ESP32 Air Quality Station and ESP Dashboard:
Main Case and Arduino Blinds Controller:
ESP Weather Station and Arduino Modular Controller:
This section covers the installation of the central smart-home-server (hereto called "the server"). For a full parts list and physical assembly see: Main Case Readme.md
The server runs RaspberryPi OS Lite, it has only been tested on a RaspberryPi 4B. I'd recommend using rpi-imager for creating the image as it lets you setup WiFi, SSH, etc, for an easier experience.
-
Flash an SD card with RaspberryPi OS Lite using rpi-imager, edit the settings to configure your user, WiFi, ssh, and other settings
-
Boot up the server and let it connect to wifi, in your router set a static IP address for the server
-
Reboot the server and connect to it over ssh
-
Ensure a USB stick is connected to the Pi and run:
sudo apt install -y git && git clone https://github.com/PrinceOfPuppers/smart-home-server.git && cd smart-home-server && ./install.sh
- The Installer will prompt you to select the usb stick from a list (will likley be the only one), after it is finished the server will be ready to go and accessable at its static ip address.
Note: The installer script enables read only file system, this makes the SD card readonly but still allows writing to the USB stick. You can disable this and re-enable it using sudo raspi-config
The smart-home-server (hereto called "the server") is a device for collecting data and controlling IOT devices (hereto called "devices"). The server runs a full web interface for easy control on mobile or desktop.
The server's functionality is best understood through two categories, Jobs and Macros and Datasources.
Jobs are things the server can do, they include:
- Transmitting RF signals (for controlling RF outlets and relays)
- Sending HTTP requests
- Updating remote LCD Dashboard formats (see LCDs page)
- Running Job Macros
- Updating the server
- And more
Jobs can be organized into macros and setup to trigger in on RF signals, button presses on the server's case, or manually through the web page.
Jobs and macros can also be run using a scheduler (i.e. turn off the lights at 11pm) or can be triggered on conditions (i.e. turn on the humidifier whenever relative humidity is below 35%). See the Schedule and Trigger pages for more details.
Macros can also include delays and other macros.
Here is an example of a simple nighttime macro:
This macro turns off all the lights, turns off a loud air filter in the bedroom, waits for 8h30min, prevents you from oversleeping by turning on the bedroom light, and then turns everything in the bedroom off after 30 more minutes.
This macro could be hooked up to an RF button outside the bedroom to be run without having to open the web app (how I do it).
The macros like bedroom on/off would be replaced with single RF switching jobs, i.e.) press bedroom ch: 1 on, for the example macros where used so they could be labeled.
The server collects data from datasources with a set polling period. The data can then be used to:
- Trigger server Jobs on conditions
- Displayed on the Dashboard
- Create Graphs
- Displayed on local and remote LCDs
Examples of each Application:
Datasources can be added and changed on the Datasources tab if they fit into one of the existing types:
Forex: currency converstionClock: tells timeAQ: air quality, temprature and humidity stationTempHumid: temprature and humidity stationWeatherImage: current weather with ascii art imageWeatherCurrent: current weather simple representationForcast: long term forcast chartErrors: log of errors in the smart homeJobLog: log of run jobsRfLog: log of rf rx/txVersion: smart home version
New Datasource Form (left). Edit existing Datasource Form (right):
Each Datasource can be displayed in the Dashboard and provides values that can be consumed by Job Triggers, Graphs and LCDs
New types of Datasources can be added here, by:
- Creating a new subclass of
Datasource(use an existing one as a base), Any required arguments should be annotated so they appear correctly in theDatasourceform - Adding a
localfunction which returns{ 'str': '...', 'data':{...} }wherestris shown in dashboard anddatacontains the values used by triggers, graphs and etc (this function is polled to get the data). - Adding a
valuesproperty which specifies what fields indataare relevant and what they should be called - Set a sane default polling period, although this is editable in the datasource form
A page for displaying desired datasources in an easy to read way, clicking on the name tag will refresh its information. Each datasource can be customized with buttons to hide its contents, colored name tags, buttons to make HTTP requests, and more.
A page to create, display and edit notes.
A page to add and update local and remote LCD dashboards.
LCDs display formatted text containing datasources, i.e. {clock} 123 will be replaced with 02:03 PM 123 and will be updated every minute when the {clock} changes. This format is set on the LCD page, a list of all formats is provided under Cheat Sheet. Numbers can be rounded like so: {temp:.0f} for 0 decimal places or {temp:.1f} for 1 decimal place.
Each LCD has its own number (0 for local and 1 or more for remote), upon power up the LCDs will reach out to the server to connect, after which the server will send updates whenever the text changes.
A page for using, adding and editing RF remotes. The server contains an RF receiver to copy existing remotes which can then hook into the server's job system, in addition to directly using the copied remote from this page.
Each remote can be named, and additional buttons can be added using the forms at the bottom of the page.
A page for triggering jobs and macros repeatedly on a schedule. The server can be setup to run a job on an interval or at a specific time every day or week, for example turn on the Christmas lights at 5pm every day and turn them off at 5am every day.
A page for triggering jobs and macros on conditions involving datasources. The server can be setup to run a job whenever a condition is met, for example whenever humidity is over 30%. comparisons can be made between two datasources as well, for example if you have 2 temperature sensors in different rooms, you can trigger a fan to turn on if room A temp is less than room B temp.
Note the condition is denounced, so it will only trigger once until the condition is no longer met. Using the humidity example, going below 30% will trigger the condition, but it will not trigger again until humidity goes above 30% and then below 30% again. This is to prevent spamming.
A page for combining jobs (and macros) into macros, macros can include jobs, delays and other macros to allow the easy triggering of complex tasks manually, on schedules or using the trigger system. See the jobs and macro section for examples.
A page for creating plots of datasources over time. New graphs can be created by selecting a datasource, a color, and a time interval to plot over. All the plots are created server side and served as an image so they can be easily saved. Clicking on the plots name or refreshing the page will update it.
If an Atmega16u2 Monitor is connected, you can press the Monitor button to push it to the screen where it will be updated whenever new data is added.
