Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

406 lines
16 KiB

6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
  1. // -----------------------------------------------------------------------------
  2. // ADS1X15-based Energy Monitor Sensor over I2C
  3. // Copyright (C) 2017-2018 by Xose Pérez <xose dot perez at gmail dot com>
  4. // -----------------------------------------------------------------------------
  5. #if SENSOR_SUPPORT && EMON_ADS1X15_SUPPORT
  6. #pragma once
  7. #include "Arduino.h"
  8. #include "EmonSensor.h"
  9. #if I2C_USE_BRZO
  10. #include <brzo_i2c.h>
  11. #else
  12. #include <Wire.h>
  13. #endif
  14. #define ADS1X15_CHANNELS (4)
  15. #define ADS1X15_CHIP_ADS1015 (0)
  16. #define ADS1X15_CHIP_ADS1115 (1)
  17. #define ADS1X15_RESOLUTION (16)
  18. #define ADS1015_CONVERSIONDELAY (1)
  19. #define ADS1115_CONVERSIONDELAY (8)
  20. #define ADS1015_BIT_SHIFT (4)
  21. #define ADS1115_BIT_SHIFT (0)
  22. #define ADS1X15_REG_POINTER_MASK (0x03)
  23. #define ADS1X15_REG_POINTER_CONVERT (0x00)
  24. #define ADS1X15_REG_POINTER_CONFIG (0x01)
  25. #define ADS1X15_REG_POINTER_LOWTHRESH (0x02)
  26. #define ADS1X15_REG_POINTER_HITHRESH (0x03)
  27. #define ADS1X15_REG_CONFIG_OS_MASK (0x8000)
  28. #define ADS1X15_REG_CONFIG_OS_SINGLE (0x8000) // Write: Set to start a single-conversion
  29. #define ADS1X15_REG_CONFIG_OS_BUSY (0x0000) // Read: Bit = 0 when conversion is in progress
  30. #define ADS1X15_REG_CONFIG_OS_NOTBUSY (0x8000) // Read: Bit = 1 when device is not performing a conversion
  31. #define ADS1X15_REG_CONFIG_MUX_MASK (0x7000)
  32. #define ADS1X15_REG_CONFIG_MUX_DIFF_0_1 (0x0000) // Differential P = AIN0, N = AIN1 (default)
  33. #define ADS1X15_REG_CONFIG_MUX_DIFF_0_3 (0x1000) // Differential P = AIN0, N = AIN3
  34. #define ADS1X15_REG_CONFIG_MUX_DIFF_1_3 (0x2000) // Differential P = AIN1, N = AIN3
  35. #define ADS1X15_REG_CONFIG_MUX_DIFF_2_3 (0x3000) // Differential P = AIN2, N = AIN3
  36. #define ADS1X15_REG_CONFIG_MUX_SINGLE_0 (0x4000) // Single-ended AIN0
  37. #define ADS1X15_REG_CONFIG_MUX_SINGLE_1 (0x5000) // Single-ended AIN1
  38. #define ADS1X15_REG_CONFIG_MUX_SINGLE_2 (0x6000) // Single-ended AIN2
  39. #define ADS1X15_REG_CONFIG_MUX_SINGLE_3 (0x7000) // Single-ended AIN3
  40. #define ADS1X15_REG_CONFIG_PGA_MASK (0x0E00)
  41. #define ADS1X15_REG_CONFIG_PGA_6_144V (0x0000) // +/-6.144V range = Gain 2/3
  42. #define ADS1X15_REG_CONFIG_PGA_4_096V (0x0200) // +/-4.096V range = Gain 1
  43. #define ADS1X15_REG_CONFIG_PGA_2_048V (0x0400) // +/-2.048V range = Gain 2 (default)
  44. #define ADS1X15_REG_CONFIG_PGA_1_024V (0x0600) // +/-1.024V range = Gain 4
  45. #define ADS1X15_REG_CONFIG_PGA_0_512V (0x0800) // +/-0.512V range = Gain 8
  46. #define ADS1X15_REG_CONFIG_PGA_0_256V (0x0A00) // +/-0.256V range = Gain 16
  47. #define ADS1X15_REG_CONFIG_MODE_MASK (0x0100)
  48. #define ADS1X15_REG_CONFIG_MODE_CONTIN (0x0000) // Continuous conversion mode
  49. #define ADS1X15_REG_CONFIG_MODE_SINGLE (0x0100) // Power-down single-shot mode (default)
  50. #define ADS1X15_REG_CONFIG_DR_MASK (0x00E0)
  51. #define ADS1015_REG_CONFIG_DR_128SPS (0x0000) // 128 samples per second
  52. #define ADS1015_REG_CONFIG_DR_250SPS (0x0020) // 250 samples per second
  53. #define ADS1015_REG_CONFIG_DR_490SPS (0x0040) // 490 samples per second
  54. #define ADS1015_REG_CONFIG_DR_920SPS (0x0060) // 920 samples per second
  55. #define ADS1015_REG_CONFIG_DR_1600SPS (0x0080) // 1600 samples per second (default)
  56. #define ADS1015_REG_CONFIG_DR_2400SPS (0x00A0) // 2400 samples per second
  57. #define ADS1015_REG_CONFIG_DR_3300SPS (0x00C0) // 3300 samples per second
  58. #define ADS1115_REG_CONFIG_DR_8SPS (0x0000) // 8 samples per second
  59. #define ADS1115_REG_CONFIG_DR_16SPS (0x0020) // 16 samples per second
  60. #define ADS1115_REG_CONFIG_DR_32SPS (0x0040) // 32 samples per second
  61. #define ADS1115_REG_CONFIG_DR_64SPS (0x0060) // 64 samples per second
  62. #define ADS1115_REG_CONFIG_DR_128SPS (0x0080) // 128 samples per second (default)
  63. #define ADS1115_REG_CONFIG_DR_250SPS (0x00A0) // 250 samples per second
  64. #define ADS1115_REG_CONFIG_DR_475SPS (0x00C0) // 475 samples per second
  65. #define ADS1115_REG_CONFIG_DR_860SPS (0x00E0) // 860 samples per second
  66. #define ADS1X15_REG_CONFIG_CMODE_MASK (0x0010)
  67. #define ADS1X15_REG_CONFIG_CMODE_TRAD (0x0000) // Traditional comparator with hysteresis (default)
  68. #define ADS1X15_REG_CONFIG_CMODE_WINDOW (0x0010) // Window comparator
  69. #define ADS1X15_REG_CONFIG_CPOL_MASK (0x0008)
  70. #define ADS1X15_REG_CONFIG_CPOL_ACTVLOW (0x0000) // ALERT/RDY pin is low when active (default)
  71. #define ADS1X15_REG_CONFIG_CPOL_ACTVHI (0x0008) // ALERT/RDY pin is high when active
  72. #define ADS1X15_REG_CONFIG_CLAT_MASK (0x0004) // Determines if ALERT/RDY pin latches once asserted
  73. #define ADS1X15_REG_CONFIG_CLAT_NONLAT (0x0000) // Non-latching comparator (default)
  74. #define ADS1X15_REG_CONFIG_CLAT_LATCH (0x0004) // Latching comparator
  75. #define ADS1X15_REG_CONFIG_CQUE_MASK (0x0003)
  76. #define ADS1X15_REG_CONFIG_CQUE_1CONV (0x0000) // Assert ALERT/RDY after one conversions
  77. #define ADS1X15_REG_CONFIG_CQUE_2CONV (0x0001) // Assert ALERT/RDY after two conversions
  78. #define ADS1X15_REG_CONFIG_CQUE_4CONV (0x0002) // Assert ALERT/RDY after four conversions
  79. #define ADS1X15_REG_CONFIG_CQUE_NONE (0x0003) // Disable the comparator and put ALERT/RDY in high state (default)
  80. class EmonADS1X15Sensor : public EmonSensor {
  81. public:
  82. // ---------------------------------------------------------------------
  83. // Public
  84. // ---------------------------------------------------------------------
  85. EmonADS1X15Sensor(): EmonSensor() {
  86. _channels = ADS1X15_CHANNELS;
  87. _sensor_id = SENSOR_EMON_ADS1X15_ID;
  88. init();
  89. }
  90. // ---------------------------------------------------------------------
  91. void setType(unsigned char type) {
  92. if (_type == type) return;
  93. _type = type;
  94. _dirty = true;
  95. }
  96. void setMask(unsigned char mask) {
  97. if (_mask == mask) return;
  98. _mask = mask;
  99. _dirty = true;
  100. }
  101. void setGain(unsigned int gain) {
  102. if (_gain == gain) return;
  103. _gain = gain;
  104. _dirty = true;
  105. }
  106. // ---------------------------------------------------------------------
  107. unsigned char getType() {
  108. return _type;
  109. }
  110. unsigned char getMask() {
  111. return _mask;
  112. }
  113. unsigned char getGain() {
  114. return _gain;
  115. }
  116. // ---------------------------------------------------------------------
  117. // Sensor API
  118. // ---------------------------------------------------------------------
  119. // Initialization method, must be idempotent
  120. void begin() {
  121. if (!_dirty) return;
  122. _dirty = false;
  123. // Discover
  124. unsigned char addresses[] = {0x48, 0x49, 0x4A, 0x4B};
  125. _address = _begin_i2c(_address, sizeof(addresses), addresses);
  126. if (_address == 0) return;
  127. // Calculate ports
  128. _ports = 0;
  129. unsigned char mask = _mask;
  130. while (mask) {
  131. if (mask & 0x01) ++_ports;
  132. mask = mask >> 1;
  133. }
  134. _count = _ports * _magnitudes;
  135. // Bit depth
  136. _resolution = ADS1X15_RESOLUTION;
  137. // Reference based on gain
  138. if (_gain == ADS1X15_REG_CONFIG_PGA_6_144V) _reference = 12.288;
  139. if (_gain == ADS1X15_REG_CONFIG_PGA_4_096V) _reference = 8.192;
  140. if (_gain == ADS1X15_REG_CONFIG_PGA_2_048V) _reference = 4.096;
  141. if (_gain == ADS1X15_REG_CONFIG_PGA_1_024V) _reference = 2.048;
  142. if (_gain == ADS1X15_REG_CONFIG_PGA_0_512V) _reference = 1.024;
  143. if (_gain == ADS1X15_REG_CONFIG_PGA_0_256V) _reference = 0.512;
  144. // Call the parent class method
  145. EmonSensor::begin();
  146. // warmup all channels
  147. warmup();
  148. }
  149. // Descriptive name of the sensor
  150. String description() {
  151. char buffer[30];
  152. snprintf(buffer, sizeof(buffer), "EMON @ ADS1%d15 @ I2C (0x%02X)", _type == ADS1X15_CHIP_ADS1015 ? 0 : 1, _address);
  153. return String(buffer);
  154. }
  155. // Descriptive name of the slot # index
  156. String slot(unsigned char index) {
  157. char buffer[35];
  158. unsigned char channel = getChannel(index % _ports);
  159. snprintf(buffer, sizeof(buffer), "EMON @ ADS1%d15 (A%d) @ I2C (0x%02X)", _type == ADS1X15_CHIP_ADS1015 ? 0 : 1, channel, _address);
  160. return String(buffer);
  161. }
  162. // Address of the sensor (it could be the GPIO or I2C address)
  163. String address(unsigned char index) {
  164. char buffer[10];
  165. unsigned char channel = getChannel(index % _ports);
  166. snprintf(buffer, sizeof(buffer), "0x%02X:%u", _address, channel);
  167. return String(buffer);
  168. }
  169. // Type for slot # index
  170. unsigned char type(unsigned char index) {
  171. if (index < _count) {
  172. _error = SENSOR_ERROR_OK;
  173. unsigned char magnitude = index / _ports;
  174. unsigned char i=0;
  175. #if EMON_REPORT_CURRENT
  176. if (magnitude == i++) return MAGNITUDE_CURRENT;
  177. #endif
  178. #if EMON_REPORT_POWER
  179. if (magnitude == i++) return MAGNITUDE_POWER_APPARENT;
  180. #endif
  181. #if EMON_REPORT_ENERGY
  182. if (magnitude == i) return MAGNITUDE_ENERGY;
  183. #endif
  184. }
  185. _error = SENSOR_ERROR_OUT_OF_RANGE;
  186. return MAGNITUDE_NONE;
  187. }
  188. void pre() {
  189. static unsigned long last = 0;
  190. for (unsigned char port=0; port<_ports; port++) {
  191. unsigned char channel = getChannel(port);
  192. _current[port] = getCurrent(channel);
  193. #if EMON_REPORT_ENERGY
  194. _energy[port] += (_current[port] * _voltage * (millis() - last) / 1000);
  195. #endif
  196. }
  197. last = millis();
  198. }
  199. // Current value for slot # index
  200. double value(unsigned char index) {
  201. if (index < _count) {
  202. _error = SENSOR_ERROR_OK;
  203. unsigned char port = index % _ports;
  204. unsigned char magnitude = index / _ports;
  205. unsigned char i=0;
  206. #if EMON_REPORT_CURRENT
  207. if (magnitude == i++) return _current[port];
  208. #endif
  209. #if EMON_REPORT_POWER
  210. if (magnitude == i++) return _current[port] * _voltage;
  211. #endif
  212. #if EMON_REPORT_ENERGY
  213. if (magnitude == i) return _energy[port];
  214. #endif
  215. }
  216. _error = SENSOR_ERROR_OUT_OF_RANGE;
  217. return 0;
  218. }
  219. protected:
  220. //----------------------------------------------------------------------
  221. // Protected
  222. //----------------------------------------------------------------------
  223. unsigned char getChannel(unsigned char port) {
  224. unsigned char count = 0;
  225. unsigned char bit = 1;
  226. for (unsigned char channel=0; channel<ADS1X15_CHANNELS; channel++) {
  227. if ((_mask & bit) == bit) {
  228. if (count == port) return channel;
  229. ++count;
  230. }
  231. bit <<= 1;
  232. }
  233. return 0;
  234. }
  235. void warmup() {
  236. for (unsigned char port=0; port<_ports; port++) {
  237. unsigned char channel = getChannel(port);
  238. _pivot[channel] = _adc_counts >> 1;
  239. getCurrent(channel);
  240. }
  241. }
  242. //----------------------------------------------------------------------
  243. // I2C
  244. //----------------------------------------------------------------------
  245. void setConfigRegistry(unsigned char channel, bool continuous, bool start) {
  246. // Start with default values
  247. uint16_t config = 0;
  248. config |= _gain; // Set PGA/voltage range (0x0200)
  249. config |= ADS1X15_REG_CONFIG_DR_MASK; // Always at max speed (0x00E0)
  250. //config |= ADS1X15_REG_CONFIG_CMODE_TRAD; // Traditional comparator (default val) (0x0000)
  251. //config |= ADS1X15_REG_CONFIG_CPOL_ACTVLOW; // Alert/Rdy active low (default val) (0x0000)
  252. //config |= ADS1X15_REG_CONFIG_CLAT_NONLAT; // Non-latching (default val) (0x0000)
  253. config |= ADS1X15_REG_CONFIG_CQUE_NONE; // Disable the comparator (default val) (0x0003)
  254. if (start) {
  255. config |= ADS1X15_REG_CONFIG_OS_SINGLE; // Start a single-conversion (0x8000)
  256. }
  257. if (continuous) {
  258. //config |= ADS1X15_REG_CONFIG_MODE_CONTIN; // Continuous mode (default) (0x0000)
  259. } else {
  260. config |= ADS1X15_REG_CONFIG_MODE_SINGLE; // Single-shot mode (0x0100)
  261. }
  262. config |= ((channel + 4) << 12); // Set single-ended input channel (0x4000 - 0x7000)
  263. #if SENSOR_DEBUG
  264. //Serial.printf("[EMON] ADS1X115 Config Registry: %04X\n", config);
  265. #endif
  266. // Write config register to the ADC
  267. #if I2C_USE_BRZO
  268. uint8_t buffer[3];
  269. buffer[0] = ADS1X15_REG_POINTER_CONFIG;
  270. buffer[1] = config >> 8;
  271. buffer[2] = config & 0xFF;
  272. brzo_i2c_start_transaction(_address, I2C_SCL_FREQUENCY);
  273. brzo_i2c_write(buffer, 3, false);
  274. brzo_i2c_end_transaction();
  275. #else
  276. Wire.beginTransmission(_address);
  277. Wire.write((uint8_t) ADS1X15_REG_POINTER_CONFIG);
  278. Wire.write((uint8_t) (config >> 8));
  279. Wire.write((uint8_t) (config & 0xFF));
  280. Wire.endTransmission();
  281. #endif
  282. }
  283. double getCurrent(unsigned char channel) {
  284. // Force stop by setting single mode and back to continuous
  285. static unsigned char previous = 9;
  286. if (previous != channel) {
  287. setConfigRegistry(channel, true, false);
  288. setConfigRegistry(channel, false, false);
  289. setConfigRegistry(channel, false, true);
  290. delay(10);
  291. readADC(channel);
  292. previous = channel;
  293. }
  294. setConfigRegistry(channel, true, true);
  295. return read(channel);
  296. }
  297. unsigned int readADC(unsigned char channel) {
  298. (void) channel;
  299. unsigned int value = 0;
  300. #if I2C_USE_BRZO
  301. uint8_t buffer[3];
  302. buffer[0] = ADS1X15_REG_POINTER_CONVERT;
  303. brzo_i2c_start_transaction(_address, I2C_SCL_FREQUENCY);
  304. brzo_i2c_write(buffer, 1, false);
  305. brzo_i2c_read(buffer, 2, false);
  306. brzo_i2c_end_transaction();
  307. value |= buffer[0] << 8;
  308. value |= buffer[1];
  309. #else
  310. Wire.beginTransmission(_address);
  311. Wire.write(ADS1X15_REG_POINTER_CONVERT);
  312. Wire.endTransmission();
  313. Wire.requestFrom(_address, (unsigned char) 2);
  314. value |= Wire.read() << 8;
  315. value |= Wire.read();
  316. #endif
  317. if (_type = ADS1X15_CHIP_ADS1015) value >>= ADS1015_BIT_SHIFT;
  318. delayMicroseconds(500);
  319. return value;
  320. }
  321. unsigned char _type = ADS1X15_CHIP_ADS1115;
  322. unsigned char _mask = 0x0F;
  323. unsigned int _gain = ADS1X15_REG_CONFIG_PGA_4_096V;
  324. unsigned char _ports;
  325. };
  326. #endif // SENSOR_SUPPORT && EMON_ADS1X15_SUPPORT