Skip to main content

CircuitPython library for DS1307 real time clock.

Project description

Introduction

Documentation Status Discord Build Status 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.

DS1307

Dependencies

This driver depends on:

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:

pip3 install adafruit-circuitpython-ds1307

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-ds1307

To install in a virtual environment in your current project:

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:

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:

import board

Now, to initialize the I2C bus:

i2c = board.I2C()

Once you have created the I2C interface object, you can use it to instantiate the RTC object:

rtc = adafruit_ds1307.DS1307(i2c)

To set the time, you need to set datetime to a time.struct_time object:

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ds1307-2.1.24.tar.gz (275.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_ds1307-2.1.24.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ds1307-2.1.24.tar.gz
Algorithm Hash digest
SHA256 8a2e20d0ec35661735b4c6b05b0b1b1422517d595fc0957521b929fc6294ba31
MD5 e4854100f45bb4e6f568a89cc38683c0
BLAKE2b-256 68632dc10be2326628250fe8de1e22e06243350adc0ed7708bfc6892e7940749

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ds1307-2.1.24-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ds1307-2.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 774371428705fc105c640bb413be3c26aff8b345e9f95f9fd06c9337ad9a6064
MD5 f72b331a9b7af08b5d3bf3287ec4395d
BLAKE2b-256 307a16ead53eb21fadadb5b75ba87e2978309fa6c149ad5154edc553e98a0dd4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page