| Name | enviroplus JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | Enviro pHAT Plus environmental monitoring add-on for Raspberry Pi |
| upload_time | 2024-04-23 10:19:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2018 Pimoroni Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
pi
raspberry
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Enviro+
Designed for environmental monitoring, Enviro+ lets you measure air quality (pollutant gases and particulates), temperature, pressure, humidity, light, and noise level. Learn more - https://shop.pimoroni.com/products/enviro-plus
[](https://github.com/pimoroni/enviroplus-python/actions/workflows/test.yml)
[](https://coveralls.io/github/pimoroni/enviroplus-python?branch=main)
[](https://pypi.python.org/pypi/enviroplus)
[](https://pypi.python.org/pypi/enviroplus)
# Installing
You are best using the "One-line" install method if you want all of the UART serial configuration for the PMS5003 particulate matter sensor to run automatically.
**Note** The code in this repository supports both the Enviro+ and Enviro Mini boards. _The Enviro Mini board does not have the Gas sensor or the breakout for the PM sensor._
:warning: This library now supports Python 3 only, Python 2 is EOL - https://www.python.org/doc/sunset-python-2/
## Install and configure dependencies from GitHub:
* `git clone https://github.com/pimoroni/enviroplus-python`
* `cd enviroplus-python`
* `./install.sh`
**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:
```
source ~/.virtualenvs/pimoroni/bin/activate
```
**Note** Raspbian/Raspberry Pi OS Lite users may first need to install git: `sudo apt install git`
## Or... Install from PyPi and configure manually:
* `python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni`
* Run `python3 -m pip install enviroplus`
And install additional dependencies:
```bash
sudo apt install python3-numpy python3-smbus python3-pil python3-setuptools
```
**Note** this will not perform any of the required configuration changes on your Pi, you may additionally need to:
* Enable i2c: `raspi-config nonint do_i2c 0`
* Enable SPI: `raspi-config nonint do_spi 0`
And if you're using a PMS5003 sensor you will need to:
### Bookworm
* Enable serial: `raspi-config nonint do_serial_hw 0`
* Disable serial terminal: `raspi-config nonint do_serial_cons 1`
* Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`
### Bullseye
* Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt`
* Disable serial terminal: `sudo raspi-config nonint do_serial 1`
* Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`
## Alternate Software & User Projects
* Enviro Plus Dashboard - https://gitlab.com/dedSyn4ps3/enviroplus-dashboard - A React-based web dashboard for viewing sensor data
* Enviro+ Example Projects - https://gitlab.com/dedSyn4ps3/enviroplus-python-projects - Includes original examples plus code to stream to Adafruit IO (more projects coming soon)
* enviro monitor - https://github.com/roscoe81/enviro-monitor
* mqtt-all - https://github.com/robmarkcole/rpi-enviro-mqtt - now upstream: [see examples/mqtt-all.py](examples/mqtt-all.py)
* enviroplus_exporter - https://github.com/tijmenvandenbrink/enviroplus_exporter - Prometheus exporter (with added support for Luftdaten and InfluxDB Cloud)
* homekit-enviroplus - https://github.com/sighmon/homekit-enviroplus - An Apple HomeKit accessory for the Pimoroni Enviro+
* go-enviroplus - https://github.com/rubiojr/go-enviroplus - Go modules to read Enviro+ sensors
* homebridge-enviroplus - https://github.com/mhawkshaw/homebridge-enviroplus - a Homebridge plugin to add the Enviro+ to HomeKit via Homebridge
* Enviro Plus Web - https://gitlab.com/idotj/enviroplusweb - Simple Flask application serves a web page with the current sensor readings and a graph over a specified time period
## Help & Support
* GPIO Pinout - https://pinout.xyz/pinout/enviro_plus
* Support forums - https://forums.pimoroni.com/c/support
* Discord - https://discord.gg/hr93ByC
1.0.2
-----
* 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
Raw data
{
"_id": null,
"home_page": null,
"name": "enviroplus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Philip Howard <phil@pimoroni.com>",
"keywords": "Pi, Raspberry",
"author": null,
"author_email": "Philip Howard <phil@pimoroni.com>",
"download_url": "https://files.pythonhosted.org/packages/7f/3e/69d7bba671bbfc76d6e186357a86ca7657af1081c858fbc7ec39a52414f0/enviroplus-1.0.2.tar.gz",
"platform": null,
"description": "# Enviro+\n\nDesigned for environmental monitoring, Enviro+ lets you measure air quality (pollutant gases and particulates), temperature, pressure, humidity, light, and noise level. Learn more - https://shop.pimoroni.com/products/enviro-plus\n\n[](https://github.com/pimoroni/enviroplus-python/actions/workflows/test.yml)\n[](https://coveralls.io/github/pimoroni/enviroplus-python?branch=main)\n[](https://pypi.python.org/pypi/enviroplus)\n[](https://pypi.python.org/pypi/enviroplus)\n\n# Installing\n\nYou are best using the \"One-line\" install method if you want all of the UART serial configuration for the PMS5003 particulate matter sensor to run automatically.\n\n**Note** The code in this repository supports both the Enviro+ and Enviro Mini boards. _The Enviro Mini board does not have the Gas sensor or the breakout for the PM sensor._\n\n\n\n\n:warning: This library now supports Python 3 only, Python 2 is EOL - https://www.python.org/doc/sunset-python-2/\n\n## Install and configure dependencies from GitHub:\n\n* `git clone https://github.com/pimoroni/enviroplus-python`\n* `cd enviroplus-python`\n* `./install.sh`\n\n**Note** Libraries will be installed in the \"pimoroni\" virtual environment, you will need to activate it to run examples:\n\n```\nsource ~/.virtualenvs/pimoroni/bin/activate\n```\n\n**Note** Raspbian/Raspberry Pi OS Lite users may first need to install git: `sudo apt install git`\n\n## Or... Install from PyPi and configure manually:\n\n* `python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni`\n* Run `python3 -m pip install enviroplus`\n\nAnd install additional dependencies:\n\n```bash\nsudo apt install python3-numpy python3-smbus python3-pil python3-setuptools\n```\n\n**Note** this will not perform any of the required configuration changes on your Pi, you may additionally need to:\n\n* Enable i2c: `raspi-config nonint do_i2c 0`\n* Enable SPI: `raspi-config nonint do_spi 0`\n\nAnd if you're using a PMS5003 sensor you will need to:\n\n### Bookworm\n\n* Enable serial: `raspi-config nonint do_serial_hw 0`\n* Disable serial terminal: `raspi-config nonint do_serial_cons 1`\n* Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`\n\n### Bullseye\n\n* Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt`\n* Disable serial terminal: `sudo raspi-config nonint do_serial 1`\n* Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`\n\n## Alternate Software & User Projects\n\n* Enviro Plus Dashboard - https://gitlab.com/dedSyn4ps3/enviroplus-dashboard - A React-based web dashboard for viewing sensor data\n* Enviro+ Example Projects - https://gitlab.com/dedSyn4ps3/enviroplus-python-projects - Includes original examples plus code to stream to Adafruit IO (more projects coming soon)\n* enviro monitor - https://github.com/roscoe81/enviro-monitor\n* mqtt-all - https://github.com/robmarkcole/rpi-enviro-mqtt - now upstream: [see examples/mqtt-all.py](examples/mqtt-all.py)\n* enviroplus_exporter - https://github.com/tijmenvandenbrink/enviroplus_exporter - Prometheus exporter (with added support for Luftdaten and InfluxDB Cloud)\n* homekit-enviroplus - https://github.com/sighmon/homekit-enviroplus - An Apple HomeKit accessory for the Pimoroni Enviro+\n* go-enviroplus - https://github.com/rubiojr/go-enviroplus - Go modules to read Enviro+ sensors\n* homebridge-enviroplus - https://github.com/mhawkshaw/homebridge-enviroplus - a Homebridge plugin to add the Enviro+ to HomeKit via Homebridge\n* Enviro Plus Web - https://gitlab.com/idotj/enviroplusweb - Simple Flask application serves a web page with the current sensor readings and a graph over a specified time period\n\n## Help & Support\n\n* GPIO Pinout - https://pinout.xyz/pinout/enviro_plus\n* Support forums - https://forums.pimoroni.com/c/support\n* Discord - https://discord.gg/hr93ByC\n\n1.0.2\n-----\n\n* README.md: Update install instructions\n* Fix installer to enable serial\n* Fix gas sensor heater pin\n\n1.0.1\n-----\n\n* README.md: Fix images\n\n1.0.0\n-----\n\n* BREAKING: Port to gpiod/gpiodevice for Pi 5/Bookworm.\n\n0.0.6\n-----\n\n* Fix noise by specifying adau7002 device\n\n0.0.5\n-----\n\n* Drop Python 2.x support\n* Add \"available()\" method for gas sensor\n\n0.0.4\n-----\n\n* Add support for ads1015 >= v0.0.7 (ADS1115 ADCs)\n* Packaging tweaks\n\n0.0.3\n-----\n\n* Fix \"self.noise_floor\" bug in get_noise_profile\n\n0.0.2\n-----\n\n* Add support for extra ADC channel in Gas\n* Handle breaking change in new ltr559 library\n* Add Noise functionality\n\n0.0.1\n-----\n\n* Initial Release\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2018 Pimoroni Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Enviro pHAT Plus environmental monitoring add-on for Raspberry Pi",
"version": "1.0.2",
"project_urls": {
"GitHub": "https://www.github.com/pimoroni/enviroplus-python",
"Homepage": "https://www.pimoroni.com"
},
"split_keywords": [
"pi",
" raspberry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7fb8cc9474738a3441d2ee59c478deb173758a29893adaa25d98dd4e0e668778",
"md5": "d6570e2e474e39d5ef575175050e06e3",
"sha256": "e3e862f08554f89183ea419c072b4a8647d69cc8dd256579453f4b38076edd04"
},
"downloads": -1,
"filename": "enviroplus-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6570e2e474e39d5ef575175050e06e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10554,
"upload_time": "2024-04-23T10:19:04",
"upload_time_iso_8601": "2024-04-23T10:19:04.437112Z",
"url": "https://files.pythonhosted.org/packages/7f/b8/cc9474738a3441d2ee59c478deb173758a29893adaa25d98dd4e0e668778/enviroplus-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f3e69d7bba671bbfc76d6e186357a86ca7657af1081c858fbc7ec39a52414f0",
"md5": "5ff58433663ca2581c51a78001a76359",
"sha256": "c617098af8ad60d0429ca02e6c4fe989f7cd4486313c2b51a12d27bf8c45c2dd"
},
"downloads": -1,
"filename": "enviroplus-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5ff58433663ca2581c51a78001a76359",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 125718,
"upload_time": "2024-04-23T10:19:06",
"upload_time_iso_8601": "2024-04-23T10:19:06.204783Z",
"url": "https://files.pythonhosted.org/packages/7f/3e/69d7bba671bbfc76d6e186357a86ca7657af1081c858fbc7ec39a52414f0/enviroplus-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 10:19:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pimoroni",
"github_project": "enviroplus-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "enviroplus"
}
