adafruit-circuitpython-ds3502


Nameadafruit-circuitpython-ds3502 JSON
Version 1.1.19 PyPI version JSON
download
home_page
SummaryCircuitPython library for the Maxim DS3502 I2C Potentionmeter
upload_time2023-09-25 15:39:46
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython ds3502 potentiometer pot resistance
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-ds3502/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/ds3502/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_DS3502/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_DS3502/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 DS3502 I2C Potentiometer


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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-ds3502

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ds3502

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

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

.. code-block:: python

    from time import sleep
    import board
    import adafruit_ds3502
    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 "ds3502_blinka_simpletest.py" example

    i2c = board.I2C()
    ds3502 = adafruit_ds3502.DS3502(i2c)
    wiper_output = AnalogIn(board.A0)

    while True:

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

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

        ds3502.wiper = 63
        print("Wiper set to %d"%ds3502.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/ds3502/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_DS3502/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-ds3502",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,ds3502,potentiometer,pot,resistance",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/fe/d1/9e21b499f42d59b94218604c19cb329e2f5f011a9219c4d6e351c8713e40/adafruit-circuitpython-ds3502-1.1.19.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds3502/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/ds3502/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_DS3502/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_DS3502/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 DS3502 I2C Potentiometer\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-ds3502/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-ds3502\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-ds3502\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-ds3502\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    from time import sleep\n    import board\n    import adafruit_ds3502\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 \"ds3502_blinka_simpletest.py\" example\n\n    i2c = board.I2C()\n    ds3502 = adafruit_ds3502.DS3502(i2c)\n    wiper_output = AnalogIn(board.A0)\n\n    while True:\n\n        ds3502.wiper = 127\n        print(\"Wiper set to %d\"%ds3502.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        ds3502.wiper = 0\n        print(\"Wiper set to %d\"%ds3502.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        ds3502.wiper = 63\n        print(\"Wiper set to %d\"%ds3502.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/ds3502/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_DS3502/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for the Maxim DS3502 I2C Potentionmeter",
    "version": "1.1.19",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DS3502"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "ds3502",
        "potentiometer",
        "pot",
        "resistance"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d67aef62b899f707e9c43885d8313d70a4a0cc2552e09a9783b5e52df44ffdfc",
                "md5": "7a5e1396b4fe85ae74f15d748e1ede32",
                "sha256": "d0f8b084f1a5652ebdc726618680b43621b733cc5c02ba4081a9042af6cba651"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ds3502-1.1.19-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7a5e1396b4fe85ae74f15d748e1ede32",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4852,
            "upload_time": "2023-09-25T15:39:45",
            "upload_time_iso_8601": "2023-09-25T15:39:45.110511Z",
            "url": "https://files.pythonhosted.org/packages/d6/7a/ef62b899f707e9c43885d8313d70a4a0cc2552e09a9783b5e52df44ffdfc/adafruit_circuitpython_ds3502-1.1.19-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fed19e21b499f42d59b94218604c19cb329e2f5f011a9219c4d6e351c8713e40",
                "md5": "05a75f4ad26bf949fc3192998810af20",
                "sha256": "738e2be0d0c5abd0568c93f532517735e7fc27a8361efcb8fa917c129af0156b"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-ds3502-1.1.19.tar.gz",
            "has_sig": false,
            "md5_digest": "05a75f4ad26bf949fc3192998810af20",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26437,
            "upload_time": "2023-09-25T15:39:46",
            "upload_time_iso_8601": "2023-09-25T15:39:46.539461Z",
            "url": "https://files.pythonhosted.org/packages/fe/d1/9e21b499f42d59b94218604c19cb329e2f5f011a9219c4d6e351c8713e40/adafruit-circuitpython-ds3502-1.1.19.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:39:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_DS3502",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-ds3502"
}
        
Elapsed time: 0.12362s