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.

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