https://github.com/adafruit/adafruit_circuitpython_ds1307
CircuitPython drivers for the DS1307 realtime clock.
https://github.com/adafruit/adafruit_circuitpython_ds1307
circuitpython hacktoberfest
Last synced: 7 months ago
JSON representation
CircuitPython drivers for the DS1307 realtime clock.
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_ds1307
- Owner: adafruit
- License: mit
- Created: 2016-11-16T22:12:39.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-06-17T16:12:04.000Z (9 months ago)
- Last Synced: 2025-07-29T01:58:00.743Z (8 months ago)
- Topics: circuitpython, hacktoberfest
- Language: Python
- Homepage:
- Size: 568 KB
- Stars: 7
- Watchers: 20
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds1307/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ds1307/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DS1307/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DS1307/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
This is a great battery-backed real time clock (RTC) that allows your
microcontroller project to keep track of time even if it is reprogrammed,
or if the power is lost. Perfect for datalogging, clock-building,
time stamping, timers and alarms, etc. The DS1307 is the most popular
RTC - but it requires 5V power to work.
The DS1307 is simple and inexpensive but not a high precision device. It may
lose or gain up to two seconds a day. For a high-precision, temperature
compensated alternative, please check out the
`DS3231 precision RTC `_.
If you do not need a DS1307, or you need a 3.3V-power/logic capable RTC
please check out our affordable
`PCF8523 RTC breakout `_.
.. image:: ../docs/_static/3296-00.jpg
:alt: DS1307
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
* `Bus Device `_
* `Register `_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI `_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ds1307
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ds1307
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ds1307
Usage Notes
===========
Of course, you must import the library to use it:
.. code:: python3
import board
import adafruit_ds1307
import time
All the Adafruit RTC libraries take an instantiated and active I2C object
(from the ``board`` library) as an argument to their constructor. The way to
create an I2C object depends on the board you are using. For boards with labeled
SCL and SDA pins, you can:
.. code:: python
import board
Now, to initialize the I2C bus:
.. code:: python
i2c = board.I2C()
Once you have created the I2C interface object, you can use it to instantiate
the RTC object:
.. code:: python
rtc = adafruit_ds1307.DS1307(i2c)
To set the time, you need to set ``datetime`` to a `time.struct_time` object:
.. code:: python
rtc.datetime = time.struct_time((2017,1,9,15,6,0,0,9,-1))
After the RTC is set, you retrieve the time by reading the ``datetime``
attribute and access the standard attributes of a struct_time such as ``tm_year``,
``tm_hour`` and ``tm_min``.
.. code:: python
t = rtc.datetime
print(t)
print(t.tm_hour, t.tm_min)
Documentation
=============
API documentation for this library can be found on `Read the Docs `_.
For information on building library documentation, please check out `this guide `_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.