Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/floofies/goosebelt
SMS alerting agent for IT WatchDogs MicroGoose which alerts via the TextBelt API.
https://github.com/floofies/goosebelt
climate-monitoring itwatchdogs microgoose monitoring-alerts monitoring-service sms textbelt work-in-progress
Last synced: 22 days ago
JSON representation
SMS alerting agent for IT WatchDogs MicroGoose which alerts via the TextBelt API.
- Host: GitHub
- URL: https://github.com/floofies/goosebelt
- Owner: Floofies
- License: mit
- Created: 2021-10-30T00:46:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T10:14:37.000Z (10 months ago)
- Last Synced: 2024-02-23T11:28:47.606Z (10 months ago)
- Topics: climate-monitoring, itwatchdogs, microgoose, monitoring-alerts, monitoring-service, sms, textbelt, work-in-progress
- Language: JavaScript
- Homepage: https://textbelt.com
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Goose Belt
>"Honk softly and carry a big cellphone; your servers will go far."
> - President Theodore Goosevelt
HTTP based SMS alert agent for ITWatchDogs' MicroGoose Climate Monitor device. Sends alerts via the TextBelt REST API: https://textbelt.com
## How-To
To use this software, you must supply a TextBelt API key and a valid 10-digit phone number. See *Environment Variables*
The MicroGoose is unauthenticated because it publicly exposes sensor and alarm data as XML via HTTP at `/data.xml`
It is reccomended to use Goose Belt with an init system (systemd) or process manager (pm2).
### Environment Variables
Two environment variables are required:
- `smsKey` is your TextBelt REST API key.
- `smsNum` is the 10-digit phone number you would like to send alerts to.
### Command-Line Interface
`gbelt` is Goose Belt's CLI-based management script, which can be used to add and remove devices to be monitored.
To use `gbelt` ensure that the NPM package is installed globally by using `-g`.
Using `gbelt add `, you can add the nickname and hostname/IP-address of the device(s) to be monitored (polled via HTTP).
A nickname is also useful to differentiate multiple MicroGoose devices, and it is included in the SMS.
*Add a MicroGoose:*
```shell
$ gbelt add MyGoose 192.168.123.123
```
*Remove a MicroGoose:*
```shell
$ gbelt remove 192.168.123.123
```
*Set the HTTP polling rate in seconds:*
```shell
$ gbelt poll 300
```
*List all connected devices:*
```shell
$ gbelt list
```
*Start Goose Belt in your TTY:*
```shell
$ gbelt start
```