GyverPower

GyverPower - библиотека для управления энергопотреблением МК AVR

Управление системным клоком
Включение/выключение периферии:
- BOD
- Таймеры
- I2C/UART/SPI
- USB
- ADC
Сон в разных режимах (список ниже)
Сон на любой период
- Калибровка таймера для точного времени сна
- Корректировка millis()

Совместимость

Atmega2560/32u4/328
Attiny85/84/167

Документация

К библиотеке есть расширенная документация

Использование

void hardwareEnable(uint16_t data);               // включение указанной периферии (см. ниже "Константы периферии")
void hardwareDisable(uint16_t data);              // выключение указанной периферии (см. ниже "Константы периферии")
void setSystemPrescaler(prescalers_t prescaler);  // установка делителя системной частоты
void adjustInternalClock(int8_t adj);             // подстройка частоты внутреннего генератора (число -120...+120)
void bodInSleep(bool en);                         // Brown-out detector в режиме сна (true вкл - false выкл) [умолч. false]

void setSleepMode(sleepmodes_t mode);             // установка текущего режима сна [умолч. POWERDOWN_SLEEP]
void sleep(sleepprds_t period);                   // сон на стандартный период
bool inSleep();                                   // вернёт true, если МК спит для проверки в прерывании

uint32_t sleepDelay(uint32_t ms);                 // сон на произвольный период в миллисекундах, возвращает остаток времени для коррекции таймеров
uint32_t sleepDelay(uint32_t ms, uint32_t sec, uint16_t min = 0, uint16_t hour = 0, uint16_t day = 0);
void setSleepResolution(sleepprds_t period);      // период WDT для sleepDelay(): меньше период - выше точность, больше период - меньше пробуждений [умолч. SLEEP_128MS]
void correctMillis(bool state);                   // корректировать millis() на время завершённых периодов сна sleepDelay() [умолч. true]
void calibrate();                                 // автоматическая калибровка таймера сна sleepDelay(), выполняется 16 мс
void wakeUp();                                    // выйти из sleepDelay() из обработчика прерывания; незавершённый период WDT не учитывается

===== РЕЖИМЫ СНА для setSleepMode() =====
IDLE_SLEEP          - Легкий сон, отключается только клок CPU и Flash, просыпается мгновенно от любых прерываний
ADC_SLEEP           - Легкий сон, отключается CPU и system clock, АЦП начинает преобразование при уходе в сон (см. пример ADCinSleep)
EXTSTANDBY_SLEEP    - Глубокий сон, идентичен POWERSAVE_SLEEP + system clock активен
STANDBY_SLEEP       - Глубокий сон, идентичен POWERDOWN_SLEEP + system clock активен
POWERSAVE_SLEEP     - Глубокий сон, идентичен POWERDOWN_SLEEP + timer 2 активен (+ можно проснуться от его прерываний), можно использовать для счета времени (см. пример powersaveMillis)
POWERDOWN_SLEEP     - Наиболее глубокий сон, отключается всё кроме WDT и внешних прерываний, просыпается от аппаратных (обычных + PCINT) или WDT

===== ПЕРИОДЫ СНА для sleep() и setSleepResolution() =====
SLEEP_16MS
SLEEP_32MS
SLEEP_64MS
SLEEP_128MS
SLEEP_256MS
SLEEP_512MS
SLEEP_1024MS
SLEEP_2048MS
SLEEP_4096MS
SLEEP_8192MS
SLEEP_FOREVER	- вечный сон

===== КОНСТАНТЫ ДЕЛИТЕЛЯ для setSystemPrescaler() =====
PRESCALER_1
PRESCALER_2
PRESCALER_4
PRESCALER_8
PRESCALER_16
PRESCALER_32
PRESCALER_64
PRESCALER_128
PRESCALER_256

===== КОНСТАНТЫ ПЕРИФЕРИИ для hardwareDisable() и hardwareEnable() =====
PWR_ALL		- всё железо
PWR_ADC		- АЦП и компаратор
PWR_TIMER1	- Таймер 0
PWR_TIMER0	- Таймер 1
PWR_TIMER2	- Таймер 2
PWR_TIMER3	- Таймер 3
PWR_TIMER4	- Таймер 4
PWR_TIMER5	- Таймер 5	
PWR_UART0	- Serial 0
PWR_UART1	- Serial 1
PWR_UART2	- Serial 2
PWR_UART3	- Serial 3
PWR_I2C		- Wire
PWR_SPI		- SPI
PWR_USB		- USB	
PWR_USI		- Wire + Spi (ATtinyXX)
PWR_LIN		- USART LIN (ATtinyXX)

Простой сон

Режим сна настраивается в power.setSleepMode(), по умолчанию активен POWERDOWN_SLEEP (остальные см. выше).
Чтобы уснуть - вызываем power.sleep() с указанием одного из стандартных периодов (см. выше).
Реальное время сна будет слегка отличаться, так как "таймер сна" не очень точный.

Сон на любой период

Режим сна настраивается в power.setSleepMode(), по умолчанию активен POWERDOWN_SLEEP (остальные см. выше).
Чтобы уснуть - вызываем power.sleepDelay() с указанием периода в миллисекундах (uint32_t, до ~50 суток).
По умолчанию данная функция "спит" периодами по 128 миллисекунд. Время бодрствования между периодами сна составляет около 2.2 мкс (при 16 Мгц), что составляет 0.0017% от времени сна. Соответственно точность времени сна кратна одному периоду сна. Этот период можно настроить в power.setSleepResolution(), которая принимает те же константы, что и sleep(). Если нужен более точный сон - можно поставить 16 мс (SLEEP_16MS), если максимальное энергосбережение - 8 секунд (SLEEP_8192MS).
setSleepResolution() задаёт не только период одного WDT-сна, но и максимальную неопределённость времени при досрочном внешнем пробуждении. Чем меньше период, тем выше точность, но тем чаще просыпается МК.
Для преждевременного пробуждения по прерыванию нужно обязательно вызвать power.wakeUp() внутри обработчика прерывания.
При внешнем пробуждении невозможно определить, сколько времени прошло внутри текущего незавершённого WDT-периода. Такой период не учитывается при коррекции millis(), поэтому после wakeUp() значение millis() может отставать не более чем примерно на один выбранный период SleepResolution, но не уходит вперёд на полный незавершённый период.
Сон sleepDelay() имеет две очень полезные возможности:
- Точный учёт завершённых периодов сна при откалиброванном WDT (см. ниже)
- Коррекция millis() на время завершённых периодов сна (см. пример sleeptime)

Простыми словами: setSleepResolution() задаёт "разрешение" сна, то есть сон sleepDelay() будет происходить указанными блоками времени, 128 мс по умолчанию. Сон через sleepDelay() автоматически корректирует время millis() после пробуждения. Если нужен более энергосберегающий сон - можно поставить бОльший период, но пробуждение по внешнему прерыванию (например кнопкой) скорректирует millis() без остатка, т.е. если поставить блок сна 8 секунд и пробудиться по кнопке на 4 секунде текущего блока сна - millis() скорректируется с отставанием на 4 секунды.

Калибровка таймера

В версии 2.0 библиотеки калибровка была упрощена: достаточно вызвать power.autoCalibrate() при запуске микроконтроллера, функция выполняется ~16 мс. Калибровку можно производить не только при запуске, но и условно "каждый день", если это нужно.

Пример

Остальные примеры смотри в examples!

// демо возможностей библиотеки
#include <GyverPower.h>

void setup() {
  pinMode(13, OUTPUT); // настраиваем вывод со светодиодом на выход
  Serial.begin(9600);

  power.autoCalibrate(); // автоматическая калибровка

  // отключение ненужной периферии
  power.hardwareDisable(PWR_ADC | PWR_TIMER1); // см раздел константы в GyverPower.h, разделяющий знак " | "

  // управление системной частотой
  power.setSystemPrescaler(PRESCALER_2); // см константы в GyverPower.h
  
  // настройка параметров сна
  power.setSleepMode(STANDBY_SLEEP); // если нужен другой режим сна, см константы в GyverPower.h (по умолчанию POWERDOWN_SLEEP)
  //power.bodInSleep(false); // рекомендуется выключить bod во сне для сохранения энергии (по умолчанию false - уже выключен!!)

  // пример однократного ухода в сон
  Serial.println("go to sleep");
  delay(100); // даем время на отправку
  
  power.sleep(SLEEP_2048MS); // спим ~ 2 секунды
  
  Serial.println("wake up!");
  delay(100); // даем время на отправку
}

void loop() {
  // пример циклического сна
  power.sleepDelay(1500);               // спим 1.5 секунды
  digitalWrite(13, !digitalRead(13));   // инвертируем состояние на пине
}

Установка

Библиотеку можно найти по названию GyverPower и установить через менеджер библиотек в:
- Arduino IDE
- Arduino IDE v2
- PlatformIO
Скачать библиотеку .zip архивом для ручной установки:
- Распаковать и положить в C:\Program Files (x86)\Arduino\libraries (Windows x64)
- Распаковать и положить в C:\Program Files\Arduino\libraries (Windows x32)
- Распаковать и положить в Документы/Arduino/libraries/
- (Arduino IDE) автоматическая установка из .zip: Скетч/Подключить библиотеку/Добавить .ZIP библиотеку… и указать скачанный архив
Читай более подробную инструкцию по установке библиотек здесь

Версии

v1.2 - фикс калибровки
v1.3 - фикс для 32U4
v1.4 - добавлен adjustInternalClock
v1.5 - совместимость с аттини
v1.6 - ещё совместимость с аттини
v1.7 - оптимизация, совместимость с ATtiny13
v1.8 - совместимость с ATmega32U4
v2.0 - оптимизация памяти, переделан sleepDelay, добавлен учёт фактически завершённых периодов сна
v2.0.1 - fix compiler warnings
v2.0.2 - исправлена ошибка компиляции ATtiny85
v2.1 - добавлена bool inSleep(), для проверки спит ли МК
v2.2 - улучшена стабильность
v2.2.3 - исправлена коррекция millis() при досрочном пробуждении sleepDelay() внешним прерыванием

Баги и обратная связь

При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru
Библиотека открыта для доработки и ваших Pull Request'ов!

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
examples		examples
src		src
.gitattributes		.gitattributes
LICENSE		LICENSE
README.md		README.md
README_EN.md		README_EN.md
keywords.txt		keywords.txt
library.properties		library.properties

Navigation Menu

Repository files navigation

GyverPower

Совместимость

Документация

Содержание

Использование

Простой сон

Сон на любой период

Калибровка таймера

Пример

Установка

Версии

Баги и обратная связь

About

Releases

Packages

Used by

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

GyverPower

Совместимость

Документация

Содержание

Использование

Простой сон

Сон на любой период

Калибровка таймера

Пример

Установка

Версии

Баги и обратная связь

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages