From 61ba4ecf33eb260244f02d64f526f85d92890b7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Xose=20P=C3=A9rez?= Date: Fri, 22 Sep 2017 18:37:05 +0200 Subject: [PATCH] Document and small fixes --- code/espurna/config/general.h | 87 ++++++++++++++++------------------ code/espurna/config/hardware.h | 6 --- code/espurna/power.ino | 10 ++-- code/espurna/power_ech1560.ino | 2 +- code/espurna/power_emon.ino | 8 ++-- code/espurna/power_v9261f.ino | 2 +- code/espurna/web.ino | 2 +- 7 files changed, 52 insertions(+), 65 deletions(-) diff --git a/code/espurna/config/general.h b/code/espurna/config/general.h index f8349258..48bec11d 100644 --- a/code/espurna/config/general.h +++ b/code/espurna/config/general.h @@ -497,16 +497,15 @@ PROGMEM const char* const custom_reset_string[] = { // POWER METERING // ----------------------------------------------------------------------------- -// Available power-metering providers +// Available power-metering providers (do not change this) #define POWER_PROVIDER_NONE 0x00 -#define POWER_PROVIDER_EMON 0x10 #define POWER_PROVIDER_EMON_ANALOG 0x10 #define POWER_PROVIDER_EMON_ADC121 0x11 #define POWER_PROVIDER_HLW8012 0x20 #define POWER_PROVIDER_V9261F 0x30 #define POWER_PROVIDER_ECH1560 0x40 -// Available magnitudes +// Available magnitudes (do not change this) #define POWER_MAGNITUDE_CURRENT 1 #define POWER_MAGNITUDE_VOLTAGE 2 #define POWER_MAGNITUDE_ACTIVE 4 @@ -515,71 +514,72 @@ PROGMEM const char* const custom_reset_string[] = { #define POWER_MAGNITUDE_POWER_FACTOR 32 #define POWER_MAGNITUDE_ALL 63 -// No power provider defined +// No power provider defined (do not change this) #ifndef POWER_PROVIDER #define POWER_PROVIDER POWER_PROVIDER_NONE #endif -// Identify available magnitudes +// Identify available magnitudes (do not change this) #if (POWER_PROVIDER == POWER_PROVIDER_HLW8012) || (POWER_PROVIDER == POWER_PROVIDER_V9261F) #define POWER_HAS_ACTIVE 1 #else #define POWER_HAS_ACTIVE 0 #endif -#define POWER_CURRENT_PRECISION 3 -#define POWER_VOLTAGE 230 -#define POWER_READ_INTERVAL 6000 -#define POWER_REPORT_INTERVAL 60000 -#define POWER_REPORT_BUFFER 12 +#define POWER_VOLTAGE 230 // Default voltage +#define POWER_READ_INTERVAL 6000 // Default reading interval (6 seconds) +#define POWER_REPORT_INTERVAL 60000 // Default report interval (1 minute) +#define POWER_REPORT_BUFFER 12 // Default buffer size () +#define POWER_CURRENT_DECIMALS 2 // Decimals for current values +#define POWER_VOLTAGE_DECIMALS 0 // Decimals for voltage values +#define POWER_POWER_DECIMALS 0 // Decimals for power values #define POWER_ENERGY_FACTOR (POWER_REPORT_INTERVAL / 1000.0 / 3600.0) -#define POWER_CURRENT_DECIMALS 2 -#define POWER_VOLTAGE_DECIMALS 0 -#define POWER_POWER_DECIMALS 0 #if POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG - #define EMON_CURRENT_RATIO 30 - #define EMON_SAMPLES 1000 - #define EMON_ADC_BITS 10 - #define EMON_REFERENCE_VOLTAGE 1.0 - #define EMON_CURRENT_OFFSET 0.25 + #define EMON_CURRENT_RATIO 30 // Current ratio in the clamp (30V/1A) + #define EMON_SAMPLES 1000 // Number of samples to get for each reading + #define EMON_ADC_BITS 10 // ADC depth + #define EMON_REFERENCE_VOLTAGE 1.0 // Reference voltage of the ADC + #define EMON_CURRENT_OFFSET 0.25 // Current offset (error) #undef ADC_VCC_ENABLED - #define ADC_VCC_ENABLED 0 + #define ADC_VCC_ENABLED 0 // Disable internal battery measurement #endif #if POWER_PROVIDER == POWER_PROVIDER_EMON_ADC121 - #define EMON_CURRENT_RATIO 30 - #define EMON_SAMPLES 1000 - #define EMON_ADC_BITS 12 - #define EMON_REFERENCE_VOLTAGE 3.3 - #define EMON_CURRENT_OFFSET 0.10 - #define ADC121_I2C_ADDRESS 0x50 + #define EMON_CURRENT_RATIO 30 // Current ratio in the clamp (30V/1A) + #define EMON_SAMPLES 1000 // Number of samples to get for each reading + #define EMON_ADC_BITS 12 // ADC depth + #define EMON_REFERENCE_VOLTAGE 3.3 // Reference voltage of the ADC + #define EMON_CURRENT_OFFSET 0.10 // Current offset (error) + #define ADC121_I2C_ADDRESS 0x50 // I2C address of the ADC121 #undef I2C_SUPPORT - #define I2C_SUPPORT 1 + #define I2C_SUPPORT 1 // Enabled I2C support #endif #if POWER_PROVIDER == POWER_PROVIDER_HLW8012 - #define HLW8012_USE_INTERRUPTS 1 - #define HLW8012_SEL_CURRENT HIGH - #define HLW8012_CURRENT_R 0.001 - #define HLW8012_VOLTAGE_R_UP ( 5 * 470000 ) // Real: 2280k - #define HLW8012_VOLTAGE_R_DOWN ( 1000 ) // Real 1.009k + #define HLW8012_USE_INTERRUPTS 1 // Use interrupts to trap HLW8012 signals + #define HLW8012_SEL_CURRENT HIGH // SEL pin to HIGH to measure current + #define HLW8012_CURRENT_R 0.001 // Current resistor + #define HLW8012_VOLTAGE_R_UP ( 5 * 470000 ) // Upstream voltage resistor + #define HLW8012_VOLTAGE_R_DOWN ( 1000 ) // Downstream voltage resistor #endif #if POWER_PROVIDER == POWER_PROVIDER_V9261F #undef POWER_REPORT_BUFFER - #define POWER_REPORT_BUFFER 60 + #define POWER_REPORT_BUFFER 60 // Override median buffer size #ifndef V9261F_PIN - #define V9261F_PIN 2 + #define V9261F_PIN 2 // TX pin from the V9261F #endif #ifndef V9261F_PIN_INVERSE - #define V9261F_PIN_INVERSE 1 + #define V9261F_PIN_INVERSE 1 // Signal is inverted #endif - #define V9261F_SYNC_INTERVAL 600 - #define V9261F_BAUDRATE 4800 + #define V9261F_SYNC_INTERVAL 600 // Sync signal length (ms) + #define V9261F_BAUDRATE 4800 // UART baudrate + + // Default ratios #define V9261F_CURRENT_FACTOR 79371434.0 #define V9261F_VOLTAGE_FACTOR 4160651.0 #define V9261F_POWER_FACTOR 153699.0 @@ -590,25 +590,18 @@ PROGMEM const char* const custom_reset_string[] = { #if POWER_PROVIDER == POWER_PROVIDER_ECH1560 #undef POWER_REPORT_BUFFER - #define POWER_REPORT_BUFFER 60 + #define POWER_REPORT_BUFFER 60 // Override median buffer size #ifndef ECH1560_CLK_PIN - #define ECH1560_CLK_PIN 4 + #define ECH1560_CLK_PIN 4 // Default CLK pin #endif #ifndef ECH1560_MISO_PIN - #define ECH1560_MISO_PIN 5 + #define ECH1560_MISO_PIN 5 // Default MISO pin #endif #ifndef ECH1560_INVERTED - #define ECH1560_INVERTED 0 + #define ECH1560_INVERTED 0 // Power signal is inverted #endif - #define ECH1560_SYNC_INTERVAL 600 - #define ECH1560_BAUDRATE 4800 - #define ECH1560_CURRENT_FACTOR 79371434.0 - #define ECH1560_VOLTAGE_FACTOR 4160651.0 - #define ECH1560_POWER_FACTOR 153699.0 - #define ECH1560_RPOWER_FACTOR ECH1560_CURRENT_FACTOR - #endif // ----------------------------------------------------------------------------- diff --git a/code/espurna/config/hardware.h b/code/espurna/config/hardware.h index b14a7e7a..25796d15 100644 --- a/code/espurna/config/hardware.h +++ b/code/espurna/config/hardware.h @@ -42,12 +42,6 @@ #define LED1_PIN 2 #define LED1_PIN_INVERSE 1 - // HLW8012 - #define POWER_PROVIDER POWER_PROVIDER_EMON_ANALOG - #define HLW8012_SEL_PIN 2 - #define HLW8012_CF1_PIN 13 - #define HLW8012_CF_PIN 14 - #elif defined(WEMOS_D1_MINI_RELAYSHIELD) // Info diff --git a/code/espurna/power.ino b/code/espurna/power.ino index ba616dd7..d166c0e7 100644 --- a/code/espurna/power.ino +++ b/code/espurna/power.ino @@ -44,7 +44,7 @@ void _powerAPISetup() { apiRegister(MQTT_TOPIC_CURRENT, MQTT_TOPIC_CURRENT, [](char * buffer, size_t len) { if (_power_ready) { - dtostrf(getCurrent(), len-1, POWER_CURRENT_PRECISION, buffer); + dtostrf(getCurrent(), len-1, POWER_CURRENT_DECIMALS, buffer); } else { buffer = NULL; } @@ -112,7 +112,7 @@ void _powerRead() { /* THERE IS A BUG HERE SOMEWHERE :) char current_buffer[10]; - dtostrf(current, sizeof(current_buffer)-1, POWER_CURRENT_PRECISION, current_buffer); + dtostrf(current, sizeof(current_buffer)-1, POWER_CURRENT_DECIMALS, current_buffer); DEBUG_MSG_P(PSTR("[POWER] Current: %sA\n"), current_buffer); DEBUG_MSG_P(PSTR("[POWER] Voltage: %sA\n"), int(voltage)); DEBUG_MSG_P(PSTR("[POWER] Apparent Power: %dW\n"), int(apparent)); @@ -137,7 +137,7 @@ void _powerRead() { root["pwrReactive"] = roundTo(reactive, POWER_POWER_DECIMALS); root["pwrFactor"] = int(100 * factor); #endif - #if POWER_PROVIDER & POWER_PROVIDER_EMON + #if (POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG) || (POWER_PROVIDER == POWER_PROVIDER_EMON_ADC121) root["emonVisible"] = 1; #endif #if POWER_PROVIDER == POWER_PROVIDER_HLW8012 @@ -179,8 +179,8 @@ void _powerReport() { char buf_current[10]; char buf_energy[10]; - dtostrf(_power_current, -9, POWER_CURRENT_PRECISION, buf_current); - dtostrf(energy_delta, -9, POWER_CURRENT_PRECISION, buf_energy); + dtostrf(_power_current, 1-sizeof(buf_current), POWER_CURRENT_DECIMALS, buf_current); + dtostrf(energy_delta, 1-sizeof(buf_energy), POWER_CURRENT_DECIMALS, buf_energy); { mqttSend(MQTT_TOPIC_CURRENT, buf_current); diff --git a/code/espurna/power_ech1560.ino b/code/espurna/power_ech1560.ino index 2cb9bdc2..4add4a80 100644 --- a/code/espurna/power_ech1560.ino +++ b/code/espurna/power_ech1560.ino @@ -204,4 +204,4 @@ void _powerLoopProvider(bool before) { } -#endif // POWER_PROVIDER & POWER_PROVIDER_EMON +#endif // POWER_PROVIDER == POWER_PROVIDER_ECH1560 diff --git a/code/espurna/power_emon.ino b/code/espurna/power_emon.ino index 75b59efc..a1945433 100644 --- a/code/espurna/power_emon.ino +++ b/code/espurna/power_emon.ino @@ -6,7 +6,7 @@ Copyright (C) 2016-2017 by Xose Pérez */ -#if (POWER_PROVIDER & POWER_PROVIDER_EMON == POWER_PROVIDER_EMON) +#if (POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG) || (POWER_PROVIDER == POWER_PROVIDER_EMON_ADC121) // ----------------------------------------------------------------------------- // MODULE GLOBALS AND CACHE @@ -39,7 +39,7 @@ unsigned int currentCallback() { #if POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG - return analogRead(0); + return analogRead(A0); #endif // POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG @@ -141,7 +141,7 @@ void _powerSetupProvider() { brzo_i2c_end_transaction(); #endif - powerConfigureProvider(); + _powerConfigureProvider(); _emon.warmup(); @@ -161,4 +161,4 @@ void _powerLoopProvider(bool before) { } -#endif // (POWER_PROVIDER & POWER_PROVIDER_EMON == POWER_PROVIDER_EMON) +#endif // (POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG) || (POWER_PROVIDER == POWER_PROVIDER_EMON_ADC121) diff --git a/code/espurna/power_v9261f.ino b/code/espurna/power_v9261f.ino index 89ff0f47..ac8a9e0f 100644 --- a/code/espurna/power_v9261f.ino +++ b/code/espurna/power_v9261f.ino @@ -231,4 +231,4 @@ void _powerLoopProvider(bool before) { } -#endif // POWER_PROVIDER & POWER_PROVIDER_EMON +#endif // POWER_PROVIDER == POWER_PROVIDER_V9261F diff --git a/code/espurna/web.ino b/code/espurna/web.ino index d95dbbc7..9a43eefb 100644 --- a/code/espurna/web.ino +++ b/code/espurna/web.ino @@ -608,7 +608,7 @@ void _wsStart(uint32_t client_id) { root["pwrReactive"] = getReactivePower(); root["pwrFactor"] = int(100 * getPowerFactor()); #endif - #if POWER_PROVIDER & POWER_PROVIDER_EMON + #if (POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG) || (POWER_PROVIDER == POWER_PROVIDER_EMON_ADC121) root["emonVisible"] = 1; #endif #if POWER_PROVIDER == POWER_PROVIDER_HLW8012