Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds18x20/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DS18X20/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 Dallas 1-Wire temperature sensor.
.. warning::
Blinka for RPi / SBC does not currently support OneWire directly. However,
you can use the `DS2482S-800 <https://github.com/adafruit/Adafruit_CircuitPython_DS248x>`_
as an I2C to OneWire bridge, see: `Learn Guide <https://learn.adafruit.com/adafruit-ds2482s-800-8-channel-i2c-to-1-wire-bus-adapter/circuitpython-and-python>`_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit OneWire <https://github.com/adafruit/Adafruit_CircuitPython_OneWire>`_
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>`_.
Usage Example
=============
.. code-block:: python
import board
from adafruit_onewire.bus import OneWireBus
from adafruit_ds18x20 import DS18X20
ow_bus = OneWireBus(board.D2)
ds18 = DS18X20(ow_bus, ow_bus.scan()[0])
ds18.temperature
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ds18x20",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, 1-wire, temperature, sensor, ds18x20, hardware, breakout, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/58/5e/a628a01c90274b2053d309dec8203905619a3c4d245a654653d40ef20e7e/adafruit_circuitpython_ds18x20-1.4.2.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds18x20/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DS18X20/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 Dallas 1-Wire temperature sensor.\n\n.. warning::\n Blinka for RPi / SBC does not currently support OneWire directly. However,\n you can use the `DS2482S-800 <https://github.com/adafruit/Adafruit_CircuitPython_DS248x>`_\n as an I2C to OneWire bridge, see: `Learn Guide <https://learn.adafruit.com/adafruit-ds2482s-800-8-channel-i2c-to-1-wire-bus-adapter/circuitpython-and-python>`_\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit OneWire <https://github.com/adafruit/Adafruit_CircuitPython_OneWire>`_\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\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n from adafruit_onewire.bus import OneWireBus\n from adafruit_ds18x20 import DS18X20\n\n ow_bus = OneWireBus(board.D2)\n ds18 = DS18X20(ow_bus, ow_bus.scan()[0])\n ds18.temperature\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for Dallas 1-Wire temperature sensor.",
"version": "1.4.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DS18X20"
},
"split_keywords": [
"adafruit",
" 1-wire",
" temperature",
" sensor",
" ds18x20",
" hardware",
" breakout",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86f04e152b201117206895ad8ad48347c9866da80739ba06eae83284d937633a",
"md5": "338f626ef4b584ca5b91f9a0f39d158f",
"sha256": "cf8bb2d9ff47acfc7110cd26d99630f28edd37f3cf05081e8c226f04bd98216a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ds18x20-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "338f626ef4b584ca5b91f9a0f39d158f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5436,
"upload_time": "2024-11-19T22:45:32",
"upload_time_iso_8601": "2024-11-19T22:45:32.504571Z",
"url": "https://files.pythonhosted.org/packages/86/f0/4e152b201117206895ad8ad48347c9866da80739ba06eae83284d937633a/adafruit_circuitpython_ds18x20-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "585ea628a01c90274b2053d309dec8203905619a3c4d245a654653d40ef20e7e",
"md5": "b9f1c978db7bc474dd74a481fcd9fe33",
"sha256": "9b958c19f5b1002f5a6b45aede8776c8dcbc28c40bd72254c7a3f7240bb18de0"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ds18x20-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "b9f1c978db7bc474dd74a481fcd9fe33",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27164,
"upload_time": "2024-11-19T22:45:33",
"upload_time_iso_8601": "2024-11-19T22:45:33.501226Z",
"url": "https://files.pythonhosted.org/packages/58/5e/a628a01c90274b2053d309dec8203905619a3c4d245a654653d40ef20e7e/adafruit_circuitpython_ds18x20-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 22:45:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DS18X20",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ds18x20"
}
JSON
