https://github.com/estevesegura/twitch-of-things
ToT - Twitch of things!
https://github.com/estevesegura/twitch-of-things
Last synced: 3 months ago
JSON representation
ToT - Twitch of things!
- Host: GitHub
- URL: https://github.com/estevesegura/twitch-of-things
- Owner: EsteveSegura
- License: mit
- Created: 2020-02-06T21:11:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-08T02:54:52.000Z (over 5 years ago)
- Last Synced: 2025-02-01T20:29:38.975Z (5 months ago)
- Language: Python
- Size: 5.86 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Twitch of Things( ToT ) It is a methodology to control arduino from twitch chat
Installation
|
Configuration
|
Usage
|
How does it work
## Installation
**NOTE**: Python 3.8.1 or higher is required.
```bash
# clone the repo
$ git clone https://github.com/EsteveSegura/twitch-of-things.git
# change the working directory to insta-growth
$ cd twitch-of-things/src/bot
# install Python if is not installed
# install the requirements
$ pip install -r requeriments.txt
```
## Configuration
Once we have installed our python project, we have to copy the code in ``src/arduino/demo.ino`` on our **arduino IDE** and send the code to the board
Now we have to go to the ``src/bot`` folder and open the ``config.py`` file and fill it with the credentials of our twitch bot and also the port on which our arduino runs.
```python
# config.py
TMI_TOKEN="oauth:xxxxxxxxxxxxxxxx"
CLIENT_ID="xxxxxxxxxxxxxxxx"
BOT_NICK="NICK_OF_THE_BOT"
BOT_PREFIX="!" #leave this like that
CHANNEL=["OUR_TWITCH_CHANNEL"]
COM_PORT="COM_PORT" #example "COM5"
```
## Usage
Being inside the ``src/bot`` folder, we simply have to run the python ``bot.py``
``` bash
$ cd src/bot
$ python bot.py
```
We can go to our **twitch chat** and write the following commands:
**!onled** : turns on the led
**!offled** : turns off the led
## How does it work
**ToT** uses the serial communication available on **USB** connections to create communication with our hardware. **ToT** gets all the chat messages from our **twitch** and interacts with **Arduino** when it receives certain commands.
**Being able to create hardware that will handle our twitch chat.**
## License
MIT © twitch-of-things