enviroplus-community 1.0.6

Community edition of Enviro pHAT Plus environmental monitoring for Raspberry Pi with opensensor.space integration

Enviro+ Community Edition

Environmental monitoring for Raspberry Pi - Measure air quality (gases and particulates), temperature, pressure, humidity, light, and noise.

---

🌍 Join the Open Sensor Network

opensensor.space is a cloud-native platform for streaming environmental sensor data to open datasets.

Part of the walkthru.earth initiative for people-first urban intelligence:

• 🌱 Minimum carbon footprint - Edge processing reduces transmission by 60-90%
• 📊 Open data - All readings stored in Parquet format on Source Cooperative
• ⚡ Near real-time - Query sensor data in the browser with DuckDB
• 🔄 Resilient - Offline-first with automatic sync

See live data from Enviro+ sensors →

---

🚀 Quick Start

Installation

# Install UV (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create isolated environment and install package
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install enviroplus-community

# Check system requirements
enviroplus-setup --check

# Install system dependencies and configure hardware
sudo enviroplus-setup --install

# Reboot (required for hardware changes)
sudo reboot

Run Examples

# List all available examples
enviroplus-examples

# Get details about a specific example
enviroplus-examples --info weather.py

# Copy examples to your project
enviroplus-examples --copy ~/my-sensors/

# Run an example
uv run python -m enviroplus.examples.weather

# Or run directly (if venv is activated)
python -m enviroplus.examples.weather

Quick Test

import time
from pimoroni_bme280 import BME280

try:
    from smbus2 import SMBus
except ImportError:
    from smbus import SMBus

bme280 = BME280(i2c_dev=SMBus(1))

while True:
    temperature = bme280.get_temperature()
    pressure = bme280.get_pressure()
    humidity = bme280.get_humidity()

    print(f"Temperature: {temperature:.1f}°C")
    print(f"Pressure: {pressure:.1f}hPa")
    print(f"Humidity: {humidity:.1f}%")
    print("---")

    time.sleep(2)

---

📦 What's Included

Hardware Support

• BME280 - Temperature, pressure, humidity
• LTR559 - Light and proximity
• MICS6814 - Gas sensor (oxidising, reducing, NH3)
• PMS5003 - Particulate matter (PM1, PM2.5, PM10)
• ADAU7002 - MEMS microphone for noise measurement
• ST7735 - 0.96" color LCD display (160x80)

Python Package

• Core sensor libraries
• 17 example scripts
• Hardware setup tool (enviroplus-setup)
• Examples helper (enviroplus-examples)
• Full documentation

Example Scripts

Basic Sensors:

• weather.py - Temperature, pressure, humidity
• light.py - Light sensor readings
• gas.py - Gas sensor readings
• particulates.py - Particulate matter readings
• compensated-temperature.py - CPU-compensated temperature

Advanced:

• all-in-one.py - Full dashboard with all sensors
• mqtt-all.py - Publish to MQTT broker
• sensorcommunity.py - Upload to Sensor.Community network
• noise-profile.py - Noise measurement with frequency analysis

See all examples →

---

🛠️ Hardware Setup

The enviroplus-setup tool automatically configures your Raspberry Pi:

# Check what's needed
enviroplus-setup --check

# Install and configure everything
sudo enviroplus-setup --install

What it does:

• ✅ Installs system packages (python3-cffi, libportaudio2)
• ✅ Enables I2C interface (for sensors)
• ✅ Enables SPI interface (for LCD display)
• ✅ Configures serial/UART (for PMS5003 sensor)
• ✅ Adds device tree overlays to /boot/firmware/config.txt
• ✅ Creates backup before changes

Note: A reboot is required after hardware configuration.

---

📖 Documentation

• Installation Guide: See above
• Example Scripts: enviroplus/examples/
• API Reference: Use enviroplus-examples --info <script> for details
• Hardware Setup: Run enviroplus-setup --help
• Publishing Guide: PYPI_PUBLISHING.md
• Development: DEVELOPMENT.md

---

🤝 Community Projects & Integrations

Amazing projects built by the community using Enviro+:

Cloud & IoT Platforms

• opensensor.space - Cloud-native open sensor network with edge processing and open data (walkthru.earth)
• enviroplus_exporter - Prometheus exporter with Luftdaten and InfluxDB Cloud support
• mqtt-all - MQTT integration (now upstream in examples/mqtt-all.py)
• sensorcommunity - Upload data to Sensor.Community (Luftdaten) network

Web Dashboards

• Enviro Plus Dashboard - React-based web dashboard for viewing sensor data
• Enviro Plus Web - Flask application serving web pages with current readings and graphs
• enviro monitor - Comprehensive environmental monitoring solution

Home Automation

• homekit-enviroplus - Apple HomeKit accessory for Enviro+
• homebridge-enviroplus - Homebridge plugin for HomeKit integration

Development Libraries

• go-enviroplus - Go modules to read Enviro+ sensors
• Enviro+ Example Projects - Includes original examples plus code to stream to Adafruit IO

Got a project? Add it here →

---

🆘 Help & Support

Need help getting started or troubleshooting?

Documentation

• Installation Guide: See Quick Start above
• Hardware Setup: Run enviroplus-setup --help
• Examples: Run enviroplus-examples to see all available examples
• API Reference: Run enviroplus-examples --info <script> for details
• GPIO Pinout: pinout.xyz/enviro_plus

Get Help

• GitHub Issues: Report bugs or request features
• GitHub Discussions: Ask questions and share ideas
• Pimoroni Forums: Community support
• Discord: Join the conversation
• Email: [e-mail] (for opensensor.space integration)

Useful Links

• Enviro+ Product: shop.pimoroni.com/products/enviro-plus
• Getting Started Guide: learn.pimoroni.com/enviro-plus
• opensensor.space: opensensor.space
• walkthru.earth: walkthru.earth

---

🔧 Development

Want to contribute? See DEVELOPMENT.md for detailed setup instructions.

# Clone repository
git clone https://github.com/walkthru-earth/enviroplus-community.git
cd enviroplus-community

# Create isolated environment
uv venv
source .venv/bin/activate

# Install for development
uv pip install -e .

# Install dev dependencies
make dev-deps

# Run tests
make pytest

# Run QA checks
make qa

# Build package
make build

---

📋 Requirements

• Hardware: Raspberry Pi with Enviro+ or Enviro Mini pHAT
• OS: Raspberry Pi OS (Debian Bookworm or later recommended)
• Python: 3.9 - 3.13 (fully tested across all versions)
• System packages: Automatically installed by enviroplus-setup

Supported boards:

• Enviro+ (all sensors)
• Enviro Mini (no gas sensor or PM sensor)

---

📜 License

MIT License - see LICENSE

Original Author: Philip Howard (Pimoroni) Maintained by: Youssef Harby (walkthru.earth)

---

🙏 Acknowledgments

• Pimoroni for creating the Enviro+ hardware and original library
• walkthru.earth for opensensor.space integration
• Community contributors for examples and integrations

---

Made with ❤️ for open environmental data

1.0.6

• Changelog: Update changelog with missing entries

1.0.5

• Repository Rename: Renamed repository to enviroplus-community
• Documentation: Updated all links to point to the new repository URL
• Version Bump: Bumped version to 1.0.5

1.0.4

• Setup: Add udev rules configuration for serial devices
• Setup: Add dialout group check for PMS5003 serial access

1.0.3

• Maintainer update: Set Youssef Harby as sole maintainer (displayed on PyPI)
• Philip Howard remains original author

1.0.2

Community Edition Updates

• Package renamed to enviroplus-community for PyPI distribution
• Python 3.12 and 3.13 support added and fully tested
• Modern packaging with UV package manager and PEP 735 dependency groups
• New tools: enviroplus-setup for hardware configuration, enviroplus-examples for examples management
• CI/CD modernization: GitHub Actions with ruff, UV, and Trusted Publishers for PyPI
• Code quality: Migrated to ruff for linting/formatting (replaces black, isort, flake8)
• Documentation: Comprehensive guides for development and PyPI publishing
• opensensor.space integration: Cloud-native platform for open sensor data
• README.md: Update install instructions
• Fix installer to enable serial
• Fix gas sensor heater pin

1.0.1

• README.md: Fix images

1.0.0

• BREAKING: Port to gpiod/gpiodevice for Pi 5/Bookworm.

0.0.6

• Fix noise by specifying adau7002 device

0.0.5

• Drop Python 2.x support
• Add "available()" method for gas sensor

0.0.4

• Add support for ads1015 >= v0.0.7 (ADS1115 ADCs)
• Packaging tweaks

0.0.3

• Fix "self.noise_floor" bug in get_noise_profile

0.0.2

• Add support for extra ADC channel in Gas
• Handle breaking change in new ltr559 library
• Add Noise functionality

0.0.1

• Initial Release