p5ych0p41h / rudiron_libs
CI/CD
Реестр контейнеров и пакетов

Rudiron_DS1302.md

Библиотека Rudiron_DS1302

Библиотека Rudiron_DS1302 предназначена для работы с модулем реального времени DS1302 на платах Rudiron. Она предоставляет простой интерфейс для чтения и установки даты и времени, обрабатывая низкоуровневую связь и преобразование данных в формате BCD.

Содержание

  • Описание библиотеки
  • Установка
  • Зависимости
  • Содержимое библиотеки
    • Конструктор
    • Методы
  • Примеры использования
    • ReadDateTime.ino
    • SetAndReadDateTime.ino
  • Проблемы и решения

Описание библиотеки

Rudiron_DS1302 упрощает взаимодействие с модулем реального времени DS1302, который отсчитывает дату (год, месяц, день, день недели) и время (часы, минуты, секунды). Библиотека управляет трехпроводным интерфейсом (CE, SCLK, IO), преобразует данные между десятичным и BCD форматами и поддерживает операции остановки/запуска часов. Она подходит для проектов, требующих точного времени, таких как таймеры, логгеры данных или часы.

Особенности:

  • Простота использования: настройка пинов и доступ к данным в несколько строк кода.
  • Надёжность: управление защитой записи и корректная обработка данных.
  • Совместимость: работает на всех платформах, поддерживаемых Arduino.
  • Лёгкость: минимальное потребление ресурсов.

Версия: 1.0.0

Установка

  1. Скачайте библиотеку:
    • Клонируйте репозиторий Rudiron Libraries или скачайте ZIP-файл из раздела релизов.
  2. Установите в Arduino IDE:
    • Откройте Arduino IDE.
    • Перейдите в Скетч -> Подключить библиотеку -> Добавить .ZIP библиотеку и выберите ZIP-файл.
    • Библиотека появится в меню Скетч -> Подключить библиотеку -> Rudiron_DS1302.
  3. Проверьте установку:
    • Убедитесь, что примеры библиотеки доступны в Файл -> Примеры -> Rudiron_DS1302.

Зависимости

  • Arduino Framework: Библиотека использует стандартные функции Arduino (pinMode, digitalWrite, digitalRead и т.д.).
  • Аппаратные требования: Модуль DS1302, подключённый к трём цифровым пинам (CE, SCLK, IO). Требуется резервная батарея (обычно CR2032) для сохранения времени при отключении питания.

Содержимое библиотеки

Библиотека предоставляет класс Rudiron_DS1302 с конструктором и пятью публичными методами для работы с модулем. Также включает структуру RudironDateTime для хранения даты и времени, и перечисления MONTH и DOW для удобного задания месяцев и дней недели.

Конструктор

Rudiron_DS1302()

  • Описание: Создаёт объект для работы с модулем DS1302.

  • Особенности:

    • Инициализирует пины как неподключённые (0) и пин IO в режиме ввода.
    • Не требует параметров; пины задаются через attach().

  • Пример:

    Rudiron_DS1302 rtc;

Методы

  • void attach(uint8_t pin_ce, uint8_t pin_sclk, uint8_t pin_io)

    • Описание: Настраивает пины для связи с модулем DS1302.

    • Параметры:

      • pin_ce: Пин Chip Enable (CE/RST).
      • pin_sclk: Пин Serial Clock (SCLK/CLK).
      • pin_io: Пин Input/Output (IO/DAT).

    • Особенности:

      • Конфигурирует пины как выходы (CE, SCLK) или вход/выход (IO).
      • Автоматически запускает осциллятор (метод start()).
      • Пины должны поддерживать цифровой ввод/вывод.

    • Пример:

      rtc.attach(0, 1, 2); // CE/RST=0, SCLK/CLK=1, IO/DAT=2

  • bool isHalted()

    • Описание: Проверяет, остановлен ли осциллятор DS1302.

    • Возвращает: true, если осциллятор остановлен, false, если работает.

    • Особенности:

      • Читает бит остановки в регистре секунд (бит 7).
      • Возвращает false, если пины не назначены.
      • Полезно для диагностики состояния модуля.

    • Пример:

      if (rtc.isHalted()) {
  // Осциллятор остановлен
}

  • void halt()

    • Описание: Останавливает осциллятор DS1302, приостанавливая отсчёт времени.

    • Особенности:

      • Устанавливает бит остановки в регистре секунд.
      • Сохраняет текущие данные в регистрах.
      • Требует вызова start() для возобновления работы.

    • Пример:

      rtc.halt(); // Остановить часы

  • void start()

    • Описание: Запускает осциллятор DS1302, возобновляя отсчёт времени.

    • Особенности:

      • Сбрасывает бит остановки в регистре секунд.
      • Вызывается автоматически в attach() и после setDateTime().
      • Ничего не делает, если пины не назначены.

    • Пример:

      rtc.start(); // Запустить часы

  • void getDateTime(RudironDateTime& dt)

    • Описание: Получает текущие дату и время из модуля.

    • Параметры: dt - ссылка на структуру RudironDateTime для хранения данных.

    • Особенности:

      • Использует режим пакетного чтения (burst mode) для получения всех регистров.
      • Преобразует данные из BCD в десятичный формат.
      • Заполняет поля структуры: year (0-99, т.е. 2000-2099), month (1-12), day (1-31), hour (0-23), minute (0-59), second (0-59), dow (1-7).
      • Ничего не делает, если пины не назначены.

    • Пример:

      RudironDateTime dt;
rtc.getDateTime(dt);

  • void setDateTime(const RudironDateTime& dt)

    • Описание: Устанавливает дату и время в модуле.

    • Параметры: dt - константная ссылка на структуру RudironDateTime с новыми значениями.

    • Особенности:

      • Отключает защиту записи перед операцией.
      • Использует пакетный режим записи.
      • Применяет модуль для ограничения значений (например, second % 60).
      • Преобразует данные в BCD формат.
      • Автоматически запускает осциллятор после установки.

    • Пример:

      RudironDateTime dt = {25, MONTH_APR, 1, 12, 0, 0, DOW_TUE};
rtc.setDateTime(dt);

Примеры использования

Библиотека включает два примера скетчей в папке examples, демонстрирующих базовое использование. Оба примера используют пины CE=0, SCLK=1, IO=2 и выводят данные в Serial Monitor (9600 бод).

ReadDateTime.ino

  • Описание: Считывает текущую дату и время с модуля DS1302 каждые 2 секунды и выводит их в Serial Monitor в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.

  • Код:

    #include <Rudiron_DS1302.h>
Rudiron_DS1302 rtc;
void setup() {
  Serial.begin(9600);
  while (!Serial);
  rtc.attach(0, 1, 2);
  Serial.println("Чтение даты и времени с DS1302...");
}
void loop() {
  RudironDateTime dt;
  rtc.getDateTime(dt);
  Serial.print("Дата и время: ");
  Serial.print(dt.year + 2000);
  Serial.print("-");
  if (dt.month < 10) Serial.print("0");
  Serial.print(dt.month);
  Serial.print("-");
  if (dt.day < 10) Serial.print("0");
  Serial.print(dt.day);
  Serial.print(" ");
  if (dt.hour < 10) Serial.print("0");
  Serial.print(dt.hour);
  Serial.print(":");
  if (dt.minute < 10) Serial.print("0");
  Serial.print(dt.minute);
  Serial.print(":");
  if (dt.second < 10) Serial.print("0");
  Serial.println(dt.second);
  delay(2000);
}

  • Особенности:

    • Показывает, как использовать getDateTime() для получения данных.
    • Форматирует вывод с ведущими нулями для удобства чтения.
    • Подходит для проверки работы модуля без предварительной настройки времени.

  • Применение: Отображение времени в часах, логгерах или таймерах.

SetAndReadDateTime.ino

  • Описание: Устанавливает конкретную дату и время (например, 2025-04-01 12:00:00, вторник), затем считывает и отображает их каждые 2 секунды в Serial Monitor.

  • Код:

    #include <Rudiron_DS1302.h>
Rudiron_DS1302 rtc;
void setup() {
  Serial.begin(9600);
  while (!Serial);
  rtc.attach(0, 1, 2);
  RudironDateTime dt;
  dt.year = 25;
  dt.month = MONTH_APR;
  dt.day = 1;
  dt.hour = 12;
  dt.minute = 0;
  dt.second = 0;
  dt.dow = DOW_TUE;
  rtc.setDateTime(dt);
  Serial.println("Дата и время установлены. Чтение данных с DS1302...");
}
void loop() {
  RudironDateTime dt;
  rtc.getDateTime(dt);
  Serial.print("Дата и время: ");
  Serial.print(dt.year + 2000);
  Serial.print("-");
  if (dt.month < 10) Serial.print("0");
  Serial.print(dt.month);
  Serial.print("-");
  if (dt.day < 10) Serial.print("0");
  Serial.print(dt.day);
  Serial.print(" ");
  if (dt.hour < 10) Serial.print("0");
  Serial.print(dt.hour);
  Serial.print(":");
  if (dt.minute < 10) Serial.print("0");
  Serial.print(dt.minute);
  Serial.print(":");
  if (dt.second < 10) Serial.print("0");
  Serial.println(dt.second);
  delay(2000);
}

  • Особенности:

    • Демонстрирует использование setDateTime() и getDateTime().
    • Использует перечисления MONTH и DOW для читаемости.
    • Полезен для инициализации модуля с заданным временем.

  • Применение: Настройка часов или синхронизация времени в проектах.

Инструкции для примеров:

  1. Подключите DS1302: CE/RST к пину 0, SCLK/CLK к пину 1, IO/DAT к пину 2.
  2. Загрузите скетч через Arduino IDE.
  3. Откройте Serial Monitor (Ctrl+Shift+M, 9600 бод).
  4. Наблюдайте за значениями даты и времени.

Проблемы и решения

Проблемы и решения: GitFlic Проблемы.

Последнее обновление: 1 апреля 2025