[32] Arduino - RTS DS3231

W tym poście chciałbym opisać podłączenie oraz programowanie zegara czasu rzeczywistego DS3231 za pomocą Arduino.

[Źródło: http://www.hobbytronics.co.uk/arduino-uno-r3, http://www.banggood.com]

Dużą zaletą tego układu, oprócz dużej precyzji jest brak konieczności wyposażenia układu w zewnętrzny kwarc. Ponieważ układ posiada taki w obudowie. Dodatkowym atutem jest układ kompensacji temperaturowej. 

Układ posiada wyjście z kwarcu 32,768kHz oraz dwa alarmy, które można zaprogramować. Dodatkowo z wbudowanego termometru można odczytać zmierzoną temperaturę.

Dokładność układu wynosi +/- 2ppm dla zakresu temperatur od 0 st. C do 40 st. C. Natomiast dla zakresy od -40 do 85 st. C może dochodzić do większych rozrzutów wynoszących +/-3ppm. Takie wartości pozwalają na uzyskanie dokładności nie przekraczające rozrzutu do 60 sekund w roku.

Biblioteką można pobrać przez menadżer bibliotek.

Program:

Program pobierający dane z układu wygląda następująco:

1. #include <DS3231.h>
2. #include <Wire.h>
3. #include <stdint.h>
5. /* Pin for SDA in Arduino uno is Analog pin 4
6.    Pin for SCL in Arduino uno is Analog pin 5 */
8. DS3231 Clock;
9. bool SetCentury=false;
10. bool AMPM_Indicat;
11. bool PM;
13. void setup() {
14.   Wire.begin();         /* Start I2C */
15.   Serial.begin(9600);   /* Enable UART transmission */
16. }
18. void loop()
19. {
20.   byte A1Day, A1Hour, A1Minute, A1Second;
21.   bool A1_Dy, A1_12h, A1_pm;
22.   byte A2Day, A2Hour, A2Minute, A2Second;
23.   bool A2_Dy, A2_12h, A2_pm;
24.   byte alarmBits;
26.   /* Get date and hour from DS3231 then send it through UART */
27.   uint8_t ds_year = Clock.getYear();
28.   uint8_t ds_month = Clock.getMonth(SetCentury);
29.   uint8_t ds_dayOfMonth = Clock.getDate();
30.   uint8_t ds_dayOfWeek = Clock.getDoW();
31.   uint8_t ds_hour = Clock.getHour(AMPM_Indicat, PM);
32.   uint8_t ds_minutes = Clock.getMinute();
33.   uint8_t ds_seconds = Clock.getSecond();
34.   uint8_t ds_temperature = Clock.getTemperature();
36.   /*  Print data */
37.   Serial.print("20");
38.   Serial.print(ds_year, DEC);       /* Print year */
39.   Serial.print('-');
40.   Serial.print(ds_month, DEC);      /* Print month */
41.   Serial.print('-');
42.   Serial.print(ds_dayOfMonth, DEC); /* Print day in month */
43.   Serial.print(' ');
44.   Serial.print(ds_dayOfWeek, DEC);  /* Day of the week */
45.   Serial.print(';');
47.   /* Print time */
48.   Serial.print(ds_hour, DEC);
49.   Serial.print(':');
50.   Serial.print(ds_minutes, DEC);
51.   Serial.print(':');
52.   Serial.print(ds_seconds, DEC);
54.   if(AMPM_Indicat)
55.   {
56.     if(PM) { Serial.print(" PM "); }
57.     else   { Serial.print(" AM "); }
58.   }
59.   else
60.   {
61.     Serial.print(" 24H ");
62.   }
64.   /* Display temperature */
65.   Serial.print("Temp=");
66.   Serial.print(ds_temperature, 2);
68.   /* Check oscillator, if time is correct */
69.   if (Clock.oscillatorCheck() == true)  { Serial.print("; Osc Time OK; ");    }
70.   else                                  { Serial.print("; Osc Time ERROR; "); }
71.   Serial.print('\n');
73.   /* Check alarms */
74.   if(Clock.checkIfAlarm(1) == true){  Serial.print("Alarm 1 GO !; ");   }
75.   if(Clock.checkIfAlarm(2) == true){  Serial.print("Alarm 2 GO !; ");   }
77.   /* Check alarm 1 information */
78.   Serial.print('\n');
79.   Serial.print("Alarm 1 data: ");
80.   Clock.getA1Time(A1Day, A1Hour, A1Minute, A1Second, alarmBits, A1_Dy, A1_12h, A1_pm);
81.   Serial.print(A1Day, DEC);
82.   if (A1_Dy) {
83.     Serial.print(" Day of week");
84.   } else {
85.     Serial.print(" Date");
86.   }
87.   Serial.print(';');
88.   Serial.print(A1Hour, DEC);
89.   Serial.print(':');
90.   Serial.print(A1Minute, DEC);
91.   Serial.print(':');
92.   Serial.print(A1Second, DEC);
93.   Serial.print(':');
94.   if (A1_12h)
95.   {
96.     if (A1_pm) { Serial.print('pm '); }
97.     else       { Serial.print('am '); }
98.   }
100.   if (Clock.checkAlarmEnabled(1)) { Serial.print("Alarm 1: enabled;"); }
102.   /* Check alarm 2 information */
103.   Serial.print('\n');
104.   Serial.print("Alarm 2 data: ");
105.   Clock.getA1Time(A2Day, A2Hour, A2Minute, A2Second, alarmBits, A2_Dy, A2_12h, A2_pm);
106.   Serial.print(A2Day, DEC);
107.   if (A2_Dy) { Serial.print(" day of week"); }
108.   else       { Serial.print(" Date");        }
110.   Serial.print(';');
111.   Serial.print(A2Hour, DEC);
112.   Serial.print(':');
113.   Serial.print(A2Minute, DEC);
114.   Serial.print(':');
115.   Serial.print(A2Second, DEC);
116.   Serial.print(':');
117.   if (A2_12h)
118.   {
119.     if (A2_pm) { Serial.print('pm '); }
120.     else       { Serial.print('am '); }
121.   }
123.   if (Clock.checkAlarmEnabled(2)) { Serial.print("Alarm 2: enabled;"); }
124.   Serial.print('\n');
125.   Serial.print("Alarm bits: ");
126.   Serial.print(alarmBits, BIN);
128.   Serial.print('\n');
129.   delay(1000);
130. }

Słów kilka o niektórych funkcjach.

Funkcja pobierająca godzinę:

1. byte DS3231::getHour(bool& h12, bool& PM) {
2.     byte temp_buffer;
3.     byte hour;
4.     Wire.beginTransmission(CLOCK_ADDRESS);
5.     Wire.write(0x02);
6.     Wire.endTransmission();
8.     Wire.requestFrom(CLOCK_ADDRESS, 1);
9.     temp_buffer = Wire.read();
10.     h12 = temp_buffer & 0b01000000;
11.     if (h12) {
12.         PM = temp_buffer & 0b00100000;
13.         hour = bcdToDec(temp_buffer & 0b00011111);
14.     } else {
15.         hour = bcdToDec(temp_buffer & 0b00111111);
16.     }
17.     return hour;
18. }

Funkcja podobnie jak pozostałe związane z datą oraz godziną zwracają aktualną wartość. Dodatkowo ta funkcja pobiera dwa wskaźniki do zmiennych logicznych. Jedna z nich określa format w jakim dane są pobrane czyli czy 12 godzinny czy 24 godziny. Druga zmienna określa czy godzina jest AM czy PM. Czyli czy od północy do 12 czy od 12 do północy. Ta część tyczy się trybu 12 godzinnego.

Kolejna funkcja sprawdza stan oscylatora:

1. bool DS3231::oscillatorCheck() {
2.     byte temp_buffer = readControlByte(1);
3.     bool result = true;
4.     if (temp_buffer & 0b10000000) {
5.         // Oscillator Stop Flag (OSF) is set, so return false.
6.         result = false;
7.     }
8.     return result;
9. }

Sprawdza ona status flagi OSF (Oscilltor Stop Flag). Jeśli funkcja zwróci false, będzie to oznaczać że coś jest nie tak z oscylatorem, czyli prawdopodobnie podawany czas jest zły. Flaga OSF jest czyszczona przez funkcje setSecond().

Kolejna funkcja sprawdza czy alarm został odpalony:

1. bool DS3231::checkIfAlarm(byte Alarm) {
2.     byte result;
3.     byte temp_buffer = readControlByte(1);
4.     if (Alarm == 1) {
5.         // Did alarm 1 go off?
6.         result = temp_buffer & 0b00000001;
7.         // clear flag
8.         temp_buffer = temp_buffer & 0b11111110;
9.     } else {
10.         // Did alarm 2 go off?
11.         result = temp_buffer & 0b00000010;
12.         // clear flag
13.         temp_buffer = temp_buffer & 0b11111101;
14.     }
15.     writeControlByte(temp_buffer, 1);
16.     return result;
17. }

Funkcja zwraca true lub false w zależności od stanu alarmu. Jako argument podawany jest numer alarmu.

Uruchamiani alarmów odbywa się za pomocą następujących funkcji:

1. /* set alarms */
2. void DS3231::setA1Time(byte A1Day, byte A1Hour, byte A1Minute, byte A1Second, byte AlarmBits, bool A1Dy, bool A1h12, bool A1PM);
3. void DS3231::setA2Time(byte A2Day, byte A2Hour, byte A2Minute, byte AlarmBits, bool A2Dy, bool A2h12, bool A2PM);
5. /* Check alarm flags */
6. void DS3231::getA1Time(byte& A2Day, byte& A2Hour, byte& A2Minute, byte& AlarmBits, bool& A2Dy, bool& A2h12, bool& A2PM);
7. void DS3231::getA2Time(byte& A2Day, byte& A2Hour, byte& A2Minute, byte& AlarmBits, bool& A2Dy, bool& A2h12, bool& A2PM);
9. /* turn on selected alarm */
10. void DS3231::turnOnAlarm(byte Alarm);
11. /* turn off alarm */
12. void DS3231::turnOffAlarm(byte Alarm);