# raspimonitor
Monitoring and alerting to your Discord server for your RaspberryPi
## Installation
You will need to set up a Discord server and webhook, see
how [here](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks).
After that, proceed to install the package in your raspberry:
```bash
pip3 install raspimonitor
```
## Usage
### Direct usage
```bash
# raspimonitor YOURHOOKHERE THRESHOLD_TEMP_IN_CELSIUS
# Example
raspimonitor http://your.web.hook.here 45
# Example temp as float:
raspimonitor http://your.web.hook.here 45.6
```
### As a cron job
Add your cron job as a script from above:
```bash
# 1. Open cron file
crontab -e
# 2. Add a cron
# Example - run every minute:
* * * * * raspimonitor http://your.web.hook.here 45
# Example - run every 5 minutes
*/5 * * * * raspimonitor http://your.web.hook.here 45
# 3. Reload cron service
sudo service cron reload
```
Ref. https://superuser.com/questions/232144/how-to-stop-a-currently-running-cron-job
## Contributing
Pull requests and issues are welcome.
## License
[MIT](https://choosealicense.com/licenses/mit/) - [License file](LICENSE)
## Obtained inspiration from
- https://github.com/git-ogawa/raspi-statmon/blob/main/src/rstatmon/statdata.py
- https://github.com/mityax/rpi-temperature-alert/tree/master
- https://www.howtogeek.com/discord-slack-alert-raspberry-pi-too-hot/
Raw data
{
"_id": null,
"home_page": null,
"name": "raspimonitor",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9.0",
"maintainer_email": null,
"keywords": "raspberry, raspberrypi, pi, monitor",
"author": "w0rmr1d3r",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/eb/99/8c25aa68ace2a2f58a2db44daaf66bf6cc312f4fdb084938ad56656c978a/raspimonitor-0.0.2.tar.gz",
"platform": null,
"description": "# raspimonitor\n\nMonitoring and alerting to your Discord server for your RaspberryPi\n\n## Installation\n\nYou will need to set up a Discord server and webhook, see\nhow [here](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks).\nAfter that, proceed to install the package in your raspberry:\n\n```bash\npip3 install raspimonitor\n```\n\n## Usage\n\n### Direct usage\n\n```bash\n# raspimonitor YOURHOOKHERE THRESHOLD_TEMP_IN_CELSIUS\n# Example\nraspimonitor http://your.web.hook.here 45\n# Example temp as float:\nraspimonitor http://your.web.hook.here 45.6\n```\n\n### As a cron job\n\nAdd your cron job as a script from above:\n\n```bash\n# 1. Open cron file\ncrontab -e\n# 2. Add a cron\n# Example - run every minute:\n* * * * * raspimonitor http://your.web.hook.here 45\n# Example - run every 5 minutes\n*/5 * * * * raspimonitor http://your.web.hook.here 45\n# 3. Reload cron service\nsudo service cron reload\n```\n\nRef. https://superuser.com/questions/232144/how-to-stop-a-currently-running-cron-job\n\n## Contributing\n\nPull requests and issues are welcome.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/) - [License file](LICENSE)\n\n## Obtained inspiration from\n\n- https://github.com/git-ogawa/raspi-statmon/blob/main/src/rstatmon/statdata.py\n- https://github.com/mityax/rpi-temperature-alert/tree/master\n- https://www.howtogeek.com/discord-slack-alert-raspberry-pi-too-hot/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Monitoring and alerting for your RaspberryPi",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/w0rmr1d3r/raspimonitor/issues",
"Changelog": "https://github.com/w0rmr1d3r/raspimonitor/releases",
"Documentation": "https://github.com/w0rmr1d3r/raspimonitor",
"Funding": "https://github.com/sponsors/w0rmr1d3r",
"Homepage": "https://github.com/w0rmr1d3r/raspimonitor",
"Repository": "https://github.com/w0rmr1d3r/raspimonitor"
},
"split_keywords": [
"raspberry",
" raspberrypi",
" pi",
" monitor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c790c1f723907381fbefa5ebf298d30e75d709a667fea4ba35275b6503a522d1",
"md5": "225f9773dba89c329384d3a4cba48894",
"sha256": "766eeaaae27874be9e8c799006c5a2c566b2fe1ab1ecfa655874f6f3b10e247e"
},
"downloads": -1,
"filename": "raspimonitor-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "225f9773dba89c329384d3a4cba48894",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.9.0",
"size": 4348,
"upload_time": "2024-05-01T10:17:51",
"upload_time_iso_8601": "2024-05-01T10:17:51.968490Z",
"url": "https://files.pythonhosted.org/packages/c7/90/c1f723907381fbefa5ebf298d30e75d709a667fea4ba35275b6503a522d1/raspimonitor-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb998c25aa68ace2a2f58a2db44daaf66bf6cc312f4fdb084938ad56656c978a",
"md5": "3afcd34d24913ca0f59dcd21399ce0cb",
"sha256": "3543b9abf0657e1dcd7bee73825f817bcb7f61885f3056d08418d1d3480342b8"
},
"downloads": -1,
"filename": "raspimonitor-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3afcd34d24913ca0f59dcd21399ce0cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9.0",
"size": 4315,
"upload_time": "2024-05-01T10:17:53",
"upload_time_iso_8601": "2024-05-01T10:17:53.350932Z",
"url": "https://files.pythonhosted.org/packages/eb/99/8c25aa68ace2a2f58a2db44daaf66bf6cc312f4fdb084938ad56656c978a/raspimonitor-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 10:17:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "w0rmr1d3r",
"github_project": "raspimonitor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "raspimonitor"
}
JSON
