| Name | automationhat JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Driver for the Pimoroni Automation HAT |
| upload_time | 2024-04-29 11:33:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2017 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
automation controller
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/pimoroni/automation-hat/actions/workflows/test.yml)
[](https://coveralls.io/github/pimoroni/automation-hat?branch=main)
[](https://pypi.python.org/pypi/automationhat)
[](https://pypi.python.org/pypi/automationhat)
Automation HAT is a home monitoring and automation controller featuring relays, analog channels, powered outputs, and buffered inputs (all 24V tolerant). This library will also work with Automation HAT's smaller siblings - Automation pHAT and Automation HAT Mini.
### Where to buy
* Pimoroni Automation HAT: <https://shop.pimoroni.com/products/automation-hat>
* Pimoroni Automation HAT Mini: <https://shop.pimoroni.com/products/automation-hat-mini>
* [DISCONTINUED] Pimoroni Automation pHAT: <https://shop.pimoroni.com/products/automation-phat>
## Installing
### Full install (recommended):
We've created an easy installation script that will install all pre-requisites and get your Automation HAT
up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal
on your Raspberry Pi desktop, as illustrated below:
In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:
```bash
git clone https://github.com/pimoroni/automation-hat
cd automation-hat
./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
```
### Development:
If you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so:
```bash
git clone https://github.com/pimoroni/automation-hat
cd automation-hat
./install.sh --unstable
```
In all cases you will have to enable the I2C bus (and SPI for Automation HAT Mini):
```
sudo raspi-config nonint do_i2c 0
sudo raspi-config nonint do_spi 0
```
## Documentation & Support
* Guides and tutorials:
* Automation HAT: <https://learn.pimoroni.com/automation-hat>
* Automation pHAT: <https://learn.pimoroni.com/automation-phat>
* Automation HAT Mini: <https://learn.pimoroni.com/automation-hat-mini>
* Function reference
<https://github.com/pimoroni/automation-hat/tree/master/documentation>
* GPIO Pinout:
* Automation HAT: <https://pinout.xyz/pinout/automation_hat>
* Automation pHAT: <https://pinout.xyz/pinout/automation_phat>
* Automation HAT Mini: <https://pinout.xyz/pinout/automation_hat_mini>
* Get help
<http://forums.pimoroni.com/c/support>
### FAQ
#### What is the accuracy and resolution of the Automation HAT
The ADS1015 is a 12-bit ADC, but since the 12th bit is the sign-bit there are only 11-bits of resolution available for positive voltage readings. The input voltage for 24v channels is scaled from 0-25.85v (25.85 rather than 24 due to how the resistor divider is set up) to 0-3.3v.
Since the full-scale range of the ADC is set to 4.096v, this means that 0-3.3v gives only ~1649 possible usable values making the input measurement granularity somewhere around 0.015v (25.85 / 1649) for the 24v inputs and 0.002v for the 3.3v input.
More information on this topic can be found here: <https://forums.pimoroni.com/t/automation-hat-accuracy/7252/3>
1.0.0
-----
* Refactor to gpiod/gpiodevice.
* Repackage to hatch/pyproject.toml.
0.4.1
-----
* Update for SN3218 v2.0.0
0.4.0
-----
* Switch to ADS1X15 library
0.3.0
-----
* Switch to setup.cfg
* Switch to markdown based README
* Support for ADS1115 board variant
0.2.3
-----
* 0.2.2 + bump for newer examples
0.2.2
-----
* Had ST7789 on the brain, swapped for ST7735
0.2.1
-----
* Add dependency on ST7789 for AMH
0.2.0
-----
* Fix: Fix thread interleaving and race conditions leading to spurious ADC readings
* Fix: Switch to non-deprecated alias of thread.isAlive
0.1.0
-----
* Fix: Defer setup to avoid import side effects
* Fix: Slowed LED update rate
* Improvement: Switched to warnings to notify about unsupported features on pHAT
0.0.4
-----
* Fix for HAT/pHAT detection
0.0.3
-----
* Fix for Python 3 support
0.0.2
-----
* Added pHAT support
* Rounded ADC output to 2 decimal places
* Set initial state for outputs and fixed toggling
* Fixed light toggling
0.0.1
-----
* Initial Release
Raw data
{
"_id": null,
"home_page": null,
"name": "automationhat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Philip Howard <phil@pimoroni.com>",
"keywords": "Pi, Raspberry, automation controller",
"author": null,
"author_email": "Philip Howard <phil@pimoroni.com>",
"download_url": "https://files.pythonhosted.org/packages/f4/dc/b3584d2d0a3bb1ce7d0c14381a2958c9f11c828f7a29e077a370a8d20e88/automationhat-1.0.0.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/pimoroni/automation-hat/actions/workflows/test.yml)\n[](https://coveralls.io/github/pimoroni/automation-hat?branch=main)\n[](https://pypi.python.org/pypi/automationhat)\n[](https://pypi.python.org/pypi/automationhat)\n\nAutomation HAT is a home monitoring and automation controller featuring relays, analog channels, powered outputs, and buffered inputs (all 24V tolerant). This library will also work with Automation HAT's smaller siblings - Automation pHAT and Automation HAT Mini.\n\n### Where to buy\n\n* Pimoroni Automation HAT: <https://shop.pimoroni.com/products/automation-hat>\n* Pimoroni Automation HAT Mini: <https://shop.pimoroni.com/products/automation-hat-mini>\n* [DISCONTINUED] Pimoroni Automation pHAT: <https://shop.pimoroni.com/products/automation-phat>\n\n## Installing\n\n### Full install (recommended):\n\nWe've created an easy installation script that will install all pre-requisites and get your Automation HAT\nup and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal\non your Raspberry Pi desktop, as illustrated below:\n\n\n\nIn the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:\n\n```bash\ngit clone https://github.com/pimoroni/automation-hat\ncd automation-hat\n./install.sh\n```\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### Development:\n\nIf you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so:\n\n```bash\ngit clone https://github.com/pimoroni/automation-hat\ncd automation-hat\n./install.sh --unstable\n```\n\nIn all cases you will have to enable the I2C bus (and SPI for Automation HAT Mini):\n\n```\nsudo raspi-config nonint do_i2c 0\nsudo raspi-config nonint do_spi 0\n```\n\n## Documentation & Support\n\n* Guides and tutorials:\n * Automation HAT: <https://learn.pimoroni.com/automation-hat>\n * Automation pHAT: <https://learn.pimoroni.com/automation-phat>\n * Automation HAT Mini: <https://learn.pimoroni.com/automation-hat-mini>\n* Function reference\n<https://github.com/pimoroni/automation-hat/tree/master/documentation>\n* GPIO Pinout:\n * Automation HAT: <https://pinout.xyz/pinout/automation_hat>\n * Automation pHAT: <https://pinout.xyz/pinout/automation_phat>\n * Automation HAT Mini: <https://pinout.xyz/pinout/automation_hat_mini>\n* Get help\n<http://forums.pimoroni.com/c/support>\n\n### FAQ\n\n#### What is the accuracy and resolution of the Automation HAT\n\nThe ADS1015 is a 12-bit ADC, but since the 12th bit is the sign-bit there are only 11-bits of resolution available for positive voltage readings. The input voltage for 24v channels is scaled from 0-25.85v (25.85 rather than 24 due to how the resistor divider is set up) to 0-3.3v.\n\nSince the full-scale range of the ADC is set to 4.096v, this means that 0-3.3v gives only ~1649 possible usable values making the input measurement granularity somewhere around 0.015v (25.85 / 1649) for the 24v inputs and 0.002v for the 3.3v input.\n\nMore information on this topic can be found here: <https://forums.pimoroni.com/t/automation-hat-accuracy/7252/3>\n\n\n1.0.0\n-----\n\n* Refactor to gpiod/gpiodevice.\n* Repackage to hatch/pyproject.toml.\n\n0.4.1\n-----\n\n* Update for SN3218 v2.0.0\n\n0.4.0\n-----\n\n* Switch to ADS1X15 library\n\n0.3.0\n-----\n\n* Switch to setup.cfg\n* Switch to markdown based README\n* Support for ADS1115 board variant\n\n0.2.3\n-----\n\n* 0.2.2 + bump for newer examples\n\n0.2.2\n-----\n\n* Had ST7789 on the brain, swapped for ST7735\n\n0.2.1\n-----\n\n* Add dependency on ST7789 for AMH\n\n0.2.0\n-----\n\n* Fix: Fix thread interleaving and race conditions leading to spurious ADC readings\n* Fix: Switch to non-deprecated alias of thread.isAlive\n\n0.1.0\n-----\n\n* Fix: Defer setup to avoid import side effects\n* Fix: Slowed LED update rate\n* Improvement: Switched to warnings to notify about unsupported features on pHAT\n\n0.0.4\n-----\n\n* Fix for HAT/pHAT detection\n\n0.0.3\n-----\n\n* Fix for Python 3 support\n\n0.0.2\n-----\n\n* Added pHAT support\n* Rounded ADC output to 2 decimal places\n* Set initial state for outputs and fixed toggling\n* Fixed light toggling\n\n0.0.1\n-----\n\n* Initial Release\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2017 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": "Driver for the Pimoroni Automation HAT",
"version": "1.0.0",
"project_urls": {
"GitHub": "https://www.github.com/pimoroni/automationhat-python",
"Homepage": "https://www.pimoroni.com"
},
"split_keywords": [
"pi",
" raspberry",
" automation controller"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e262622b325923c1483834d737014c89b8ba8839bc53fa6fc84a3fb5741adf7",
"md5": "0e01ffc829b5bc837dde9f9593757901",
"sha256": "e62849aa5c191c42cb52f964869a16f5af02dd3acfd6f1b536ab08a0a1dc96ab"
},
"downloads": -1,
"filename": "automationhat-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e01ffc829b5bc837dde9f9593757901",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11758,
"upload_time": "2024-04-29T11:33:39",
"upload_time_iso_8601": "2024-04-29T11:33:39.710251Z",
"url": "https://files.pythonhosted.org/packages/5e/26/2622b325923c1483834d737014c89b8ba8839bc53fa6fc84a3fb5741adf7/automationhat-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f4dcb3584d2d0a3bb1ce7d0c14381a2958c9f11c828f7a29e077a370a8d20e88",
"md5": "a394ff4a4e36f90c48fa8349afdaf68d",
"sha256": "1d066c51f3f443a02614429b9107f41b09ce93e9b538a80028470a32a13606be"
},
"downloads": -1,
"filename": "automationhat-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a394ff4a4e36f90c48fa8349afdaf68d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 113952,
"upload_time": "2024-04-29T11:33:41",
"upload_time_iso_8601": "2024-04-29T11:33:41.837944Z",
"url": "https://files.pythonhosted.org/packages/f4/dc/b3584d2d0a3bb1ce7d0c14381a2958c9f11c828f7a29e077a370a8d20e88/automationhat-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 11:33:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pimoroni",
"github_project": "automationhat-python",
"github_not_found": true,
"lcname": "automationhat"
}
