WaterBot

WaterBot - Discord GPIO Controller for Raspberry Pi

WaterBot is a versatile Python bot designed to facilitate remote control of GPIO pins on a Raspberry Pi Zero W via Discord. It leverages OpenAI's capabilities and can only respond to messages from a specified Discord channel, ensuring secure and controlled interaction.

Key Features

• Remote GPIO Control: Effortlessly manage GPIO pins from anywhere using Discord.
• Channel-Specific Interaction: The bot is configured to respond exclusively to messages from a designated Discord channel, enhancing security and functionality.
• Command Interface: Utilize a straightforward command-based interface to manage devices seamlessly.
• Timed Operations: Activate devices for predetermined durations, such as turning a device on for 1 hour.
• Automatic Scheduling: Schedule devices to turn on or off at specific times, simplifying automation tasks.
• Emulation Mode: Test and develop your commands without needing physical hardware, making development more accessible.
• Configurable Mapping: Easily configure device-to-pin mappings via a simple .env file, allowing for custom setups tailored to specific needs.
• Extensive Unit Testing: The project includes comprehensive unit test coverage to ensure reliability and performance.

Requirements

• Python Version: Ensure Python 3.11 or higher is installed.
• Raspberry Pi: Compatible with Raspberry Pi Zero W or any model of Raspberry Pi.
• Discord Bot: A Discord bot token and an appropriate server channel for communication.

Usage Examples

To interact with WaterBot through Discord, use commands such as:

Device Control:

status
on light
off pump
on fan 3600
off heater 1800
on all
off all

Scheduling:

schedules
schedule pump on 08:00
schedule pump off 12:00
schedule light on 06:30
unschedule pump on 20:00

Development and Testing

For non-Raspberry Pi users, set OPERATION_MODE=emulation in the .env file to simulate GPIO operations. The bot includes comprehensive testing capabilities that can be executed with pytest, ensuring all functionalities are well-covered and operational.

CI/CD Integration

WaterBot is equipped with robust CI/CD pipelines, enabling automated testing and deployment through both GitHub Actions and GitLab CI/CD. This ensures consistent quality control and streamlined updates.

Running as a Service

For users looking to enhance automation further, WaterBot can be configured to run as a systemd service on a Raspberry Pi, streamlining the bot's operation and enabling automatic startup on boot.