(r2) SHT30NopI2CTemperatureAndHumiditySensor < IoT_Course

Tags: view all tags
---+ The SHT30 !I2C Temperature and Humidity Sensor
---++ Introduction

The SHT30 is a temperature and humidity sensor for the !I2C bus. Typical accuracy for temperature is +- 0.1 °C and +- 1.5% relative humidity. Sensirion, the company behind the SHT30 supplies a series of documents including the data sheet, several application notes and sample code, written in C for the !STM32F10x micro-controller. You can find them at [[https://www.sensirion.com/en/download-center/humidity-sensors/digital-humidity-sensors-for-various-applications/][https://www.sensirion.com/en/download-center/humidity-sensors/digital-humidity-sensors-for-various-applications.]]

There is also [[https://github.com/rsc1975/micropython-sht30][a SHT30 driver written for !MicroPython on the ESP8266]] but unfortunately it did not work on the ESP32 out of the box and it implements only a small subset of the SHT30's functions. I therefore developed a driver called sht3x translating the Sensirion code into !MicroPython.

Here is a list of functions, their command codes and if they are implemented in the SHT30 driver:

| Function | Repeatability | measurement per s | Clock Stretching | Command Code | Implemented in SHT30 driver |
| Single shot data acquisition | High | | enabled | 0x2C06 | no |
| ^ | Medium | ^ | ^ | 0x2C0D | no |
| ^ | Low | ^ | ^ | 0x2C10 | no |
| ^ | High | ^ | disabled | 0x2400 | yes |
| ^ | Medium | ^ | ^ | 0x240B | no |
| ^ | Low | ^ | ^ | 0x2416 | no |
| Continuous data acquisition | High |  0.5  | disabled | 0x2032 | no |
| ^ | Medium | ^ | ^ | 0x2024 | no |
| ^ | Low | ^ | ^ | 0x202F | no |
| ^ | High |  1  | ^ | 0x2130 | no |
| ^ | Medium | ^ | ^ | 0x2120 | no |
| ^ | Low | ^ | ^ | 0x212D | no |
| ^ | High |  2  | ^ | 0x2236 | no |
| ^ | Medium | ^ | ^ | 0x2220 | no |
| ^ | Low | ^ | ^ | 0x222B | no |
| ^ | High |  4  | ^ | 0x2334 | no |
| ^ | Medium | ^ | ^ | 0x2322 | no |
| ^ | Low | ^ | ^ | 0x2329 | no |
| ^ | High |  10  | ^ | 0x2737 | no |
| ^ | Medium | ^ | ^ | 0x2722 | no |
| ^ | Low | ^ | ^ | 0x272A | no |
| Read serial number | | | | 0x3780 | no |
| Fetch Data | | | | 0xE000 | no |
| Accelerated Response Time | ^ | ^ | ^ | 0x2B32 | no |
| Break continuous acquisition | ^ | ^ | ^ | 0x3093 | no |
| Soft Reset | ^ | ^ | ^ | 0x30A2 | yes |
| Heater enable | ^ | ^ | ^ | 0x306D | yes |
| Heater disable | ^ | ^ | ^ | 0x3066 | yes |
| Read out status register | ^ | ^ | ^ | 0xF32D | yes |
| Clear status register | ^ | ^ | ^ | 0x3041 | yes |
| Read high alert limit | set | ^ | ^ | 0xE11F | no |
| ^ | clear | ^ | ^ | 0xE114 | no |
| Read low alert limit | set | ^ | ^ | 0xE109 | no |
| ^ | clear | ^ | ^ | 0xE102 | no |
| Write high alert limit | set | ^ | ^ | 0x611D | no |
| ^ | clear | ^ | ^ | 0x6116 | no |
| Write low alert limit | set | ^ | ^ | 0x610B | no |
| ^ | clear | ^ | ^ | 0x6100 | no |

---++ Methods available in the !SHT3X class

Here is a list of the available methods of the !SHT3Xclass:

*__init__(scl_pin=machine.Pin(22),sda_pin=machine.Pin(21),i2c,address=0x45)*: creates an instance of the !SHT3X object. The default values for scl_pin, sda_pin and i2c_address should be ok for the ESP32 and our version of the SHT30 shield. The method raises an !SHT3XError.BUS_ERROR if the sht30 chip is not found on the !I2C bus

_from sht3x import !SHT3X_

_sht30 = !SHT3X()_

should therefore work and create the !SHT3X object.

*sht30.isPresent()*: returns <i>True </i>if the sht30 is chip is found on the !I2C bus, _False_ otherwise

<b>sht30.serialNumber(): </b>Returns the 32 bit serial number of the sht30 chip

<b>sht30.readStatus(): </b>Returns the status bits (16 bits) from the status register

<b>sht30.printStatus(): </b>Prints the status bits from the sht30 status register in a humanly readable form

*sht30.clearStatus()*: Clears the status register

*sht30.softReset()*: Resets the sht30

*sht30.enableHeater()*: Switches the heater on

*sht30.disableHeater()*: Switches the heater off

*sht30.getTempAndHumi(clockStretching=!SHT3X.CLOCK_STRETCH, repeatability=!SHT3X.REP_S_LOW, raw=False, timeout=100)*

get temperature and humidity in the selected mode. If clock stretching as been selected the corresponding command 0x2cxx is issued followed by a wait until the measurement has been completed. The wait time used is the maximum measurement time for that mode found in table 4 chapter 2.2 of the data sheet.

If no clock stretching is selected the method will poll the sht30 every ms for the result data. It within "timeout ms" the sht30 does not return the result an !SHT3X.TIMEOUT error is raised.

After the wait, the data are read out and the checksum checked. If the checksum received is wrong an !SHT3X.CRC_ERROR is raised.

If raw mode has been selected the 6 byte result (16 bits for temperature, 16 bits humidity and 2*8 bits checksums) is returned. Otherwise the raw values are converted to physical temperature values (in °C) and relative humidity (in %) which are returned to the caller.

*sht30.Celsius2Fahrenheit(tempC)*: takes a temperature value in °C and converts it to °F

<b>sht30.startPeriodicMeas(mps=0.5,repeatability=self.REP_P_HIGH): </b>starts repetitive measurements in the selected mode. In "continuous mode" clock stretching is not done. Here I wait for the period selected before the data are read out.

*sht30.stopPeriodicMeas()*: Stops "continuous measurement mode"

<b>sht30.measPeriodic(self,mps=0.5, repeatability=REP_P_HIGH, raw=False, noOfMeas=50): </b>Starts continuous measurements using sht30.startPeriodicMeas(), reads out the data after each measurement cycle and stores them into a list, stops continuous measurements using stopPeriodicMeas() as soon as "noOfMeas" measurements have been reached. Returns the list of acquired measurements.

-- %USERSIG{UliRaich - 2020-05-22}%

---++ Comments

%COMMENT%
Topic revision: r2 - 2020-05-22 - UliRaich