adafruit-circuitpython-pcf8563 2.0.0

Introduction to Adafruit’s PCF8563 Real Time Clock (RTC) Library

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 PCF8563 is simple and inexpensive but not a high precision device. It may lose or gain multiple seconds a day. For a high-precision, temperature compensated alternative, please check out the DS3231 precision RTC. If you need a DS1307 for compatibility reasons, check out our DS1307 RTC breakout.

Dependencies

This driver depends on the Register and Bus Device libraries. Please ensure they are also available on the CircuitPython filesystem. This is easily achieved by downloading a 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-pcf8563

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

sudo pip3 install adafruit-circuitpython-pcf8563

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-pcf8563

Usage Notes

import busio
from adafruit_pcf8563.pcf8563 import PCF8563
import time

from board import *

i2c_bus = board.I2C()

rtc = PCF8563(i2c_bus)

rtc.datetime = time.struct_time((2017,1,9,15,6,0,0,9,-1))

t = rtc.datetime
print(t)
print(t.tm_hour, t.tm_min)

rtc.alarm = (time.struct_time((2017,1,9,15,6,0,0,9,-1)), "daily")

if rtc.alarm_status:
    print("wake up!")
    rtc.alarm_status = False

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.