https://github.com/mountaingod2/stripalerts
API event controlled LED animations.
https://github.com/mountaingod2/stripalerts
Last synced: about 2 months ago
JSON representation
API event controlled LED animations.
- Host: GitHub
- URL: https://github.com/mountaingod2/stripalerts
- Owner: MountainGod2
- License: mit
- Created: 2023-12-16T01:23:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-17T01:31:30.000Z (over 1 year ago)
- Last Synced: 2025-02-13T03:29:54.464Z (4 months ago)
- Language: Python
- Size: 4.01 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StripAlerts - LED Alerts for Chaturbate Events
This Python script integrates with the Chaturbate Events API to process tip events, controlling an LED strip to display visual alerts.
It defaults to a rainbow background animation and a sparkle alert for all tips and allows users to set the color of the lights for a
preset length of time by tipping a certain value of tokens with a tip message containing a color from the list.
## Key Features
- **Event Polling:** Real-time polling of the Chaturbate Events API for the latest tip events.
- **Dynamic Tip Processing:** Responds to tipping events with customizable LED animations.
- **Advanced LED Control:** Manages LED strips for a variety of animations and colors.
- **Color-Specific Alerts:** Set up alerts that react to specific user messages with designated colors.
- **User-Friendly Customization:** Easy-to-configure settings for alert types, duration, LED brightness, and more.
## Getting Started
### Prerequisites
- Python 3.x: [Download Python](https://www.python.org/downloads/)
- Libraries: `aiohttp`, `adafruit_led_animation`, `dotenv` , etc. (See `requirements.txt`)
### Installation
1. **Clone the Repository:**
```bash
git clone https://github.com/MountainGod2/stripalerts.git
```
2. **Install Dependencies:**
Navigate to the cloned directory and run:
```bash
pip install -r requirements.txt
```
### Configuration
- Create a `.env` file in the root directory with the following variables or use `webui.py`:
```
USERNAME=YourChaturbateAPIUsername
TOKEN=YourChaturbateAPIToken
BASE_URL=https://events.testbed.cb.dev/events/
LED_PIN=D18
LED_COUNT=100
LED_BRIGHTNESS=0.1
COLOR_ALERT_TOKENS=35
COLOR_DURATION=600
ALERT_DURATION=3
```
### Customizing LED Settings
Modify the settings in the `.env` file to match your connected LED strip and user preferences.
### Usage
1. Run the script:
```bash
python main.py
```
2. Observe the LED strip responding to Chaturbate events.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [Chaturbate Events API](https://chaturbate.com/) for providing the event data.
- [Adafruit](https://www.adafruit.com/) for the fantastic LED animation library.
- [ChatGPT](https://chat.openai.com/) for creating 90% of this program (README.md included), and for letting me pretend I know Python.