Merge pull request #102 from pimoroni/release-0.0.4

Gadgetoid · web-flow · commit a28a817f3bb0 · 2021-09-02T11:49:25.000+01:00
Add support for ADS1115
diff --git a/Makefile b/Makefile
@@ -36,14 +36,14 @@ check:
 tag:
 	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
 
-python-readme: library/README.rst
+python-readme: library/README.md
 
 python-license: library/LICENSE.txt
 
-library/README.rst: README.md library/CHANGELOG.txt
-	pandoc --from=markdown --to=rst -o library/README.rst README.md
-	echo "" >> library/README.rst
-	cat library/CHANGELOG.txt >> library/README.rst
+library/README.md: README.md library/CHANGELOG.txt
+	cp README.md library/README.md
+	printf "\n# Changelog\n" >> library/README.md
+	cat library/CHANGELOG.txt >> library/README.md
 
 library/LICENSE.txt: LICENSE
 	cp LICENSE library/LICENSE.txt
diff --git a/library/CHANGELOG.txt b/library/CHANGELOG.txt
@@ -1,3 +1,9 @@
+0.0.4
+-----
+
+* Add support for ads1015 >= v0.0.7 (ADS1115 ADCs)
+* Packaging tweaks
+
 0.0.3
 -----
 
diff --git a/library/MANIFEST.in b/library/MANIFEST.in
@@ -1,5 +1,5 @@
 include CHANGELOG.txt
 include LICENSE.txt
-include README.rst
+include README.md
 include setup.py
 recursive-include enviroplus *.py
diff --git a/library/README.md b/library/README.md
@@ -0,0 +1,94 @@
+# 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
+
+
+[![Build Status](https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/enviroplus-python)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=master)
+[![PyPi Package](https://img.shields.io/pypi/v/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
+[![Python Versions](https://img.shields.io/pypi/pyversions/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
+
+# Installing
+
+You're 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._
+
+![Enviro Plus pHAT](./Enviro-Plus-pHAT.jpg)
+![Enviro Mini pHAT](./Enviro-mini-pHAT.jpg)
+
+## One-line (Installs from GitHub)
+
+```
+curl -sSL https://get.pimoroni.com/enviroplus | bash
+```
+
+**Note** report issues with one-line installer here: https://github.com/pimoroni/get
+
+## Or... Install and configure dependencies from GitHub:
+
+* `git clone https://github.com/pimoroni/enviroplus-python`
+* `cd enviroplus-python`
+* `sudo ./install.sh`
+
+**Note** Raspbian Lite users may first need to install git: `sudo apt install git`
+
+## Or... Install from PyPi and configure manually:
+
+* Run `sudo pip install enviroplus`
+
+**Note** this wont 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:
+
+* 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`
+
+And install additional dependencies:
+
+```
+sudo apt install python-numpy python-smbus python-pil python-setuptools
+```
+
+## Alternate Software & User Projects
+
+* 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)
+* adafruit_io.py - https://github.com/dedSyn4ps3/enviroplus-python/blob/master/examples/adafruit_io.py - uses Adafruit Blinka and BME280 libraries to publish to Adafruit IO
+* 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
+
+## Help & Support
+
+* GPIO Pinout - https://pinout.xyz/pinout/enviro_plus
+* Support forums - http://forums.pimoroni.com/c/support
+* Discord - https://discord.gg/hr93ByC
+
+# Changelog
+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
diff --git a/library/README.rst b/library/README.rst
diff --git a/library/enviroplus/__init__.py b/library/enviroplus/__init__.py
@@ -1 +1 @@
-__version__ = '0.0.3'
+__version__ = '0.0.4'
diff --git a/library/setup.cfg b/library/setup.cfg
@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
 [metadata]
 name = enviroplus
-version = 0.0.3
+version = 0.0.4
 author = Philip Howard
 author_email = phil@pimoroni.com
 description = Enviro pHAT Plus environmental monitoring add-on for Raspberry Pi
-long_description = file: README.rst
+long_description = file: README.md
+long_description_content_type = text/markdown
 keywords = Raspberry Pi
 url = https://www.pimoroni.com
 project_urls =

-Original file line number
+Diff line change
@@ @@ -1,3 +1,9 @@ @@
 +0.0.4
 +-----
++
 +* Add support for ads1015 >= v0.0.7 (ADS1115 ADCs)
 +* Packaging tweaks
++
 .0.3
 -----
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.0.3'`
	`1`	`+__version__ = '0.0.4'`