battery.cpp File Reference

Battery related functions. More...

#include "../includes/battery.h"
#include "Arduino.h"
#include "../includes/alarm_controller.h"
#include "../includes/debug.h"
#include "../includes/parameters.h"

Go to the source code of this file.

Functions
void	initBattery ()
	Initialize battery abstraction. More...
void	updateBatterySample ()
	Handle battery voltage calculation. More...
void	updateBatteryState (uint32_t p_cycleNumber)
	Updates battery states. More...
void	batteryLoop (uint32_t p_cycleNumber)
	Handle battery events. More...
uint32_t	getBatteryLevel ()
	Returns battery level. More...
uint32_t	getBatteryLevelX10 ()
	Returns battery level x10 for better accuracy. More...
uint32_t	getBatteryLevelX100 ()
	Returns battery level x100 for better accuracy. More...
bool	isBatteryVeryLow ()
	Check if battery level is very low. More...
bool	isBatteryDeepDischarged ()
	Check if battery is deeply discharged. More...
bool	isMainsConnected ()
	Check if mains are connected. More...
bool	isMainsAvailable ()
	Check if the cable between power supply and expander input is connected. More...

Variables
static uint32_t	rawBatterySample [BATTERY_MAX_SAMPLES]
static uint32_t	batteryCurrentSample = 0
static uint32_t	batteryTotalSamples = 0
static uint32_t	rawBatteryMeanVoltage = RAW_VOLTAGE_MAINS
static bool	isRunningOnBattery = false
static bool	mainsConnected = false
static bool	mainsConnectedAvailable = false

Detailed Description

Battery related functions.

Author

Makers For Life

Copyright

Copyright (c) 2020 Makers For Life

Definition in file battery.cpp.

Function Documentation

batteryLoop()

void batteryLoop

(

uint32_t

p_cycleNumber

)

Handle battery events.

Parameters

p_cycleNumber

Number of cycles since boot

Warning

It must be called in the program loop

Definition at line 117 of file battery.cpp.

                                         {
    updateBatterySample();
    updateBatteryState(p_cycleNumber);
}

getBatteryLevel()

uint32_t getBatteryLevel

(

)

Returns battery level.

Returns

Battery level in volts

Definition at line 123 of file battery.cpp.

{ return rawBatteryMeanVoltage * RAW_BATTERY_MULTIPLIER; }

getBatteryLevelX10()

uint32_t getBatteryLevelX10

(

)

Returns battery level x10 for better accuracy.

Returns

Battery level in volts x10

Definition at line 126 of file battery.cpp.

{ return rawBatteryMeanVoltage * (10.0 * RAW_BATTERY_MULTIPLIER); }

getBatteryLevelX100()

uint32_t getBatteryLevelX100

(

)

Returns battery level x100 for better accuracy.

Returns

Battery level in volts x100

Definition at line 129 of file battery.cpp.

{ return rawBatteryMeanVoltage * (100.0 * RAW_BATTERY_MULTIPLIER); }

initBattery()

void initBattery

(

)

Initialize battery abstraction.

Warning

It must be called once to be able to check battery level

Definition at line 33 of file battery.cpp.

                   {
    // hardware v3 expander is connected to AC ON relay. that remains an optionnal wiring.
    pinMode(PIN_IN_MAINS_CONNECTED, INPUT_PULLUP);
    pinMode(PIN_IN_CONNECTION_TO_SUPPLY_OK, INPUT_PULLUP);
    analogReadResolution(ADC_RESOLUTION_MAKAIR);
 
    for (uint8_t i = 0; i < BATTERY_MAX_SAMPLES; i++) {
        rawBatterySample[i] = 0;
    }
 
    // Running this in setup avoids triggering alarms at startup
    for (uint8_t i = 0; i < BATTERY_MAX_SAMPLES; i++) {
        updateBatterySample();
    }
}

isBatteryDeepDischarged()

bool isBatteryDeepDischarged

(

)

Check if battery is deeply discharged.

Definition at line 136 of file battery.cpp.

                               {
    return rawBatteryMeanVoltage < RAW_VOLTAGE_ON_BATTERY_STOP_THRESHOLD;
}

isBatteryVeryLow()

bool isBatteryVeryLow

(

)

Check if battery level is very low.

Definition at line 132 of file battery.cpp.

                        {
    return rawBatteryMeanVoltage < RAW_VOLTAGE_ON_BATTERY_NOT_STARTING_THRESHOLD;
}

isMainsAvailable()

bool isMainsAvailable

(

)

Check if the cable between power supply and expander input is connected.

Definition at line 144 of file battery.cpp.

{ return mainsConnectedAvailable; }

isMainsConnected()

bool isMainsConnected

(

)

Check if mains are connected.

Definition at line 141 of file battery.cpp.

{ return (!isRunningOnBattery); }

updateBatterySample()

void updateBatterySample

(

)

Handle battery voltage calculation.

Definition at line 49 of file battery.cpp.

                           {
    uint16_t rawVout = analogRead(PIN_BATTERY);
 
    // Assign sample from Vout
    rawBatterySample[batteryCurrentSample] = rawVout;
 
    // Increment sample
    batteryCurrentSample++;
 
    // If we reached max samples
    if (batteryCurrentSample >= BATTERY_MAX_SAMPLES) {
        batteryCurrentSample = 0;
    }
 
    batteryTotalSamples = 0;
    for (uint8_t i = 0; i < BATTERY_MAX_SAMPLES; i++) {
        batteryTotalSamples += rawBatterySample[i];
    }
    // Updates mean voltage
    rawBatteryMeanVoltage = (batteryTotalSamples / BATTERY_MAX_SAMPLES);
}

updateBatteryState()

void updateBatteryState

(

uint32_t

p_cycleNumber

)

Updates battery states.

Parameters

p_cycleNumber

Number of cycle since start

Definition at line 71 of file battery.cpp.

                                                {
    // The connector includes a small wire between gnd and PIN_IN_CONNECTION_TO_SUPPLY_OK.
    // If this is not detected, there may be a end of line connection problem,
    // and there is a fallback to Vbat value
    mainsConnectedAvailable = (LOW == digitalRead(PIN_IN_CONNECTION_TO_SUPPLY_OK));
    mainsConnected = (LOW == digitalRead(PIN_IN_MAINS_CONNECTED));
 
    if ((mainsConnectedAvailable && !mainsConnected)
        || (!mainsConnectedAvailable
            && (rawBatteryMeanVoltage < (RAW_VOLTAGE_ON_BATTERY_HIGH - RAW_VOLTAGE_HYSTERESIS)))) {
        alarmController.detectedAlarm(RCM_SW_16, p_cycleNumber,
                                      (RAW_VOLTAGE_ON_BATTERY_HIGH - RAW_VOLTAGE_HYSTERESIS),
                                      rawBatteryMeanVoltage);
        isRunningOnBattery = true;
    } else if ((mainsConnectedAvailable && mainsConnected)
               || (!mainsConnectedAvailable
                   && (rawBatteryMeanVoltage > RAW_VOLTAGE_ON_BATTERY_HIGH))) {
        alarmController.notDetectedAlarm(RCM_SW_16);
        isRunningOnBattery = false;
    } else {
        // This is an hysteresis, so do nothing here
    }
 
    if (!mainsConnected
        && (rawBatteryMeanVoltage < (RAW_VOLTAGE_ON_BATTERY - RAW_VOLTAGE_HYSTERESIS))) {
        alarmController.detectedAlarm(RCM_SW_11, p_cycleNumber,
                                      (RAW_VOLTAGE_ON_BATTERY - RAW_VOLTAGE_HYSTERESIS),
                                      rawBatteryMeanVoltage);
    } else if (mainsConnected || (rawBatteryMeanVoltage > RAW_VOLTAGE_ON_BATTERY)) {
        alarmController.notDetectedAlarm(RCM_SW_11);
    } else {
        // This is an hysteresis, so do nothing here
    }
 
    if (!mainsConnected
        && (rawBatteryMeanVoltage < (RAW_VOLTAGE_ON_BATTERY_LOW - RAW_VOLTAGE_HYSTERESIS))) {
        alarmController.detectedAlarm(RCM_SW_12, p_cycleNumber,
                                      (RAW_VOLTAGE_ON_BATTERY_LOW - RAW_VOLTAGE_HYSTERESIS),
                                      rawBatteryMeanVoltage);
    } else if (mainsConnected || (rawBatteryMeanVoltage > RAW_VOLTAGE_ON_BATTERY_LOW)) {
        alarmController.notDetectedAlarm(RCM_SW_12);
    } else {
        // This is an hysteresis, so do nothing here
    }
}

Variable Documentation

batteryCurrentSample

uint32_t batteryCurrentSample = 0

static

Definition at line 26 of file battery.cpp.

batteryTotalSamples

uint32_t batteryTotalSamples = 0

static

Definition at line 27 of file battery.cpp.

isRunningOnBattery

bool isRunningOnBattery = false

static

Definition at line 29 of file battery.cpp.

mainsConnected

bool mainsConnected = false

static

Definition at line 30 of file battery.cpp.

mainsConnectedAvailable

bool mainsConnectedAvailable = false

static

Definition at line 31 of file battery.cpp.

rawBatteryMeanVoltage

uint32_t rawBatteryMeanVoltage = RAW_VOLTAGE_MAINS

static

Definition at line 28 of file battery.cpp.

rawBatterySample

uint32_t rawBatterySample[BATTERY_MAX_SAMPLES]

static

Definition at line 25 of file battery.cpp.