Welcome to Juham™ documentation!¶

Welcome to Juham™ - Juha’s Ultimate Home Automation Masterpiece¶
Description¶
Juham
extend the functionality of Masterpiece
object by adding capabilities for MQTT
communication and integration with time series databases. The base class provides only a minimal
set of interfaces. Actual features, such as MQTT and time series database implementations — along with home
automation-specific functionalities — are provided through separate plugin modules built on Juham
class.
Project Status¶
Current State: Pre-Alpha (Status 2)
In its current form, Juham™ may still resemble more of a home automation experiment (or even a “mess”) than a “masterpiece,” but I’m working hard to reach that goal!
Goals¶
The aim of Juham™ is to have fun by learning Python and GitLab ecosystems, by developing a home automation framework capable of controlling all the devices in my home, with the potential to be adapted for other homes as well.
Special Thanks¶
This project would not have been possible without the generous support of two exceptional individuals: my friend, Teppo K., and my son, Mahi.
Teppo provided the initial spark for this project by donating a Raspberry Pi, a temperature sensor, and an inspiring demonstration of his own home automation system.
My son Mahi has been instrumental in translating my ideas into Python code, offering invaluable support and encouragement throughout the development process.
I am deeply grateful to both of you — thank you!
LICENSE¶
Copyright (c) 2024, Juha Meskanen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
** 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. **
Contributing to Juham™ - Juha’s Ultimate Home Automation Masterpiece¶
Thank You!¶
Thank you in advance for your forthcoming contributions, whether they are bug fixes, documentation improvements, entirely new features, or simply feedback. Your efforts will be highly appreciated and will help turn this project from its current mission state into an actual masterpiece.
Design Patterns¶
Please read the developer documentation and understand the few design patterns behind Juham™ before contributing. This will help ensure that your contributions align with the project’s design and goals. .. todo:: (okay, the documentation is currently lacking many essential chapters, add.)
Code Formatting¶
To help maintain consistent code formatting across different developers, we use ‘black’ python formatter, by Microsoft.
Strange, the formatter doesn’t seem to format that much, it doesn’t organize imports, doesn’t adjust docstring lenghts .. todo:: most likely I don’t know how to use it properly, read the docs.
Using Emacs and Makefile¶
Despite my attempts to fall in love with Eclipse, VSCode and other IDEs, I still find Emacs and Makefile the best tools for many workflows. So there is a Makefile in the root folder. For those old dogs who are like me
make help
More Stuff¶
Todo
TBA
Changelog¶
[0.0.1] - January, 25 2025¶
Initial release:
Juham
base class with MQTT and Timeseries abstraction.
TODOs for Juham™¶
An exceptionally well structured and priorized list of TODOs for Juham™
Automation¶
- [_] Feature to optimize the balance between solar power production and electricity consumption to minimize costs
associated with electricity transmission.
[_] Support for the current 1-Hour, and the forthcoming 15-Minute Imbalance Settlement Period
[_] Bought five small solar panel elements, capable to produce electricity up to 5 volts. This could be used as a real time solar radiation sensor with Shelly Plus 1 wifi relay.
Design¶
[_] Support for MQTT password, encrypted in the .json configuration file, for security.
[_] Simulation classes for essential data sources, for development, testing, and demonstration purposes.
Documentation¶
[_] Design and integrate a distinctive and highly professional Juham™ look with an outstanding logo and other graphics.
Testing¶
[_] Write unit tests for all classes
[_] Mocking (e.g. unittest.mock?)
Inline TODO¶
The following items have been extraced from the source code:
Todo
TBA
(The original entry is located in ../CONTRIBUTING.rst, line 43.)