| Name | hirsh JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | Resilient monitoring system that detects utility outages in unreliable environments (e.g. IoT, RaspberryPi, etc) |
| upload_time | 2022-12-12 19:59:10 |
| maintainer | |
| docs_url | None |
| author | Roman Glushko |
| requires_python | >=3.9,<4.0 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Hirsh
📟 Resilient monitoring system that detects utility outages in unreliable environments (e.g. IoT, RaspberryPi, etc).
Hirsh is designed and optimized for:
- 💪 residency, robustness and self-healing
- 📟 running in resource-constrained IoT-like unstable environments
## Maturity
The project is in early MVP state.
It's being actively tested using my RaspberryPi Zero 2W under the current unstable Ukrainian infrastructure conditions.
## Setups
Hirsh can be executed in any IoT device or board computer that supports Linux-like OS and Python 3.9+.
- [Only Supported] Basic: The basic setup includes just the device.
The device is plugged into the main electricity circuit/outlet along with a router that provides network connection for the device.
- UPS: TBU
## Monitors
In theory, you can track any utilities your home has (e.g. electricity, network, gas, water, etc.).
However, in practice it's the easiest to track:
- network connection [Only Supported]
- electricity supply
## How does it work?
TBU
## Notifications
### Telegram
The primary way to notify you about outages is via [Telegram bot](https://core.telegram.org/bots).
You need to create [a new bot](https://t.me/BotFather) and add it to a group or a channel.
## References
### Similar Projects
- https://github.com/fabytm/Outage-Detector
- https://github.com/nestukh/rpi-powerfail
- https://www.kc4rcr.com/power-outage-notification/
- https://homediyelectronics.com/projects/raspberrypi/poweroffdelay/powerfail
- https://projects-raspberry.com/power-outage-sensor/
- https://raspberrypi.stackexchange.com/questions/13538/raspberry-pi-to-email-when-power-outage-occurs
### Python + RPi
- https://medium.com/geekculture/gpio-programming-on-the-raspberry-pi-python-libraries-e12af7e0a812
### AsyncIO and RPi
- https://github.com/PierreRust/apigpio
- https://beenje.github.io/blog/posts/experimenting-with-asyncio-on-a-raspberry-pi/
- https://www.digikey.bg/en/maker/projects/getting-started-with-asyncio-in-micropython-raspberry-pi-pico/110b4243a2f544b6af60411a85f0437c
- https://docs.micropython.org/en/latest/library/uasyncio.html
### Deployment
- https://github.com/beenje/legomac
Raw data
{
"_id": null,
"home_page": "",
"name": "hirsh",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Roman Glushko",
"author_email": "roman.glushko.m@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/37/3e/16a32b642ec4681c312d83691265201eda779b4c8506f7d97fa4b57c54fa/hirsh-0.0.2.tar.gz",
"platform": null,
"description": "# Hirsh\n\n\ud83d\udcdf Resilient monitoring system that detects utility outages in unreliable environments (e.g. IoT, RaspberryPi, etc).\n\nHirsh is designed and optimized for:\n\n- \ud83d\udcaa residency, robustness and self-healing \n- \ud83d\udcdf running in resource-constrained IoT-like unstable environments\n\n## Maturity\n\nThe project is in early MVP state. \n\nIt's being actively tested using my RaspberryPi Zero 2W under the current unstable Ukrainian infrastructure conditions.\n\n## Setups\n\nHirsh can be executed in any IoT device or board computer that supports Linux-like OS and Python 3.9+.\n\n- [Only Supported] Basic: The basic setup includes just the device.\n The device is plugged into the main electricity circuit/outlet along with a router that provides network connection for the device.\n- UPS: TBU\n\n## Monitors\n\nIn theory, you can track any utilities your home has (e.g. electricity, network, gas, water, etc.). \nHowever, in practice it's the easiest to track:\n\n- network connection [Only Supported]\n- electricity supply\n\n## How does it work?\n\nTBU\n\n## Notifications\n\n### Telegram\n\nThe primary way to notify you about outages is via [Telegram bot](https://core.telegram.org/bots).\nYou need to create [a new bot](https://t.me/BotFather) and add it to a group or a channel.\n\n## References\n\n### Similar Projects\n\n- https://github.com/fabytm/Outage-Detector\n- https://github.com/nestukh/rpi-powerfail\n- https://www.kc4rcr.com/power-outage-notification/\n- https://homediyelectronics.com/projects/raspberrypi/poweroffdelay/powerfail\n- https://projects-raspberry.com/power-outage-sensor/\n- https://raspberrypi.stackexchange.com/questions/13538/raspberry-pi-to-email-when-power-outage-occurs\n\n### Python + RPi\n\n- https://medium.com/geekculture/gpio-programming-on-the-raspberry-pi-python-libraries-e12af7e0a812\n\n### AsyncIO and RPi\n\n- https://github.com/PierreRust/apigpio\n- https://beenje.github.io/blog/posts/experimenting-with-asyncio-on-a-raspberry-pi/\n- https://www.digikey.bg/en/maker/projects/getting-started-with-asyncio-in-micropython-raspberry-pi-pico/110b4243a2f544b6af60411a85f0437c\n- https://docs.micropython.org/en/latest/library/uasyncio.html\n\n### Deployment\n\n- https://github.com/beenje/legomac",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Resilient monitoring system that detects utility outages in unreliable environments (e.g. IoT, RaspberryPi, etc)",
"version": "0.0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8dd5eb742c5a1e3702dcfd334f16b11d",
"sha256": "bdb1dbcb2f0d3e8c5c807376fd27c332ddaf92836cb17f0d48b26dfdd9ee730f"
},
"downloads": -1,
"filename": "hirsh-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8dd5eb742c5a1e3702dcfd334f16b11d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 16747,
"upload_time": "2022-12-12T19:59:08",
"upload_time_iso_8601": "2022-12-12T19:59:08.548837Z",
"url": "https://files.pythonhosted.org/packages/2d/ab/784329454130db4bb26e6d760a1d59a9a9c2674c4208fd4681f037932e3b/hirsh-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "948451a8043272d1b5da873bd090a19b",
"sha256": "13399b9b717d86754cfb056e20f04c85db8fa33d6517e29254a85249dccb14d5"
},
"downloads": -1,
"filename": "hirsh-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "948451a8043272d1b5da873bd090a19b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 19591,
"upload_time": "2022-12-12T19:59:10",
"upload_time_iso_8601": "2022-12-12T19:59:10.497451Z",
"url": "https://files.pythonhosted.org/packages/37/3e/16a32b642ec4681c312d83691265201eda779b4c8506f7d97fa4b57c54fa/hirsh-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-12 19:59:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "hirsh"
}
