# MS8607

**Repository Path**: github_project/MS8607

## Basic Information

- **Project Name**: MS8607
- **Description**: MS8607MS8607MS8607
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-15
- **Last Updated**: 2023-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MS8607 Python module for Raspberry Pi via direct I²C
This Python module contains the class that encapsulates basic methods to communicate with the MS8607 board via a direct I²C interface.

![MS8607 Grove board](https://github.com/anton-a-tkachev/MS8607/blob/master/71023519.jpg "MS8607 Grove board")
![MS8607 PHT sensor](https://github.com/anton-a-tkachev/MS8607/blob/master/product-details.png "MS8607 PHT sensor")

MS8607 is a Grove-board equipped with the MS8607-02BA01 PHT-sensor (pressure-humidity-temperature) that connects to your Raspberry Pi via the direct I²C interface. For Raspberry Pi models A+/B+/2B/3B/3B+/3A+/Zero the I²C interface uses the following GPIO pins:

GPIO PIN | I²C wire |  GROVE wire color
---|---|---
#4 | 5V power | RED
#6 | Ground | BLACK
#3 | SDA | WHITE
#5 | SCL | YELLOW

![Raspberry Pi GPIO pinout diagram](https://github.com/anton-a-tkachev/MS8607/blob/master/GPIO-Pinout-Diagram-2.png "Raspberry Pi GPIO pinout diagram")

![MS8607 connected to Raspberry Pi via Grove cable](https://github.com/anton-a-tkachev/MS8607/blob/master/IMG_20200510_180430.jpg)

For other Raspberry Pi models, please refer to GPIO pinout documentation.

To make this Python module work with your Raspberry Pi follow the steps listed below:
1. Activate I2C interface in your OS. In Raspbian this can be done with the default configuration utility ```sudo raspi-config```
2. Install pigpio daemon in the OS with ```sudo apt-get install pigpiod``` 
3. Install pigpio module in python with ```pip install pigpio```
4. Run pigpio daemon in the OS with ```sudo pigpiod``` prior to using the MS8607 module in Python
5. Now that you have the daemon running in background, you can import and use the MS8607 module in your Python project ```from MS8607 import MS8607```

A detailed description of pigpio Python module can be found on [pigpio library](http://abyz.me.uk/rpi/pigpio/python.html)

## Basic usage
For a minimal usage example please refer to the file [example.py](https://github.com/anton-a-tkachev/MS8607/blob/master/example.py). 
You can simply run the file with ```python example.py``` from your terminal

```Python
from MS8607_WL import MS8607

sensor = MS8607()

print(sensor.get_t())      # get temperature (with two auxilary variables)
print(sensor.get_rh())     # get humidity (temperature uncompensated)
print(sensor.get_tp())     # get temperature and pressure
print(sensor.get_th())     # get temperature and humidity (temperature compensated)
print(sensor.get_tph())    # get temperature, pressure and humidity (temperature compensated)
```

Which should output something like this
```
(21.696204048395156, 2169.6204048395157, 52631)
57.564300537109375
(21.718119245767593, 986.0175926909147)
(21.84103772044182, 57.88805793225765)
(21.730527114868163, 986.0183309207076, 57.700319343566896)
```

## MS8607 list of methods
Here are enumerated the methods to communicate with the MS8607 board via I2C interface in Python

### ```MS8607(i2c_bus, pi)``` - constructor
Initializes a connection with the sensors, resets the sensors, and fetches conversion coefficients from 0x76 device - temperature and pressure sensor.
The constructor takes two variables:
- I2C bus number (by default ```i2c_bus = 1```)
- pigpio connection handle (by default ```pi = pigpio.pi()```)

When something goes wrong at this stage, there is no exception handling so that the user will get a standard error message from python interpreter.

### ```get_t()``` - measure temperature
Attempts to fetch temperature data from the MS8607 board.
Returns a tuple:
- Temperature in degrees Celsius,
- TEMP - auxilary variable used for calculations,
- dT - auxilary variable used for calculations

When unable to fetch the data or any other error, returns ```None``` values.

### ```get_tp()``` - measure temperature and pressure
Returns a tuple:
- Temperature in degrees Celsius,
- Pressure in mbar or hPa (which is the same)

When unable to fetch the data or any other error, returns ```None``` values. Note that the pressure measurement depends on the ambient temperature, so that there is no method for independent pressure measurement.

### ```get_rh(T)``` - measure relative humidity
Returns relative humidity in %. Ambient temperature can be passed to this method for a slightly better accuracy of the relative humidity measurement. If no temperature is provided to the method, then it measures the relative humidity without the temperature compensation. 
When unable to fetch the data or any other error, returns ```None```.

### ```get_tph()``` - measure temperature, pressure and humidity
Returns a tuple:
- Temperature in degrees Celsius,
- Pressure in mbar or hPa (which is the same),
- Relative humidity in % (temperature compensated for a slightly better accuracy)

When unable to fetch the data or any other error, returns ```None```.

### ```get_th()``` - measure temperature and humidity
Returns a tuple:
- Temperature in degrees Celsius,
- Relative humidity in % (temperature compensated for a slightly better accuracy)

When unable to fetch the data or any other error, returns ```None```.