adafruit-circuitpython-us100


Nameadafruit-circuitpython-us100 JSON
Version 1.1.17 PyPI version JSON
download
home_page
SummaryCircuitPython library for reading distance and temperature via US-100 ultra-sonic sensor.
upload_time2024-02-08 22:58:37
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit us100 temperature temp distance sensor ultra-sonic hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka pyserial
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-us100/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/us100/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_US100/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_US100/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 reading distance and temperature via US-100 ultra-sonic sensor


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-us100

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-us100

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

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

.. code-block:: python

	import time
	import board
	import busio
	import adafruit_us100

	uart = busio.UART(board.TX, board.RX, baudrate=9600)
	# Create a US-100 module instance.
	us100 = adafruit_us100.US100(uart)

	while True:
	    print("-----")
	    print(f"Temperature: {us100.temperature}°C")
	    print(f"Distance: {us100.distance} cm")
	    time.sleep(0.5)


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

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-us100",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,us100,temperature,temp,distance,sensor,ultra-sonic,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/91/44/1277407fab41156026d0990ef11ce67bf2c016c45b41450e7363b995b960/adafruit-circuitpython-us100-1.1.17.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-us100/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/us100/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_US100/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_US100/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 reading distance and temperature via US-100 ultra-sonic sensor\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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-us100/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-us100\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-us100\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-us100\n\nUsage Example\n=============\n\n.. code-block:: python\n\n\timport time\n\timport board\n\timport busio\n\timport adafruit_us100\n\n\tuart = busio.UART(board.TX, board.RX, baudrate=9600)\n\t# Create a US-100 module instance.\n\tus100 = adafruit_us100.US100(uart)\n\n\twhile True:\n\t    print(\"-----\")\n\t    print(f\"Temperature: {us100.temperature}\u00b0C\")\n\t    print(f\"Distance: {us100.distance} cm\")\n\t    time.sleep(0.5)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/us100/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_US100/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for reading distance and temperature via US-100 ultra-sonic sensor.",
    "version": "1.1.17",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_US100"
    },
    "split_keywords": [
        "adafruit",
        "us100",
        "temperature",
        "temp",
        "distance",
        "sensor",
        "ultra-sonic",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6b0e538de0c095d30ee43247a088717530eeae38f92f0e8f989b90b30191f45",
                "md5": "5ceda6fa735ec785cab9f489b29a2053",
                "sha256": "73e21a5ecadb5a127a0bfc568f3b9613b88cf7a1c0edd1342384ad3198b5adca"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_us100-1.1.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5ceda6fa735ec785cab9f489b29a2053",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4943,
            "upload_time": "2024-02-08T22:58:35",
            "upload_time_iso_8601": "2024-02-08T22:58:35.013614Z",
            "url": "https://files.pythonhosted.org/packages/c6/b0/e538de0c095d30ee43247a088717530eeae38f92f0e8f989b90b30191f45/adafruit_circuitpython_us100-1.1.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "91441277407fab41156026d0990ef11ce67bf2c016c45b41450e7363b995b960",
                "md5": "e8965556f34e73acd7e482f7d4ab2e7c",
                "sha256": "2a9d43c894f4cc557de93102a3932d373f4d203951a27998b09a966ecdff29be"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-us100-1.1.17.tar.gz",
            "has_sig": false,
            "md5_digest": "e8965556f34e73acd7e482f7d4ab2e7c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 25853,
            "upload_time": "2024-02-08T22:58:37",
            "upload_time_iso_8601": "2024-02-08T22:58:37.319538Z",
            "url": "https://files.pythonhosted.org/packages/91/44/1277407fab41156026d0990ef11ce67bf2c016c45b41450e7363b995b960/adafruit-circuitpython-us100-1.1.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-08 22:58:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_US100",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "pyserial",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-us100"
}
        
Elapsed time: 0.82770s