Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/ds1307
DS1307 full function driver library for general MCU and Linux.
https://github.com/libdriver/ds1307
c ds1307 full-function-driver iic linux mcu rtc
Last synced: 12 days ago
JSON representation
DS1307 full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/ds1307
- Owner: libdriver
- License: mit
- Created: 2023-06-23T04:12:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-31T11:25:03.000Z (2 months ago)
- Last Synced: 2024-10-11T00:19:16.261Z (28 days ago)
- Topics: c, ds1307, full-function-driver, iic, linux, mcu, rtc
- Language: C
- Homepage: https://www.libdriver.com
- Size: 2.54 MB
- Stars: 103
- Watchers: 13
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
## LibDriver DS1307
[](/misra/README.md) [](https://www.libdriver.com/docs/ds1307/index.html) [](/LICENSE)
The 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.
LibDriver 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.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [example output](#example-output)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver DS1307 source files.
/interface includes LibDriver DS1307 IIC platform independent template.
/test includes LibDriver DS1307 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver DS1307 sample code.
/doc includes LibDriver DS1307 offline document.
/datasheet includes DS1307 datasheet.
/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.
/misra includes the LibDriver MISRA code scanning results.
### Install
Reference /interface IIC platform independent template and finish your platform IIC driver.
Add 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.
### Usage
You 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.
#### example basic
```C
#include "driver_ds1307_basic.h"
uint8_t res;
uint8_t addr;
uint8_t data;
uint32_t t;
ds1307_time_t time;
/* basic init */
res = ds1307_basic_init();
if (res != 0)
{
return 1;
}
/* set the zone */
res = ds1307_basic_set_timestamp_time_zone(8);
if (res != 0)
{
(void)ds1307_basic_deinit();
return 1;
}
...
t = 1612686500;
/* set time */
res = ds1307_basic_set_timestamp((time_t)t);
if (res != 0)
{
(void)ds1307_basic_deinit();
return 1;
}
/* output */
ds1307_interface_debug_print("ds1307: set timestamp %d.\n", (time_t)t);
...
/* basic get time */
res = ds1307_basic_get_time(&time);
if (res != 0)
{
(void)ds1307_basic_deinit();
return 1;
}
/* output */
if (time.format == DS1307_FORMAT_24H)
{
ds1307_interface_debug_print("ds1307: %04d-%02d-%02d %02d:%02d:%02d %d.\n",
time.year, time.month, time.date,
time.hour, time.minute, time.second, time.week
);
}
else
{
ds1307_interface_debug_print("ds1307: %04d-%02d-%02d %s %02d:%02d:%02d %d.\n",
time.year, time.month, time.date, (time.am_pm == DS1307_AM) ? "AM" : "PM",
time.hour, time.minute, time.second, time.week
);
}
...
addr = 0;
data = 0x08;
/* write ram */
res = ds1307_basic_write_ram(addr, &data, 1);
if (res != 0)
{
(void)ds1307_basic_deinit();
return 1;
}
/* output */
ds1307_interface_debug_print("ds1307: ram write addr %d 0x%02X.\n", addr, data);
/* read ram */
res = ds1307_basic_read_ram(addr, &data, 1);
if (res != 0)
{
(void)ds1307_basic_deinit();
return 1;
}
/* output */
ds1307_interface_debug_print("ds1307: ram read addr %d 0x%02X.\n", addr, data);
...
/* basic deinit */
(void)ds1307_basic_deinit();
return 0;
```
#### example output
```C
#include "driver_ds1307_output.h"
uint8_t res;
uint32_t t;
ds1307_time_t time;
/* output init */
res = ds1307_output_init();
if (res != 0)
{
return 1;
}
/* set the zone */
res = ds1307_output_set_timestamp_time_zone(8);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
...
t = 1612686500;
/* set time */
res = ds1307_output_set_timestamp((time_t)t);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
/* output */
ds1307_interface_debug_print("ds1307: set timestamp %d.\n", (time_t)t);
/* output get time */
res = ds1307_output_get_time(&time);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
/* output */
if (time.format == DS1307_FORMAT_24H)
{
ds1307_interface_debug_print("ds1307: %04d-%02d-%02d %02d:%02d:%02d %d.\n",
time.year, time.month, time.date,
time.hour, time.minute, time.second, time.week
);
}
else
{
ds1307_interface_debug_print("ds1307: %04d-%02d-%02d %s %02d:%02d:%02d %d.\n",
time.year, time.month, time.date, (time.am_pm == DS1307_AM) ? "AM" : "PM",
time.hour, time.minute, time.second, time.week
);
}
...
/* set mode */
res = ds1307_output_set_mode(DS1307_OUTPUT_MODE_LEVEL);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
/* set level */
res = ds1307_output_set_level(DS1307_OUTPUT_LEVEL_LOW);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
...
/* set mode */
res = ds1307_output_set_mode(DS1307_OUTPUT_MODE_SQUARE_WAVE);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
/* set freq */
res = ds1307_output_set_square_wave_frequency(DS1307_SQUARE_WAVE_FREQUENCY_1_HZ);
if (res != 0)
{
(void)ds1307_output_deinit();
return 1;
}
...
/* output deinit */
(void)ds1307_output_deinit();
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/ds1307/index.html](https://www.libdriver.com/docs/ds1307/index.html).
Offline documents: /doc/html/index.html.
### Contributing
Please refer to CONTRIBUTING.md.
### License
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
### Contact Us
Please send an e-mail to [email protected].