Metadata-Version: 2.3
Name: bugcam
Version: 0.1.0
Summary: detect and classify insects on a raspberry pi
License: MIT
Keywords: hailo,raspberry-pi,insect-detection,insect-classification,computer-vision,ai,sensing-garden,mit,senseable-city-lab
Author: Deniz Aydemir
Author-email: deniz@aydemir.us
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Dist: boto3 (>=1.34.0)
Requires-Dist: numpy (<2.0.0)
Requires-Dist: opencv-python
Requires-Dist: rich (>=13.0.0)
Requires-Dist: sensing-garden-client (>=0.0.8)
Requires-Dist: setproctitle
Requires-Dist: typer[all] (>=0.9.0)
Project-URL: Repository, https://github.com/MIT-Senseable-City-Lab/sensing-garden
Description-Content-Type: text/markdown

# BugCam - Raspberry Pi Insect Detection

CLI for running insect detection on Raspberry Pi with Hailo AI HAT+.

## Quick Start

### 1. Hardware Requirements
- Raspberry Pi 4/5
- Raspberry Pi Camera Module 3
- Raspberry Pi AI HAT+ (Hailo8/Hailo8L)
- Active cooler recommended

See [Hardware Setup Guide](docs/getting-started/hardware-setup.md) for detailed assembly instructions.

### 2. Install BugCam

```bash
# Install system dependencies
sudo apt install hailo-all

# Install bugcam CLI
pip install .
# OR with pipx for isolated install
pipx install .
```

See [Installation Guide](docs/getting-started/installation.md) for detailed setup instructions.

### 3. Run Detection

```bash
# Preview camera with detection overlay
bugcam preview

# Start continuous detection
bugcam detect start

# Save detections to file
bugcam detect start --output detections.jsonl

# Enable autostart on boot
bugcam autostart enable
```

See [CLI Reference](docs/cli-reference.md) for complete command documentation.

## Pre-compiled Models

Insect detection models are included in `resources/`:
- `yolov8m.hef` - Medium model (31MB) - Higher accuracy
- `yolov8s.hef` - Small model (11MB) - Faster inference

## Documentation

### Getting Started
- [Hardware Setup](docs/getting-started/hardware-setup.md) - Raspberry Pi and camera assembly
- [Installation](docs/getting-started/installation.md) - Software installation and configuration
- [Hotspot Setup](docs/getting-started/hotspot-setup.md) - Configure wireless access point

### Reference
- [CLI Reference](docs/cli-reference.md) - Complete command documentation

### Advanced
- [Monitoring](docs/advanced/monitoring.md) - Performance monitoring and debugging
- [TensorFlow Lite Alternative](docs/advanced/tensorflow-alternative.md) - Running without AI HAT

## Development

```bash
# Install with dev dependencies
poetry install

# Run tests
poetry run pytest tests/ -v

# Run CLI from source
poetry run bugcam --help
```

## License

MIT

