RX-8025NB Real Time Clock Module by EPSON
Dependents: TYBLE16_simple_data_logger Check_external_RTC
RX8025NB.h@4:d8ce59684dfa, 2016-05-05 (annotated)
- Committer:
- kenjiArai
- Date:
- Thu May 05 02:13:03 2016 +0000
- Revision:
- 4:d8ce59684dfa
- Parent:
- 3:d59c12d14ca9
- Child:
- 5:e8e8b1b6c103
Set minimum value 2 minutes for Alarm-D
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kenjiArai | 0:cdf2921959b4 | 1 | /* |
kenjiArai | 0:cdf2921959b4 | 2 | * mbed library program |
kenjiArai | 0:cdf2921959b4 | 3 | * Control RX-8025NB Real Time Clock Module |
kenjiArai | 0:cdf2921959b4 | 4 | * EPSON |
kenjiArai | 0:cdf2921959b4 | 5 | * |
kenjiArai | 2:ce49c4ba4c02 | 6 | * Copyright (c) 2015,'16 Kenji Arai / JH1PJL |
kenjiArai | 0:cdf2921959b4 | 7 | * http://www.page.sannet.ne.jp/kenjia/index.html |
kenjiArai | 0:cdf2921959b4 | 8 | * http://mbed.org/users/kenjiArai/ |
kenjiArai | 0:cdf2921959b4 | 9 | * Created: June 3rd, 2015 |
kenjiArai | 4:d8ce59684dfa | 10 | * Revised: May 5th, 2016 |
kenjiArai | 0:cdf2921959b4 | 11 | * |
kenjiArai | 0:cdf2921959b4 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, |
kenjiArai | 0:cdf2921959b4 | 13 | * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE |
kenjiArai | 0:cdf2921959b4 | 14 | * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
kenjiArai | 0:cdf2921959b4 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
kenjiArai | 0:cdf2921959b4 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
kenjiArai | 0:cdf2921959b4 | 17 | */ |
kenjiArai | 3:d59c12d14ca9 | 18 | |
kenjiArai | 0:cdf2921959b4 | 19 | /* |
kenjiArai | 0:cdf2921959b4 | 20 | *---------------- REFERENCE ---------------------------------------------------------------------- |
kenjiArai | 0:cdf2921959b4 | 21 | * Original Information |
kenjiArai | 0:cdf2921959b4 | 22 | * http://www.epsondevice.com/docs/qd/ja/DownloadServlet?id=ID000515 |
kenjiArai | 0:cdf2921959b4 | 23 | * Sensor board |
kenjiArai | 2:ce49c4ba4c02 | 24 | * http://www5.epsondevice.com/ja/products/i2c/rx8025sa.html |
kenjiArai | 0:cdf2921959b4 | 25 | */ |
kenjiArai | 0:cdf2921959b4 | 26 | |
kenjiArai | 0:cdf2921959b4 | 27 | #ifndef RX8025_H |
kenjiArai | 0:cdf2921959b4 | 28 | #define RX8025_H |
kenjiArai | 0:cdf2921959b4 | 29 | |
kenjiArai | 0:cdf2921959b4 | 30 | #include "mbed.h" |
kenjiArai | 0:cdf2921959b4 | 31 | |
kenjiArai | 0:cdf2921959b4 | 32 | // RTC EPSON RX8025 |
kenjiArai | 2:ce49c4ba4c02 | 33 | // 7bit address = 0b0110010(No other choice) |
kenjiArai | 0:cdf2921959b4 | 34 | #define RX8025ADDR (0x32 << 1) |
kenjiArai | 0:cdf2921959b4 | 35 | |
kenjiArai | 0:cdf2921959b4 | 36 | #define RTC_Wk_Sunday ((uint8_t)0x00) |
kenjiArai | 0:cdf2921959b4 | 37 | #define RTC_Wk_Monday ((uint8_t)0x01) |
kenjiArai | 0:cdf2921959b4 | 38 | #define RTC_Wk_Tuesday ((uint8_t)0x02) |
kenjiArai | 0:cdf2921959b4 | 39 | #define RTC_Wk_Wednesday ((uint8_t)0x03) |
kenjiArai | 0:cdf2921959b4 | 40 | #define RTC_Wk_Thursday ((uint8_t)0x04) |
kenjiArai | 0:cdf2921959b4 | 41 | #define RTC_Wk_Friday ((uint8_t)0x05) |
kenjiArai | 0:cdf2921959b4 | 42 | #define RTC_Wk_Saturday ((uint8_t)0x06) |
kenjiArai | 0:cdf2921959b4 | 43 | |
kenjiArai | 0:cdf2921959b4 | 44 | // Register definition |
kenjiArai | 4:d8ce59684dfa | 45 | #define RX8025_REG_SEC 0x0 |
kenjiArai | 4:d8ce59684dfa | 46 | #define RX8025_REG_MIN 0x1 |
kenjiArai | 4:d8ce59684dfa | 47 | #define RX8025_REG_HOUR 0x2 |
kenjiArai | 4:d8ce59684dfa | 48 | #define RX8025_REG_WDAY 0x3 |
kenjiArai | 4:d8ce59684dfa | 49 | #define RX8025_REG_DAY 0x4 |
kenjiArai | 4:d8ce59684dfa | 50 | #define RX8025_REG_MON 0x5 |
kenjiArai | 4:d8ce59684dfa | 51 | #define RX8025_REG_YEAR 0x6 |
kenjiArai | 4:d8ce59684dfa | 52 | #define RX8025_REG_OFFSET 0x7 |
kenjiArai | 4:d8ce59684dfa | 53 | #define RX8025_REG_ALARMW_MIN 0x8 |
kenjiArai | 4:d8ce59684dfa | 54 | #define RX8025_REG_ALARMW_HOUR 0x9 |
kenjiArai | 0:cdf2921959b4 | 55 | #define RX8025_REG_ALARMW_WDAY 0xa |
kenjiArai | 0:cdf2921959b4 | 56 | #define RX8025_REG_ALARMD_MIN 0xb |
kenjiArai | 0:cdf2921959b4 | 57 | #define RX8025_REG_ALARMD_HOUR 0xc |
kenjiArai | 0:cdf2921959b4 | 58 | #define RX8025_REG_RESERVED 0xd |
kenjiArai | 0:cdf2921959b4 | 59 | #define RX8025_REG_CONTL1 0xe |
kenjiArai | 0:cdf2921959b4 | 60 | #define RX8025_REG_CONTL2 0xf |
kenjiArai | 0:cdf2921959b4 | 61 | |
kenjiArai | 0:cdf2921959b4 | 62 | // Buffer size |
kenjiArai | 0:cdf2921959b4 | 63 | #define RTC_BUF_SIZ (RX8025_REG_CONTL2 + 5) |
kenjiArai | 0:cdf2921959b4 | 64 | |
kenjiArai | 0:cdf2921959b4 | 65 | /** Interface for RTC (I2C Interface) EPSON RX8025 |
kenjiArai | 0:cdf2921959b4 | 66 | * |
kenjiArai | 0:cdf2921959b4 | 67 | * Standalone type RTC via I2C interface |
kenjiArai | 0:cdf2921959b4 | 68 | * |
kenjiArai | 0:cdf2921959b4 | 69 | * @code |
kenjiArai | 0:cdf2921959b4 | 70 | * #include "mbed.h" |
kenjiArai | 0:cdf2921959b4 | 71 | * |
kenjiArai | 0:cdf2921959b4 | 72 | * // I2C Communication |
kenjiArai | 0:cdf2921959b4 | 73 | * RX8025 RX8025(dp5,dp27); // RTC(RX8025) SDA, SCL (Fixed address) |
kenjiArai | 0:cdf2921959b4 | 74 | * // If you connected I2C line not only this device but also other devices, |
kenjiArai | 0:cdf2921959b4 | 75 | * // you need to declare following method. |
kenjiArai | 0:cdf2921959b4 | 76 | * I2C i2c(dp5,dp27); // SDA, SCL |
kenjiArai | 0:cdf2921959b4 | 77 | * RX8025 RX8025(i2c); // RTC(RX8025) (Fixed address) |
kenjiArai | 0:cdf2921959b4 | 78 | * |
kenjiArai | 0:cdf2921959b4 | 79 | * int main() { |
kenjiArai | 0:cdf2921959b4 | 80 | * tm t; |
kenjiArai | 0:cdf2921959b4 | 81 | * time_t seconds; |
kenjiArai | 0:cdf2921959b4 | 82 | * char buf[40]; |
kenjiArai | 0:cdf2921959b4 | 83 | * |
kenjiArai | 2:ce49c4ba4c02 | 84 | * while(1){ |
kenjiArai | 2:ce49c4ba4c02 | 85 | * RX8025.get_time_rtc(&t); // read RTC data |
kenjiArai | 2:ce49c4ba4c02 | 86 | * seconds = mktime(&t); |
kenjiArai | 2:ce49c4ba4c02 | 87 | * strftime(buf, 40, "%I:%M:%S %p (%Y/%m/%d)", localtime(&seconds)); |
kenjiArai | 2:ce49c4ba4c02 | 88 | * printf("Date: %s\r\n", buf); |
kenjiArai | 2:ce49c4ba4c02 | 89 | * } |
kenjiArai | 0:cdf2921959b4 | 90 | * } |
kenjiArai | 0:cdf2921959b4 | 91 | * @endcode |
kenjiArai | 0:cdf2921959b4 | 92 | */ |
kenjiArai | 0:cdf2921959b4 | 93 | |
kenjiArai | 0:cdf2921959b4 | 94 | class RX8025 |
kenjiArai | 0:cdf2921959b4 | 95 | { |
kenjiArai | 0:cdf2921959b4 | 96 | public: |
kenjiArai | 0:cdf2921959b4 | 97 | |
kenjiArai | 0:cdf2921959b4 | 98 | typedef struct { // BCD format |
kenjiArai | 0:cdf2921959b4 | 99 | uint8_t rtc_seconds; |
kenjiArai | 0:cdf2921959b4 | 100 | uint8_t rtc_minutes; |
kenjiArai | 0:cdf2921959b4 | 101 | uint8_t rtc_hours; |
kenjiArai | 0:cdf2921959b4 | 102 | uint8_t rtc_weekday; |
kenjiArai | 0:cdf2921959b4 | 103 | uint8_t rtc_date; |
kenjiArai | 0:cdf2921959b4 | 104 | uint8_t rtc_month; |
kenjiArai | 0:cdf2921959b4 | 105 | uint8_t rtc_year_raw; |
kenjiArai | 0:cdf2921959b4 | 106 | uint16_t rtc_year; |
kenjiArai | 0:cdf2921959b4 | 107 | } rtc_time; |
kenjiArai | 0:cdf2921959b4 | 108 | |
kenjiArai | 0:cdf2921959b4 | 109 | /** Configure data pin |
kenjiArai | 0:cdf2921959b4 | 110 | * @param data SDA and SCL pins |
kenjiArai | 0:cdf2921959b4 | 111 | */ |
kenjiArai | 0:cdf2921959b4 | 112 | RX8025(PinName p_sda, PinName p_scl); |
kenjiArai | 0:cdf2921959b4 | 113 | |
kenjiArai | 0:cdf2921959b4 | 114 | /** Configure data pin (with other devices on I2C line) |
kenjiArai | 0:cdf2921959b4 | 115 | * @param I2C previous definition |
kenjiArai | 0:cdf2921959b4 | 116 | */ |
kenjiArai | 0:cdf2921959b4 | 117 | RX8025(I2C& p_i2c); |
kenjiArai | 0:cdf2921959b4 | 118 | |
kenjiArai | 0:cdf2921959b4 | 119 | /** Read RTC data with Standard C "struct tm" format |
kenjiArai | 0:cdf2921959b4 | 120 | * @param tm (data save area) |
kenjiArai | 0:cdf2921959b4 | 121 | * @return none but all data in tm |
kenjiArai | 0:cdf2921959b4 | 122 | */ |
kenjiArai | 0:cdf2921959b4 | 123 | void read_rtc_std(tm *); |
kenjiArai | 0:cdf2921959b4 | 124 | void get_time_rtc(tm *); |
kenjiArai | 0:cdf2921959b4 | 125 | |
kenjiArai | 0:cdf2921959b4 | 126 | /** Write data to RTC data with Standard C "struct tm" format |
kenjiArai | 0:cdf2921959b4 | 127 | * @param tm (save writing data) |
kenjiArai | 0:cdf2921959b4 | 128 | * @return none but all data in tm |
kenjiArai | 0:cdf2921959b4 | 129 | */ |
kenjiArai | 0:cdf2921959b4 | 130 | void write_rtc_std(tm *); |
kenjiArai | 0:cdf2921959b4 | 131 | void set_time_rtc(tm *); |
kenjiArai | 0:cdf2921959b4 | 132 | |
kenjiArai | 2:ce49c4ba4c02 | 133 | /** Set Alarm-D / INTA time |
kenjiArai | 4:d8ce59684dfa | 134 | * @param next time (unit: minutes) from now on minimum = 2 minutes!! |
kenjiArai | 2:ce49c4ba4c02 | 135 | * @return none |
kenjiArai | 2:ce49c4ba4c02 | 136 | */ |
kenjiArai | 2:ce49c4ba4c02 | 137 | void set_next_alarmD_INTA(uint16_t time); |
kenjiArai | 2:ce49c4ba4c02 | 138 | |
kenjiArai | 2:ce49c4ba4c02 | 139 | /** Clear Alarm-D / INTA interrupt |
kenjiArai | 2:ce49c4ba4c02 | 140 | * @param none |
kenjiArai | 2:ce49c4ba4c02 | 141 | * @return none |
kenjiArai | 2:ce49c4ba4c02 | 142 | */ |
kenjiArai | 2:ce49c4ba4c02 | 143 | void clear_alarmD_INTA(void); |
kenjiArai | 2:ce49c4ba4c02 | 144 | |
kenjiArai | 0:cdf2921959b4 | 145 | /** Read one byte from specific register |
kenjiArai | 0:cdf2921959b4 | 146 | * @param register address |
kenjiArai | 0:cdf2921959b4 | 147 | * @return register data |
kenjiArai | 0:cdf2921959b4 | 148 | */ |
kenjiArai | 0:cdf2921959b4 | 149 | uint8_t read_reg_byte(uint8_t reg); |
kenjiArai | 0:cdf2921959b4 | 150 | |
kenjiArai | 0:cdf2921959b4 | 151 | /** Write one byte into specific register |
kenjiArai | 0:cdf2921959b4 | 152 | * @param register address, data |
kenjiArai | 0:cdf2921959b4 | 153 | * @return register saved data |
kenjiArai | 0:cdf2921959b4 | 154 | */ |
kenjiArai | 0:cdf2921959b4 | 155 | uint8_t write_reg_byte(uint8_t reg, uint8_t data); |
kenjiArai | 0:cdf2921959b4 | 156 | |
kenjiArai | 0:cdf2921959b4 | 157 | /** Read RTC data with own format |
kenjiArai | 0:cdf2921959b4 | 158 | * @param tm (data save area) |
kenjiArai | 0:cdf2921959b4 | 159 | * @return none but all data in tm |
kenjiArai | 0:cdf2921959b4 | 160 | */ |
kenjiArai | 0:cdf2921959b4 | 161 | void read_rtc_direct(rtc_time *); |
kenjiArai | 0:cdf2921959b4 | 162 | |
kenjiArai | 0:cdf2921959b4 | 163 | /** Read RTC data with own format |
kenjiArai | 0:cdf2921959b4 | 164 | * @param tm (save writing data) |
kenjiArai | 0:cdf2921959b4 | 165 | * @return none but all data in tm |
kenjiArai | 0:cdf2921959b4 | 166 | */ |
kenjiArai | 0:cdf2921959b4 | 167 | void write_rtc_direct(rtc_time *); |
kenjiArai | 0:cdf2921959b4 | 168 | |
kenjiArai | 0:cdf2921959b4 | 169 | /** Set I2C clock frequency |
kenjiArai | 0:cdf2921959b4 | 170 | * @param freq. |
kenjiArai | 0:cdf2921959b4 | 171 | * @return none |
kenjiArai | 0:cdf2921959b4 | 172 | */ |
kenjiArai | 0:cdf2921959b4 | 173 | void frequency(int hz); |
kenjiArai | 0:cdf2921959b4 | 174 | |
kenjiArai | 0:cdf2921959b4 | 175 | protected: |
kenjiArai | 2:ce49c4ba4c02 | 176 | I2C _i2c; |
kenjiArai | 2:ce49c4ba4c02 | 177 | |
kenjiArai | 0:cdf2921959b4 | 178 | uint8_t bin2bcd(uint8_t); |
kenjiArai | 0:cdf2921959b4 | 179 | uint8_t bcd2bin(uint8_t); |
kenjiArai | 4:d8ce59684dfa | 180 | uint8_t set_alarmD_reg (uint16_t time); |
kenjiArai | 1:817e81048235 | 181 | void init(void); |
kenjiArai | 0:cdf2921959b4 | 182 | |
kenjiArai | 0:cdf2921959b4 | 183 | private: |
kenjiArai | 0:cdf2921959b4 | 184 | uint8_t RX8025_addr; |
kenjiArai | 2:ce49c4ba4c02 | 185 | char rtc_buf[RTC_BUF_SIZ]; // buffer for RTC |
kenjiArai | 0:cdf2921959b4 | 186 | }; |
kenjiArai | 0:cdf2921959b4 | 187 | |
kenjiArai | 0:cdf2921959b4 | 188 | #endif // RX8025_H |