Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterdavehello/taipowertoslack
Fetch Taipower's "Power Information of Today", and send the information to your Slack channel
https://github.com/peterdavehello/taipowertoslack
bash demo hacktoberfest power script shellscript slack taipower taiwan webhook
Last synced: 4 days ago
JSON representation
Fetch Taipower's "Power Information of Today", and send the information to your Slack channel
- Host: GitHub
- URL: https://github.com/peterdavehello/taipowertoslack
- Owner: PeterDaveHello
- License: wtfpl
- Created: 2021-05-19T16:32:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-10T16:04:20.000Z (over 1 year ago)
- Last Synced: 2024-10-19T23:24:14.649Z (18 days ago)
- Topics: bash, demo, hacktoberfest, power, script, shellscript, slack, taipower, taiwan, webhook
- Language: Shell
- Homepage:
- Size: 51.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TaipowerToSlack
TaipowerToSlack is a tool that fetches the "Power Information of Today" from Taipower and sends the data to a designated Slack channel, allowing users to easily monitor Taiwan's power supply status.
Taipower's "Power Information of Today" page:
- English:
- Chinese:
Please note that this is primarily a shell script demo, with code that might be less elegant and some hard-coded values.
## Screenshots
Slack Screenshot:
Terminal Screenshot:
## Setup and Usage
### 1. Obtain your Slack Incoming Webhook URL
Refer to [Slack's Documentation](https://api.slack.com/messaging/webhooks) for details on how to obtain an Incoming Webhook URL for your Slack channel.
### 2. Clone this repository or download the script
Clone the repository:
```sh
git clone https://github.com/PeterDaveHello/TaipowerToSlack
```
Or, download the run.sh script directly, and make the run.sh script executable:
```sh
curl https://github.com/PeterDaveHello/TaipowerToSlack/raw/master/run.sh -o /path/to/TaipowerToSlack/run.sh
chmod +x /path/to/TaipowerToSlack/run.sh
```
### 3. Configure and execute the script
Navigate to the directory containing the `run.sh` script.
Set the `SLACK_HOOK` variable in the shell script, or pass it when running the script:
```sh
SLACK_HOOK=https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX ./run.sh
```
The result should be displayed on your Slack channel as shown in the screenshot.
### 4. Optional: Post to Slack only when the status changes
To enable this option, you can either set the `STATELESS` and `ONLY_POST_ON_STATUS_CHANGE` environment variables when running the script or modify them directly in the `run.sh` script:
- Pass the variables when running the script:
```sh
STATELESS=false ONLY_POST_ON_STATUS_CHANGE=true ./run.sh
```
- Or modify the `run.sh` script:
```sh
STATELESS="false"
ONLY_POST_ON_STATUS_CHANGE="true"
```
With either configuration, the script will use the file `~/.taipower.status` to store the status and only post a message to Slack when the status changes.
## Dependencies
- `jq`: for parsing JSON data
- `curl`: for fetching JSON data from the Taipower API
- `bash`: for running the shell script
- `mktemp`: for creating temporary files
- `bc`: for calculating percentages from data
If any of these tools are missing, you can usually install them using your system's package manager (e.g., `apt`, `yum`, or `pacman`).
## License
This project is released under the [WTFPL v2 license](https://choosealicense.com/licenses/wtfpl/).