This little pure python module provides a single class to get the temperature of a w1 sensor
Project description
# W1ThermSensor
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/timofurrer/w1thermsensor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
> Get the temperature from your w1 therm sensor in a single line of code!<br>
> It's designed to be used with the Rasperry Pi hardware but also works on a Beagle Bone and others.
***
[![Build Status](https://travis-ci.org/timofurrer/w1thermsensor.svg?branch=master)](https://travis-ci.org/timofurrer/w1thermsensor) [![codecov.io](http://codecov.io/github/timofurrer/w1thermsensor/coverage.svg?branch=master)](http://codecov.io/github/timofurrer/w1thermsensor?branch=master) [![Code Climate](https://codeclimate.com/github/timofurrer/w1thermsensor/badges/gpa.svg)](https://codeclimate.com/github/timofurrer/w1thermsensor) [![Code Health](https://landscape.io/github/timofurrer/w1thermsensor/master/landscape.svg?style=flat)](https://landscape.io/github/timofurrer/w1thermsensor/master) [![PyPI version](https://badge.fury.io/py/w1thermsensor.svg)](https://badge.fury.io/py/w1thermsensor)
**New:** use [w1thermsensor as a CLI tool](#usage-as-cli-tool)! - Since version *0.3.0*
**Raspberry Pi:** this package is available in Rasbian as `python-w1thermsensor` and `python3-w1thermsensor`.
## Supported devices
The following w1 therm sensor devices are supported:
* DS18S20
* DS1822
* DS18B20
* DS28EA00
* DS1825/MAX31850K
## Setup
You just need a w1 therm sensor. <br>
Some of them can be bought here: [Adafruit: DS18B20](https://www.adafruit.com/search?q=DS18B20) <br>
I've used a Raspberry Pi with an GPIO Breakout (Pi Cobbler). Other hardware like the Beagle Bone are supported, too.
## Installation
### From PIP
This possibility is supported on all distribution:
pip install w1thermsensor
*Note: maybe root privileges are required*
### On Raspbian using apt-get
If you are using the `w1thermsensor` module on a Rasperry Pi running raspbian you can install it from the offical repository:
```bash
sudo apt-get install python-w1thermsensor
```
Or if you are using python 3:
```bash
sudo apt-get install python3-w1thermsensor
```
### Create debian packages
debuild -us -uc
## Usage as python package
The usage is very simple and the interface clean..
All examples are with the `DS18B20` sensor - It works the same way for the other supported devices.
### Basic usage with one sensor (implicit)
```python
from w1thermsensor import W1ThermSensor
sensor = W1ThermSensor()
temperature_in_celsius = sensor.get_temperature()
temperature_in_fahrenheit = sensor.get_temperature(W1ThermSensor.DEGREES_F)
temperature_in_all_units = sensor.get_temperatures([
W1ThermSensor.DEGREES_C,
W1ThermSensor.DEGREES_F,
W1ThermSensor.KELVIN])
```
The need kernel modules will be automatically loaded in the constructor of the `W1ThermSensor` class. <br>
If something went wrong an exception is raised.
*The first found sensor will be taken*
### Basic usage with one sensor (explicit)
The DS18B20 sensor with the ID `00000588806a` will be taken.
```python
from w1thermsensor import W1ThermSensor
sensor = W1ThermSensor(W1ThermSensor.THERM_SENSOR_DS18B20, "00000588806a")
temperature_in_celsius = sensor.get_temperature()
```
### Multiple sensors
With the `get_available_sensors` class-method you can get the ids of all available sensors.
```python
from w1thermsensor import W1ThermSensor
for sensor in W1ThermSensor.get_available_sensors():
print("Sensor %s has temperature %.2f" % (sensor.id, sensor.get_temperature()))
```
Only sensors of a specific therm sensor type:
```python
from w1thermsensor import W1ThermSensor
for sensor in W1ThermSensor.get_available_sensors([W1ThermSensor.THERM_SENSOR_DS18B20]):
print("Sensor %s has temperature %.2f" % (sensor.id, sensor.get_temperature()))
```
## Usage as CLI tool
The w1thermsensor module can be used as CLI tool since version `0.3.0`. <br>
*Please note that the CLI tool will only get installed with the Raspbian Python 3 package* (`sudo apt-get install python3-w1thermsensor`)
### List sensors
List all available sensors:
```
$ w1thermsensor ls
$ w1thermsensor ls --json # show results in JSON format
```
List only sensors of a specific type:
```
$ w1thermsensor ls --type DS1822
$ w1thermsensor ls --type DS1822 --type MAX31850K # specify multiple sensor types
$ w1thermsensor ls --type DS1822 --json # show results in JSON format
```
### Show temperatures
Show temperature of all available sensors: (Same synopsis as `ls`)
```
$ w1thermsensor all --type DS1822
$ w1thermsensor all --type DS1822 --type MAX31850K # specify multiple sensor types
$ w1thermsensor all --type DS1822 --json # show results in JSON format
```
Show temperature of a single sensor:
```
$ w1thermsensor get 1 # 1 is the id obtained by the ls command
$ w1thermsensor get --hwid 00000588806a --type DS18B20
$ w1thermsensor get 1 # show results in JSON format
```
## Contribution
I'm happy about all types of contributions to this project! :beers:
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/timofurrer/w1thermsensor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
> Get the temperature from your w1 therm sensor in a single line of code!<br>
> It's designed to be used with the Rasperry Pi hardware but also works on a Beagle Bone and others.
***
[![Build Status](https://travis-ci.org/timofurrer/w1thermsensor.svg?branch=master)](https://travis-ci.org/timofurrer/w1thermsensor) [![codecov.io](http://codecov.io/github/timofurrer/w1thermsensor/coverage.svg?branch=master)](http://codecov.io/github/timofurrer/w1thermsensor?branch=master) [![Code Climate](https://codeclimate.com/github/timofurrer/w1thermsensor/badges/gpa.svg)](https://codeclimate.com/github/timofurrer/w1thermsensor) [![Code Health](https://landscape.io/github/timofurrer/w1thermsensor/master/landscape.svg?style=flat)](https://landscape.io/github/timofurrer/w1thermsensor/master) [![PyPI version](https://badge.fury.io/py/w1thermsensor.svg)](https://badge.fury.io/py/w1thermsensor)
**New:** use [w1thermsensor as a CLI tool](#usage-as-cli-tool)! - Since version *0.3.0*
**Raspberry Pi:** this package is available in Rasbian as `python-w1thermsensor` and `python3-w1thermsensor`.
## Supported devices
The following w1 therm sensor devices are supported:
* DS18S20
* DS1822
* DS18B20
* DS28EA00
* DS1825/MAX31850K
## Setup
You just need a w1 therm sensor. <br>
Some of them can be bought here: [Adafruit: DS18B20](https://www.adafruit.com/search?q=DS18B20) <br>
I've used a Raspberry Pi with an GPIO Breakout (Pi Cobbler). Other hardware like the Beagle Bone are supported, too.
## Installation
### From PIP
This possibility is supported on all distribution:
pip install w1thermsensor
*Note: maybe root privileges are required*
### On Raspbian using apt-get
If you are using the `w1thermsensor` module on a Rasperry Pi running raspbian you can install it from the offical repository:
```bash
sudo apt-get install python-w1thermsensor
```
Or if you are using python 3:
```bash
sudo apt-get install python3-w1thermsensor
```
### Create debian packages
debuild -us -uc
## Usage as python package
The usage is very simple and the interface clean..
All examples are with the `DS18B20` sensor - It works the same way for the other supported devices.
### Basic usage with one sensor (implicit)
```python
from w1thermsensor import W1ThermSensor
sensor = W1ThermSensor()
temperature_in_celsius = sensor.get_temperature()
temperature_in_fahrenheit = sensor.get_temperature(W1ThermSensor.DEGREES_F)
temperature_in_all_units = sensor.get_temperatures([
W1ThermSensor.DEGREES_C,
W1ThermSensor.DEGREES_F,
W1ThermSensor.KELVIN])
```
The need kernel modules will be automatically loaded in the constructor of the `W1ThermSensor` class. <br>
If something went wrong an exception is raised.
*The first found sensor will be taken*
### Basic usage with one sensor (explicit)
The DS18B20 sensor with the ID `00000588806a` will be taken.
```python
from w1thermsensor import W1ThermSensor
sensor = W1ThermSensor(W1ThermSensor.THERM_SENSOR_DS18B20, "00000588806a")
temperature_in_celsius = sensor.get_temperature()
```
### Multiple sensors
With the `get_available_sensors` class-method you can get the ids of all available sensors.
```python
from w1thermsensor import W1ThermSensor
for sensor in W1ThermSensor.get_available_sensors():
print("Sensor %s has temperature %.2f" % (sensor.id, sensor.get_temperature()))
```
Only sensors of a specific therm sensor type:
```python
from w1thermsensor import W1ThermSensor
for sensor in W1ThermSensor.get_available_sensors([W1ThermSensor.THERM_SENSOR_DS18B20]):
print("Sensor %s has temperature %.2f" % (sensor.id, sensor.get_temperature()))
```
## Usage as CLI tool
The w1thermsensor module can be used as CLI tool since version `0.3.0`. <br>
*Please note that the CLI tool will only get installed with the Raspbian Python 3 package* (`sudo apt-get install python3-w1thermsensor`)
### List sensors
List all available sensors:
```
$ w1thermsensor ls
$ w1thermsensor ls --json # show results in JSON format
```
List only sensors of a specific type:
```
$ w1thermsensor ls --type DS1822
$ w1thermsensor ls --type DS1822 --type MAX31850K # specify multiple sensor types
$ w1thermsensor ls --type DS1822 --json # show results in JSON format
```
### Show temperatures
Show temperature of all available sensors: (Same synopsis as `ls`)
```
$ w1thermsensor all --type DS1822
$ w1thermsensor all --type DS1822 --type MAX31850K # specify multiple sensor types
$ w1thermsensor all --type DS1822 --json # show results in JSON format
```
Show temperature of a single sensor:
```
$ w1thermsensor get 1 # 1 is the id obtained by the ls command
$ w1thermsensor get --hwid 00000588806a --type DS18B20
$ w1thermsensor get 1 # show results in JSON format
```
## Contribution
I'm happy about all types of contributions to this project! :beers:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
w1thermsensor-0.3.4.tar.gz
(8.3 kB
view hashes)
Built Distributions
Close
Hashes for w1thermsensor-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44be76ccb2ce0cff47dbd380282b0a57c6bb19c04f4686cfa0337a603b7b124d |
|
MD5 | 44f0de369fcb085032beb107418fd90b |
|
BLAKE2b-256 | f0c68333f5c3c8214fe8bdbcd5f25461541e53247bd94b78212c88360ec4494a |
Close
Hashes for w1thermsensor-0.3.4-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38e21f256b2083bc79ca39816143e2320f892251c0310aede9c324bf631b683d |
|
MD5 | 2a67708ffd31d8cb7cff13a87d8dee69 |
|
BLAKE2b-256 | e810e961f7f3085c9bb45fe3088095cb905be7ca120d3564ab3ba9b55a1ef8b5 |