rtc10  2.0.0.0
rtc10.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef RTC10_H
35 #define RTC10_H
36 
41 #ifdef PREINIT_SUPPORTED
42 #include "preinit.h"
43 #endif
44 
45 #ifdef MikroCCoreVersion
46  #if MikroCCoreVersion >= 1
47  #include "delays.h"
48  #endif
49 #endif
50 
51 #include "drv_digital_out.h"
52 #include "drv_digital_in.h"
53 #include "drv_i2c_master.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define RTC10_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
67  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
68  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define RTC10_RETVAL uint8_t
78 
79 #define RTC10_OK 0x00
80 #define RTC10_INIT_ERROR 0xFF
81 
87 #define RTC10_I2C_SLAVE_ADDRESS 0x68
88 
94 #define RTC10_RTCSEC 0x00
95 #define RTC10_RTCMIN 0x01
96 #define RTC10_RTCHOUR 0x02
97 #define RTC10_RTCWKDAY 0x03
98 #define RTC10_RTCDATE 0x04
99 #define RTC10_RTCMTH 0x05
100 #define RTC10_RTCYEAR 0x06
101 #define RTC10_ALM1SEC 0x07
102 #define RTC10_ALM1MIN 0x08
103 #define RTC10_ALM1HOUR 0x09
104 #define RTC10_ALM1DATE 0x0A
105 #define RTC10_ALM2MIN 0x0B
106 #define RTC10_ALM2HOUR 0x0C
107 #define RTC10_ALM2DATE 0x0D
108 #define RTC10_CONTROL 0x0E
109 #define RTC10_STATUS 0x0F
110 #define RTC10_AGING 0x10
111 #define RTC10_TEMPERATURE_MSB 0x11
112 #define RTC10_TEMPERATURE_LSB 0x12
113 
119 #define RTC10_DISABLE_ALARMS 0x00
120 #define RTC10_ENABLE_ALARM_1 0x01
121 #define RTC10_ENABLE_ALARM_2 0x02
122 #define RTC10_ENABLE_INTERRUPT 0x04
123  // End group macro
126 // --------------------------------------------------------------- PUBLIC TYPES
135 typedef struct
136 {
137  // Output pins
138 
139  digital_out_t rst;
140 
141  // Input pins
142 
143  digital_in_t an;
144  digital_in_t int_pin;
145 
146  // Modules
147 
148  i2c_master_t i2c;
149 
150  // ctx variable
151 
152  uint8_t slave_address;
153 
154 } rtc10_t;
155 
159 typedef struct
160 {
161  // Communication gpio pins
162 
163  pin_name_t scl;
164  pin_name_t sda;
165 
166  // Additional gpio pins
167 
168  pin_name_t an;
169  pin_name_t rst;
170  pin_name_t int_pin;
171 
172  // static variable
173 
174  uint32_t i2c_speed;
175  uint8_t i2c_address;
176 
177 } rtc10_cfg_t;
178  // End types group
180 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
181 
187 #ifdef __cplusplus
188 extern "C"{
189 #endif
190 
200 
210 
219 
230 void rtc10_generic_write ( rtc10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
231 
242 void rtc10_generic_read ( rtc10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
243 
254 void rtc10_hw_reset ( rtc10_t *ctx );
255 
264 
273 uint8_t rtc10_read_byte ( rtc10_t *ctx, uint8_t reg_address );
274 
284 void rtc10_write_byte ( rtc10_t *ctx, uint8_t reg_address, uint8_t write_data );
285 
295 
305 void rtc10_set_time_seconds ( rtc10_t *ctx, uint8_t seconds );
306 
316 
326 void rtc10_set_time_minutes ( rtc10_t *ctx, uint8_t minutes );
327 
337 
347 
356 uint8_t rtc10_get_time_hours ( rtc10_t *ctx );
357 
367 void rtc10_set_time_hours( rtc10_t *ctx, uint8_t hours );
368 
378 
395 void rtc10_set_day_of_the_week ( rtc10_t *ctx, uint8_t w_day );
396 
405 uint8_t rtc10_get_date_day ( rtc10_t *ctx );
406 
416 void rtc10_set_date_day ( rtc10_t *ctx, uint8_t date_day );
417 
426 uint8_t rtc10_get_date_month ( rtc10_t *ctx );
427 
437 void rtc10_set_date_month( rtc10_t *ctx, uint8_t date_month );
438 
447 uint8_t rtc10_get_date_year ( rtc10_t *ctx );
448 
458 void rtc10_set_date_year ( rtc10_t *ctx, uint16_t date_year );
459 
472 void rtc10_set_time ( rtc10_t *ctx, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds );
473 
486 void rtc10_get_time ( rtc10_t *ctx, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
487 
501 void rtc10_set_date( rtc10_t *ctx, uint8_t day_of_the_week, uint8_t date_day, uint8_t date_month, uint16_t date_year );
502 
516 void rtc10_get_date( rtc10_t *ctx, uint8_t *day_of_the_week, uint8_t *date_day, uint8_t *date_month, uint8_t *date_year );
517 
527 
537 void rtc10_set_alarm_time_seconds ( rtc10_t *ctx, uint8_t seconds );
538 
548 
558 void rtc10_set_alarm_time_minutes( rtc10_t *ctx, uint8_t minutes );
559 
569 
579 void rtc10_set_alarm_time_hours ( rtc10_t *ctx, uint8_t hours );
580 
590 
600 void rtc10_set_alarm_date_day ( rtc10_t *ctx, uint8_t date_day );
601 
615 void rtc10_set_first_alarm ( rtc10_t *ctx, uint8_t time_days, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds );
616 
630 void rtc10_get_first_alarm ( rtc10_t *ctx, uint8_t *time_days, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
631 
645 void rtc10_set_second_alarm( rtc10_t *ctx, uint8_t time_days, uint8_t time_hours, uint8_t time_minutes );
646 
660 void rtc10_get_second_alarm ( rtc10_t *ctx, uint8_t *time_days, uint8_t *time_hours, uint8_t *time_minutes );
661 
672 
714 void rtc10_set_config( rtc10_t *ctx, uint8_t config_data );
715 
759 uint8_t rtc10_get_status ( rtc10_t *ctx );
760 
771 
772 
773 
774 #ifdef __cplusplus
775 }
776 #endif
777 #endif // _RTC10_H_
778  // End public_function group
781 
782 // ------------------------------------------------------------------------- END
rtc10_cfg_t::an
pin_name_t an
Definition: rtc10.h:168
rtc10_get_date_year
uint8_t rtc10_get_date_year(rtc10_t *ctx)
Get year function.
rtc10_set_alarm_time_seconds
void rtc10_set_alarm_time_seconds(rtc10_t *ctx, uint8_t seconds)
Set alarm time seconds function.
rtc10_get_date
void rtc10_get_date(rtc10_t *ctx, uint8_t *day_of_the_week, uint8_t *date_day, uint8_t *date_month, uint8_t *date_year)
Get time hours, minutes and seconds function.
rtc10_hw_reset
void rtc10_hw_reset(rtc10_t *ctx)
Hardware reset function.
rtc10_generic_read
void rtc10_generic_read(rtc10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
rtc10_init
RTC10_RETVAL rtc10_init(rtc10_t *ctx, rtc10_cfg_t *cfg)
Initialization function.
rtc10_set_day_of_the_week
void rtc10_set_day_of_the_week(rtc10_t *ctx, uint8_t w_day)
Set day of the week function.
rtc10_set_time_minutes
void rtc10_set_time_minutes(rtc10_t *ctx, uint8_t minutes)
Generic read function.
rtc10_get_alarm_time_hours
uint8_t rtc10_get_alarm_time_hours(rtc10_t *ctx)
Get alarm time hours function.
rtc10_get_date_month
uint8_t rtc10_get_date_month(rtc10_t *ctx)
Get month function.
rtc10_t::an
digital_in_t an
Definition: rtc10.h:143
rtc10_set_time_hours
void rtc10_set_time_hours(rtc10_t *ctx, uint8_t hours)
Set hours function.
rtc10_get_time_seconds
uint8_t rtc10_get_time_seconds(rtc10_t *ctx)
Get seconds function.
rtc10_generic_write
void rtc10_generic_write(rtc10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
rtc10_default_cfg
void rtc10_default_cfg(rtc10_t *ctx)
Click Default Configuration function.
rtc10_cfg_t::sda
pin_name_t sda
Definition: rtc10.h:164
rtc10_t
Click ctx object definition.
Definition: rtc10.h:136
rtc10_cfg_t::i2c_address
uint8_t i2c_address
Definition: rtc10.h:175
rtc10_get_time_hours
uint8_t rtc10_get_time_hours(rtc10_t *ctx)
Get hours function.
rtc10_set_date_year
void rtc10_set_date_year(rtc10_t *ctx, uint16_t date_year)
Set month function.
rtc10_get_day_of_the_week
uint8_t rtc10_get_day_of_the_week(rtc10_t *ctx)
Get day of the week function.
rtc10_get_date_day
uint8_t rtc10_get_date_day(rtc10_t *ctx)
Get date function.
rtc10_t::i2c
i2c_master_t i2c
Definition: rtc10.h:148
rtc10_get_alarm_time_seconds
uint8_t rtc10_get_alarm_time_seconds(rtc10_t *ctx)
Get alarm time seconds function.
rtc10_t::int_pin
digital_in_t int_pin
Definition: rtc10.h:144
rtc10_cfg_setup
void rtc10_cfg_setup(rtc10_cfg_t *cfg)
Config Object Initialization function.
rtc10_set_alarm_time_hours
void rtc10_set_alarm_time_hours(rtc10_t *ctx, uint8_t hours)
Set alarm time seconds function.
rtc10_set_second_alarm
void rtc10_set_second_alarm(rtc10_t *ctx, uint8_t time_days, uint8_t time_hours, uint8_t time_minutes)
Set Alarm 2 time: hours, minutes and seconds function.
rtc10_get_second_alarm
void rtc10_get_second_alarm(rtc10_t *ctx, uint8_t *time_days, uint8_t *time_hours, uint8_t *time_minutes)
Set Alarm 2 time: hours, minutes and seconds function.
rtc10_set_time
void rtc10_set_time(rtc10_t *ctx, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds)
Set time: hours, minutes and seconds function.
rtc10_get_century_flag
uint8_t rtc10_get_century_flag(rtc10_t *ctx)
Get century flag function.
rtc10_get_first_alarm
void rtc10_get_first_alarm(rtc10_t *ctx, uint8_t *time_days, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds)
Get Alarm 1 time hours, minutes and seconds function.
rtc10_set_date
void rtc10_set_date(rtc10_t *ctx, uint8_t day_of_the_week, uint8_t date_day, uint8_t date_month, uint16_t date_year)
Set date hours, minutes and seconds function.
rtc10_set_first_alarm
void rtc10_set_first_alarm(rtc10_t *ctx, uint8_t time_days, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds)
Set Alarm 1 time: hours, minutes and seconds function.
rtc10_cfg_t::rst
pin_name_t rst
Definition: rtc10.h:169
rtc10_enable_counting
void rtc10_enable_counting(rtc10_t *ctx)
Enable counting function.
rtc10_write_byte
void rtc10_write_byte(rtc10_t *ctx, uint8_t reg_address, uint8_t write_data)
Generic read function.
rtc10_t::rst
digital_out_t rst
Definition: rtc10.h:139
rtc10_cfg_t
Click configuration structure definition.
Definition: rtc10.h:160
rtc10_get_time_minutes
uint8_t rtc10_get_time_minutes(rtc10_t *ctx)
Get seconds function.
rtc10_set_century_flag
void rtc10_set_century_flag(rtc10_t *ctx)
Set century flag function.
rtc10_check_interrupt
uint8_t rtc10_check_interrupt(rtc10_t *ctx)
Check the state of interrupt function.
rtc10_get_time
void rtc10_get_time(rtc10_t *ctx, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds)
Get time hours, minutes and seconds function.
rtc10_get_temperature
float rtc10_get_temperature(rtc10_t *ctx)
Get temperature function.
rtc10_get_alarm_date_day
uint8_t rtc10_get_alarm_date_day(rtc10_t *ctx)
Get alarm days function.
rtc10_cfg_t::int_pin
pin_name_t int_pin
Definition: rtc10.h:170
rtc10_cfg_t::scl
pin_name_t scl
Definition: rtc10.h:163
rtc10_set_config
void rtc10_set_config(rtc10_t *ctx, uint8_t config_data)
Set configuration function.
rtc10_get_alarm_time_minutes
uint8_t rtc10_get_alarm_time_minutes(rtc10_t *ctx)
Get alarm time minutes function.
rtc10_set_date_month
void rtc10_set_date_month(rtc10_t *ctx, uint8_t date_month)
Set month function.
rtc10_set_alarm_date_day
void rtc10_set_alarm_date_day(rtc10_t *ctx, uint8_t date_day)
Set alarm days function.
rtc10_read_byte
uint8_t rtc10_read_byte(rtc10_t *ctx, uint8_t reg_address)
Generic read function.
rtc10_set_date_day
void rtc10_set_date_day(rtc10_t *ctx, uint8_t date_day)
Set date function.
rtc10_set_alarm_time_minutes
void rtc10_set_alarm_time_minutes(rtc10_t *ctx, uint8_t minutes)
Set alarm time seconds function.
rtc10_set_time_seconds
void rtc10_set_time_seconds(rtc10_t *ctx, uint8_t seconds)
Generic read function.
RTC10_RETVAL
#define RTC10_RETVAL
Definition: rtc10.h:77
rtc10_get_status
uint8_t rtc10_get_status(rtc10_t *ctx)
Get configuration status function.
rtc10_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: rtc10.h:174
rtc10_t::slave_address
uint8_t slave_address
Definition: rtc10.h:152