Introduction

Documentation Status Discord

CircuitPython driver for Dallas 1-Wire temperature sensor.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

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

API Reference

adafruit_ds18x20

Driver for Dallas 1-Wire temperature sensor.

  • Author(s): Carter Nelson
class adafruit_ds18x20.DS18X20(bus, address)[source]

Class which provides interface to DS18X20 temperature sensor.

resolution

The programmable resolution. 9, 10, 11, or 12 bits.

temperature

The temperature in degrees Celsius.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds18x20 --library_location .