rtc14 2.0.0.0
rtc14.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef RTC14_H
29#define RTC14_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define RTC14_REG_SC 0x00
60#define RTC14_REG_MN 0x01
61#define RTC14_REG_HR 0x02
62#define RTC14_REG_DT 0x03
63#define RTC14_REG_MO 0x04
64#define RTC14_REG_YR 0x05
65#define RTC14_REG_DW 0x06
66#define RTC14_REG_SR 0x07
67#define RTC14_REG_INT 0x08
68#define RTC14_REG_ATR 0x0A
69#define RTC14_REG_DTR 0x0B
70#define RTC14_REG_SCA 0x0C
71#define RTC14_REG_MNA 0x0D
72#define RTC14_REG_HRA 0x0E
73#define RTC14_REG_DTA 0x0F
74#define RTC14_REG_MOA 0x10
75#define RTC14_REG_DWA 0x11
76#define RTC14_REG_USR1 0x12
77#define RTC14_REG_USR2 0x13
78#define RTC14_REG_SCT 0x14
79#define RTC14_REG_MNT 0x15
80#define RTC14_REG_HRT 0x16
81#define RTC14_REG_DTT 0x17
82#define RTC14_REG_MOT 0x18
83#define RTC14_REG_YRT 0x19
84 // rtc14_reg
86
101#define RTC14_SET_HOURS_FORMAT_12 0x00
102#define RTC14_SET_HOURS_FORMAT_24 0x80
103#define RTC14_SET_HOURS_FORMAT_12_AM 0x00
104#define RTC14_SET_HOURS_FORMAT_12_PM 0x20
105#define RTC14_SET_ALARM_ENABLE 0x80
106#define RTC14_SET_INT_ENABLE 0x40
107#define RTC14_SET_SOFT_RESET 0x80
108#define RTC14_SET_ENABLE_WRTC 0x10
109
114#define RTC14_DW_SUNDAY 0x00
115#define RTC14_DW_MONDAY 0x01
116#define RTC14_DW_TUESDAY 0x02
117#define RTC14_DW_WEDNESDAY 0x03
118#define RTC14_DW_THURSDAY 0x04
119#define RTC14_DW_FRIDAY 0x05
120#define RTC14_DW_SATURDAY 0x06
121
127#define RTC14_SET_DEV_ADDR 0x6F
128 // rtc14_set
130
145#define RTC14_MAP_MIKROBUS( cfg, mikrobus ) \
146 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
147 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
148 cfg.fo = MIKROBUS( mikrobus, MIKROBUS_AN ); \
149 cfg.ein = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
150 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
151 // rtc14_map // rtc14
154
159typedef struct
160{
161 // Output pins
162 digital_out_t ein;
164 // Input pins
165 digital_in_t fo;
166 digital_in_t int_pin;
168 // Modules
169 i2c_master_t i2c;
171 // I2C slave address
174} rtc14_t;
175
180typedef struct
181{
182 pin_name_t scl;
183 pin_name_t sda;
185 pin_name_t fo;
186 pin_name_t ein;
187 pin_name_t int_pin;
189 uint32_t i2c_speed;
190 uint8_t i2c_address;
193
198typedef struct
199{
201 uint8_t am_pm;
202 uint8_t hours;
203 uint8_t min;
204 uint8_t sec;
205
207
212typedef struct
213{
214 uint8_t year;
215 uint8_t month;
216 uint8_t day;
217 uint8_t day_of_week;
218
219
221
226typedef struct
227{
228 uint8_t sec;
229 uint8_t min;
230 uint8_t hours;
231 uint8_t day;
232 uint8_t month;
233 uint8_t day_of_week;
234
236
241typedef struct
242{
243 uint8_t sec;
244 uint8_t min;
245 uint8_t hours;
246 uint8_t day;
247 uint8_t month;
248 uint8_t year;
249
251
256typedef enum
257{
259 RTC14_ERROR = -1
260
262
281
298err_t rtc14_init ( rtc14_t *ctx, rtc14_cfg_t *cfg );
299
316
334err_t rtc14_generic_write ( rtc14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
335
353err_t rtc14_generic_read ( rtc14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
354
371err_t rtc14_write_sram ( rtc14_t *ctx, uint16_t sram_data_in );
372
389err_t rtc14_read_sram ( rtc14_t *ctx, uint16_t *sram_data_out );
390
406
421uint8_t rtc14_get_fout ( rtc14_t *ctx );
422
439
456
473err_t rtc14_get_time ( rtc14_t *ctx, rtc14_time_t *rtc_time );
474
491err_t rtc14_set_time ( rtc14_t *ctx, rtc14_time_t rtc_time );
492
509err_t rtc14_get_date ( rtc14_t *ctx, rtc14_date_t *rtc_date );
510
527err_t rtc14_set_date ( rtc14_t *ctx, rtc14_date_t rtc_date );
528
545err_t rtc14_get_alarm ( rtc14_t *ctx, rtc14_alarm_t *rtc_alarm );
546
563err_t rtc14_set_alarm ( rtc14_t *ctx, rtc14_alarm_t rtc_alarm );
564
578
595err_t rtc14_get_time_stamp ( rtc14_t *ctx, rtc14_time_stamp_t *rtc_time_stamp );
596
597#ifdef __cplusplus
598}
599#endif
600#endif // RTC14_H
601 // rtc14
603
604// ------------------------------------------------------------------------ END
err_t rtc14_generic_write(rtc14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
RTC 14 I2C writing function.
err_t rtc14_init(rtc14_t *ctx, rtc14_cfg_t *cfg)
RTC 14 initialization function.
err_t rtc14_set_date(rtc14_t *ctx, rtc14_date_t rtc_date)
RTC 14 set date function.
void rtc14_cfg_setup(rtc14_cfg_t *cfg)
RTC 14 configuration object setup function.
err_t rtc14_get_time(rtc14_t *ctx, rtc14_time_t *rtc_time)
RTC 14 get time function.
err_t rtc14_set_time(rtc14_t *ctx, rtc14_time_t rtc_time)
RTC 14 set time function.
void rtc14_trigger_time_stamp(rtc14_t *ctx)
RTC 14 trigger time stamp function.
err_t rtc14_write_sram(rtc14_t *ctx, uint16_t sram_data_in)
RTC 14 write SRAM function.
uint8_t rtc14_get_fout(rtc14_t *ctx)
RTC 14 get fout function.
err_t rtc14_get_time_stamp(rtc14_t *ctx, rtc14_time_stamp_t *rtc_time_stamp)
RTC 14 get time stamp function.
uint8_t rtc14_get_interrupt(rtc14_t *ctx)
RTC 14 get interrupt function.
err_t rtc14_soft_reset(rtc14_t *ctx)
RTC 14 soft reset function.
err_t rtc14_generic_read(rtc14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
RTC 14 I2C reading function.
err_t rtc14_get_alarm(rtc14_t *ctx, rtc14_alarm_t *rtc_alarm)
RTC 14 get alarm function.
err_t rtc14_enable_rtc(rtc14_t *ctx)
RTC 14 enable RTC function.
err_t rtc14_get_date(rtc14_t *ctx, rtc14_date_t *rtc_date)
RTC 14 get date function.
err_t rtc14_default_cfg(rtc14_t *ctx)
RTC 14 default configuration function.
err_t rtc14_set_alarm(rtc14_t *ctx, rtc14_alarm_t rtc_alarm)
RTC 14 set alarm function.
err_t rtc14_read_sram(rtc14_t *ctx, uint16_t *sram_data_out)
RTC 14 I2C reading SRAM function.
rtc14_return_value_t
RTC 14 Click return value data.
Definition: rtc14.h:257
@ RTC14_ERROR
Definition: rtc14.h:259
@ RTC14_OK
Definition: rtc14.h:258
RTC 14 Click alarm object.
Definition: rtc14.h:227
uint8_t hours
Definition: rtc14.h:230
uint8_t month
Definition: rtc14.h:232
uint8_t day
Definition: rtc14.h:231
uint8_t day_of_week
Definition: rtc14.h:233
uint8_t min
Definition: rtc14.h:229
uint8_t sec
Definition: rtc14.h:228
RTC 14 Click configuration object.
Definition: rtc14.h:181
pin_name_t ein
Definition: rtc14.h:186
pin_name_t fo
Definition: rtc14.h:185
uint32_t i2c_speed
Definition: rtc14.h:189
pin_name_t scl
Definition: rtc14.h:182
pin_name_t int_pin
Definition: rtc14.h:187
pin_name_t sda
Definition: rtc14.h:183
uint8_t i2c_address
Definition: rtc14.h:190
RTC 14 Click date object.
Definition: rtc14.h:213
uint8_t month
Definition: rtc14.h:215
uint8_t day
Definition: rtc14.h:216
uint8_t year
Definition: rtc14.h:214
uint8_t day_of_week
Definition: rtc14.h:217
RTC 14 Click context object.
Definition: rtc14.h:160
digital_in_t fo
Definition: rtc14.h:165
digital_in_t int_pin
Definition: rtc14.h:166
i2c_master_t i2c
Definition: rtc14.h:169
digital_out_t ein
Definition: rtc14.h:162
uint8_t slave_address
Definition: rtc14.h:172
RTC 14 Click time stamp object.
Definition: rtc14.h:242
uint8_t hours
Definition: rtc14.h:245
uint8_t month
Definition: rtc14.h:247
uint8_t day
Definition: rtc14.h:246
uint8_t year
Definition: rtc14.h:248
uint8_t min
Definition: rtc14.h:244
uint8_t sec
Definition: rtc14.h:243
RTC 14 Click time object.
Definition: rtc14.h:199
uint8_t hours
Definition: rtc14.h:202
uint8_t hours_format
Definition: rtc14.h:200
uint8_t min
Definition: rtc14.h:203
uint8_t sec
Definition: rtc14.h:204
uint8_t am_pm
Definition: rtc14.h:201