energyic_UART.cpp

/* ATM90E26 Energy Monitor Demo Application

   The MIT License (MIT)

 Copyright (c) 2016 whatnick and Ryzee

 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
*/
#include <energyic_UART.h>

ATM90E26_UART::ATM90E26_UART(Stream *UART) { ATM_UART = UART; }

unsigned short ATM90E26_UART::CommEnergyIC(unsigned char RW,
                                           unsigned char address,
                                           unsigned short val) {
  unsigned short output;
  // Set read write flag
  address |= RW << 7;

  byte host_chksum = address;
  if (!RW) {
    unsigned short chksum_short = (val >> 8) + (val & 0xFF) + address;
    host_chksum = chksum_short & 0xFF;
  }

  // Clear out any data left in the buffer so it does not interfere later
  ATM_UART->read();
  // begin UART command
  ATM_UART->write(0xFE);
  ATM_UART->write(address);

  if (!RW) {
    byte MSBWrite = val >> 8;
    byte LSBWrite = val & 0xFF;
    ATM_UART->write(MSBWrite);
    ATM_UART->write(LSBWrite);
  }
  ATM_UART->write(host_chksum);
#if defined(ESP32)
  delay(40); // Somehow, Arduino framework for ESP32 needs this delay
#else
  delay(10);
#endif

  // Read register only
  if (RW) {
    byte MSByte = ATM_UART->read();
    byte LSByte = ATM_UART->read();
    byte atm90_chksum = ATM_UART->read();

    if (atm90_chksum == ((LSByte + MSByte) & 0xFF)) {
      output = (MSByte << 8) | LSByte; // join MSB and LSB;
      return output;
    }
    Serial.println("Read failed");
    delay(20); // Delay from failed transaction
    return 0xFFFF;
  }

  // Write register only
  else {
    byte atm90_chksum = ATM_UART->read();
    if (atm90_chksum != host_chksum) {
      Serial.println("Write failed");
      delay(20); // Delay from failed transaction
    }
  }
  return 0xFFFF;
}

double ATM90E26_UART::GetLineVoltage() {
  unsigned short voltage = CommEnergyIC(1, Urms, 0xFFFF);
  return (double)voltage / 100;
}

unsigned short ATM90E26_UART::GetMeterStatus() {
  return CommEnergyIC(1, EnStatus, 0xFFFF);
}

double ATM90E26_UART::GetLineCurrent() {
  unsigned short current = CommEnergyIC(1, Irms, 0xFFFF);
  return (double)current / 1000;
}

double ATM90E26_UART::GetActivePower() {
  short int apower = (short int)CommEnergyIC(
      1, Pmean, 0xFFFF); // Complement, MSB is signed bit
  return (double)apower;
}

double ATM90E26_UART::GetFrequency() {
  unsigned short freq = CommEnergyIC(1, Freq, 0xFFFF);
  return (double)freq / 100;
}

double ATM90E26_UART::GetPowerFactor() {
  short int pf = (short int)CommEnergyIC(1, PowerF, 0xFFFF); // MSB is signed
                                                             // bit
  // if negative
  if (pf & 0x8000) {
    pf = (pf & 0x7FFF) * -1;
  }
  return (double)pf / 1000;
}

double ATM90E26_UART::GetImportEnergy() {
  // Register is cleared after reading
  unsigned short ienergy = CommEnergyIC(1, APenergy, 0xFFFF);
  return (double)ienergy *
         0.0001; // returns kWh if PL constant set to 1000imp/kWh
}

double ATM90E26_UART::GetExportEnergy() {
  // Register is cleared after reading
  unsigned short eenergy = CommEnergyIC(1, ANenergy, 0xFFFF);
  return (double)eenergy *
         0.0001; // returns kWh if PL constant set to 1000imp/kWh
}

unsigned short ATM90E26_UART::GetSysStatus() {
  return CommEnergyIC(1, SysStatus, 0xFFFF);
}

/*
Initialise Energy IC, assume UART has already began in the main code
*/
void ATM90E26_UART::InitEnergyIC() {
  unsigned short systemstatus;

  CommEnergyIC(0, SoftReset, 0x789A); // Perform soft reset
  CommEnergyIC(0, FuncEn, 0x0030);    // Voltage sag irq=1, report on warnout
                                   // pin=1, energy dir change irq=0
  CommEnergyIC(0, SagTh, 0x1F2F); // Voltage sag threshhold

  // Set metering calibration values
  CommEnergyIC(0, CalStart, 0x5678); // Metering calibration startup command.
                                     // Register 21 to 2B need to be set
  CommEnergyIC(0, PLconstH, 0x00B9); // PL Constant MSB
  CommEnergyIC(0, PLconstL, 0xC1F3); // PL Constant LSB
  CommEnergyIC(0, Lgain, 0x1D39);    // Line calibration gain
  CommEnergyIC(0, Lphi, 0x0000);     // Line calibration angle
  CommEnergyIC(0, PStartTh, 0x08BD); // Active Startup Power Threshold
  CommEnergyIC(0, PNolTh, 0x0000);   // Active No-Load Power Threshold
  CommEnergyIC(0, QStartTh, 0x0AEC); // Reactive Startup Power Threshold
  CommEnergyIC(0, QNolTh, 0x0000);   // Reactive No-Load Power Threshold
  CommEnergyIC(0, MMode, 0x9422); // Metering Mode Configuration. All defaults.
                                  // See pg 31 of datasheet.
  CommEnergyIC(0, CSOne, 0x4A34); // Write CSOne, as self calculated

  Serial.print("Checksum 1:");
  Serial.println(
      CommEnergyIC(1, CSOne, 0x0000),
      HEX); // Checksum 1. Needs to be calculated based off the above values.

  // Set measurement calibration values
  CommEnergyIC(
      0, AdjStart,
      0x5678); // Measurement calibration startup command, registers 31-3A
  CommEnergyIC(0, Ugain, 0xD464);    // Voltage rms gain
  CommEnergyIC(0, IgainL, 0x6E49);   // L line current gain
  CommEnergyIC(0, Uoffset, 0x0000);  // Voltage offset
  CommEnergyIC(0, IoffsetL, 0x0000); // L line current offset
  CommEnergyIC(0, PoffsetL, 0x0000); // L line active power offset
  CommEnergyIC(0, QoffsetL, 0x0000); // L line reactive power offset
  CommEnergyIC(0, CSTwo, 0xD294);    // Write CSTwo, as self calculated

  Serial.print("Checksum 2:");
  Serial.println(
      CommEnergyIC(1, CSTwo, 0x0000),
      HEX); // Checksum 2. Needs to be calculated based off the above values.

  CommEnergyIC(0, CalStart, 0x8765); // Checks correctness of 21-2B registers
                                     // and starts normal metering if ok
  CommEnergyIC(0, AdjStart, 0x8765); // Checks correctness of 31-3A registers
                                     // and starts normal measurement  if ok

  systemstatus = GetSysStatus();

  if (systemstatus & 0xC000) {
    // checksum 1 error
    Serial.println("Checksum 1 Error!!");
  }
  if (systemstatus & 0x3000) {
    // checksum 2 error
    Serial.println("Checksum 2 Error!!");
  }
}