globals.h

Go to the documentation of this file.

 
#pragma once
 
#include <Arduino.h>
 
#include "flags.h"
 
extern bool
SILENCE,
DEBUG;
 
const char START_MESSAGE[] PROGMEM = "\n============ START: [BQ28Z610 Driver] ============\nLicense: MIT License\nCopyright (c) 2024 Oleksii Sylichenko\n==================================================\n";
 
const int DEVICE_ADDR = 0x55;
 
class SecurityMode {
  public:
    static const byte FULL_ACCESS = 1;
    static const byte UNSEALED = 2;
    static const byte SEALED = 3;
};
 
class DeviceSecurity {
  public:
    static const u32 DEFAULT_UNSEAL_KEY = 0x36720414;
    static const u32 DEFAULT_FULL_ACCESS_KEY = 0xFFFFFFFF;
};
 
class BlockProtocol {
  public:
    static const int REQUEST_MAX_SIZE = 32;  
    static const int PAYLOAD_MAX_SIZE = REQUEST_MAX_SIZE;  
 
    static const int ADDR_SIZE = 2;  
    static const int CHECKSUM_SIZE = 1;  
    static const int LENGTH_SIZE = 1;  
    static const int CHECKSUM_AND_LENGTH_SIZE = CHECKSUM_SIZE + LENGTH_SIZE;  
    static const int SERVICE_SIZE = ADDR_SIZE + CHECKSUM_SIZE + LENGTH_SIZE;  
 
    static const int DATA_INDEX = 2;  
    static const int CHECKSUM_INDEX = 34;  
    static const int LENGTH_INDEX = 35;  
 
    static const int RESPONSE_MAX_SIZE = 36;  
    static const int MAX = RESPONSE_MAX_SIZE;
};
 
class StdCommands {
  public:
    static const byte MANUFACTURER_ACCESS_CONTROL = 0x00;
    static const byte TEMPERATURE = 0x06;
    static const byte VOLTAGE = 0x08;
    static const byte BATTERY_STATUS = 0x0A;
    static const byte CURRENT = 0x0C;
    static const byte REMAINING_CAPACITY = 0x10;
    static const byte FULL_CHARGE_CAPACITY = 0x12;
    static const byte AVERAGE_CURRENT = 0x14;
    static const byte CYCLE_COUNT = 0x2A;
    static const byte RELATIVE_STATE_OF_CHARGE = 0x2C;
    static const byte STATE_OF_HEALTH = 0x2E;
    static const byte CHARGING_VOLTAGE = 0x30;
    static const byte CHARGING_CURRENT = 0x32;
    static const byte DESIGN_CAPACITY = 0x3C;
    static const byte ALT_MANUFACTURER_ACCESS = 0x3E;
    static const byte MAC_DATA = 0x40;
    static const byte MAC_DATA_CHECKSUM = 0x60;
};
 
class AltManufacturerCommands {
  public:
    static const word DEVICE_TYPE = 0x0001;
    static const word FIRMWARE_VERSION = 0x0002;
    static const word HARDWARE_VERSION = 0x0003;
    static const word CHEMICAL_ID = 0x0006;
    static const word DEVICE_RESET = 0x0012;
    static const word CHG_FET = 0x001F;
    static const word DSG_FET = 0x0020;
    static const word GAUGE_EN = 0x0021;
    static const word FET_CONTROL = 0x0022;
    static const word LIFETIME_DATA_RESET = 0x0028;
    static const word PERMANENT_FAIL_DATA_RESET = 0x0029;
    static const word SEAL_DEVICE = 0x0030;
    static const word SAFETY_ALERT = 0x0050;
    static const word PF_ALERT = 0x0052;
    static const word PF_STATUS = 0x0053;
    static const word OPERATION_STATUS = 0x0054;
    static const word CHARGING_STATUS = 0x0055;
    static const word GAUGING_STATUS = 0x0056;
    static const word MANUFACTURER_STATUS = 0x0057;
    static const word DA_STATUS_1 = 0x0071;
    static const word DA_STATUS_2 = 0x0072;
    static const word IT_STATUS_1 = 0x0073;
    static const word IT_STATUS_2 = 0x0074;
    static const word IT_STATUS_3 = 0x0075;
};
 
class DA_STATUS_1 {
  public:
    static const byte CELL_VOLTAGE_1 = 0;
    static const byte CELL_VOLTAGE_2 = 2;
    static const byte BAT_VOLTAGE = 8;
    static const byte PACK_VOLTAGE = 10;
    static const byte CELL_CURRENT_1 = 12;
    static const byte CELL_CURRENT_2 = 14;
    static const byte CELL_POWER_1 = 20;
    static const byte CELL_POWER_2 = 22;
    static const byte POWER = 28;
    static const byte AVG_POWER = 30;
};
 
class IT_STATUS_2 {
  public:
    static const byte DOD0_1 = 10;
 
    static const byte DOD0_2 = 12;
 
    static const byte DOD0_Passed_Q = 14;
 
    static const byte DOD0_Passed_Energy = 16;
 
    static const byte DOD0_Time = 18;
 
    static const byte DODEOC_1 = 20;
 
    static const byte DODEOC_2 = 22;
};
 
class IT_STATUS_3 {
  public:
    static const byte QMax_1 = 0;
    static const byte QMax_2 = 2;
    static const byte QMaxDOD0_1 = 4;
    static const byte QMaxDOD0_2 = 6;
    static const byte QMaxPassedQ = 8;
    static const byte QMaxTime = 10;
    static const byte Tk = 12;
    static const byte Ta = 14;
    static const byte RAW_DOD0_1 = 16;
    static const byte RAW_DOD0_2 = 18;
};
 
class Units {
  public:
    static PGM_P MAH() {
      return PSTR("mAh");
    }
    static PGM_P CWH() {
      return PSTR("cWh");
    }
    static PGM_P MW() {
      return PSTR("mW");
    }
    static PGM_P MA() {
      return PSTR("mA");
    }
    static PGM_P V() {
      return PSTR("V");
    }
    static PGM_P PERCENT() {
      return PSTR("%");
    }
    static PGM_P CELSIUS() {
      return PSTR("°C");
    }
};
 
const float DECIPART = 0.1;
const float DECIPART_DECIMAL = 1;
 
const float PERMIL = 0.001;
const byte PERMIL_DECIMAL = 3;