{"id":16146178,"url":"https://github.com/libdriver/ds1307","last_synced_at":"2025-04-07T19:16:56.669Z","repository":{"id":212769798,"uuid":"657438090","full_name":"libdriver/ds1307","owner":"libdriver","description":"DS1307 full function driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2025-03-02T09:46:22.000Z","size":2697,"stargazers_count":70,"open_issues_count":1,"forks_count":25,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-31T17:17:29.739Z","etag":null,"topics":["c","ds1307","full-function-driver","iic","linux","mcu","rtc"],"latest_commit_sha":null,"homepage":"https://www.libdriver.com","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libdriver.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-23T04:12:44.000Z","updated_at":"2025-03-02T09:45:52.000Z","dependencies_parsed_at":"2023-12-16T06:56:11.014Z","dependency_job_id":"92537d9b-c730-4118-bf3b-11df26d30d17","html_url":"https://github.com/libdriver/ds1307","commit_stats":null,"previous_names":["libdriver/ds1307"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fds1307","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fds1307/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fds1307/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fds1307/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/ds1307/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247713258,"owners_count":20983683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","ds1307","full-function-driver","iic","linux","mcu","rtc"],"created_at":"2024-10-10T00:19:20.764Z","updated_at":"2025-04-07T19:16:56.632Z","avatar_url":"https://github.com/libdriver.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)\n\n\u003cdiv align=center\u003e\n\u003cimg src=\"/doc/image/logo.svg\" width=\"400\" height=\"150\"/\u003e\n\u003c/div\u003e\n\n## LibDriver DS1307\n\n[![MISRA](https://img.shields.io/badge/misra-compliant-brightgreen.svg)](/misra/README.md) [![API](https://img.shields.io/badge/api-reference-blue.svg)](https://www.libdriver.com/docs/ds1307/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nThe DS1307 serial real-time clock (RTC) is a low-power, full binary-coded decimal (BCD) clock/calendar plus 56 bytes of NV SRAM. Address and data are transferred serially through an I2C, bidirectional bus. The clock/calendar provides seconds, minutes, hours, day, date, month, and year information. The end of the month date is automatically adjusted for months with fewer than 31 days, including corrections for leap year. The clock operates in either the 24-hour or 12-hour format with AM/PM indicator. The DS1307 has a built-in power-sense circuit that detects power failures and automatically switches to the backup supply. Timekeeping operation continues while the part operates from the backup supply.\n\nLibDriver DS1307 is a full function driver of ds1307 launched by LibDriver.It provides time reading, square wave output and other functions. LibDriver is MISRA compliant.\n\n### Table of Contents\n\n  - [Instruction](#Instruction)\n  - [Install](#Install)\n  - [Usage](#Usage)\n    - [example basic](#example-basic)\n    - [example output](#example-output)\n  - [Document](#Document)\n  - [Contributing](#Contributing)\n  - [License](#License)\n  - [Contact Us](#Contact-Us)\n\n### Instruction\n\n/src includes LibDriver DS1307 source files.\n\n/interface includes LibDriver DS1307 IIC platform independent template.\n\n/test includes LibDriver DS1307 driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver DS1307 sample code.\n\n/doc includes LibDriver DS1307 offline document.\n\n/datasheet includes DS1307 datasheet.\n\n/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.\n\n/misra includes the LibDriver MISRA code scanning results.\n\n### Install\n\nReference /interface IIC platform independent template and finish your platform IIC driver.\n\nAdd the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.\n\n### Usage\n\nYou can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.\n\n#### example basic\n\n```C\n#include \"driver_ds1307_basic.h\"\n\nuint8_t res;\nuint8_t addr;\nuint8_t data;\nuint32_t t;\nds1307_time_t time;\n\n/* basic init */\nres = ds1307_basic_init();\nif (res != 0)\n{\n    return 1;\n}\n    \n/* set the zone */\nres = ds1307_basic_set_timestamp_time_zone(8);\nif (res != 0)\n{\n    (void)ds1307_basic_deinit();\n\n    return 1;\n}\n\n...\n    \nt = 1612686500;\n\n/* set time */\nres = ds1307_basic_set_timestamp((time_t)t);\nif (res != 0)\n{\n    (void)ds1307_basic_deinit();\n\n    return 1;\n}\n\n/* output */\nds1307_interface_debug_print(\"ds1307: set timestamp %d.\\n\", (time_t)t);\n\n...\n    \n/* basic get time */\nres = ds1307_basic_get_time(\u0026time);\nif (res != 0)\n{\n    (void)ds1307_basic_deinit();\n\n    return 1;\n}\n\n/* output */\nif (time.format == DS1307_FORMAT_24H)\n{\n    ds1307_interface_debug_print(\"ds1307: %04d-%02d-%02d %02d:%02d:%02d %d.\\n\",\n                                 time.year, time.month, time.date,\n                                 time.hour, time.minute, time.second, time.week\n                                );\n}\nelse\n{\n    ds1307_interface_debug_print(\"ds1307: %04d-%02d-%02d %s %02d:%02d:%02d %d.\\n\",\n                                 time.year, time.month, time.date, (time.am_pm == DS1307_AM) ? \"AM\" : \"PM\",\n                                 time.hour, time.minute, time.second, time.week\n                                );\n}\n\n...\n\naddr = 0;\ndata = 0x08;\n\n/* write ram */\nres = ds1307_basic_write_ram(addr, \u0026data, 1);\nif (res != 0)\n{\n    (void)ds1307_basic_deinit();\n\n    return 1;\n}\n\n/* output */\nds1307_interface_debug_print(\"ds1307: ram write addr %d 0x%02X.\\n\", addr, data);\n\n/* read ram */\nres = ds1307_basic_read_ram(addr, \u0026data, 1);\nif (res != 0)\n{\n    (void)ds1307_basic_deinit();\n\n    return 1;\n}\n\n/* output */\nds1307_interface_debug_print(\"ds1307: ram read addr %d 0x%02X.\\n\", addr, data);\n\n...\n    \n/* basic deinit */\n(void)ds1307_basic_deinit();\n\nreturn 0;\n```\n\n#### example output\n\n```C\n#include \"driver_ds1307_output.h\"\n\nuint8_t res;\nuint32_t t;\nds1307_time_t time;\n\n/* output init */\nres = ds1307_output_init();\nif (res != 0)\n{\n    return 1;\n}\n\n/* set the zone */\nres = ds1307_output_set_timestamp_time_zone(8);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n...\n    \nt = 1612686500;\n\n/* set time */\nres = ds1307_output_set_timestamp((time_t)t);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n/* output */\nds1307_interface_debug_print(\"ds1307: set timestamp %d.\\n\", (time_t)t);\n\n/* output get time */\nres = ds1307_output_get_time(\u0026time);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n/* output */\nif (time.format == DS1307_FORMAT_24H)\n{\n    ds1307_interface_debug_print(\"ds1307: %04d-%02d-%02d %02d:%02d:%02d %d.\\n\",\n                                 time.year, time.month, time.date,\n                                 time.hour, time.minute, time.second, time.week\n                                );\n}\nelse\n{\n    ds1307_interface_debug_print(\"ds1307: %04d-%02d-%02d %s %02d:%02d:%02d %d.\\n\",\n                                 time.year, time.month, time.date, (time.am_pm == DS1307_AM) ? \"AM\" : \"PM\",\n                                 time.hour, time.minute, time.second, time.week\n                                );\n}\n\n...\n\n/* set mode */\nres = ds1307_output_set_mode(DS1307_OUTPUT_MODE_LEVEL);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n/* set level */\nres = ds1307_output_set_level(DS1307_OUTPUT_LEVEL_LOW);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n...\n\n/* set mode */\nres = ds1307_output_set_mode(DS1307_OUTPUT_MODE_SQUARE_WAVE);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n/* set freq */\nres = ds1307_output_set_square_wave_frequency(DS1307_SQUARE_WAVE_FREQUENCY_1_HZ);\nif (res != 0)\n{\n    (void)ds1307_output_deinit();\n\n    return 1;\n}\n\n...\n    \n/* output deinit */\n(void)ds1307_output_deinit();\n\nreturn 0;\n```\n\n### Document\n\nOnline documents: [https://www.libdriver.com/docs/ds1307/index.html](https://www.libdriver.com/docs/ds1307/index.html).\n\nOffline documents: /doc/html/index.html.\n\n### Contributing\n\nPlease refer to CONTRIBUTING.md.\n\n### License\n\nCopyright (c) 2015 - present LibDriver All rights reserved\n\n\n\nThe MIT License (MIT) \n\n\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\n\nof this software and associated documentation files (the \"Software\"), to deal\n\nin the Software without restriction, including without limitation the rights\n\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n\ncopies of the Software, and to permit persons to whom the Software is\n\nfurnished to do so, subject to the following conditions: \n\n\n\nThe above copyright notice and this permission notice shall be included in all\n\ncopies or substantial portions of the Software. \n\n\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n\nSOFTWARE. \n\n### Contact Us\n\nPlease send an e-mail to lishifenging@outlook.com.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fds1307","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fds1307","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fds1307/lists"}