README.md
Noisebell
A switch monitoring system that detects circuit state changes via GPIO and sends webhook notifications to configured endpoints.
This is build by Jet Pham to be used at Noisebridge to replace their old discord status bot
Features
- GPIO circuit monitoring with configurable pin
- Webhook notifications with retry mechanism
- REST API for managing webhook endpoints
- Daily rotating log files
- Cross-compilation support for Raspberry Pi deployment
Requirements
- Rust toolchain
- Raspberry Pi (tested on aarch64)
- For development: Cross-compilation tools (for
crosscommand)
Installation
- Clone the repository:
bash
| 1 | git clone https://github.com/yourusername/noisebell.git |
| 2 | cd noisebell |
- Build the project:
bash
| 1 | cargo build --release |
Configuration
GPIO Pin
The default GPIO pin is set to 17. You can modify this in src/main.rs.
Webhook Endpoints
Webhook endpoints are stored in endpoints.json. The file should follow this format:
json
| 1 | { |
| 2 | "endpoints": [ |
| 3 | { |
| 4 | "url": "https://your-webhook-url.com", |
| 5 | "description": "Description of this endpoint" |
| 6 | } |
| 7 | ] |
| 8 | } |
Usage
- Start the server:
bash
| 1 | ./target/release/noisebell |
The server will:
- Start listening on
127.0.0.1:8080 - Begin monitoring the configured GPIO pin
- Send webhook notifications when circuit state changes
API Endpoints
Add Webhook Endpoint
bash
| 1 | curl -X POST http://localhost:8080/endpoints \ |
| 2 | -H "Content-Type: application/json" \ |
| 3 | -d '{ |
| 4 | "url": "https://your-webhook-url.com", |
| 5 | "description": "My webhook" |
| 6 | }' |
Webhook Payload Format
When a circuit state change is detected, the following JSON payload is sent to all configured endpoints:
json
| 1 | { |
| 2 | "event_type": "circuit_state_change", |
| 3 | "timestamp": "2024-03-21T12:34:56Z", |
| 4 | "new_state": "open" // or "closed" |
| 5 | } |
Deployment
The project includes a deployment script for Raspberry Pi. To deploy:
- Ensure you have cross-compilation tools installed:
bash
| 1 | cargo install cross |
- Run the deployment script:
bash
| 1 | ./deploy.sh |
This will:
- Cross-compile the project for aarch64
- Copy the binary and configuration to your Raspberry Pi
- Set appropriate permissions
Logging
Logs are stored in the logs directory with daily rotation for the past 7 days