| Name | juham JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Juha's Ultimate Home Automation Masterpiece |
| upload_time | 2024-12-30 08:58:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | 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. ** |
| keywords |
home
automation
juham
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Welcome to Juham™ - Juha's Ultimate Home Automation Masterpiece
===============================================================
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 actively developing it to reach that goal!
Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
Goals
-----
The aim of Juham™ is to develop a robust home automation framework capable of controlling all the devices
in my home, with the potential to be adapted for other homes as well.
Getting Started
---------------
### Installation
1. Install Juham™ core functionality:
.. code-block:: bash
pip install juham
This will install the basic framework needed to get started.
2. Explore the available features and install any additional modules you require. For example, to add weather
forecasting plugins:
.. code-block:: bash
pip install juham_visualcrossing
pip install juham_openweathermap
3. Set up **InfluxDB 3.0** and **Grafana Cloud**.
These services are optional, but I strongly recommend using them to monitor your home remotely. Juham™
can function without them, but visualizing and recording data greatly enhances the system's capabilities.
4. Configure Juham™. This involves a two-step process:
**Step 1:** Initialize the configuration by running:
.. code-block:: bash
juham --init
This will generate JSON configuration files in your home directory at ``~/.juham/config/*``.
**Step 2:** Edit the following configuration files to fit your setup:
- ``Base.json``: Provide your MQTT host and port information.
- ``JDatabase.json``: Enter your InfluxDB account details.
- ``RVisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
- ``Shelly*.json``: If you have Shelly devices, configure them here.
5. Perform a test run of Juham™ without the ``--init`` argument to check for any errors:
.. code-block:: bash
juham
6. If the system runs smoothly, you can set up ``juham`` as a service to run continuously.
Tailoring to Your Home
----------------------
Every home is unique, and Juham™ serves as a customizable starting point for building your own home automation system.
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!
Raw data
{
"_id": null,
"home_page": null,
"name": "juham",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"J. Meskanen\" <juham.api@gmail.com>",
"keywords": "home, automation, juham",
"author": null,
"author_email": "J Meskanen <juham.api@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e9/c2/9065f8d97cd125fbf1d179a98c04baecb5680a745dbace200f1868e8cb54/juham-0.1.5.tar.gz",
"platform": null,
"description": "Welcome to Juham\u2122 - Juha's Ultimate Home Automation Masterpiece\r\n===============================================================\r\n\r\nProject Status\r\n--------------\r\n\r\n**Current State**: **Pre-Alpha (Status 2)** \r\n\r\nIn its current form, Juham\u2122 may still resemble more of a home automation experiment (or even a \"mess\") than \r\na \"masterpiece,\" but I'm actively developing it to reach that goal!\r\n\r\nPlease check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.\r\n\r\n\r\nGoals\r\n-----\r\n\r\nThe aim of Juham\u2122 is to develop a robust home automation framework capable of controlling all the devices \r\nin my home, with the potential to be adapted for other homes as well.\r\n\r\n\r\nGetting Started\r\n---------------\r\n\r\n### Installation\r\n\r\n1. Install Juham\u2122 core functionality:\r\n\r\n .. code-block:: bash\r\n\r\n pip install juham\r\n\r\n This will install the basic framework needed to get started.\r\n\r\n2. Explore the available features and install any additional modules you require. For example, to add weather \r\n forecasting plugins:\r\n\r\n .. code-block:: bash\r\n\r\n pip install juham_visualcrossing\r\n pip install juham_openweathermap\r\n\r\n3. Set up **InfluxDB 3.0** and **Grafana Cloud**. \r\n These services are optional, but I strongly recommend using them to monitor your home remotely. Juham\u2122 \r\n can function without them, but visualizing and recording data greatly enhances the system's capabilities.\r\n\r\n4. Configure Juham\u2122. This involves a two-step process:\r\n\r\n **Step 1:** Initialize the configuration by running:\r\n\r\n .. code-block:: bash\r\n\r\n juham --init\r\n\r\n This will generate JSON configuration files in your home directory at ``~/.juham/config/*``.\r\n\r\n **Step 2:** Edit the following configuration files to fit your setup:\r\n\r\n - ``Base.json``: Provide your MQTT host and port information.\r\n - ``JDatabase.json``: Enter your InfluxDB account details.\r\n - ``RVisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.\r\n - ``Shelly*.json``: If you have Shelly devices, configure them here.\r\n\r\n5. Perform a test run of Juham\u2122 without the ``--init`` argument to check for any errors:\r\n\r\n .. code-block:: bash\r\n\r\n juham\r\n\r\n6. If the system runs smoothly, you can set up ``juham`` as a service to run continuously.\r\n\r\n\r\nTailoring to Your Home\r\n----------------------\r\n\r\nEvery home is unique, and Juham\u2122 serves as a customizable starting point for building your own home automation system.\r\n\r\n\r\nSpecial Thanks\r\n--------------\r\n\r\nThis project would not have been possible without the generous support of two exceptional \r\nindividuals: my friend, **Teppo K.**, and my son, **Mahi**. \r\n\r\n- 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.\r\n- My son Mahi has been instrumental in translating my ideas into Python code, offering invaluable support and encouragement throughout the development process.\r\n\r\nI am deeply grateful to both of you \u2014 thank you!\r\n",
"bugtrack_url": null,
"license": "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. ** ",
"summary": "Juha's Ultimate Home Automation Masterpiece",
"version": "0.1.5",
"project_urls": {
"Bug Reports": "https://meskanen.com",
"Funding": "https://meskanen.com",
"Homepage": "https://meskanen.com",
"Say Thanks!": "http://meskanen.com",
"Source": "https://meskanen.com"
},
"split_keywords": [
"home",
" automation",
" juham"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27ed6b6b88653f1372c30de2a3f791411674e2526bcd16d09fcd472e9e2c468a",
"md5": "d8310d21c8f48f1dcc77cc501f1a5da5",
"sha256": "e907ac68ac2e7b31fd26f971c608cc9fb403431cde8c1c2708759e51d68a9d6f"
},
"downloads": -1,
"filename": "juham-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8310d21c8f48f1dcc77cc501f1a5da5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 53758,
"upload_time": "2024-12-30T08:58:06",
"upload_time_iso_8601": "2024-12-30T08:58:06.970726Z",
"url": "https://files.pythonhosted.org/packages/27/ed/6b6b88653f1372c30de2a3f791411674e2526bcd16d09fcd472e9e2c468a/juham-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9c29065f8d97cd125fbf1d179a98c04baecb5680a745dbace200f1868e8cb54",
"md5": "cfab7adeac05ed98de8c7d0b77d49814",
"sha256": "156e91fbcf5d610a5159cc72084abf0fcd1b8651f677d0ec4219752d65d80fe6"
},
"downloads": -1,
"filename": "juham-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "cfab7adeac05ed98de8c7d0b77d49814",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 43268,
"upload_time": "2024-12-30T08:58:09",
"upload_time_iso_8601": "2024-12-30T08:58:09.211194Z",
"url": "https://files.pythonhosted.org/packages/e9/c2/9065f8d97cd125fbf1d179a98c04baecb5680a745dbace200f1868e8cb54/juham-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-30 08:58:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "juham"
}
