1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
# HTU21D(F)/Si7013/Si7020/Si7021/SHT21 i2c based temperature sensors support
#
# Copyright (C) 2020 Lucio Tarantino <lucio.tarantino@gmail.com>
#
# This file may be distributed under the terms of the GNU GPLv3 license.
import logging
from . import bus
######################################################################
# NOTE: The implementation requires write support of length 0
# before reading on the i2c bus of the mcu.
#
# Compatible Sensors:
# HTU21D - Tested on Linux MCU.
# Si7013 - Untested
# Si7020 - Untested
# Si7021 - Tested on Pico MCU
# SHT21 - Tested on Linux MCU.
#
######################################################################
HTU21D_I2C_ADDR = 0x40
HTU21D_COMMANDS = {
"HTU21D_TEMP": 0xE3,
"HTU21D_HUMID": 0xE5,
"HTU21D_TEMP_NH": 0xF3,
"HTU21D_HUMID_NH": 0xF5,
"WRITE": 0xE6,
"READ": 0xE7,
"RESET": 0xFE,
"SERIAL": [0xFA, 0x0F, 0xFC, 0xC9],
"FIRMWARE_READ": [0x84, 0xB8],
}
HTU21D_RESOLUTION_MASK = 0x7E
HTU21D_RESOLUTIONS = {
"TEMP14_HUM12": int("00000000", 2),
"TEMP13_HUM10": int("10000000", 2),
"TEMP12_HUM08": int("00000001", 2),
"TEMP11_HUM11": int("10000001", 2),
}
ID_MAP = {
0x0D: "SI7013",
0x14: "SI7020",
0x15: "SI7021",
0x31: "SHT21",
0x01: "SHT21",
0x32: "HTU21D",
}
# Device with conversion time for tmp/resolution bit
# The format is:
# <CHIPNAME>:{id:<ID>, ..<RESOlUTION>:[<temp time>,<humidity time>].. }
HTU21D_DEVICES = {
"SI7013": {
"TEMP14_HUM12": [0.11, 0.12],
"TEMP13_HUM10": [0.7, 0.5],
"TEMP12_HUM08": [0.4, 0.4],
"TEMP11_HUM11": [0.3, 0.7],
},
"SI7020": {
"TEMP14_HUM12": [0.11, 0.12],
"TEMP13_HUM10": [0.7, 0.5],
"TEMP12_HUM08": [0.4, 0.4],
"TEMP11_HUM11": [0.3, 0.7],
},
"SI7021": {
"TEMP14_HUM12": [0.11, 0.12],
"TEMP13_HUM10": [0.7, 0.5],
"TEMP12_HUM08": [0.4, 0.4],
"TEMP11_HUM11": [0.3, 0.7],
},
"SHT21": {
"TEMP14_HUM12": [0.85, 0.29],
"TEMP13_HUM10": [0.43, 0.9],
"TEMP12_HUM08": [0.22, 0.4],
"TEMP11_HUM11": [0.11, 0.15],
},
"HTU21D": {
"TEMP14_HUM12": [0.50, 0.16],
"TEMP13_HUM10": [0.25, 0.5],
"TEMP12_HUM08": [0.13, 0.3],
"TEMP11_HUM11": [0.12, 0.8],
},
}
# temperature coefficient for RH compensation at range 0C..80C,
# for HTU21D & SHT21 only
HTU21D_TEMP_COEFFICIENT = -0.15
# crc8 polynomial for 16bit value, CRC8 -> x^8 + x^5 + x^4 + 1
HTU21D_CRC8_POLYNOMINAL = 0x13100
class HTU21D:
def __init__(self, config):
self.printer = config.get_printer()
self.name = config.get_name().split()[-1]
self.reactor = self.printer.get_reactor()
self.i2c = bus.MCU_I2C_from_config(
config, default_addr=HTU21D_I2C_ADDR, default_speed=100000
)
self.hold_master_mode = config.getboolean("htu21d_hold_master", False)
self.resolution = config.get("htu21d_resolution", "TEMP12_HUM08")
self.report_time = config.getint("htu21d_report_time", 30, minval=5)
if self.resolution not in HTU21D_RESOLUTIONS:
raise config.error(
"Invalid HTU21D Resolution. Valid are %s"
% "|".join(HTU21D_RESOLUTIONS.keys())
)
self.deviceId = config.get("sensor_type")
self.temp = self.min_temp = self.max_temp = self.humidity = 0.0
self.sample_timer = self.reactor.register_timer(self._sample_htu21d)
self.printer.add_object("htu21d " + self.name, self)
self.printer.register_event_handler("klippy:connect", self.handle_connect)
def handle_connect(self):
self._init_htu21d()
self.reactor.update_timer(self.sample_timer, self.reactor.NOW)
def setup_minmax(self, min_temp, max_temp):
self.min_temp = min_temp
self.max_temp = max_temp
def setup_callback(self, cb):
self._callback = cb
def get_report_time_delta(self):
return self.report_time
def _init_htu21d(self):
# Device Soft Reset
self.i2c.i2c_write([HTU21D_COMMANDS["RESET"]])
# Wait 15ms after reset
self.reactor.pause(self.reactor.monotonic() + 0.15)
# Read ChipId
params = self.i2c.i2c_read(
[HTU21D_COMMANDS["SERIAL"][2], HTU21D_COMMANDS["SERIAL"][3]], 3
)
response = bytearray(params["response"])
rdevId = response[0] << 8
rdevId |= response[1]
checksum = response[2]
if self._chekCRC8(rdevId) != checksum:
logging.warning("htu21d: Reading deviceId !Checksum error!")
rdevId = rdevId >> 8
guess_dev = ID_MAP.get(rdevId, "Unknown")
if guess_dev == self.deviceId:
logging.info("htu21d: Found Device Type %s" % guess_dev)
else:
logging.warning("htu21d: Unknown Device ID %#x " % rdevId)
if self.deviceId != guess_dev:
logging.warning(
"htu21d: Found device %s. Forcing to type %s as config."
% (guess_dev, self.deviceId)
)
# Set Resolution
params = self.i2c.i2c_read([HTU21D_COMMANDS["READ"]], 1)
response = bytearray(params["response"])
registerData = response[0] & HTU21D_RESOLUTION_MASK
registerData |= HTU21D_RESOLUTIONS[self.resolution]
self.i2c.i2c_write([HTU21D_COMMANDS["WRITE"]], registerData)
logging.info("htu21d: Setting resolution to %s " % self.resolution)
def _sample_htu21d(self, eventtime):
try:
# Read Temperature
if self.hold_master_mode:
params = self.i2c.i2c_write([HTU21D_COMMANDS["HTU21D_TEMP"]])
else:
params = self.i2c.i2c_write([HTU21D_COMMANDS["HTU21D_TEMP_NH"]])
# Wait
self.reactor.pause(
self.reactor.monotonic()
+ HTU21D_DEVICES[self.deviceId][self.resolution][0]
)
params = self.i2c.i2c_read([], 3)
response = bytearray(params["response"])
rtemp = response[0] << 8
rtemp |= response[1]
if self._chekCRC8(rtemp) != response[2]:
logging.warning("htu21d: Checksum error on Temperature reading!")
else:
self.temp = 0.002681 * float(rtemp) - 46.85
logging.debug("htu21d: Temperature %.2f " % self.temp)
# Read Humidity
if self.hold_master_mode:
self.i2c.i2c_write([HTU21D_COMMANDS["HTU21D_HUMID"]])
else:
self.i2c.i2c_write([HTU21D_COMMANDS["HTU21D_HUMID_NH"]])
# Wait
self.reactor.pause(
self.reactor.monotonic()
+ HTU21D_DEVICES[self.deviceId][self.resolution][1]
)
params = self.i2c.i2c_read([], 3)
response = bytearray(params["response"])
rhumid = response[0] << 8
rhumid |= response[1]
if self._chekCRC8(rhumid) != response[2]:
logging.warning("htu21d: Checksum error on Humidity reading!")
else:
# clear status bits,
# humidity always returns xxxxxx10 in the LSB field
rhumid ^= 0x02
self.humidity = 0.001907 * float(rhumid) - 6
if self.humidity < 0:
# due to RH accuracy, measured value might be
# slightly less than 0 or more 100
self.humidity = 0
elif self.humidity > 100:
self.humidity = 100
# Only for HTU21D & SHT21.
# Calculates temperature compensated Humidity, %RH
if (
self.deviceId in ["SHT21", "HTU21D"]
and self.temp > 0
and self.temp < 80
):
logging.debug("htu21d: Do temp compensation..")
self.humidity = self.humidity
+(25.0 - self.temp) * HTU21D_TEMP_COEFFICIENT
logging.debug("htu21d: Humidity %.2f " % self.humidity)
except Exception:
logging.exception("htu21d: Error reading data")
self.temp = self.humidity = 0.0
return self.reactor.NEVER
if self.temp < self.min_temp or self.temp > self.max_temp:
self.printer.invoke_shutdown(
"HTU21D temperature %0.1f outside range of %0.1f:%.01f"
% (self.temp, self.min_temp, self.max_temp)
)
measured_time = self.reactor.monotonic()
print_time = self.i2c.get_mcu().estimated_print_time(measured_time)
self._callback(print_time, self.temp)
return measured_time + self.report_time
def _chekCRC8(self, data):
for bit in range(0, 16):
if data & 0x8000:
data = (data << 1) ^ HTU21D_CRC8_POLYNOMINAL
else:
data <<= 1
data = data >> 8
return data
def get_status(self, eventtime):
return {
"temperature": round(self.temp, 2),
"humidity": self.humidity,
}
def load_config(config):
# Register sensor
pheater = config.get_printer().lookup_object("heaters")
for stype in HTU21D_DEVICES:
pheater.add_sensor_factory(stype, HTU21D)
|
