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/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 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 <https://www.adafruit.com/products/3013/>`_.
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 <https://www.adafruit.com/products/3295>`_.
.. image:: ../docs/_static/3296-00.jpg
:alt: DS1307
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit 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-ds1307/>`_. 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 <https://docs.circuitpython.org/projects/ds1307/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_DS1307/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ds1307",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,real,time,clock,rtc,breakout,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/24/ca/57f7f6e184d033ba8f1603aeb24d839f8bef6bb5abada7d67c94f947e4d4/adafruit-circuitpython-ds1307-2.1.19.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds1307/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ds1307/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://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DS1307/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DS1307/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,\ntime stamping, timers and alarms, etc. The DS1307 is the most popular\nRTC - but it requires 5V power to work.\n\nThe DS1307 is simple and inexpensive but not a high precision device. It may\nlose or gain up to two seconds a day. For a high-precision, temperature\ncompensated alternative, please check out the\n`DS3231 precision RTC <https://www.adafruit.com/products/3013/>`_.\nIf you do not need a DS1307, or you need a 3.3V-power/logic capable RTC\nplease check out our affordable\n`PCF8523 RTC breakout <https://www.adafruit.com/products/3295>`_.\n\n.. image:: ../docs/_static/3296-00.jpg\n :alt: DS1307\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit 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-ds1307/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ds1307\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ds1307\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-ds1307\n\nUsage Notes\n===========\n\nOf course, you must import the library to use it:\n\n.. code:: python3\n\n import board\n import adafruit_ds1307\n import time\n\nAll the Adafruit RTC libraries take an instantiated and active I2C object\n(from the ``board`` 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 import board\n\nNow, to initialize the I2C bus:\n\n.. code:: python\n\n i2c = 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 = adafruit_ds1307.DS1307(i2c)\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\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ds1307/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_DS1307/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for DS1307 real time clock.",
"version": "2.1.19",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DS1307"
},
"split_keywords": [
"adafruit",
"real",
"time",
"clock",
"rtc",
"breakout",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "874e62b3e5ddec5a0b0994c48431bdaac1745d60c4aa265bc6dee5ff55185b77",
"md5": "0ea9e1cde25f42f94e35ee040eebb604",
"sha256": "f17afe418796a655d5a6d76449822692e36e7ea31220e7e2e31bf737830019f6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ds1307-2.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ea9e1cde25f42f94e35ee040eebb604",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5859,
"upload_time": "2023-09-25T15:39:14",
"upload_time_iso_8601": "2023-09-25T15:39:14.776177Z",
"url": "https://files.pythonhosted.org/packages/87/4e/62b3e5ddec5a0b0994c48431bdaac1745d60c4aa265bc6dee5ff55185b77/adafruit_circuitpython_ds1307-2.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24ca57f7f6e184d033ba8f1603aeb24d839f8bef6bb5abada7d67c94f947e4d4",
"md5": "38bdf4dc00988b2c07ec45f5bab6ff43",
"sha256": "a0c7f976c4902c85159c9385d420cf3b226a79fdc1e221f90d7a8ae1e23b0018"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ds1307-2.1.19.tar.gz",
"has_sig": false,
"md5_digest": "38bdf4dc00988b2c07ec45f5bab6ff43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 280008,
"upload_time": "2023-09-25T15:39:15",
"upload_time_iso_8601": "2023-09-25T15:39:15.955711Z",
"url": "https://files.pythonhosted.org/packages/24/ca/57f7f6e184d033ba8f1603aeb24d839f8bef6bb5abada7d67c94f947e4d4/adafruit-circuitpython-ds1307-2.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:39:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DS1307",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ds1307"
}
JSON
