Module lib.tools.awake

Manage the battery

# Distributed under Pycameresp License
# Copyright (c) 2023 Remi BERTHOLET
# pylint:disable=consider-using-f-string
""" Manage the battery """
import machine
import uasyncio
import tools.jsonconfig
import tools.logger
import tools.tasking

class AwakeConfig(tools.jsonconfig.JsonConfig):
        """ Awake configuration """
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)

                # GPIO wake up
                self.activated = False  # Wake up on GPIO status
                self.wake_up_gpio = 13 # Wake up GPIO number
                self.awake_duration = 120 # Awake duration in seconds
                self.sleep_duration = 3600*24*365 # Sleep duration in seconds

class Awake:
        """ Manage the awake """
        config = None
        awake_counter = [0] # Decrease each second

        @staticmethod
        def init(**kwargs):
                """ Init awake class """
                # If config not yet read
                if Awake.config is None:
                        Awake.config = AwakeConfig()
                        Awake.config.load_create()
                        Awake.keep_awake()
                else:
                        Awake.config.refresh()

        @staticmethod
        def set_pin_wake_up():
                """ Configure the wake up gpio on high level. For ESP32CAM, the GPIO 13 is used to detect the state of PIR detector. """
                Awake.init()
                try:
                        if Awake.config.wake_up_gpio != 0:
                                import esp32
                                wake1 = machine.Pin(Awake.config.wake_up_gpio, mode=machine.Pin.IN, pull=machine.Pin.PULL_DOWN)
                                esp32.wake_on_ext0(pin = wake1, level = esp32.WAKEUP_ANY_HIGH)
                                tools.logger.syslog("Pin wake up on %d"%Awake.config.wake_up_gpio)
                        else:
                                tools.logger.syslog("Pin wake up disabled")
                        return True
                except Exception as err:
                        tools.logger.syslog(err,"Cannot set wake up")
                return False

        @staticmethod
        def is_pin_wake_up():
                """ Indicates that the machine wake up on pin modification (Only available at start) """
                Awake.init()
                if Awake.config.activated:
                        try:
                                pin = machine.Pin(Awake.config.wake_up_gpio, machine.Pin.IN, machine.Pin.PULL_UP)
                                return True if pin.value() == 1 else False
                        except:
                                return False
                else:
                        return False

        @staticmethod
        def keep_awake():
                """ Keep awake  """
                if Awake.config.activated:
                        Awake.awake_counter[0] = Awake.config.awake_duration

        @staticmethod
        async def task(**kwargs):
                """ Awake task core """
                Awake.init(**kwargs)

                if Awake.config.activated:
                        Awake.awake_counter[0] -= 1
                        if Awake.awake_counter[0] <= 0:
                                tools.logger.syslog("Sleep %d s"%Awake.config.sleep_duration)

                                # Set the wake up on PIR detection
                                Awake.set_pin_wake_up()
                                machine.deepsleep(Awake.config.sleep_duration*1000)
                        await uasyncio.sleep(1)
                else:
                        await uasyncio.sleep(60)

        @staticmethod
        def start(**kwargs):
                """ Start awake task """
                tools.tasking.Tasks.create_monitor(Awake.task, **kwargs)

Classes

class Awake

Manage the awake

Expand source code

class Awake:
        """ Manage the awake """
        config = None
        awake_counter = [0] # Decrease each second

        @staticmethod
        def init(**kwargs):
                """ Init awake class """
                # If config not yet read
                if Awake.config is None:
                        Awake.config = AwakeConfig()
                        Awake.config.load_create()
                        Awake.keep_awake()
                else:
                        Awake.config.refresh()

        @staticmethod
        def set_pin_wake_up():
                """ Configure the wake up gpio on high level. For ESP32CAM, the GPIO 13 is used to detect the state of PIR detector. """
                Awake.init()
                try:
                        if Awake.config.wake_up_gpio != 0:
                                import esp32
                                wake1 = machine.Pin(Awake.config.wake_up_gpio, mode=machine.Pin.IN, pull=machine.Pin.PULL_DOWN)
                                esp32.wake_on_ext0(pin = wake1, level = esp32.WAKEUP_ANY_HIGH)
                                tools.logger.syslog("Pin wake up on %d"%Awake.config.wake_up_gpio)
                        else:
                                tools.logger.syslog("Pin wake up disabled")
                        return True
                except Exception as err:
                        tools.logger.syslog(err,"Cannot set wake up")
                return False

        @staticmethod
        def is_pin_wake_up():
                """ Indicates that the machine wake up on pin modification (Only available at start) """
                Awake.init()
                if Awake.config.activated:
                        try:
                                pin = machine.Pin(Awake.config.wake_up_gpio, machine.Pin.IN, machine.Pin.PULL_UP)
                                return True if pin.value() == 1 else False
                        except:
                                return False
                else:
                        return False

        @staticmethod
        def keep_awake():
                """ Keep awake  """
                if Awake.config.activated:
                        Awake.awake_counter[0] = Awake.config.awake_duration

        @staticmethod
        async def task(**kwargs):
                """ Awake task core """
                Awake.init(**kwargs)

                if Awake.config.activated:
                        Awake.awake_counter[0] -= 1
                        if Awake.awake_counter[0] <= 0:
                                tools.logger.syslog("Sleep %d s"%Awake.config.sleep_duration)

                                # Set the wake up on PIR detection
                                Awake.set_pin_wake_up()
                                machine.deepsleep(Awake.config.sleep_duration*1000)
                        await uasyncio.sleep(1)
                else:
                        await uasyncio.sleep(60)

        @staticmethod
        def start(**kwargs):
                """ Start awake task """
                tools.tasking.Tasks.create_monitor(Awake.task, **kwargs)

Class variables

var awake_counter

var config

Static methods

def init(**kwargs)

Init awake class

Expand source code

@staticmethod
def init(**kwargs):
        """ Init awake class """
        # If config not yet read
        if Awake.config is None:
                Awake.config = AwakeConfig()
                Awake.config.load_create()
                Awake.keep_awake()
        else:
                Awake.config.refresh()

def is_pin_wake_up()

Indicates that the machine wake up on pin modification (Only available at start)

Expand source code

@staticmethod
def is_pin_wake_up():
        """ Indicates that the machine wake up on pin modification (Only available at start) """
        Awake.init()
        if Awake.config.activated:
                try:
                        pin = machine.Pin(Awake.config.wake_up_gpio, machine.Pin.IN, machine.Pin.PULL_UP)
                        return True if pin.value() == 1 else False
                except:
                        return False
        else:
                return False

def keep_awake()

Keep awake

Expand source code

@staticmethod
def keep_awake():
        """ Keep awake  """
        if Awake.config.activated:
                Awake.awake_counter[0] = Awake.config.awake_duration

def set_pin_wake_up()

Configure the wake up gpio on high level. For ESP32CAM, the GPIO 13 is used to detect the state of PIR detector.

Expand source code

@staticmethod
def set_pin_wake_up():
        """ Configure the wake up gpio on high level. For ESP32CAM, the GPIO 13 is used to detect the state of PIR detector. """
        Awake.init()
        try:
                if Awake.config.wake_up_gpio != 0:
                        import esp32
                        wake1 = machine.Pin(Awake.config.wake_up_gpio, mode=machine.Pin.IN, pull=machine.Pin.PULL_DOWN)
                        esp32.wake_on_ext0(pin = wake1, level = esp32.WAKEUP_ANY_HIGH)
                        tools.logger.syslog("Pin wake up on %d"%Awake.config.wake_up_gpio)
                else:
                        tools.logger.syslog("Pin wake up disabled")
                return True
        except Exception as err:
                tools.logger.syslog(err,"Cannot set wake up")
        return False

def start(**kwargs)

Start awake task

Expand source code

@staticmethod
def start(**kwargs):
        """ Start awake task """
        tools.tasking.Tasks.create_monitor(Awake.task, **kwargs)

async def task(**kwargs)

Awake task core

Expand source code

@staticmethod
async def task(**kwargs):
        """ Awake task core """
        Awake.init(**kwargs)

        if Awake.config.activated:
                Awake.awake_counter[0] -= 1
                if Awake.awake_counter[0] <= 0:
                        tools.logger.syslog("Sleep %d s"%Awake.config.sleep_duration)

                        # Set the wake up on PIR detection
                        Awake.set_pin_wake_up()
                        machine.deepsleep(Awake.config.sleep_duration*1000)
                await uasyncio.sleep(1)
        else:
                await uasyncio.sleep(60)

class AwakeConfig

Awake configuration

Constructor

Expand source code

class AwakeConfig(tools.jsonconfig.JsonConfig):
        """ Awake configuration """
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)

                # GPIO wake up
                self.activated = False  # Wake up on GPIO status
                self.wake_up_gpio = 13 # Wake up GPIO number
                self.awake_duration = 120 # Awake duration in seconds
                self.sleep_duration = 3600*24*365 # Sleep duration in seconds

Ancestors

• tools.jsonconfig.JsonConfig