Published February 1, 2023 © GPL3+

ACCM Shields v1 & v2 for Arduino UNO

AC Digital Clamp and Meter

IntermediateWork in progress8 hours148

Things used in this project

Hardware components

ElectroPeak 0.96" OLED 64x128 Display Module

Tactile Switch, SPST-NO

5 mm LED: Red

LED, Blue

Arduino UNO

SparkFun TRRS 3.5mm Jack Breakout

I used https://www.amazon.fr/dp/B015FIUEOI?psc=1&ref=ppx_yo2ov_dt_b_product_details

PCB prototyping 60x40mm

https://www.amazon.fr/dp/B0B7BLQ95V?psc=1&ref=ppx_yo2ov_dt_b_product_details

sct013 sensors

https://fr.aliexpress.com/item/1005004726031706.html

Software apps and online services

Arduino IDE

Hand tools and fabrication machines

Soldering iron (generic)

Story

This project reflects the second stage of work with the Prototype of Current Clamp with accounting and triggering capabilities.

ACCM Concepts

Sinusoidal currents inside electric cables produce a variable and also sinusoidal electromagnetic field. Thanks to the electrical induction physical property, the sct013 sensor (a copper coil and a resistor in parallel) produces a voltage as output which is related to the fluctuations of the electromagnetic fields around the wire going through the sct013 clamp.

Then, based on user frequency settings, the software will try to catch analog sample of data of exactly a period. It will then calculate min and max values over the period and the effective value of the sct013 output and then convert it into a current value (conversion ratio depends of sct013 model).

Final work consist in energy accounting (kWh) and triggering amount of energy used (Wh) or money spent (€) in order to produce an action : the prototype produces a blue led flash.

ACCMv2 Features

Small OLED Display to report to end-user

Fast and fine autocalibration process end-user can launch any time

4 individual SCT lines monitored

Group or Single view (current, power, accounting, budget, noise)

Freq range : 0-500Hz (16 points at 500Hz, 160 points at 50Hz)

Detect power on the lines (red led)

Count user defined energy amount (in Wh) or bill amount (blue led)

Power consumption : 0.25W/h (0.05A)

ACCMv2 Cost killing circuit

In regards of the early prototype of ACCM and its v1 shield for which you'll find some photos, there was a lot of resistors for each SCT lines (vcc dividers to raise up the signals) and resistors for leds and buttons.

There were some interesting technical improvements compared to the original circuit with the ACCM Shield v2 :

almost all resistors are gone (except for leds) : button can use internal pullup resistor of the Arduino UNO board and if we don't raise up signals of the SCT sensors, it just mean we have to double max value to find original signal amplitude with the great advantage to raise up by 100% the SCT range capabilities of sensors (see Circuit limits section).
button have been reduced to one piece (playing with multiple way to call for instructions with a single button : short, long, very long, double press)

ACCMv2 Circuit limits

The Arduino circuit is 5V (using USB power line), centering the sinusoidal signal at 0V allows a max value of 5V also for the sinusoidal signal (3.54V effective). It means this circuit will only allow the following ranges of power, depending of the probe model :

sct013 1V/10A: 0.1-35.4A
sct013 1V/30A: 0.3-105.6A
sct013 1V/60A: 0.6-211.2A
sct013 1V/100A: 1-340A

Note that if you choose to power your board with Vin or with the regular power entry of the board you can also extend sensors ranges capabilities, just pay attention to the max current the circuit will require if you increase input voltage.

ACCMv2 Software improvements

There was a couple of things that have been improved in ACCMv2 compared to the prototype application.

A very basic performance add-on was to completely leave the micros() call and only work with millis() to measure time within the application. This is a well known fix.

Main part of improvements concerns data acquisition over a period. While we loose the capability to store all measured point with timestamp index (too much memory required for that feature), using operator overriding on a C++ object class allowed to maintain data acquisition frequency around 8kHz and also to calculate and store min,max,sum,count of a value. Please consult value.h and value.cpp files to look up on this point.

The eZButton object class has been extended to provide new output values depending the way end-users interact with the button : short, long, very long and double press. You may have a look to this there : appButton.h and appButton.cpp.

Some idea was found try build an uptime counter to report about application uptime to end-user (timer.h and timer.cpp).

ACCMv2 Software limits

Available memory running the application is actually the main focus to try to switch to a very stable release of the software. Final works will consist in making the code more efficient and optimize running memory usage.

One identified source of high memory usage is String() object concatenation. This is still massively used in the application and may be first step to try improve memory usage.

Code

ACCM_20221212.ino

#include <Wire.h>
#include <Adafruit_GFX.h>
#include <Adafruit_SSD1306.h>
#include <MemoryFree.h>
#include "appButton.h"
#include "accm.h"
#include "basics.h"
#include "timer.h"

#define POWER_LED 13
#define COUNTER_LED 8

#define APP_BTN_PIN 2

const String APP="ACCM";
const String VERSION="v0.13";
const String DATE="20221216";
const String CONTACT="freddy@linuxtribe.fr";

timer uptime; // provides uptime loop and display for end-user.

appButton menuButton(APP_BTN_PIN, INPUT_PULLUP); // button app declaration

// declare display
#define SCREEN_WIDTH 128 // OLED display width, in pixels
#define SCREEN_HEIGHT 32 // OLED display height, in pixels

// Declaration for an SSD1306 display connected to I2C (SDA, SCL pins)
// The pins for I2C are defined by the Wire-library. 
// On an arduino UNO:       A4(SDA), A5(SCL)
// On an arduino MEGA 2560: 20(SDA), 21(SCL)
// On an arduino LEONARDO:   2(SDA),  3(SCL), ...
#define OLED_RESET     -1 // Reset pin # (or -1 if sharing Arduino reset pin)
#define SCREEN_ADDRESS 0x3C ///< See datasheet for Address; 0x3D for 128x64, 0x3C for 128x32
Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RESET);

// Declare the accm application and accm line number
accm EnergyApp;

void setup() {
  // setup ACCM Lines (for SCT013 probes)
  EnergyApp.line[0].pin = 3;
  EnergyApp.line[0].sct_model = 10;
  EnergyApp.line[0].freq = 50;
  EnergyApp.line[0].voltage = 220;
  EnergyApp.line[0].warn = 0.001;
  
  EnergyApp.line[1].pin = 2;
  EnergyApp.line[1].sct_model = 10;
  EnergyApp.line[1].freq = 50;
  EnergyApp.line[1].voltage = 220;
  EnergyApp.line[1].warn = 0.001;
  
  EnergyApp.line[2].pin = 1;
  EnergyApp.line[2].sct_model = 30;
  EnergyApp.line[2].freq = 50;
  EnergyApp.line[2].voltage = 220;
  EnergyApp.line[2].warn = 0.001;
  
  EnergyApp.line[3].pin = 0;
  EnergyApp.line[3].sct_model = 30;
  EnergyApp.line[3].freq = 50;
  EnergyApp.line[3].voltage = 220;
  EnergyApp.line[3].warn = 0.001;
  
/*
  Serial.begin(9600);
  Serial.println();
  Serial.println(APP + " " + VERSION + " " + DATE);
  Serial.println(String(freeMemory()) + " bytes RAM free");
*/
  
//   initialize serial port to access reports
  if(!display.begin(SSD1306_SWITCHCAPVCC, SCREEN_ADDRESS)) {
    Serial.println(F("SSD1306 allocation failed"));
    for(;;); // Don't proceed, loop forever
  }
  display.clearDisplay();
  display.setTextSize(1); // Draw 2X-scale text
  display.setTextColor(SSD1306_WHITE);
  display.setCursor(0,1);
  display.println(APP + " " + VERSION + " " + DATE);
  display.println(CONTACT);
  display.println(String(freeMemory()) + " bytes RAM free");
  digitalWrite(POWER_LED, HIGH);
  digitalWrite(COUNTER_LED, HIGH);
  display.display();
  delay(500);
}

enum viewMode { group, single, settings, credentials, off };
enum menu { current, power, counter, budget, noise };
menu accmMenu = counter;
viewMode accmViewMode = credentials;
int accmCurrentLine = 0;

void nextViewMode(void) {
  switch (accmViewMode) {
    case group:
      accmDisplayMenu("VIEW MODE", "SINGLE");
      accmViewMode = single;
      break;
    case single:
      accmDisplayMenu("FIRMWARE", "SETTINGS");
      accmViewMode = settings;
      break;
    case settings:      
      accmDisplayMenu("SCREEN OFF", "SLEEPING");
      accmViewMode = off;
      break;
    case off:
      accmDisplayMenu("ABOUT", "CREDENTIALS");
      accmViewMode = credentials;
      break;
    case credentials:
      accmDisplayMenu("VIEW MODE", "GROUP");
      accmViewMode = group;
      break;
    default:
      break; 
  }
}

void nextAppMenu(void) {
  switch (accmMenu) {
    case current:
       accmDisplayMenu("MENU", "POWER CLAMP");
       accmMenu = power;
       break;
    case power:
      accmDisplayMenu("MENU", "ENERGY COUNTER");
      accmMenu = counter;
      break;
    case counter:
      accmDisplayMenu("MENU", "BUDGET CLAMP");
      accmMenu = budget;
      break;
    case budget:
      accmDisplayMenu("MENU", "NOISE THRESHOLDS");
      accmMenu = noise;
      break;
    case noise:
      accmDisplayMenu("MENU", "CURRENT CLAMP");
      accmMenu = current;
      break;
    default:
      break;
  }
}

void accmDisplayMenu(String m, String sm) {
  display.clearDisplay();
  int x = 5*floor((25-m.length())/2);
  display.setCursor(x,6);
  display.println(m);
  x = 5*floor((25-sm.length())/2);
  display.setCursor(x,18);
  display.println(sm);
  display.display();
  delay(800);
}

void accmAllLedsWorkarround(void) {
  int isOn = 0;
  for (int i=0;i<ACCM_LINES;i++) {
    if (EnergyApp.meter[i].eff() > EnergyApp.noise[i])
      isOn++;
  }
  if (isOn) {
    digitalWrite(POWER_LED, HIGH);
  } else {
    digitalWrite(POWER_LED, LOW);
  }
}

void accmSingleCounterLeds(void) {
  if (floor(EnergyApp.counter[accmCurrentLine]/EnergyApp.line[accmCurrentLine].warn) > EnergyApp.warnCounter[accmCurrentLine]) {
    EnergyApp.warnCounter[accmCurrentLine]++;
    digitalWrite(COUNTER_LED, HIGH);
    delay(80);
    digitalWrite(COUNTER_LED, LOW);
  }
}

void accmReport(void) {
    display.clearDisplay();
    display.setCursor(0,0);
    switch (accmViewMode) {
      case group:
        switch (accmMenu) {
          case current:
            accmAllLedsWorkarround();
            for (int i=0;i<ACCM_LINES; i++)
              if (EnergyApp.clamp[i].eff() > 1000)
                display.println("L" + String(i+1) + " " + String(EnergyApp.clamp[i].eff()/1000)+" A");
              else
                display.println("L" + String(i+1) + " " + String(EnergyApp.clamp[i].eff())+" mA");
            break;
          case power:
            accmAllLedsWorkarround();
            for (int i=0;i<ACCM_LINES; i++)
              if (EnergyApp.meter[i].eff() > 1000)
               display.println("L" + String(i+1) + " " + String(EnergyApp.meter[i].eff()/1000)+" kWatt");
             else
               display.println("L" + String(i+1) + " " + String(EnergyApp.meter[i].eff())+" Watt");
            break;
          case counter:
            accmAllLedsWorkarround();
            for (int i=0;i<ACCM_LINES; i++) {
               accmCurrentLine = i;
               accmSingleCounterLeds();
               display.println("L" + String(i+1) + " " + String(EnergyApp.counter[i],10)+" kWh");
            }  
            break;
          case budget:
            accmAllLedsWorkarround();
            for (int i=0;i<ACCM_LINES; i++)
              display.println("L" + String(i+1) + " " + String(EnergyApp.counter[i]*0.1740,10)+" euros");
            break;
          case noise:
            accmAllLedsWorkarround();
            for (int i=0;i<ACCM_LINES; i++)
              display.println("N" + String(i+1) + " " + String(EnergyApp.noise[i],2)+" Watt");
            break;
          default:
            break;
        };
        break;
      case single:
        if (EnergyApp.meter[accmCurrentLine].eff() > EnergyApp.noise[accmCurrentLine]) {
          digitalWrite(POWER_LED, HIGH);
        } else {
          digitalWrite(POWER_LED, LOW);
        }
        accmSingleCounterLeds();
        display.print("L" + String(accmCurrentLine+1) + " A" + String(EnergyApp.line[accmCurrentLine].pin));
        if (EnergyApp.noise[accmCurrentLine] > 1000)
          display.print(" N" + String(EnergyApp.noise[accmCurrentLine]/1000,2)+"kW ");
        else
          display.print(" N" + String(EnergyApp.noise[accmCurrentLine],2)+"W ");
        display.println("1V/" + String(EnergyApp.line[accmCurrentLine].sct_model) + "A" );
        if (EnergyApp.clamp[accmCurrentLine].eff() > 1000)
          display.print(String(EnergyApp.clamp[accmCurrentLine].eff()/1000,3)+"A ");
        else
          display.print(String(EnergyApp.clamp[accmCurrentLine].eff(),2)+"mA ");
        if (EnergyApp.meter[accmCurrentLine].eff() > 1000)
          display.println(String(EnergyApp.meter[accmCurrentLine].eff()/1000,3)+"kW");
        else
          display.println(String(EnergyApp.meter[accmCurrentLine].eff(),2)+"W");
        display.println(String(EnergyApp.counter[accmCurrentLine],10)+" kWh");
        display.println(String(EnergyApp.counter[accmCurrentLine]*0.1740,10)+" euros");      
        break;
      case settings:
        for (int i=0;i<ACCM_LINES; i++)
         display.println("L" + String(i+1) + " A" + String(EnergyApp.line[i].pin) + " " + String(EnergyApp.line[i].voltage) + "V" + String(EnergyApp.line[i].freq) + "Hz 1V/" + String(EnergyApp.line[i].sct_model) + "A");
        break;
      case credentials:
        digitalWrite(POWER_LED, LOW);
        digitalWrite(COUNTER_LED, LOW);
        display.println(APP + " " + VERSION + " " + DATE);
        display.println(CONTACT);
        display.println(String(freeMemory()) + " bytes RAM free");
        display.println("up " + uptime.smartDuration()); 
        break;
      default:
        break;
    };       
    display.display();    
}

void loop() {
  // put your main code here, to run repeatedly:
  menuButton.loop();
  EnergyApp.loop();
   
  if (menuButton.shortPress() || menuButton.longPress()) {
    switch (accmViewMode) {
      case group:
        nextAppMenu();
        break;
      case single:
        if (++accmCurrentLine == ACCM_LINES)
          accmCurrentLine = 0;
        break;
      default:
        break;
    }
  }
  if (menuButton.veryLongPress()) {
    display.clearDisplay();
    display.setCursor(0,0);
    switch (accmViewMode) {
      case group:
        accmDisplayMenu("FAST CALIBRATION", "all lines off");
        display.setCursor(40,9);
        display.print("__");
        display.display();       
        for (int i=0;i<ACCM_LINES; i++) {
          EnergyApp.calibrate(i, 100);
          display.print("__");
          display.display();
        }
        break;
      case single:
        accmDisplayMenu("FINE CALIBRATION", "L" + String(accmCurrentLine +1 ) + " A" + String(EnergyApp.line[accmCurrentLine].pin) + " off");
        EnergyApp.calibrate(accmCurrentLine, 1000);
        break;
      default:
        break;    
    }
  }
  if (menuButton.doublePress()) {
    nextViewMode();
  }
  accmReport();
  uptime.update();
}

Credits

ffrouin

3 projects • 3 followers

Open Source and Standard greatly help integration and maintenance costs. IT, 3D Printing and Electronic R&D, Repair : The Domestic Industry.

ACCM Shields v1 & v2 for Arduino UNO

Things used in this project

Hardware components

Software apps and online services

Hand tools and fabrication machines

Story

ACCM Concepts

ACCMv2 Features

ACCMv2 Cost killing circuit

ACCMv2 Circuit limits

ACCMv2 Software improvements

ACCMv2 Software limits

Schematics

Circuit Diagram

ACCMv1 Shield v1 (welcome screen)

ACCMv1 Shield v1 (current clamp)

ACCMv1 Shield v1 (power clamp)

ACCMv1 Shield v1 (power meter)

ACCM Shield v1 (full line details)

ACCMv1 Shield v1 (recto)

ACCMv1 Shield v1 (recto - behind the screen)

ACCMv1 Shield v1 (verso)

ACCMv2 Shield v2 (recto)

ACCMv2 Shield v2 (recto - behind the screen)

ACCMv2 Shield v2 (verso)

Code

ACCM_20221212.ino

ACCMv2 additional ressources

Credits

ffrouin

Comments

Embed the widget on your own site

ACCM Shields v1 & v2 for Arduino UNO

ACCM Shields v1 & v2 for Arduino UNO

Things used in this project

Hardware components

Software apps and online services

Hand tools and fabrication machines

Story

ACCM Concepts

ACCMv2 Features

ACCMv2 Cost killing circuit

ACCMv2 Circuit limits

ACCMv2 Software improvements

ACCMv2 Software limits

Schematics

Circuit Diagram

ACCMv1 Shield v1 (welcome screen)

ACCMv1 Shield v1 (current clamp)

ACCMv1 Shield v1 (power clamp)

ACCMv1 Shield v1 (power meter)

ACCM Shield v1 (full line details)

ACCMv1 Shield v1 (recto)

ACCMv1 Shield v1 (recto - behind the screen)

ACCMv1 Shield v1 (verso)

ACCMv2 Shield v2 (recto)

ACCMv2 Shield v2 (recto - behind the screen)

ACCMv2 Shield v2 (verso)

Code

ACCM_20221212.ino

ACCMv2 additional ressources

Credits

ffrouin

Comments

Related channels and tags