{"id":29860221,"url":"https://github.com/libdriver/pcf8563","last_synced_at":"2025-07-30T03:15:39.281Z","repository":{"id":264366845,"uuid":"893008305","full_name":"libdriver/pcf8563","owner":"libdriver","description":"PCF8563 full-featured driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2025-04-18T15:35:58.000Z","size":4013,"stargazers_count":30,"open_issues_count":0,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-19T04:49:33.188Z","etag":null,"topics":["c","full-featured-driver","iic","linux","pcf8563","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,"zenodo":null}},"created_at":"2024-11-23T09:39:29.000Z","updated_at":"2025-04-18T15:35:36.000Z","dependencies_parsed_at":"2024-12-29T12:23:05.825Z","dependency_job_id":"c673c32b-3ac4-4e26-8efd-1af0bf547b4e","html_url":"https://github.com/libdriver/pcf8563","commit_stats":null,"previous_names":["libdriver/pcf8563"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/libdriver/pcf8563","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fpcf8563","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fpcf8563/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fpcf8563/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fpcf8563/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/pcf8563/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fpcf8563/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267803291,"owners_count":24146517,"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","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","full-featured-driver","iic","linux","pcf8563","rtc"],"created_at":"2025-07-30T03:15:33.801Z","updated_at":"2025-07-30T03:15:39.273Z","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 PCF8563\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/pcf8563/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nThe PCF8563 is a CMOS1 Real-Time Clock (RTC) and calendar optimized for low power consumption. A programmable clock output, interrupt output, and voltage-low detector are also provided. All addresses and data are transferred serially via a two-line bidirectional I2C-bus. Maximum bus speed is 400 kbit/s. The register address is incremented automatically after each written or read data byte.\n\nLibDriver PCF8563 is a full-featured driver of PCF8563 launched by LibDriver.It provides time reading, alarm clock triggering, timer interrupt triggering, 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 alarm](#example-alarm)\n    - [example timer](#example-timer)\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 PCF8563 source files.\n\n/interface includes LibDriver PCF8563 IIC platform independent template.\n\n/test includes LibDriver PCF8563 driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver PCF8563 sample code.\n\n/doc includes LibDriver PCF8563 offline document.\n\n/datasheet includes PCF8563 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_pcf8563_basic.h\"\n\nuint8_t res;\npcf8563_time_t time;\n\n/* basic init */\nres = pcf8563_basic_init();\nif (res != 0)\n{\n    return 1;\n}\n\n/* set the zone */\nres = pcf8563_basic_set_timestamp_time_zone(8);\nif (res != 0)\n{\n    (void)pcf8563_basic_deinit();\n\n    return 1;\n}\n\n...\n    \n/* set time */\nres = pcf8563_basic_set_timestamp((time_t)1612686500);\nif (res != 0)\n{\n    (void)pcf8563_basic_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: set timestamp %d.\\n\", (time_t)1612686500);\n\n...\n\n/* basic get time */\nres = pcf8563_basic_get_time(\u0026time);\nif (res != 0)\n{\n    (void)pcf8563_basic_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: %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\n...\n    \n/* basic deinit */\n(void)pcf8563_basic_deinit();\n\nreturn 0;\n```\n\n#### example alarm\n\n```C\n#include \"driver_pcf8563_alarm.h\"\n\nuint8_t res;\nuint8_t g_alarm_flag;\nuint32_t i;\npcf8563_alarm_param_t param;\npcf8563_time_t time;\n\nstatic void a_alarm_callback(uint8_t type)\n{\n    switch (type)\n    {\n        case PCF8563_INTERRUPT_EVENT_TIMER :\n        {\n            pcf8563_interface_debug_print(\"pcf8563: irq timer.\\n\");\n\n            break;\n        }\n        case PCF8563_INTERRUPT_EVENT_ALARM :\n        {\n            g_alarm_flag = 1;\n            pcf8563_interface_debug_print(\"pcf8563: irq alarm.\\n\");\n\n            break;\n        }\n        default :\n        {\n            pcf8563_interface_debug_print(\"pcf8563: irq unknown.\\n\");\n\n            break;\n        }\n    }\n}\n\n/* alarm init */\nres = pcf8563_alarm_init(a_alarm_callback);\nif (res != 0)\n{\n    return 1;\n}\n\n/* set the zone */\nres = pcf8563_alarm_set_timestamp_time_zone(8);\nif (res != 0)\n{\n    (void)pcf8563_alarm_deinit();\n\n    return 1;\n}\n\n...\n    \n/* set time */\nres = pcf8563_alarm_set_timestamp((time_t)1612686500);\nif (res != 0)\n{\n    (void)pcf8563_alarm_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: set timestamp %d.\\n\", (time_t)1612686500);\n\n...\n\n/* alarm get time */\nres = pcf8563_alarm_get_time(\u0026time);\nif (res != 0)\n{\n    (void)pcf8563_alarm_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: %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\n...\n\n/* gpio interrupt init */\ng_gpio_irq = pcf8563_alarm_irq_handler;\nres = gpio_interrupt_init();\nif (res != 0)\n{\n    (void)pcf8563_alarm_deinit();\n    \n    return 1;\n}\n\ng_alarm_flag = 0;\n\n/* enable alarm */\nparam.minute = 1;\nparam.minute_enable = PCF8563_BOOL_TRUE;\nparam.hour = 1;\nparam.hour_enable = PCF8563_BOOL_FALSE;\nparam.day = 1;\nparam.day_enable = PCF8563_BOOL_FALSE;\nparam.week = 1;\nparam.week_enable = PCF8563_BOOL_FALSE;\nparam.mode = PCF8563_INTERRUPT_MODE_PULSE;\nres = pcf8563_alarm_enable(\u0026param);\nif (res != 0)\n{\n    g_gpio_irq = 0;\n    gpio_interrupt_deinit();\n    (void)pcf8563_alarm_deinit();\n\n    return 1;\n}\n\nfor (i = 0; i \u003c 180; i++)\n{\n    if (g_alarm_flag != 0)\n    {\n        break;\n    }\n    pcf8563_interface_delay_ms(1000);\n    pcf8563_interface_debug_print(\"pcf8563: %ds.\\n\", i + 1);\n}\n\n/* check flag */\nif (g_alarm_flag == 0)\n{\n    pcf8563_interface_debug_print(\"pcf8563: not found alarm.\\n\");\n}\n\n/* gpio interrupt deinit */\ng_gpio_irq = 0;\ngpio_interrupt_deinit();\n\n...\n\n/* disable alarm */\n(void)pcf8563_alarm_disable();\n\n/* alarm deinit */\n(void)pcf8563_alarm_deinit();\n\nreturn 0;\n```\n#### example timer\n\n```C\n#include \"driver_pcf8563_timer.h\"\n\nuint8_t res;\nuint8_t g_alarm_flag;\nuint32_t i;\npcf8563_time_t time;\n\nstatic void a_timer_callback(uint8_t type)\n{\n    switch (type)\n    {\n        case PCF8563_INTERRUPT_EVENT_TIMER :\n        {\n            g_timer_flag = 1;\n            pcf8563_interface_debug_print(\"pcf8563: irq timer.\\n\");\n\n            break;\n        }\n        case PCF8563_INTERRUPT_EVENT_ALARM :\n        {\n            pcf8563_interface_debug_print(\"pcf8563: irq alarm.\\n\");\n\n            break;\n        }\n        default :\n        {\n            pcf8563_interface_debug_print(\"pcf8563: irq unknown.\\n\");\n\n            break;\n        }\n    }\n}\n\n/* timer init */\nres = pcf8563_timer_init(a_timer_callback);\nif (res != 0)\n{\n    return 1;\n}\n\n/* set the zone */\nres = pcf8563_timer_set_timestamp_time_zone(8);\nif (res != 0)\n{\n    (void)pcf8563_timer_deinit();\n\n    return 1;\n}\n\n...\n    \n/* set time */\nres = pcf8563_timer_set_timestamp((time_t)1612686500);\nif (res != 0)\n{\n    (void)pcf8563_timer_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: set timestamp %d.\\n\", (time_t)1612686500);\n\n...\n    \n/* timer get time */\nres = pcf8563_timer_get_time(\u0026time);\nif (res != 0)\n{\n    (void)pcf8563_timer_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: %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\n...\n    \n/* gpio interrupt init */\ng_gpio_irq = pcf8563_timer_irq_handler;\nres = gpio_interrupt_init();\nif (res != 0)\n{\n    (void)pcf8563_timer_deinit();\n    \n    return 1;\n}\n\ng_timer_flag = 0;\n\n/* enable timer */\nres = pcf8563_timer_enable(PCF8563_TIMER_FREQ_1HZ, 60, PCF8563_INTERRUPT_MODE_PULSE);\nif (res != 0)\n{\n    g_gpio_irq = 0;\n    gpio_interrupt_deinit();\n    (void)pcf8563_timer_deinit();\n\n    return 1;\n}\n\nfor (i = 0; i \u003c 180; i++)\n{\n    if (g_timer_flag != 0)\n    {\n        break;\n    }\n    pcf8563_interface_delay_ms(1000);\n    pcf8563_interface_debug_print(\"pcf8563: %ds.\\n\", i + 1);\n}\n\n/* check flag */\nif (g_timer_flag == 0)\n{\n    pcf8563_interface_debug_print(\"pcf8563: not found timer.\\n\");\n}\n\n/* gpio interrupt deinit */\ng_gpio_irq = 0;\ngpio_interrupt_deinit();\n\n...\n    \n/* disable timer */\n(void)pcf8563_timer_disable();\n    \n/* timer deinit */\n(void)pcf8563_timer_deinit();\n\nreturn 0;\n```\n\n#### example output\n\n```C\n#include \"driver_pcf8563_output.h\"\n\nuint8_t res;\npcf8563_time_t time;\n\n/* output init */\nres = pcf8563_output_init();\nif (res != 0)\n{\n    return 1;\n}\n\n/* set the zone */\nres = pcf8563_output_set_timestamp_time_zone(8);\nif (res != 0)\n{\n    (void)pcf8563_output_deinit();\n\n    return 1;\n}\n\n...\n    \n/* set time */\nres = pcf8563_output_set_timestamp((time_t)1612686500);\nif (res != 0)\n{\n    (void)pcf8563_output_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: set timestamp %d.\\n\", (time_t)1612686500);\n\n...\n\n/* output get time */\nres = pcf8563_output_get_time(\u0026time);\nif (res != 0)\n{\n    (void)pcf8563_output_deinit();\n\n    return 1;\n}\n\n/* output */\npcf8563_interface_debug_print(\"pcf8563: %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\n...\n    \n/* output enable */\nres = pcf8563_output_enable(PCF8563_CLOCK_OUT_1HZ);\nif (res != 0)\n{\n    (void)pcf8563_output_deinit();\n\n    return 1;\n}\n\n...\n    \n/* output disable */\nres = pcf8563_output_disable();\nif (res != 0)\n{\n    (void)pcf8563_output_deinit();\n\n    return 1;\n}\n\n...\n    \n/* output deinit */\n(void)pcf8563_output_deinit();\n\nreturn 0;\n```\n\n### Document\n\nOnline documents: [https://www.libdriver.com/docs/pcf8563/index.html](https://www.libdriver.com/docs/pcf8563/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%2Fpcf8563","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fpcf8563","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fpcf8563/lists"}