RTC_NXP_Arduino 0.4.0
LED driver device operation sample code for Arduino
Loading...
Searching...
No Matches
RTC_NXP.h
1
8#ifndef ARDUINO_LED_DRIVER_NXP_ARD_H
9#define ARDUINO_LED_DRIVER_NXP_ARD_H
10
11#include <Arduino.h>
12#include <stdint.h>
13#include <time.h>
14
15#include <I2C_device.h>
16#include <SPI.h>
17
27{
28public:
30 enum board {
31 NONE,
32 ARDUINO_SHIELD,
33 };
36 SECOND,
37 MINUTE,
38 HOUR,
39 DAY,
40 WEEKDAY,
41 };
42
44 RTC_NXP();
45
47 virtual ~RTC_NXP();
48
50 virtual void begin( void ) = 0;
51
59 time_t time( time_t* tp );
60
65 virtual void set( struct tm* now_tm ) = 0;
66
71 virtual bool oscillator_stop( void ) = 0;
72
78 virtual void alarm( alarm_setting digit, int val ) = 0;
79
82 virtual void alarm_clear( void ) = 0;
83
86 virtual void alarm_disable( void ) = 0;
87
90 virtual uint8_t int_clear( void ) = 0;
91
92protected:
97 virtual time_t rtc_time( void ) = 0;
98
104 static uint8_t bcd2dec( uint8_t v );
105
111 static uint8_t dec2bcd( uint8_t v );
112};
113
114
123class PCF2131_base : public RTC_NXP
124{
125public:
127 enum reg_num {
128 Control_1, Control_2, Control_3, Control_4, Control_5,
129 SR_Reset,
130 _100th_Seconds, Seconds, Minutes,Hours, Days, Weekdays, Months, Years,
131 Second_alarm, Minute_alarm, Hour_alarm, Day_alarm, Weekday_alarm,
132 CLKOUT_ctl,
133 Timestp_ctl1, Sec_timestp1, Min_timestp1, Hour_timestp1, Day_timestp1, Mon_timestp1, Year_timestp1,
134 Timestp_ctl2, Sec_timestp2, Min_timestp2, Hour_timestp2, Day_timestp2, Mon_timestp2, Year_timestp2,
135 Timestp_ctl3, Sec_timestp3, Min_timestp3, Hour_timestp3, Day_timestp3, Mon_timestp3, Year_timestp3,
136 Timestp_ctl4, Sec_timestp4, Min_timestp4, Hour_timestp4, Day_timestp4, Mon_timestp4, Year_timestp4,
137 Aging_offset,
138 INT_A_MASK1, INT_A_MASK2, INT_B_MASK1, INT_B_MASK2,
139 Watchdg_tim_ctl, Watchdg_tim_val
140 };
143 DISABLE,
144 EVERY_SECOND,
145 EVERY_MINUTE,
146 };
149 LAST,
150 FIRST,
151 };
152
154 PCF2131_base();
155
157 virtual ~PCF2131_base();
158
160 void begin( void );
161
166 bool oscillator_stop( void );
167
172 time_t rtc_time( void );
173
178 void set( struct tm* now_tm );
179
180
186 void alarm( alarm_setting digit, int val );
187
194 void alarm( alarm_setting digit, int val, int int_sel );
195
198 void alarm_clear( void );
199
202 void alarm_disable( void );
203
210 void timestamp( int num, timestanp_setting ts_setting, int int_sel = 0 );
211
217 time_t timestamp( int num );
218
221 uint8_t int_clear( void );
222
225 uint8_t int_clear( uint8_t* state_p );
226
232 void periodic_interrupt_enable( periodic_int_select sel, int int_sel = 0 );
233
234protected:
236 virtual void _reg_w( uint8_t reg, uint8_t *vp, int len ) = 0;
237
239 virtual void _reg_r( uint8_t reg, uint8_t *vp, int len ) = 0;
240
242 virtual void _reg_w( uint8_t reg, uint8_t val ) = 0;
243
245 virtual uint8_t _reg_r( uint8_t reg ) = 0;
246
248 virtual void _bit_op8( uint8_t reg, uint8_t mask, uint8_t val ) = 0;
249
250private:
251 const int int_mask_reg[ 2 ][ 2 ] = {
252 { INT_A_MASK1, INT_A_MASK2, },
253 { INT_B_MASK1, INT_B_MASK2, },
254 };
255};
256
257
265class PCF2131_I2C : public PCF2131_base, public I2C_device
266{
267public:
269 PCF2131_I2C( uint8_t i2c_address = (0xA6 >> 1) );
270
272 virtual ~PCF2131_I2C();
273
274private:
276 void _reg_w( uint8_t reg, uint8_t *vp, int len );
277
279 void _reg_r( uint8_t reg, uint8_t *vp, int len );
280
282 void _reg_w( uint8_t reg, uint8_t val );
283
285 uint8_t _reg_r( uint8_t reg );
286
288 void _bit_op8( uint8_t reg, uint8_t mask, uint8_t val );
289};
290
291
300{
301public:
309 void txrx( uint8_t *data, uint16_t size );
310
318 void reg_w( uint8_t reg_adr, uint8_t *data, uint16_t size );
319
327 void reg_w( uint8_t reg_adr, uint8_t data );
328
336 void reg_r( uint8_t reg_adr, uint8_t *data, uint16_t size );
337
343 uint8_t reg_r( uint8_t reg_adr );
344
350 void write_r8( uint8_t reg, uint8_t val );
351
357 uint8_t read_r8( uint8_t reg );
358
367 void bit_op8( uint8_t reg, uint8_t mask, uint8_t value );
368};
369
378{
379public:
381 PCF2131_SPI();
382
384 virtual ~PCF2131_SPI();
385
386private:
387// void txrx( uint8_t *data, uint16_t size );
388
390 void _reg_w( uint8_t reg, uint8_t *vp, int len );
391
393 void _reg_r( uint8_t reg, uint8_t *vp, int len );
394
396 void _reg_w( uint8_t reg, uint8_t val );
397
399 uint8_t _reg_r( uint8_t reg );
400
402 void _bit_op8( uint8_t reg, uint8_t mask, uint8_t val );
403};
404
412class PCF85063_base : public RTC_NXP
413{
414public:
415 enum reg_num {
416 Control_1, Control_2,
417 Offset,
418 RAM_byte,
419 Seconds, Minutes, Hours, Days, Weekdays, Months, Years,
420 Second_alarm, Minute_alarm, Hour_alarm, Day_alarm, Weekday_alarm,
421 Timer_value, Timer_mode
422 };
425
427 virtual ~PCF85063_base();
428
430 void begin( void );
431
436 void set( struct tm* now_tm );
437
442 bool oscillator_stop( void );
443
449 void alarm( alarm_setting digit, int val );
450
453 void alarm_clear( void );
454
457 void alarm_disable( void );
458
461 uint8_t int_clear( void );
462
463
469 float timer( float period );
470
471protected:
476 time_t rtc_time( void );
477
479 virtual void _reg_w( uint8_t reg, uint8_t *vp, int len ) = 0;
480
482 virtual void _reg_r( uint8_t reg, uint8_t *vp, int len ) = 0;
483
485 virtual void _reg_w( uint8_t reg, uint8_t val ) = 0;
486
488 virtual uint8_t _reg_r( uint8_t reg ) = 0;
489
491 virtual void _bit_op8( uint8_t reg, uint8_t mask, uint8_t val ) = 0;
492};
493
494class PCF85063A : public PCF85063_base, public I2C_device
495{
496public:
497 PCF85063A( uint8_t i2c_address = (0xA2 >> 1) );
498
500 virtual ~PCF85063A();
501
502private:
504 void _reg_w( uint8_t reg, uint8_t *vp, int len );
505
507 void _reg_r( uint8_t reg, uint8_t *vp, int len );
508
510 void _reg_w( uint8_t reg, uint8_t val );
511
513 uint8_t _reg_r( uint8_t reg );
514
516 void _bit_op8( uint8_t reg, uint8_t mask, uint8_t val );
517};
518
519class PCF85063TP : public PCF85063A
520{
521public:
522 PCF85063TP( uint8_t i2c_address = (0xA2 >> 1) );
523
525 virtual ~PCF85063TP();
526
530 void alarm( alarm_setting digit, int val );
531
535 void alarm_clear( void );
536
540 void alarm_disable( void );
541
545 uint8_t int_clear( void );
546
547
551 float timer( float period );
552
553};
554
555class PCF85263A : public RTC_NXP, public I2C_device
556{
557public:
558 enum reg_num {
559 _100th_seconds, Seconds, Minutes, Hours, Days, Weekdays, Months, Years,
560 Second_alarm1, Minute_alarm1, Hour_alarm1, Day_alarm1, Month_alarm1,
561 Minute_alarm2, Hour_alarm2, Weekday_alarm2,
562 Alarm_enables,
563 TSR1_seconds, TSR1_minutes, TSR1_hours, TSR1_days, TSR1_months, TSR1_years,
564 TSR2_seconds, TSR2_minutes, TSR2_hours, TSR2_days, TSR2_months, TSR2_years,
565 TSR3_seconds, TSR3_minutes, TSR3_hours, TSR3_days, TSR3_months, TSR3_years,
566 TSR_mode,
567 Offset, Oscillator, Battery_switch, Pin_IO, Function,
568 INTA_enable, INTB_enable, Flags,
569 RAM_byte, WatchDog, Stop_enable, Resets,
570
571 Hours_xx_xx_00 = 0x03, Hours_xx_00_xx, Hours_00_xx_xx, Reserved0, Reserved1,
572 Second_alm1, Minute_alm1, Hr_xx_xx_00_alm1, Hr_xx_00_xx_alm1, Hr_00_xx_xx_alm1,
573 Minute_alm2, Hr_xx_00_alm2, Hr_00_xx_alm2,
574 TSR1_hr_xx_xx_00 = 0x13, TSR1_hr_xx_00_xx, TSR1_hr_00_xx_xx, Reserved2,
575 TSR2_hr_xx_xx_00 = 0x19, TSR2_hr_xx_00_xx, TSR2_hr_00_xx_xx, Reserved3,
576 TSR3_hr_xx_xx_00 = 0x1F, TSR3_hr_xx_00_xx, TSR3_hr_00_xx_xx, Reserved4,
577 };
578
581 SECOND,
582 MINUTE,
583 HOUR,
584 DAY,
585 MONTH,
586 MINUTE2,
587 HOUR2,
588 WEEKDAY2,
589 };
590
593 DISABLE,
594 EVERY_SECOND,
595 EVERY_MINUTE,
596 };
597
599 enum inta {
600 INTA_CLKOUT,
601 INTA_BATTERY_MODE_INDICATION,
602 INTA_INTTERRUPT,
603 INTA_HIGH_Z,
604 };
605
607 enum intb {
608 INTB_DISABLE,
609 INTB_INTTERRUPT,
610 INTB_CLKOUT,
611 INTB_INPUT_MODE,
612 };
613
615 enum ts_in {
616 TS_PULLUP_80K = 0x00,
617 TS_PULLUP_40K = 0x40,
618 TSL_ACTIVE_HIGH = 0x00,
619 TSL_ACTIVE_LOW = 0x20,
620 TSIM_CMOS = 0x00,
621 TSIM_MECHANICAL = 0x10,
622 };
623
625 PCF85263A( uint8_t i2c_address = (0xA2 >> 1) );
626
628 virtual ~PCF85263A();
629
631 void begin( void );
632
637 void set( struct tm* now_tm );
638
643 bool oscillator_stop( void );
644
650 void alarm( alarm_setting digit, int val );
651
658 void alarm( alarm_setting digit, int val, int int_sel );
659
665 void alarm( alarm_setting_85263A digit, int val, int int_sel = 0 );
666
669 void alarm_clear( void );
670
673 void alarm_disable( void );
674
677 uint8_t int_clear( void );
678
683 time_t rtc_time( void );
684
689 void periodic_interrupt_enable( periodic_int_select sel, int int_sel = 0 );
690
696 void pin_congfig(inta cfg_a, intb cfg_b);
697
702 void ts_congfig(int setting);
703
708 time_t timestamp( int num );
709
710private:
711 void set_alarm( int digit, int val, int int_sel );
712};
713
714class ForFutureExtention : public RTC_NXP, public I2C_device
715{
716public:
719
722
724 void begin( void );
725
730 void set( struct tm* now_tm );
731
736 bool oscillator_stop( void );
737
742 void alarm( alarm_setting digit, int val );
743
746 void alarm_clear( void );
747
750 void alarm_disable( void );
751
754 uint8_t int_clear( void );
755
756protected:
761 time_t rtc_time( void );
762};
763
764
765#endif // ARDUINO_LED_DRIVER_NXP_ARD_H
void alarm(alarm_setting digit, int val)
void alarm_clear(void)
virtual ~ForFutureExtention()
time_t rtc_time(void)
uint8_t int_clear(void)
bool oscillator_stop(void)
void alarm_disable(void)
void set(struct tm *now_tm)
virtual ~PCF2131_I2C()
Definition: PCF2131_I2C.cpp:7
virtual ~PCF2131_SPI()
Definition: PCF2131_SPI.cpp:7
void timestamp(int num, timestanp_setting ts_setting, int int_sel=0)
void begin(void)
virtual uint8_t _reg_r(uint8_t reg)=0
periodic_int_select
Definition: RTC_NXP.h:142
void set(struct tm *now_tm)
uint8_t int_clear(void)
void alarm_clear(void)
time_t rtc_time(void)
void periodic_interrupt_enable(periodic_int_select sel, int int_sel=0)
virtual ~PCF2131_base()
Definition: PCF2131_base.cpp:7
void alarm_disable(void)
bool oscillator_stop(void)
void alarm(alarm_setting digit, int val)
virtual void _reg_r(uint8_t reg, uint8_t *vp, int len)=0
virtual void _bit_op8(uint8_t reg, uint8_t mask, uint8_t val)=0
virtual void _reg_w(uint8_t reg, uint8_t val)=0
virtual void _reg_w(uint8_t reg, uint8_t *vp, int len)=0
void set(struct tm *now_tm)
Definition: PCF85063A.cpp:15
virtual void _bit_op8(uint8_t reg, uint8_t mask, uint8_t val)=0
bool oscillator_stop(void)
Definition: PCF85063A.cpp:38
uint8_t int_clear(void)
Definition: PCF85063A.cpp:60
void alarm_disable(void)
Definition: PCF85063A.cpp:55
void alarm(alarm_setting digit, int val)
Definition: PCF85063A.cpp:43
virtual void _reg_w(uint8_t reg, uint8_t val)=0
float timer(float period)
Definition: PCF85063A.cpp:68
virtual void _reg_w(uint8_t reg, uint8_t *vp, int len)=0
void begin(void)
Definition: PCF85063A.cpp:11
virtual uint8_t _reg_r(uint8_t reg)=0
virtual void _reg_r(uint8_t reg, uint8_t *vp, int len)=0
virtual ~PCF85063_base()
Definition: PCF85063A.cpp:7
void alarm_clear(void)
Definition: PCF85063A.cpp:50
time_t rtc_time(void)
Definition: PCF85063A.cpp:100
virtual ~PCF85063A()
Definition: PCF85063A.cpp:124
virtual ~PCF85063TP()
Definition: PCF85063TP.cpp:13
void alarm(alarm_setting digit, int val)
Definition: PCF85063TP.cpp:17
uint8_t int_clear(void)
Definition: PCF85063TP.cpp:34
float timer(float period)
Definition: PCF85063TP.cpp:40
void alarm_disable(void)
Definition: PCF85063TP.cpp:29
void alarm_clear(void)
Definition: PCF85063TP.cpp:24
void pin_congfig(inta cfg_a, intb cfg_b)
Definition: PCF85263A.cpp:124
void alarm_disable(void)
Definition: PCF85263A.cpp:84
void ts_congfig(int setting)
Definition: PCF85263A.cpp:129
void alarm(alarm_setting digit, int val)
Definition: PCF85263A.cpp:46
void periodic_interrupt_enable(periodic_int_select sel, int int_sel=0)
Definition: PCF85263A.cpp:116
uint8_t int_clear(void)
Definition: PCF85263A.cpp:90
virtual ~PCF85263A()
Definition: PCF85263A.cpp:7
time_t timestamp(int num)
Definition: PCF85263A.cpp:135
void begin(void)
Definition: PCF85263A.cpp:11
alarm_setting_85263A
Definition: RTC_NXP.h:580
bool oscillator_stop(void)
Definition: PCF85263A.cpp:41
void alarm_clear(void)
Definition: PCF85263A.cpp:79
periodic_int_select
Definition: RTC_NXP.h:592
time_t rtc_time(void)
Definition: PCF85263A.cpp:98
void set(struct tm *now_tm)
Definition: PCF85263A.cpp:15
virtual void begin(void)=0
virtual uint8_t int_clear(void)=0
virtual void set(struct tm *now_tm)=0
virtual time_t rtc_time(void)=0
RTC_NXP()
Definition: RTC_NXP.cpp:3
virtual void alarm_disable(void)=0
virtual bool oscillator_stop(void)=0
alarm_setting
Definition: RTC_NXP.h:35
static uint8_t dec2bcd(uint8_t v)
Definition: RTC_NXP.cpp:24
static uint8_t bcd2dec(uint8_t v)
Definition: RTC_NXP.cpp:19
virtual ~RTC_NXP()
Definition: RTC_NXP.cpp:7
virtual void alarm_clear(void)=0
virtual void alarm(alarm_setting digit, int val)=0
time_t time(time_t *tp)
Definition: RTC_NXP.cpp:11
void reg_w(uint8_t reg_adr, uint8_t *data, uint16_t size)
Definition: SPI_for_RTC.cpp:10
uint8_t read_r8(uint8_t reg)
Definition: SPI_for_RTC.cpp:52
void txrx(uint8_t *data, uint16_t size)
Definition: SPI_for_RTC.cpp:3
void bit_op8(uint8_t reg, uint8_t mask, uint8_t value)
Definition: SPI_for_RTC.cpp:57
void reg_r(uint8_t reg_adr, uint8_t *data, uint16_t size)
Definition: SPI_for_RTC.cpp:27
void write_r8(uint8_t reg, uint8_t val)
Definition: SPI_for_RTC.cpp:47