Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-emc2101/badge/?version=latest
:target: https://docs.circuitpython.org/projects/emc2101/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython driver for EMC2101 brushless fan controller
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-emc2101/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-emc2101
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-emc2101
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-emc2101
Usage Example
=============
.. code-block:: python3
import time
import board
from adafruit_emc2101 import EMC2101
i2c = board.I2C() # uses board.SCL and board.SDA
emc = EMC2101(i2c)
print("Setting fan speed to 25%")
emc.manual_fan_speed = 25
time.sleep(2) # longer sleep to let it spin down from 100%
print("Fan speed", emc.fan_speed)
Additional examples, including the use of the temperature look up table
(LUT) can be found in the examples/ folder:
* emc2101_lut_example.py
* emc2101_set_pwm_freq.py
* emc2101_simpletest.py
For access to some additional properties, but without configuring the LUT,
use the intermediate class EMC2101_EXT:
.. code-block:: python3
import time
import board
from adafruit_emc2101 import EMC2101_EXT
i2c = board.I2C() # uses board.SCL and board.SDA
emc = EMC2101_EXT(i2c)
print("External limit temp is", emc.external_temp_high_limit)
print("Setting external limit temp to 50C")
emc.external_temp_high_limit = 50
When the temperature limits are exceeded the device sets the alert bit
in the status register and (if configured to do so) will raise the ALERT
output pin as an interrupt.
EMC2101_EXT defines properties for internal and external temperature
limits, and has register definitions for all registers except the LUT
itself. The EMC2101_LUT class includes this as well.
The EMC2101_Regs class is intended for internal use, and defines register
addresses.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/emc2101/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-emc2101",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,emc2101,Fan,Controller,RPM,Noctua,Sunon,Cooling,Thermostat,PWM,Tach",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f9/3e/8a57cee80d49724fef864f8f1dd55b20dd76a7ce35e8092dc6f32dd2ecb1/adafruit-circuitpython-emc2101-1.2.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-emc2101/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/emc2101/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython driver for EMC2101 brushless fan controller\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-emc2101/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-emc2101\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-emc2101\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-emc2101\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n from adafruit_emc2101 import EMC2101\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n\n emc = EMC2101(i2c)\n print(\"Setting fan speed to 25%\")\n emc.manual_fan_speed = 25\n time.sleep(2) # longer sleep to let it spin down from 100%\n print(\"Fan speed\", emc.fan_speed)\n\nAdditional examples, including the use of the temperature look up table\n(LUT) can be found in the examples/ folder:\n\n* emc2101_lut_example.py\n* emc2101_set_pwm_freq.py\n* emc2101_simpletest.py\n\nFor access to some additional properties, but without configuring the LUT,\nuse the intermediate class EMC2101_EXT:\n\n.. code-block:: python3\n\n import time\n import board\n from adafruit_emc2101 import EMC2101_EXT\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n\n emc = EMC2101_EXT(i2c)\n print(\"External limit temp is\", emc.external_temp_high_limit)\n print(\"Setting external limit temp to 50C\")\n emc.external_temp_high_limit = 50\n\nWhen the temperature limits are exceeded the device sets the alert bit\nin the status register and (if configured to do so) will raise the ALERT\noutput pin as an interrupt.\n\nEMC2101_EXT defines properties for internal and external temperature\nlimits, and has register definitions for all registers except the LUT\nitself. The EMC2101_LUT class includes this as well.\n\nThe EMC2101_Regs class is intended for internal use, and defines register\naddresses.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/emc2101/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Brushless fan controller",
"version": "1.2.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_EMC2101"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"emc2101",
"fan",
"controller",
"rpm",
"noctua",
"sunon",
"cooling",
"thermostat",
"pwm",
"tach"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce1c789924d86fe7214fcd87a8a1af1405fa2f987122a8f790d1269ff4c7a5e8",
"md5": "15d7aafda73d0d696e241f6facc56069",
"sha256": "8e466df8519e3447b2fe535b91cd6de93e0fb888b9903ba0c96d632705e470bd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_emc2101-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15d7aafda73d0d696e241f6facc56069",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21569,
"upload_time": "2023-09-25T15:39:58",
"upload_time_iso_8601": "2023-09-25T15:39:58.519276Z",
"url": "https://files.pythonhosted.org/packages/ce/1c/789924d86fe7214fcd87a8a1af1405fa2f987122a8f790d1269ff4c7a5e8/adafruit_circuitpython_emc2101-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f93e8a57cee80d49724fef864f8f1dd55b20dd76a7ce35e8092dc6f32dd2ecb1",
"md5": "0b385a2fa5f50b4c7c99fa1844b9eb1e",
"sha256": "40569ecdfd8af237c7bb048de9591429383764a2e7b418ae19d599cf1c7f92d8"
},
"downloads": -1,
"filename": "adafruit-circuitpython-emc2101-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "0b385a2fa5f50b4c7c99fa1844b9eb1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38775,
"upload_time": "2023-09-25T15:40:01",
"upload_time_iso_8601": "2023-09-25T15:40:01.239780Z",
"url": "https://files.pythonhosted.org/packages/f9/3e/8a57cee80d49724fef864f8f1dd55b20dd76a7ce35e8092dc6f32dd2ecb1/adafruit-circuitpython-emc2101-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:40:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_EMC2101",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-emc2101"
}
JSON
