forked from enesbcs/ESPEasyPluginPlayground
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_P163_DS1631.ino
312 lines (288 loc) · 13.2 KB
/
_P163_DS1631.ino
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
//#######################################################################################################
//################ Plugin 163: DS1631/1731 High Precision Digital Thermometer I2C #######################
//#######################################################################################################
// This plugin works with ESPEasy V1 and V2, comment/uncomment specific parts (WEB LOAD and WEB SAVE)
// MyMessage *msgTemp163; // Mysensors
#define PLUGIN_163
#define PLUGIN_ID_163 163
#define PLUGIN_NAME_163 "High Precision Digital Thermometer DS1631/DS1731 I2C"
#define PLUGIN_VALUENAME1_163 "Temperature"
boolean Plugin_163_init = false;
uint8_t i2cAddress163;
uint8_t resolution163;
boolean Plugin_163(byte function, struct EventStruct *event, String& string)
{
boolean success = false;
static byte portValue = 0;
switch (function)
{
case PLUGIN_DEVICE_ADD:
{
Device[++deviceCount].Number = PLUGIN_ID_163;
Device[deviceCount].Type = DEVICE_TYPE_I2C;
Device[deviceCount].VType = SENSOR_TYPE_SINGLE;
Device[deviceCount].Ports = 0;
Device[deviceCount].PullUpOption = false;
Device[deviceCount].InverseLogicOption = false;
Device[deviceCount].FormulaOption = true;
Device[deviceCount].SendDataOption = true;
Device[deviceCount].ValueCount = 1;
Device[deviceCount].TimerOption = true;
Device[deviceCount].GlobalSyncOption = true;
break;
}
case PLUGIN_GET_DEVICENAME:
{
string = F(PLUGIN_NAME_163);
break;
}
case PLUGIN_GET_DEVICEVALUENAMES:
{
strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[0], PSTR(PLUGIN_VALUENAME1_163));
break;
}
case PLUGIN_WEBFORM_LOAD:
{
byte choice0 = Settings.TaskDevicePluginConfig[event->TaskIndex][0];
//// ---------------------- Code for ESP Easy V2 -------------------------------------- ////
//// Comment / uncomment this part ////
// int optionValues0[8];
// optionValues0[0] = 0x48;
// optionValues0[1] = 0x49;
// optionValues0[2] = 0x4A;
// optionValues0[3] = 0x4B;
// optionValues0[4] = 0x4C;
// optionValues0[5] = 0x4D;
// optionValues0[6] = 0x4E;
// optionValues0[7] = 0x4F;
// addFormSelectorI2C(string, F("plugin_163_adr"),8 , optionValues0, choice0);
//
// byte choice1 = Settings.TaskDevicePluginConfig[event->TaskIndex][1];
//
// String options1[4];
// options1[0] = F("9");
// options1[1] = F("10");
// options1[2] = F("11");
// options1[3] = F("12");
// int optionValues1[4] = { 0,1,2,3 };
// addFormSelector(string, F("Resolution"), F("plugin_163_res"),4 , options1, optionValues1, choice1);
// addUnit(string, F("bits"));
//// ////
//// -------------------- End Code for ESP Easy V2 ------------------------------------ ////
//// ////
//// ---------------------- Code for ESP Easy V1 -------------------------------------- ////
//// Comment / uncomment this part ////
String options0[8];
options0[0] = F("0x48 - 000");
options0[1] = F("0x49 - 001");
options0[2] = F("0x4A - 010");
options0[3] = F("0x4B - 011");
options0[4] = F("0x4C - 100");
options0[5] = F("0x4D - 101");
options0[6] = F("0x4E - 110");
options0[7] = F("0x4F - 111");
uint8_t optionValues0[8];
optionValues0[0] = (0x48);
optionValues0[1] = (0x49);
optionValues0[2] = (0x4A);
optionValues0[3] = (0x4B);
optionValues0[4] = (0x4C);
optionValues0[5] = (0x4D);
optionValues0[6] = (0x4E);
optionValues0[7] = (0x4F);
string += F("<TR><TD>I2C Address:<TD><select name='plugin_163_adr'>");
for (byte x = 0; x < 8; x++) {
string += F("<option value='");
string += optionValues0[x];
string += "'";
if (choice0 == optionValues0[x]) string += F(" selected");
string += ">";
string += options0[x];
string += F("</option>");
}
string += F("</select>");
byte choice1 = Settings.TaskDevicePluginConfig[event->TaskIndex][1];
String options1[4];
options1[0] = F("9 bits");
options1[1] = F("10 bits");
options1[2] = F("11 bits");
options1[3] = F("12 bits");
int optionValues1[4] = { 0,1,2,3 };
string += F("<TR><TD>Resolution<TD><select name='plugin_163_res'>");
for (byte x = 0; x < 4; x++) {
string += F("<option value='");
string += optionValues1[x];
string += "'";
if (choice1 == optionValues1[x]) string += F(" selected");
string += ">";
string += options1[x];
string += F("</option>");
}
string += F("</select>");
//// ////
//// -------------------- End Code for ESP Easy V1 ------------------------------------ ////
//// ////
success = true;
break;
}
case PLUGIN_WEBFORM_SAVE:
{
//// ---------------------- Code for ESP Easy V2 -------------------------------------- ////
//// Comment / uncomment this part ////
// Settings.TaskDevicePluginConfig[event->TaskIndex][0] = getFormItemInt(F("plugin_163_adr"));
// Settings.TaskDevicePluginConfig[event->TaskIndex][1] = getFormItemInt(F("plugin_163_res"));
//// ////
//// -------------------- End Code for ESP Easy V2 ------------------------------------ ////
//// ////
//// ---------------------- Code for ESP Easy V1 -------------------------------------- ////
//// Comment / uncomment this part ////
String plugin1 = WebServer.arg("plugin_163_adr");
Settings.TaskDevicePluginConfig[event->TaskIndex][0] = plugin1.toInt();
String plugin2 = WebServer.arg("plugin_163_res");
Settings.TaskDevicePluginConfig[event->TaskIndex][1] = plugin2.toInt();
//// ////
//// -------------------- End Code for ESP Easy V1 ------------------------------------ ////
//// ////
success = true;
Plugin_163_init = false; // Force device setup next time
success = true;
break;
}
case PLUGIN_INIT:
{
uint8_t configRegister163;
Plugin_163_init = true;
i2cAddress163 = (uint8_t)Settings.TaskDevicePluginConfig[event->TaskIndex][0];
resolution163 = (uint8_t)Settings.TaskDevicePluginConfig[event->TaskIndex][1];
configRegister163 = (resolution163 * 4) + 1;
writeConfigRegister163(i2cAddress163,configRegister163);
success = true;
break;
}
case PLUGIN_READ:
{
float temperature;
temperature = readTemperature163(i2cAddress163,resolution163);
UserVar[event->BaseVarIndex] = temperature;
String log = F("DS1631 : Temperature: ");
log += UserVar[event->BaseVarIndex];
addLog(LOG_LEVEL_INFO,log);
success = true;
break;
}
}
return success;
}
////////////////////////////////////////////////////////////////////////////////
//// ////
//// DS1631 system constants ////
//// ////
////////////////////////////////////////////////////////////////////////////////
//// ////
//// I2C address selectable bits
//// A0_DS1631 1 // 0 : GND - 1 : VCC
//// A1_DS1631 1 // 0 : GND - 1 : VCC
//// A2_DS1631 1 // 0 : GND - 1 : VCC
//// ADDRESS_DS1631 (0x48 | A2_DS1631<<2 | A1_DS1631<<1 | A0_DS1631)
//// Status / configuration bits
//// ONESHOT 1 // bit 1SHOT=1 : One shot temperature conversion mode
//// POL 0 // bit POL, not used here
//// NVB 0 // bit NVB, not used here
//// TLF 0 // bit TLF, not used here
//// THF 0 // bit THF, not used here
//// R0_DS1631 0 // RESOLUTION BIT 00 : 9 bits - 01 : 10 bits
//// R1_DS1631 0 // RESOLUTION BIT 10 : 11 bits - 11 : 12 bits
//// Configuration register
//// REGISTER_CONFIG (THF<<6 | TLF<<5 | NVB<<4 | R1_DS1631<<3 | R0_DS1631<<2 | POL<<1 | ONESHOT)
#define DONE_MASK 0x80 // Temperature conversion status DONE bit mask
//// DS1621 I2C commands
#define READ_TEMPERATURE 0xAA
#define ACCESS_CONFIG 0xAC
#define START_CONVER 0x51
#define STOP_CONVER 0x22
//// ////
////////////////////////////////////////////////////////////////////////////////
//// ////
//// Functions ////
//// ////
////////////////////////////////////////////////////////////////////////////////
//// Stop the temperature conversion (if configured in continuous ////
//// conversion mode) ////
void stopConversion163(uint8_t _i2cAddress) {
Wire.beginTransmission(_i2cAddress);
Wire.write(STOP_CONVER);
Wire.endTransmission();
}
//// ////
////////////////////////////////////////////////////////////////////////////////
//// Start the temperature conversion ////
void startConversion163(uint8_t _i2cAddress) {
Wire.beginTransmission(_i2cAddress);
Wire.write(START_CONVER);
Wire.endTransmission();
}
//// ////
////////////////////////////////////////////////////////////////////////////////
//// Write to the configuration register ////
void writeConfigRegister163(uint8_t _i2cAddress, uint8_t _data) {
stopConversion163(_i2cAddress);
Wire.beginTransmission(_i2cAddress);
Wire.write(ACCESS_CONFIG);
Wire.write(_data);
Wire.endTransmission();
}
//// ////
////////////////////////////////////////////////////////////////////////////////
//// Read the configuration register ////
uint8_t readConfigRegister163(uint8_t _i2cAddress) {
uint8_t _data;
Wire.beginTransmission(_i2cAddress);
Wire.write(ACCESS_CONFIG);
Wire.endTransmission();
Wire.requestFrom(_i2cAddress, 1);
if(Wire.available()) {
_data = Wire.read();
}
return _data;
}
//// ////
////////////////////////////////////////////////////////////////////////////////
//// Test if temperature conversion ending ////
boolean readAvailableData163(uint8_t _i2cAddress) {
int8_t endConversion = 0;
do {
Wire.beginTransmission(_i2cAddress);
Wire.write(ACCESS_CONFIG);
Wire.endTransmission(false); // I2C RESTART
Wire.requestFrom(_i2cAddress, 1);
if (1 <= Wire.available()) endConversion = Wire.read() & DONE_MASK;
} while (!endConversion);
}
//// ////
////////////////////////////////////////////////////////////////////////////////
//// Read temperature and return float value ////
float readTemperature163(uint8_t _i2cAddress, uint8_t _resolution){
uint8_t temperatureMSB = 0;
uint8_t temperatureLSB = 0;
float temperature;
float coef[4] = {0.5, 0.25, 0.125, 0.0625};
startConversion163(_i2cAddress);
readAvailableData163(_i2cAddress);
Wire.beginTransmission(_i2cAddress);
Wire.write(READ_TEMPERATURE);
Wire.endTransmission(false); // I2C RESTART
Wire.requestFrom(_i2cAddress, 2);
if (2 <= Wire.available()) {
temperatureMSB = (uint8_t) Wire.read();
temperatureLSB = (uint8_t) Wire.read();
}
stopConversion163(_i2cAddress);
temperature = (float) temperatureMSB;
if (temperatureMSB & 0x80) temperature -= 256; // negative temperature
if (_resolution == 0) temperatureLSB /= 128;
if (_resolution == 1) temperatureLSB /= 64;
if (_resolution == 2) temperatureLSB /= 32;
if (_resolution == 3) temperatureLSB /= 16;
temperature += (float)temperatureLSB * coef[_resolution];
return (float)temperature;
}