Introduction to Adafruit's PCF8563 Real Time Clock (RTC) Library
================================================================
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pcf8563/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pcf8563/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://discord.gg/nBQh6qu
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PCF8563/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PCF8563/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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. <https://www.adafruit.com/products/3013>`_
If you need a DS1307 for compatibility reasons, check out our
`DS1307 RTC breakout <https://www.adafruit.com/products/3296>`_.
Dependencies
=============
This driver depends on the `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
and `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
libraries. Please ensure they are also available on the CircuitPython filesystem.
This is easily achieved by downloading
`a library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pcf8563/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pcf8563
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pcf8563
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-pcf8563
Usage Notes
===========
Basics
------
Of course, you must import the library to use it:
.. code:: python
import busio
from adafruit_pcf8563.pcf8563 import PCF8563
import time
All the Adafruit RTC libraries take an instantiated and active I2C object
(from the `busio` 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
from board import *
Now, to initialize the I2C bus:
.. code:: python
i2c_bus = board.I2C()
Once you have created the I2C interface object, you can use it to instantiate
the RTC object:
.. code:: python
rtc = PCF8563(i2c_bus)
Date and time
-------------
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)
Alarm
-----
To set the time, you need to set `alarm` to a tuple with a `time.struct_time`
object and string representing the frequency such as "hourly":
.. code:: python
rtc.alarm = (time.struct_time((2017,1,9,15,6,0,0,9,-1)), "daily")
After the RTC is set, you retrieve the alarm status by reading the
`alarm_status` attribute. Once True, set it back to False to reset.
.. code:: python
if rtc.alarm_status:
print("wake up!")
rtc.alarm_status = False
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pcf8563/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_PCF8563/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-pcf8563",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, pcf8563, real, time, clock, rtc, breakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d0/c6/2a4b99cf50e277355962498509cfd1f1889654300656bf2a35a5c46bb9d2/adafruit_circuitpython_pcf8563-2.0.3.tar.gz",
"platform": null,
"description": "\nIntroduction to Adafruit's PCF8563 Real Time Clock (RTC) Library\n================================================================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pcf8563/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pcf8563/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://discord.gg/nBQh6qu\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PCF8563/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PCF8563/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis is a great battery-backed real time clock (RTC) that allows your\nmicrocontroller project to keep track of time even if it is reprogrammed,\nor if the power is lost. Perfect for datalogging, clock-building, time\nstamping, timers and alarms, etc.\n\nThe PCF8563 is simple and inexpensive but not a high precision device.\nIt may lose or gain multiple seconds a day. For a high-precision,\ntemperature compensated alternative, please check out the\n`DS3231 precision RTC. <https://www.adafruit.com/products/3013>`_\nIf you need a DS1307 for compatibility reasons, check out our\n`DS1307 RTC breakout <https://www.adafruit.com/products/3296>`_.\n\nDependencies\n=============\n\nThis driver depends on the `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\nand `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\nlibraries. Please ensure they are also available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`a library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pcf8563/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-pcf8563\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-pcf8563\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-pcf8563\n\n\nUsage Notes\n===========\n\nBasics\n------\n\nOf course, you must import the library to use it:\n\n.. code:: python\n\n import busio\n from adafruit_pcf8563.pcf8563 import PCF8563\n import time\n\nAll the Adafruit RTC libraries take an instantiated and active I2C object\n(from the `busio` library) as an argument to their constructor. The way to\ncreate an I2C object depends on the board you are using. For boards with labeled\nSCL and SDA pins, you can:\n\n.. code:: python\n\n from board import *\n\nNow, to initialize the I2C bus:\n\n.. code:: python\n\n i2c_bus = board.I2C()\n\nOnce you have created the I2C interface object, you can use it to instantiate\nthe RTC object:\n\n.. code:: python\n\n rtc = PCF8563(i2c_bus)\n\nDate and time\n-------------\n\nTo set the time, you need to set ``datetime`` to a `time.struct_time` object:\n\n.. code:: python\n\n rtc.datetime = time.struct_time((2017,1,9,15,6,0,0,9,-1))\n\nAfter the RTC is set, you retrieve the time by reading the `datetime`\nattribute and access the standard attributes of a struct_time such as ``tm_year``,\n``tm_hour`` and ``tm_min``.\n\n.. code:: python\n\n t = rtc.datetime\n print(t)\n print(t.tm_hour, t.tm_min)\n\nAlarm\n-----\n\nTo set the time, you need to set `alarm` to a tuple with a `time.struct_time`\nobject and string representing the frequency such as \"hourly\":\n\n.. code:: python\n\n rtc.alarm = (time.struct_time((2017,1,9,15,6,0,0,9,-1)), \"daily\")\n\nAfter the RTC is set, you retrieve the alarm status by reading the\n`alarm_status` attribute. Once True, set it back to False to reset.\n\n.. code:: python\n\n if rtc.alarm_status:\n print(\"wake up!\")\n rtc.alarm_status = False\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pcf8563/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_PCF8563/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for PCF8563 real time clock.",
"version": "2.0.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PCF8563"
},
"split_keywords": [
"adafruit",
" pcf8563",
" real",
" time",
" clock",
" rtc",
" breakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60b0b5d7cf9191ba815e3b3d94420c228669cbede8ae076758a7037bb5914c1b",
"md5": "00206c295a46b52f0ecc3437b858809d",
"sha256": "78ca892204586361b4664298504b619eb5caaf1e783e1e760fa3e1d2cf7ace75"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pcf8563-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00206c295a46b52f0ecc3437b858809d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9131,
"upload_time": "2024-10-10T16:00:43",
"upload_time_iso_8601": "2024-10-10T16:00:43.433812Z",
"url": "https://files.pythonhosted.org/packages/60/b0/b5d7cf9191ba815e3b3d94420c228669cbede8ae076758a7037bb5914c1b/adafruit_circuitpython_pcf8563-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0c62a4b99cf50e277355962498509cfd1f1889654300656bf2a35a5c46bb9d2",
"md5": "460e73a4c7ee31afa5b61acede074a89",
"sha256": "62c420199652c7ec67a1c76b56d61f44d3e875f5490476156a2b397928e0ab4e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pcf8563-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "460e73a4c7ee31afa5b61acede074a89",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30134,
"upload_time": "2024-10-10T16:00:44",
"upload_time_iso_8601": "2024-10-10T16:00:44.714492Z",
"url": "https://files.pythonhosted.org/packages/d0/c6/2a4b99cf50e277355962498509cfd1f1889654300656bf2a35a5c46bb9d2/adafruit_circuitpython_pcf8563-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 16:00:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_PCF8563",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-pcf8563"
}
JSON
