Publish

Author: HAIZAKURA

.gitignore

@@ -8,7 +8,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-build/
 develop-eggs/
 dist/
 downloads/

README.md

@@ -1,2 +1,40 @@
 # esp-sht3x-micropython
- A SHT3x (SHT30/31/35) Lib for esp8266/esp32 with micropython.
+ A SHT3x (SHT30/31/35) Lib for esp8266/esp32 with MicroPython.
+
+If you are using pyboard or another board, please modify the usage of `Pin` and `I2C` .
+
+## Usage
+
+```python
+from sht3x import SHT3x_Sensor
+
+sht3x_sensor = SHT3x_Sensor(freq = 100000, sdapin=5, sclpin=4)
+measure_data = sht3x_sensor.read_temp_humd()
+# measure_data = [22.9759, 73.8277]
+# The default decimal place is 4 digits
+temp = measure_data[0]
+humd = measure_data[1]
+
+print('Temp:', temp)
+# Temp: 22.9759
+print('Humd:', humd)
+# Humd: 73.8277
+```
+
+## Notice
+
+The default temperature is Celsius. If you need Fahrenheit, please change it in `sht3x.py` .
+
+Just uncomment the following code.
+
+```python
+# temperature = (315.0 * float(temperature_raw) / 65535.0) - 49
+```
+
+And comment the following code.
+
+```python
+temperature = (175.0 * float(temperature_raw) / 65535.0) - 45
+```
+
+The `build/sh3x.mpy` is a compiled bytecode file, and only can be used in `MicroPython v1.12+` .

build/sht3x.mpy

@@ -0,0 +1,30 @@
+import sys
+import utime
+from machine import Pin
+from machine import I2C
+
+class SHT3x_Sensor:
+
+	def __init__(self, freq, sdapin, sclpin):
+		self.i2c = I2C(freq=freq, sda=Pin(sdapin), scl=Pin(sclpin)) 
+		addrs = self.i2c.scan()
+		if not addrs:
+			raise Exception('no SHT3X found at bus on SDA pin %d SCL pin %d' % (sdapin, sclpin))
+		self.addr = addrs.pop()	
+
+	def read_temp_humd(self):
+		status = self.i2c.writeto(self.addr,b'\x24\x00')
+		# delay (20 slow)
+		utime.sleep(1)
+		# read 6 bytes
+		databytes = self.i2c.readfrom(self.addr, 6)
+		dataset = [databytes[0],databytes[1]]
+		dataset = [databytes[3],databytes[4]]
+		temperature_raw = databytes[0] << 8 | databytes[1]
+		temperature = (175.0 * float(temperature_raw) / 65535.0) - 45
+		# fahreheit
+		# temperature = (315.0 * float(temperature_raw) / 65535.0) - 49
+		humidity_raw = databytes[3] << 8  | databytes[4]
+		humidity = (100.0 * float(humidity_raw) / 65535.0)
+		sensor_data = [temperature, humidity]
+		return sensor_data