| Name | pms5003 JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | PMS5003 Particulate Sensor |
| upload_time | 2024-04-24 14:14:25 |
| 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.
|
# PMS5003 Particulate Sensor
[](https://github.com/pimoroni/pms5003-python/actions/workflows/test.yml)
[](https://coveralls.io/github/pimoroni/pms5003-python?branch=main)
[](https://pypi.python.org/pypi/pms5003)
[](https://pypi.python.org/pypi/pms5003)
# Installing
**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/pms5003-python`
* `cd pms5003-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 pms5003`
**Note** this will not perform any of the required configuration changes on your Pi, you may additionally 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`
In both cases the last line will switch Bluetooth over to miniUART, see https://www.raspberrypi.org/documentation/configuration/uart.md for more details.
1.0.1
-----
* Remove platform detection and default to Pi-compatible pins
* Support passing in LineRequest and offset for custom pins (supported in gpiodevice>=0.0.4)
1.0.0
-----
* Repackage to hatch/pyproject.toml
* Port to gpiod/gpiodevice (away from RPi.GPIO)
0.0.5
-----
* BugFix: Read start-of-frame a byte at a time to avoid misalignment issues, potential fix for #2, #3 and #4
* Enhancement: Clarified error message when length packet cannot be read
* Enhancement: Clarified error message when start of frame cannot be read
* Enhancement: Added new error message where raw data length is less than expected (frame length)
0.0.4
-----
* Packaging improvements/bugfix from boilerplate
0.0.3
-----
* Added pyserial dependency
0.0.2
-----
* Added reset function
0.0.1
-----
* Initial Release
Raw data
{
"_id": null,
"home_page": null,
"name": "pms5003",
"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/ee/49/0cba310a578061b80994f66b6f7924d511b2add0a68d7abb09bfb88b1f94/pms5003-1.0.1.tar.gz",
"platform": null,
"description": "# PMS5003 Particulate Sensor\n\n[](https://github.com/pimoroni/pms5003-python/actions/workflows/test.yml)\n[](https://coveralls.io/github/pimoroni/pms5003-python?branch=main)\n[](https://pypi.python.org/pypi/pms5003)\n[](https://pypi.python.org/pypi/pms5003)\n\n# Installing\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/pms5003-python`\n* `cd pms5003-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 pms5003`\n\n**Note** this will not perform any of the required configuration changes on your Pi, you may additionally 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\nIn both cases the last line will switch Bluetooth over to miniUART, see https://www.raspberrypi.org/documentation/configuration/uart.md for more details.\n\n1.0.1\n-----\n\n* Remove platform detection and default to Pi-compatible pins\n* Support passing in LineRequest and offset for custom pins (supported in gpiodevice>=0.0.4)\n\n1.0.0\n-----\n\n* Repackage to hatch/pyproject.toml\n* Port to gpiod/gpiodevice (away from RPi.GPIO)\n\n0.0.5\n-----\n\n* BugFix: Read start-of-frame a byte at a time to avoid misalignment issues, potential fix for #2, #3 and #4\n* Enhancement: Clarified error message when length packet cannot be read\n* Enhancement: Clarified error message when start of frame cannot be read\n* Enhancement: Added new error message where raw data length is less than expected (frame length)\n\n0.0.4\n-----\n\n* Packaging improvements/bugfix from boilerplate\n\n0.0.3\n-----\n\n* Added pyserial dependency\n\n0.0.2\n-----\n\n* Added reset function\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": "PMS5003 Particulate Sensor",
"version": "1.0.1",
"project_urls": {
"GitHub": "https://www.github.com/pimoroni/pms5003-python",
"Homepage": "https://www.pimoroni.com"
},
"split_keywords": [
"pi",
" raspberry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a78ae39517e1e0977397f273a9f9be9c0847e832365106a5090851dbd76c2a0",
"md5": "11bd0871e6b656edc3fd1e7b7438db62",
"sha256": "38f51a40d1a09efb4bb7f6f01376dc870ed720253a664a1f4d1ae19581f6e3db"
},
"downloads": -1,
"filename": "pms5003-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11bd0871e6b656edc3fd1e7b7438db62",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7942,
"upload_time": "2024-04-24T14:13:59",
"upload_time_iso_8601": "2024-04-24T14:13:59.625723Z",
"url": "https://files.pythonhosted.org/packages/4a/78/ae39517e1e0977397f273a9f9be9c0847e832365106a5090851dbd76c2a0/pms5003-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee490cba310a578061b80994f66b6f7924d511b2add0a68d7abb09bfb88b1f94",
"md5": "8ee6a1710e49c2d0e7cbbe806974b49f",
"sha256": "92a248bd74910202beab5c2784b8a2f131a6c643eedff5502cc52652d415232b"
},
"downloads": -1,
"filename": "pms5003-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8ee6a1710e49c2d0e7cbbe806974b49f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12459,
"upload_time": "2024-04-24T14:14:25",
"upload_time_iso_8601": "2024-04-24T14:14:25.573511Z",
"url": "https://files.pythonhosted.org/packages/ee/49/0cba310a578061b80994f66b6f7924d511b2add0a68d7abb09bfb88b1f94/pms5003-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 14:14:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pimoroni",
"github_project": "pms5003-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pms5003"
}
