adafruit-circuitpython-ds1841


Nameadafruit-circuitpython-ds1841 JSON
Version 1.0.17 PyPI version JSON
download
home_page
SummaryI2C Logarithmic Resistor
upload_time2023-09-25 15:39:23
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython ds1841 log potentiometer pot bias
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds1841/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/ds1841/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_DS1841/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_DS1841/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 library for the Maxim DS1841 I2C Logarithmic Resistor


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-ds1841/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ds1841

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ds1841

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-ds1841

Usage Example
=============

.. code-block:: python

    from time import sleep
    import board
    import busio
    import adafruit_ds1841
    from analogio import AnalogIn

    ####### NOTE ################
    # this example will not work with Blinka/rasberry Pi due to the lack of analog pins.
    # Blinka and Raspberry Pi users should run the "ds1841_blinka_simpletest.py" example

    # WIRING:
    # 1 Wire connecting  VCC to RH to make a voltage divider using the
    #   internal resistor between RH and RW
    # 2 Wire connecting RW to A0

    i2c = busio.I2C(board.SCL, board.SDA)
    ds1841 = adafruit_ds1841.DS1841(i2c)
    wiper_output = AnalogIn(board.A0)

    while True:

        ds1841.wiper = 127
        print("Wiper set to %d"%ds1841.wiper)
        voltage = wiper_output.value
        voltage *= 3.3
        voltage /= 65535
        print("Wiper voltage: %.2f"%voltage)
        print("")
        sleep(1.0)

        ds1841.wiper = 0
        print("Wiper set to %d"%ds1841.wiper)
        voltage = wiper_output.value
        voltage *= 3.3
        voltage /= 65535
        print("Wiper voltage: %.2f"%voltage)
        print("")
        sleep(1.0)

        ds1841.wiper = 63
        print("Wiper set to %d"%ds1841.wiper)
        voltage = wiper_output.value
        voltage *= 3.3
        voltage /= 65535
        print("Wiper voltage: %.2f"%voltage)
        print("")
        sleep(1.0)


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ds1841/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_DS1841/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-ds1841",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,ds1841,Log,Potentiometer,pot,bias",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/eb/79/0faea2bb8c47c30e30947114a8825962e43ac47bbe0c63a28d4691889679/adafruit-circuitpython-ds1841-1.0.17.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds1841/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/ds1841/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_DS1841/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_DS1841/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 library for the Maxim DS1841 I2C Logarithmic Resistor\n\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ds1841/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-ds1841\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-ds1841\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-ds1841\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    from time import sleep\n    import board\n    import busio\n    import adafruit_ds1841\n    from analogio import AnalogIn\n\n    ####### NOTE ################\n    # this example will not work with Blinka/rasberry Pi due to the lack of analog pins.\n    # Blinka and Raspberry Pi users should run the \"ds1841_blinka_simpletest.py\" example\n\n    # WIRING:\n    # 1 Wire connecting  VCC to RH to make a voltage divider using the\n    #   internal resistor between RH and RW\n    # 2 Wire connecting RW to A0\n\n    i2c = busio.I2C(board.SCL, board.SDA)\n    ds1841 = adafruit_ds1841.DS1841(i2c)\n    wiper_output = AnalogIn(board.A0)\n\n    while True:\n\n        ds1841.wiper = 127\n        print(\"Wiper set to %d\"%ds1841.wiper)\n        voltage = wiper_output.value\n        voltage *= 3.3\n        voltage /= 65535\n        print(\"Wiper voltage: %.2f\"%voltage)\n        print(\"\")\n        sleep(1.0)\n\n        ds1841.wiper = 0\n        print(\"Wiper set to %d\"%ds1841.wiper)\n        voltage = wiper_output.value\n        voltage *= 3.3\n        voltage /= 65535\n        print(\"Wiper voltage: %.2f\"%voltage)\n        print(\"\")\n        sleep(1.0)\n\n        ds1841.wiper = 63\n        print(\"Wiper set to %d\"%ds1841.wiper)\n        voltage = wiper_output.value\n        voltage *= 3.3\n        voltage /= 65535\n        print(\"Wiper voltage: %.2f\"%voltage)\n        print(\"\")\n        sleep(1.0)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ds1841/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_DS1841/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "I2C Logarithmic Resistor",
    "version": "1.0.17",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DS1841"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "ds1841",
        "log",
        "potentiometer",
        "pot",
        "bias"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8b5261cec7464e6f20932e651995f0c038f2a4a57772559c53ea5c87e63fbff0",
                "md5": "27fe7fb48997894ab08ac699e72c5f04",
                "sha256": "d2049a10f0dda446e5c1cb230336c04e5ac0a2c90bc93dd3ea1db8b6fd662114"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ds1841-1.0.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "27fe7fb48997894ab08ac699e72c5f04",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5853,
            "upload_time": "2023-09-25T15:39:21",
            "upload_time_iso_8601": "2023-09-25T15:39:21.983125Z",
            "url": "https://files.pythonhosted.org/packages/8b/52/61cec7464e6f20932e651995f0c038f2a4a57772559c53ea5c87e63fbff0/adafruit_circuitpython_ds1841-1.0.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb790faea2bb8c47c30e30947114a8825962e43ac47bbe0c63a28d4691889679",
                "md5": "895aebff097a90cf9bfb582da4f26aed",
                "sha256": "4fa77c3c24a00e803e999a0060abf354c8af494435023ce7da3774e23aa9963d"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-ds1841-1.0.17.tar.gz",
            "has_sig": false,
            "md5_digest": "895aebff097a90cf9bfb582da4f26aed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27822,
            "upload_time": "2023-09-25T15:39:23",
            "upload_time_iso_8601": "2023-09-25T15:39:23.611355Z",
            "url": "https://files.pythonhosted.org/packages/eb/79/0faea2bb8c47c30e30947114a8825962e43ac47bbe0c63a28d4691889679/adafruit-circuitpython-ds1841-1.0.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:39:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_DS1841",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-ds1841"
}
        
Elapsed time: 1.09946s