├── .codespellrc ├── library.properties ├── .github ├── dependabot.yml └── workflows │ ├── spell-check.yml │ ├── check-arduino.yml │ ├── report-size-deltas.yml │ ├── compile-examples.yml │ └── sync-labels.yml ├── README.adoc ├── examples ├── SimpleRTCAlarm │ └── SimpleRTCAlarm.ino ├── Epoch │ └── Epoch.ino ├── SleepRTCAlarm │ └── SleepRTCAlarm.ino └── SimpleRTC │ └── SimpleRTC.ino ├── keywords.txt ├── docs ├── readme.md └── api.md ├── src ├── RTCZero.h └── RTCZero.cpp └── LICENSE.txt /.codespellrc: -------------------------------------------------------------------------------- 1 | # See: https://github.com/codespell-project/codespell#using-a-config-file 2 | [codespell] 3 | # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: 4 | ignore-words-list = , 5 | check-filenames = 6 | check-hidden = 7 | skip = ./.git 8 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=RTCZero 2 | version=1.6.0 3 | author=Arduino 4 | maintainer=Arduino 5 | sentence=Allows using the RTC functionalities. For Arduino Zero, MKRZero and MKR1000 only. 6 | paragraph=With this library you can use the RTC peripheral of an Arduino Zero or MKR1000 in order to program actions related to date and time. 7 | category=Timing 8 | url=http://www.arduino.cc/en/Reference/RTC 9 | architectures=samd 10 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file 2 | version: 2 3 | 4 | updates: 5 | # Configure check for outdated GitHub Actions actions in workflows. 6 | # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot 7 | - package-ecosystem: github-actions 8 | directory: / # Check the repository's workflows under /.github/workflows/ 9 | schedule: 10 | interval: daily 11 | -------------------------------------------------------------------------------- /.github/workflows/spell-check.yml: -------------------------------------------------------------------------------- 1 | name: Spell Check 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | spellcheck: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v6 20 | 21 | - name: Spell check 22 | uses: codespell-project/actions-codespell@master 23 | -------------------------------------------------------------------------------- /.github/workflows/check-arduino.yml: -------------------------------------------------------------------------------- 1 | name: Check Arduino 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | lint: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v6 20 | 21 | - name: Arduino Lint 22 | uses: arduino/arduino-lint-action@v2 23 | with: 24 | compliance: specification 25 | library-manager: update 26 | # Always use this setting for official repositories. Remove for 3rd party projects. 27 | official: true 28 | project-type: library 29 | -------------------------------------------------------------------------------- /.github/workflows/report-size-deltas.yml: -------------------------------------------------------------------------------- 1 | name: Report Size Deltas 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/report-size-deltas.yml" 8 | schedule: 9 | # Run at the minimum interval allowed by GitHub Actions. 10 | # Note: GitHub Actions periodically has outages which result in workflow failures. 11 | # In this event, the workflows will start passing again once the service recovers. 12 | - cron: "*/5 * * * *" 13 | workflow_dispatch: 14 | repository_dispatch: 15 | 16 | jobs: 17 | report: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - name: Comment size deltas reports to PRs 21 | uses: arduino/report-size-deltas@v1 22 | with: 23 | # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow 24 | sketches-reports-source: ^sketches-report-.+ 25 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | :repository-owner: arduino-libraries 2 | :repository-name: RTCZero 3 | 4 | = {repository-name} Library for Arduino = 5 | 6 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] 7 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] 8 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] 9 | 10 | The RTCZero library enables an Arduino Zero or MKR1000 board to take control of the internal RTC. 11 | 12 | For more information about this library please visit us at 13 | http://arduino.cc/en/Reference/RTC 14 | -------------------------------------------------------------------------------- /examples/SimpleRTCAlarm/SimpleRTCAlarm.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Simple RTC Alarm for Arduino Zero and MKR1000 3 | 4 | Demonstrates how to set an RTC alarm for the Arduino Zero and MKR1000 5 | 6 | This example code is in the public domain 7 | 8 | http://arduino.cc/en/Tutorial/SimpleRTCAlarm 9 | 10 | created by Arturo Guadalupi 11 | 25 Sept 2015 12 | 13 | modified 14 | 21 Oct 2015 15 | */ 16 | 17 | #include 18 | 19 | /* Create an RTCZero object */ 20 | RTCZero rtc; 21 | 22 | /* Change these values to set the current initial time */ 23 | const byte seconds = 0; 24 | const byte minutes = 0; 25 | const byte hours = 16; 26 | 27 | /* Change these values to set the current initial date */ 28 | const byte day = 25; 29 | const byte month = 9; 30 | const byte year = 15; 31 | 32 | void setup() 33 | { 34 | Serial.begin(9600); 35 | 36 | rtc.begin(); // initialize RTC 24H format 37 | 38 | rtc.setTime(hours, minutes, seconds); 39 | rtc.setDate(day, month, year); 40 | 41 | rtc.setAlarmTime(16, 0, 10); 42 | rtc.enableAlarm(rtc.MATCH_HHMMSS); 43 | 44 | rtc.attachInterrupt(alarmMatch); 45 | } 46 | 47 | void loop() 48 | { 49 | 50 | } 51 | 52 | void alarmMatch() 53 | { 54 | Serial.println("Alarm Match!"); 55 | } 56 | -------------------------------------------------------------------------------- /examples/Epoch/Epoch.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Epoch time example for Arduino Zero and MKR1000 3 | 4 | Demonstrates how to set time using epoch for the Arduino Zero and MKR1000 5 | 6 | This example code is in the public domain 7 | 8 | created by Sandeep Mistry 9 | 31 Dec 2015 10 | modified 11 | 18 Feb 2016 12 | */ 13 | 14 | #include 15 | 16 | /* Create an RTCZero object */ 17 | RTCZero rtc; 18 | 19 | void setup() { 20 | Serial.begin(9600); 21 | 22 | rtc.begin(); // initialize RTC 23 | 24 | rtc.setEpoch(1451606400); // Jan 1, 2016 25 | } 26 | 27 | void loop() { 28 | Serial.print("Unix time = "); 29 | Serial.println(rtc.getEpoch()); 30 | 31 | Serial.print("Seconds since Jan 1 2000 = "); 32 | Serial.println(rtc.getY2kEpoch()); 33 | 34 | // Print date... 35 | Serial.print(rtc.getDay()); 36 | Serial.print("/"); 37 | Serial.print(rtc.getMonth()); 38 | Serial.print("/"); 39 | Serial.print(rtc.getYear()); 40 | Serial.print("\t"); 41 | 42 | // ...and time 43 | print2digits(rtc.getHours()); 44 | Serial.print(":"); 45 | print2digits(rtc.getMinutes()); 46 | Serial.print(":"); 47 | print2digits(rtc.getSeconds()); 48 | 49 | Serial.println(); 50 | 51 | delay(1000); 52 | } 53 | 54 | void print2digits(int number) { 55 | if (number < 10) { 56 | Serial.print("0"); 57 | } 58 | Serial.print(number); 59 | } 60 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map For RTCZero 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | RTCZero KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | 15 | getDay KEYWORD2 16 | getMonth KEYWORD2 17 | getYear KEYWORD2 18 | getHours KEYWORD2 19 | getMinutes KEYWORD2 20 | getSeconds KEYWORD2 21 | 22 | setDay KEYWORD2 23 | setMonth KEYWORD2 24 | setYear KEYWORD2 25 | setHours KEYWORD2 26 | setMinutes KEYWORD2 27 | setSeconds KEYWORD2 28 | setDate KEYWORD2 29 | setTime KEYWORD2 30 | 31 | getEpoch KEYWORD2 32 | getY2kEpoch KEYWORD2 33 | setEpoch KEYWORD2 34 | setY2kEpoch KEYWORD2 35 | 36 | getAlarmDay KEYWORD2 37 | getAlarmMonth KEYWORD2 38 | getAlarmYear KEYWORD2 39 | getAlarmHours KEYWORD2 40 | getAlarmMinutes KEYWORD2 41 | getAlarmSeconds KEYWORD2 42 | 43 | setAlarmDay KEYWORD2 44 | setAlarmMonth KEYWORD2 45 | setAlarmYear KEYWORD2 46 | setAlarmHours KEYWORD2 47 | setAlarmMinutes KEYWORD2 48 | setAlarmSeconds KEYWORD2 49 | setAlarmDate KEYWORD2 50 | setAlarmTime KEYWORD2 51 | 52 | enableAlarm KEYWORD2 53 | disableAlarm KEYWORD2 54 | 55 | standbyMode KEYWORD2 56 | 57 | ####################################### 58 | # Constants (LITERAL1) 59 | ####################################### 60 | -------------------------------------------------------------------------------- /docs/readme.md: -------------------------------------------------------------------------------- 1 | # RTC Library 2 | 3 | This library allows an enables an Arduino based on SAMD architectures (es. [Zero](), [MKRZero]() or [MKR1000]() Board) to control and use the internal RTC (Real Time Clock). A real-time clock is a clock that keeps track of the current time and that can be used in order to program actions at a certain time. Most RTCs use a crystal oscillator (like in the Arduino Zero) whose frequency is 32.768 kHz (same frequency used in quartz clocks and watches). Namely this the frequency equal to 2^15 cycles per second and so is a convenient rate to use with simple binary counter circuits. Furthermore the RTC can continue to operate in any sleep mode, so it can be used to wake up the device from sleep modes in a programmed way. Every time the board is powered, the RTC is reset and starts from a standard date. To keep the time and the RTC running it is necessary to keep the board powered. A button sized lithium battery or any battery in the 3V range, connected through a diode to the 3.3V pin, is enough to keep RTC alive if the CPU is put in sleep mode before the standard USB or VIN power is disconnected. 4 | 5 | To use this library 6 | 7 | ``` arduino 8 | #include 9 | ``` 10 | 11 | ## Examples 12 | 13 | - [Simple RTC]() 14 | - [Simple RTC Alarm]() 15 | - [Sleep RTC Alarm]() 16 | -------------------------------------------------------------------------------- /examples/SleepRTCAlarm/SleepRTCAlarm.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Sleep RTC Alarm for Arduino Zero 3 | 4 | Demonstrates the use of an alarm to wake up an Arduino Zero from Standby mode 5 | 6 | This example code is in the public domain 7 | 8 | http://arduino.cc/en/Tutorial/SleepRTCAlarm 9 | 10 | created by Arturo Guadalupi 11 | 17 Nov 2015 12 | modified 13 | 01 Mar 2016 14 | 15 | NOTE: 16 | If you use this sketch with a MKR1000 you will see no output on the serial monitor. 17 | This happens because the USB clock is stopped so the USB connection is stopped too. 18 | **To see again the USB port you have to double tap on the reset button!** 19 | */ 20 | 21 | #include 22 | 23 | /* Create an RTCZero object */ 24 | RTCZero rtc; 25 | 26 | /* Change these values to set the current initial time */ 27 | const byte seconds = 0; 28 | const byte minutes = 00; 29 | const byte hours = 17; 30 | 31 | /* Change these values to set the current initial date */ 32 | const byte day = 17; 33 | const byte month = 11; 34 | const byte year = 15; 35 | 36 | void setup() 37 | { 38 | pinMode(LED_BUILTIN, OUTPUT); 39 | digitalWrite(LED_BUILTIN, LOW); 40 | 41 | rtc.begin(); 42 | 43 | rtc.setTime(hours, minutes, seconds); 44 | rtc.setDate(day, month, year); 45 | 46 | rtc.setAlarmTime(17, 00, 10); 47 | rtc.enableAlarm(rtc.MATCH_HHMMSS); 48 | 49 | rtc.attachInterrupt(alarmMatch); 50 | 51 | rtc.standbyMode(); 52 | } 53 | 54 | void loop() 55 | { 56 | rtc.standbyMode(); // Sleep until next alarm match 57 | } 58 | 59 | void alarmMatch() 60 | { 61 | digitalWrite(LED_BUILTIN, HIGH); 62 | } 63 | -------------------------------------------------------------------------------- /examples/SimpleRTC/SimpleRTC.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Simple RTC for Arduino Zero and MKR1000 3 | 4 | Demonstrates the use of the RTC library for the Arduino Zero and MKR1000 5 | 6 | This example code is in the public domain 7 | 8 | http://arduino.cc/en/Tutorial/SimpleRTC 9 | 10 | created by Arturo Guadalupi 11 | 15 Jun 2015 12 | modified 13 | 18 Feb 2016 14 | modified by Andrea Richetta 15 | 24 Aug 2016 16 | */ 17 | 18 | #include 19 | 20 | /* Create an RTCZero object */ 21 | RTCZero rtc; 22 | 23 | /* Change these values to set the current initial time */ 24 | const byte seconds = 0; 25 | const byte minutes = 0; 26 | const byte hours = 16; 27 | 28 | /* Change these values to set the current initial date */ 29 | const byte day = 15; 30 | const byte month = 6; 31 | const byte year = 15; 32 | 33 | void setup() 34 | { 35 | Serial.begin(9600); 36 | 37 | rtc.begin(); // initialize RTC 38 | 39 | // Set the time 40 | rtc.setHours(hours); 41 | rtc.setMinutes(minutes); 42 | rtc.setSeconds(seconds); 43 | 44 | // Set the date 45 | rtc.setDay(day); 46 | rtc.setMonth(month); 47 | rtc.setYear(year); 48 | 49 | // you can use also 50 | //rtc.setTime(hours, minutes, seconds); 51 | //rtc.setDate(day, month, year); 52 | } 53 | 54 | void loop() 55 | { 56 | // Print date... 57 | print2digits(rtc.getDay()); 58 | Serial.print("/"); 59 | print2digits(rtc.getMonth()); 60 | Serial.print("/"); 61 | print2digits(rtc.getYear()); 62 | Serial.print(" "); 63 | 64 | // ...and time 65 | print2digits(rtc.getHours()); 66 | Serial.print(":"); 67 | print2digits(rtc.getMinutes()); 68 | Serial.print(":"); 69 | print2digits(rtc.getSeconds()); 70 | 71 | Serial.println(); 72 | 73 | delay(1000); 74 | } 75 | 76 | 77 | 78 | void print2digits(int number) { 79 | if (number < 10) { 80 | Serial.print("0"); // print a 0 before if the number is < than 10 81 | } 82 | Serial.print(number); 83 | } -------------------------------------------------------------------------------- /src/RTCZero.h: -------------------------------------------------------------------------------- 1 | /* 2 | RTC library for Arduino Zero. 3 | Copyright (c) 2015 Arduino LLC. All right reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU Lesser General Public 16 | License along with this library; if not, write to the Free Software 17 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 18 | */ 19 | 20 | #ifndef RTC_ZERO_H 21 | #define RTC_ZERO_H 22 | 23 | #include "Arduino.h" 24 | 25 | typedef void(*voidFuncPtr)(void); 26 | 27 | class RTCZero { 28 | public: 29 | 30 | enum Alarm_Match: uint8_t // Should we have this enum or just use the identifiers from /component/rtc.h ? 31 | { 32 | MATCH_OFF = RTC_MODE2_MASK_SEL_OFF_Val, // Never 33 | MATCH_SS = RTC_MODE2_MASK_SEL_SS_Val, // Every Minute 34 | MATCH_MMSS = RTC_MODE2_MASK_SEL_MMSS_Val, // Every Hour 35 | MATCH_HHMMSS = RTC_MODE2_MASK_SEL_HHMMSS_Val, // Every Day 36 | MATCH_DHHMMSS = RTC_MODE2_MASK_SEL_DDHHMMSS_Val, // Every Month 37 | MATCH_MMDDHHMMSS = RTC_MODE2_MASK_SEL_MMDDHHMMSS_Val, // Every Year 38 | MATCH_YYMMDDHHMMSS = RTC_MODE2_MASK_SEL_YYMMDDHHMMSS_Val // Once, on a specific date and a specific time 39 | }; 40 | 41 | RTCZero(); 42 | void begin(bool resetTime = false); 43 | 44 | void enableAlarm(Alarm_Match match); 45 | void disableAlarm(); 46 | 47 | void attachInterrupt(voidFuncPtr callback); 48 | void detachInterrupt(); 49 | 50 | void standbyMode(); 51 | 52 | /* Get Functions */ 53 | 54 | uint8_t getSeconds(); 55 | uint8_t getMinutes(); 56 | uint8_t getHours(); 57 | 58 | uint8_t getDay(); 59 | uint8_t getMonth(); 60 | uint8_t getYear(); 61 | 62 | uint8_t getAlarmSeconds(); 63 | uint8_t getAlarmMinutes(); 64 | uint8_t getAlarmHours(); 65 | 66 | uint8_t getAlarmDay(); 67 | uint8_t getAlarmMonth(); 68 | uint8_t getAlarmYear(); 69 | 70 | /* Set Functions */ 71 | 72 | void setSeconds(uint8_t seconds); 73 | void setMinutes(uint8_t minutes); 74 | void setHours(uint8_t hours); 75 | void setTime(uint8_t hours, uint8_t minutes, uint8_t seconds); 76 | 77 | void setDay(uint8_t day); 78 | void setMonth(uint8_t month); 79 | void setYear(uint8_t year); 80 | void setDate(uint8_t day, uint8_t month, uint8_t year); 81 | 82 | void setAlarmSeconds(uint8_t seconds); 83 | void setAlarmMinutes(uint8_t minutes); 84 | void setAlarmHours(uint8_t hours); 85 | void setAlarmTime(uint8_t hours, uint8_t minutes, uint8_t seconds); 86 | 87 | void setAlarmDay(uint8_t day); 88 | void setAlarmMonth(uint8_t month); 89 | void setAlarmYear(uint8_t year); 90 | void setAlarmDate(uint8_t day, uint8_t month, uint8_t year); 91 | 92 | /* Epoch Functions */ 93 | 94 | time_t getEpoch(); 95 | uint32_t getY2kEpoch(); 96 | void setEpoch(uint32_t ts); 97 | void setY2kEpoch(uint32_t ts); 98 | void setAlarmEpoch(uint32_t ts); 99 | 100 | bool isConfigured() { 101 | return _configured; 102 | } 103 | 104 | private: 105 | bool _configured; 106 | 107 | void config32kOSC(void); 108 | void configureClock(void); 109 | void RTCreadRequest(); 110 | bool RTCisSyncing(void); 111 | void RTCdisable(); 112 | void RTCenable(); 113 | void RTCreset(); 114 | void RTCresetRemove(); 115 | }; 116 | 117 | #endif // RTC_ZERO_H 118 | -------------------------------------------------------------------------------- /.github/workflows/compile-examples.yml: -------------------------------------------------------------------------------- 1 | name: Compile Examples 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/compile-examples.yml" 8 | - "examples/**" 9 | - "src/**" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/compile-examples.yml" 13 | - "examples/**" 14 | - "src/**" 15 | schedule: 16 | # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms). 17 | - cron: "0 8 * * TUE" 18 | workflow_dispatch: 19 | repository_dispatch: 20 | 21 | jobs: 22 | build: 23 | name: ${{ matrix.board.fqbn }} 24 | runs-on: ubuntu-latest 25 | 26 | env: 27 | SKETCHES_REPORTS_PATH: sketches-reports 28 | 29 | strategy: 30 | fail-fast: false 31 | 32 | matrix: 33 | board: 34 | - fqbn: arduino:samd:arduino_zero_edbg 35 | platforms: | 36 | - name: arduino:samd 37 | artifact-name-suffix: arduino-samd-arduino_zero_edbg 38 | - fqbn: arduino:samd:mkr1000 39 | platforms: | 40 | - name: arduino:samd 41 | artifact-name-suffix: arduino-samd-mkr1000 42 | - fqbn: arduino:samd:mkrzero 43 | platforms: | 44 | - name: arduino:samd 45 | artifact-name-suffix: arduino-samd-mkrzero 46 | - fqbn: arduino:samd:mkrwifi1010 47 | platforms: | 48 | - name: arduino:samd 49 | artifact-name-suffix: arduino-samd-mkrwifi1010 50 | - fqbn: arduino:samd:mkrfox1200 51 | platforms: | 52 | - name: arduino:samd 53 | artifact-name-suffix: arduino-samd-mkrfox1200 54 | - fqbn: arduino:samd:mkrwan1300 55 | platforms: | 56 | - name: arduino:samd 57 | artifact-name-suffix: arduino-samd-mkrwan1300 58 | - fqbn: arduino:samd:mkrwan1310 59 | platforms: | 60 | - name: arduino:samd 61 | artifact-name-suffix: arduino-samd-mkrwan1310 62 | - fqbn: arduino:samd:mkrgsm1400 63 | platforms: | 64 | - name: arduino:samd 65 | artifact-name-suffix: arduino-samd-mkrgsm1400 66 | - fqbn: arduino:samd:mkrnb1500 67 | platforms: | 68 | - name: arduino:samd 69 | artifact-name-suffix: arduino-samd-mkrnb1500 70 | - fqbn: arduino:samd:mkrvidor4000 71 | platforms: | 72 | - name: arduino:samd 73 | artifact-name-suffix: arduino-samd-mkrvidor4000 74 | - fqbn: arduino:samd:nano_33_iot 75 | platforms: | 76 | - name: arduino:samd 77 | artifact-name-suffix: arduino-samd-nano_33_iot 78 | 79 | steps: 80 | - name: Checkout repository 81 | uses: actions/checkout@v6 82 | 83 | - name: Compile examples 84 | uses: arduino/compile-sketches@v1 85 | with: 86 | github-token: ${{ secrets.GITHUB_TOKEN }} 87 | fqbn: ${{ matrix.board.fqbn }} 88 | platforms: ${{ matrix.board.platforms }} 89 | libraries: | 90 | # Install the library from the local path. 91 | - source-path: ./ 92 | # Additional library dependencies can be listed here. 93 | # See: https://github.com/arduino/compile-sketches#libraries 94 | sketch-paths: | 95 | - examples 96 | enable-deltas-report: true 97 | sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} 98 | 99 | - name: Save sketches report as workflow artifact 100 | uses: actions/upload-artifact@v6 101 | with: 102 | if-no-files-found: error 103 | path: ${{ env.SKETCHES_REPORTS_PATH }} 104 | name: sketches-report-${{ matrix.board.artifact-name-suffix }} 105 | -------------------------------------------------------------------------------- /.github/workflows/sync-labels.yml: -------------------------------------------------------------------------------- 1 | # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md 2 | name: Sync Labels 3 | 4 | # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows 5 | on: 6 | push: 7 | paths: 8 | - ".github/workflows/sync-labels.ya?ml" 9 | - ".github/label-configuration-files/*.ya?ml" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/sync-labels.ya?ml" 13 | - ".github/label-configuration-files/*.ya?ml" 14 | schedule: 15 | # Run daily at 8 AM UTC to sync with changes to shared label configurations. 16 | - cron: "0 8 * * *" 17 | workflow_dispatch: 18 | repository_dispatch: 19 | 20 | env: 21 | CONFIGURATIONS_FOLDER: .github/label-configuration-files 22 | CONFIGURATIONS_ARTIFACT: label-configuration-files 23 | 24 | jobs: 25 | check: 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - name: Checkout repository 30 | uses: actions/checkout@v6 31 | 32 | - name: Download JSON schema for labels configuration file 33 | id: download-schema 34 | uses: carlosperate/download-file-action@v2 35 | with: 36 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json 37 | location: ${{ runner.temp }}/label-configuration-schema 38 | 39 | - name: Install JSON schema validator 40 | run: | 41 | sudo npm install \ 42 | --global \ 43 | ajv-cli \ 44 | ajv-formats 45 | 46 | - name: Validate local labels configuration 47 | run: | 48 | # See: https://github.com/ajv-validator/ajv-cli#readme 49 | ajv validate \ 50 | --all-errors \ 51 | -c ajv-formats \ 52 | -s "${{ steps.download-schema.outputs.file-path }}" \ 53 | -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" 54 | 55 | download: 56 | needs: check 57 | runs-on: ubuntu-latest 58 | 59 | strategy: 60 | matrix: 61 | filename: 62 | # Filenames of the shared configurations to apply to the repository in addition to the local configuration. 63 | # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels 64 | - universal.yml 65 | 66 | steps: 67 | - name: Download 68 | uses: carlosperate/download-file-action@v2 69 | with: 70 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} 71 | 72 | - name: Pass configuration files to next job via workflow artifact 73 | uses: actions/upload-artifact@v6 74 | with: 75 | path: | 76 | *.yaml 77 | *.yml 78 | if-no-files-found: error 79 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 80 | 81 | sync: 82 | needs: download 83 | runs-on: ubuntu-latest 84 | 85 | steps: 86 | - name: Set environment variables 87 | run: | 88 | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable 89 | echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" 90 | 91 | - name: Determine whether to dry run 92 | id: dry-run 93 | if: > 94 | github.event_name == 'pull_request' || 95 | ( 96 | ( 97 | github.event_name == 'push' || 98 | github.event_name == 'workflow_dispatch' 99 | ) && 100 | github.ref != format('refs/heads/{0}', github.event.repository.default_branch) 101 | ) 102 | run: | 103 | # Use of this flag in the github-label-sync command will cause it to only check the validity of the 104 | # configuration. 105 | echo "::set-output name=flag::--dry-run" 106 | 107 | - name: Checkout repository 108 | uses: actions/checkout@v6 109 | 110 | - name: Download configuration files artifact 111 | uses: actions/download-artifact@v7 112 | with: 113 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 114 | path: ${{ env.CONFIGURATIONS_FOLDER }} 115 | 116 | - name: Remove unneeded artifact 117 | uses: geekyeggo/delete-artifact@v5 118 | with: 119 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 120 | 121 | - name: Merge label configuration files 122 | run: | 123 | # Merge all configuration files 124 | shopt -s extglob 125 | cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" 126 | 127 | - name: Install github-label-sync 128 | run: sudo npm install --global github-label-sync 129 | 130 | - name: Sync labels 131 | env: 132 | GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} 133 | run: | 134 | # See: https://github.com/Financial-Times/github-label-sync 135 | github-label-sync \ 136 | --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ 137 | ${{ steps.dry-run.outputs.flag }} \ 138 | ${{ github.repository }} 139 | -------------------------------------------------------------------------------- /docs/api.md: -------------------------------------------------------------------------------- 1 | # RTC Library 2 | 3 | ## Methods 4 | 5 | ### `begin()` 6 | 7 | Initializes the internal RTC. begin() needs to be called before any other RTC library methods. 8 | 9 | #### Syntax 10 | 11 | ``` arduino 12 | rtc.begin() 13 | ``` 14 | 15 | 16 | #### Parameters 17 | 18 | none 19 | 20 | ### `setHours()` 21 | 22 | Set the RTC hours value. 23 | 24 | #### Syntax 25 | 26 | ``` arduino 27 | rtc.setHours(byte hours) 28 | ``` 29 | 30 | #### Parameters 31 | 32 | - hours: the hours value to be set. 33 | 34 | ### `setMinutes()` 35 | 36 | Set the RTC minutes value. 37 | 38 | #### Syntax 39 | 40 | ``` arduino 41 | rtc.setMinutes(byte minutes) 42 | ``` 43 | 44 | #### Parameters 45 | 46 | - minutes: the minutes value to be set. 47 | 48 | ### `setSeconds()` 49 | 50 | #### Description 51 | Set the RTC seconds value. 52 | 53 | #### Syntax 54 | 55 | ``` 56 | rtc.setSeconds(byte seconds) 57 | ``` 58 | 59 | #### Parameters 60 | seconds: the seconds value to be set. 61 | 62 | 63 | ### `setTime()` 64 | 65 | Set the RTC hours, minutes and seconds. 66 | 67 | #### Syntax 68 | 69 | ``` arduino 70 | rtc.setTime(byte hours, byte minutes, byte seconds) 71 | ``` 72 | 73 | #### Parameters 74 | 75 | - hours: the hours value to be set. 76 | 77 | - minutes: the minutes value to be set. 78 | 79 | - seconds: the seconds value to be set. 80 | ### `setYear()` 81 | Set the RTC year. 82 | 83 | #### Syntax 84 | 85 | ``` arduino 86 | rtc.setYear(byte year) 87 | ``` 88 | 89 | #### Parameters 90 | 91 | - year: the year value to be set. 92 | 93 | ### `setMonth()` 94 | 95 | Set the RTC month. 96 | 97 | #### Syntax 98 | 99 | ``` arduino 100 | rtc.setMonth(uint8_t month) 101 | ``` 102 | 103 | #### Parameters 104 | 105 | - month: the month value to be set. 106 | 107 | ### `setDay()` 108 | 109 | Set the RTC day. 110 | 111 | #### Syntax 112 | 113 | ``` arduino 114 | rtc.setDay(byte day) 115 | ``` 116 | 117 | #### Parameters 118 | 119 | - day: the day value to be set. 120 | 121 | ### `setDate()` 122 | 123 | Set the RTC day, month and year. 124 | 125 | #### Syntax 126 | 127 | ``` arduino 128 | rtc.setDate(byte day, byte month, byte year) 129 | ``` 130 | 131 | #### Parameters 132 | 133 | - day: the day value to be set. 134 | 135 | - month: the month value to be set. 136 | 137 | - year: the year value to be set. 138 | 139 | ### `getHours()` 140 | 141 | Get the RTC hours value. 142 | 143 | #### Syntax 144 | 145 | ``` arduino 146 | rtc.getHours() 147 | ``` 148 | 149 | #### Return 150 | the hours value. 151 | 152 | ### `getMinutes()` 153 | 154 | Get the RTC minutes value. 155 | 156 | #### Syntax 157 | 158 | ``` arduino 159 | rtc.getMinutes() 160 | ``` 161 | 162 | #### Return 163 | the minutes value. 164 | 165 | ### `getSeconds()` 166 | 167 | Get the RTC seconds value. 168 | 169 | #### Syntax 170 | 171 | ``` arduino 172 | rtc.getSeconds() 173 | ``` 174 | 175 | #### Return 176 | the seconds value. 177 | 178 | ### `getYear()` 179 | 180 | Get the RTC Year value. 181 | 182 | #### Syntax 183 | 184 | ``` arduino 185 | rtc.getYear() 186 | ``` 187 | 188 | #### Return 189 | the year value. 190 | 191 | ### `getMonth()` 192 | 193 | Get the RTC month value. 194 | 195 | #### Syntax 196 | 197 | ``` arduino 198 | rtc.getMonth() 199 | ``` 200 | 201 | #### Return 202 | the month value. 203 | 204 | ### `getDay()` 205 | 206 | Get the RTC day value. 207 | 208 | #### Syntax 209 | 210 | ``` arduino 211 | rTC.getDay() 212 | ``` 213 | 214 | #### Return 215 | the day value. 216 | 217 | ### `setAlarmHours()` 218 | 219 | Set the RTC Alarm hours value. 220 | 221 | #### Syntax 222 | 223 | ``` arduino 224 | rtc.setAlarmHours(uint8_t hours) 225 | ``` 226 | 227 | #### Parameters 228 | 229 | - hours: the hours value to be set. 230 | 231 | ### `setAlarmMinutes()` 232 | 233 | Set the RTC Alarm minutes value. 234 | 235 | #### Syntax 236 | 237 | ``` arduino 238 | rtc.setAlarmMinutes(byte minutes) 239 | ``` 240 | 241 | #### Parameters 242 | 243 | - minutes: the minutes value to be set. 244 | 245 | ### `setAlarmSeconds()` 246 | 247 | Set the RTC Alarm seconds value. 248 | 249 | #### Syntax 250 | 251 | ``` arduino 252 | rtc.setAlarmSeconds(byte seconds) 253 | ``` 254 | 255 | #### Parameters 256 | 257 | - seconds: the seconds value to be set. 258 | 259 | ### `setAlarmTime()` 260 | 261 | Set the RTC Alarm hours, minutes and seconds. 262 | 263 | #### Syntax 264 | 265 | ``` arduino 266 | rtc.setAlarmTime(byte hours, byte minutes, byte seconds) 267 | ``` 268 | 269 | #### Parameters 270 | 271 | - hours: the hours value to be set. 272 | 273 | - minutes: the minutes value to be set. 274 | 275 | - seconds: the seconds value to be set. 276 | 277 | ### `setAlarmYear()` 278 | 279 | Set the RTC Alarm year. 280 | 281 | #### Syntax 282 | 283 | ``` arduino 284 | rtc.setAlarmYear(byte year) 285 | ``` 286 | 287 | #### Parameters 288 | 289 | - year: the year value to be set. 290 | 291 | ### `setAlarmMonth()` 292 | 293 | Set the RTC Alarm month. 294 | 295 | #### Syntax 296 | 297 | ``` arduino 298 | rtc.setAlarmMonth(byte month) 299 | ``` 300 | 301 | #### Parameters 302 | 303 | - month: the month value to be set. 304 | 305 | ### `setAlarmDay()` 306 | 307 | Set the RTC Alarm day. 308 | 309 | #### Syntax 310 | 311 | ``` arduino 312 | rtc.setAlarmDay(uint8_t day) 313 | ``` 314 | 315 | #### Parameters 316 | 317 | - day: the day value to be set. 318 | 319 | ### `setAlarmDate()` 320 | 321 | Set the RTC Alarm day, month and year. 322 | 323 | #### Syntax 324 | 325 | ``` arduino 326 | rtc.setAlarmDate(byte day, byte month, byte year) 327 | ``` 328 | 329 | #### Parameters 330 | 331 | - day: the day value to be set. 332 | 333 | - month: the month value to be set. 334 | 335 | - year: the year value to be set. 336 | 337 | ### `enableAlarm()` 338 | 339 | Enable the RTC alarm to be triggered on a chosen match type 340 | 341 | #### Syntax 342 | 343 | ``` arduino 344 | rtc.enableAlarm(rtc.AlarmMatch) 345 | ``` 346 | 347 | #### Parameters 348 | 349 | - AlarmMatch: the chosen match type that can be chosen between: 350 | 351 | - MATCH_SS: generate an alarm on seconds match; 352 | - MATCH_MMSS: generate an alarm on minutes and seconds match; 353 | - MATCH_HHMMSS: generate an alarm on hours, minutes and seconds match; 354 | - MATCH_DHHMMSS: generate an alarm on day, hours, minutes and seconds match; 355 | - MATCH_MMDDHHMMSS: generate an alarm on month, day, hours, minutes and seconds match; 356 | - MATCH_YYMMDDHHMMSS: generate an alarm on year, month, day, hours, minutes and seconds match; 357 | 358 | ### `disableAlarm()` 359 | 360 | Disable the RTC alarm triggering. 361 | 362 | #### Syntax 363 | 364 | ``` arduino 365 | rtc.disableAlarm() 366 | ``` 367 | 368 | #### Parameters 369 | 370 | none 371 | 372 | ### `attachInterrupt()` 373 | 374 | Attach an interrupt action on alarm match. 375 | 376 | #### Syntax 377 | 378 | ``` arduino 379 | rtc.attachInterrupt(voidFuncPtr callback) 380 | ``` 381 | 382 | #### Parameters 383 | 384 | - callback: The name of the function to be called on alarm match 385 | 386 | ### `detachInterrupt()` 387 | 388 | Detach interrupt action on alarm match. 389 | 390 | #### Syntax 391 | 392 | ``` arduino 393 | rtc.detachInterrupt() 394 | ``` 395 | 396 | #### Parameters 397 | 398 | none 399 | 400 | ### `standbyMode()` 401 | 402 | Send the board in standby mode. 403 | 404 | #### Syntax 405 | 406 | ``` arduino 407 | rtc.standbyMode() 408 | ``` 409 | 410 | 411 | #### Parameters 412 | 413 | None 414 | -------------------------------------------------------------------------------- /src/RTCZero.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | RTC library for Arduino Zero. 3 | Copyright (c) 2015 Arduino LLC. All right reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU Lesser General Public 16 | License along with this library; if not, write to the Free Software 17 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 18 | */ 19 | 20 | #include 21 | 22 | #include "RTCZero.h" 23 | 24 | #define EPOCH_TIME_OFF 946684800 // This is 1st January 2000, 00:00:00 in epoch time 25 | #define EPOCH_TIME_YEAR_OFF 100 // years since 1900 26 | 27 | // Default date & time after reset 28 | #define DEFAULT_YEAR 2000 // 2000..2063 29 | #define DEFAULT_MONTH 1 // 1..12 30 | #define DEFAULT_DAY 1 // 1..31 31 | #define DEFAULT_HOUR 0 // 1..23 32 | #define DEFAULT_MINUTE 0 // 0..59 33 | #define DEFAULT_SECOND 0 // 0..59 34 | 35 | voidFuncPtr RTC_callBack = NULL; 36 | 37 | RTCZero::RTCZero() 38 | { 39 | _configured = false; 40 | } 41 | 42 | void RTCZero::begin(bool resetTime) 43 | { 44 | uint16_t tmp_reg = 0; 45 | 46 | PM->APBAMASK.reg |= PM_APBAMASK_RTC; // turn on digital interface clock 47 | config32kOSC(); 48 | 49 | // If the RTC is in clock mode and the reset was 50 | // not due to POR or BOD, preserve the clock time 51 | // POR causes a reset anyway, BOD behaviour is? 52 | bool validTime = false; 53 | RTC_MODE2_CLOCK_Type oldTime; 54 | 55 | if ((!resetTime) && (PM->RCAUSE.reg & (PM_RCAUSE_SYST | PM_RCAUSE_WDT | PM_RCAUSE_EXT))) { 56 | if (RTC->MODE2.CTRL.reg & RTC_MODE2_CTRL_MODE_CLOCK) { 57 | validTime = true; 58 | oldTime.reg = RTC->MODE2.CLOCK.reg; 59 | } 60 | } 61 | 62 | // Setup clock GCLK2 with OSC32K divided by 32 63 | configureClock(); 64 | 65 | RTCdisable(); 66 | 67 | RTCreset(); 68 | 69 | tmp_reg |= RTC_MODE2_CTRL_MODE_CLOCK; // set clock operating mode 70 | tmp_reg |= RTC_MODE2_CTRL_PRESCALER_DIV1024; // set prescaler to 1024 for MODE2 71 | tmp_reg &= ~RTC_MODE2_CTRL_MATCHCLR; // disable clear on match 72 | 73 | //According to the datasheet RTC_MODE2_CTRL_CLKREP = 0 for 24h 74 | tmp_reg &= ~RTC_MODE2_CTRL_CLKREP; // 24h time representation 75 | 76 | RTC->MODE2.READREQ.reg &= ~RTC_READREQ_RCONT; // disable continuously mode 77 | 78 | RTC->MODE2.CTRL.reg = tmp_reg; 79 | while (RTCisSyncing()) 80 | ; 81 | 82 | NVIC_EnableIRQ(RTC_IRQn); // enable RTC interrupt 83 | NVIC_SetPriority(RTC_IRQn, 0x00); 84 | 85 | RTC->MODE2.INTENSET.reg |= RTC_MODE2_INTENSET_ALARM0; // enable alarm interrupt 86 | RTC->MODE2.Mode2Alarm[0].MASK.bit.SEL = MATCH_OFF; // default alarm match is off (disabled) 87 | 88 | while (RTCisSyncing()) 89 | ; 90 | 91 | RTCenable(); 92 | RTCresetRemove(); 93 | 94 | // If desired and valid, restore the time value, else use first valid time value 95 | if ((!resetTime) && (validTime) && (oldTime.reg != 0L)) { 96 | RTC->MODE2.CLOCK.reg = oldTime.reg; 97 | } 98 | else { 99 | RTC->MODE2.CLOCK.reg = RTC_MODE2_CLOCK_YEAR(DEFAULT_YEAR - 2000) | RTC_MODE2_CLOCK_MONTH(DEFAULT_MONTH) 100 | | RTC_MODE2_CLOCK_DAY(DEFAULT_DAY) | RTC_MODE2_CLOCK_HOUR(DEFAULT_HOUR) 101 | | RTC_MODE2_CLOCK_MINUTE(DEFAULT_MINUTE) | RTC_MODE2_CLOCK_SECOND(DEFAULT_SECOND); 102 | } 103 | while (RTCisSyncing()) 104 | ; 105 | 106 | _configured = true; 107 | } 108 | 109 | void RTC_Handler(void) 110 | { 111 | if (RTC_callBack != NULL) { 112 | RTC_callBack(); 113 | } 114 | 115 | RTC->MODE2.INTFLAG.reg = RTC_MODE2_INTFLAG_ALARM0; // must clear flag at end 116 | } 117 | 118 | void RTCZero::enableAlarm(Alarm_Match match) 119 | { 120 | if (_configured) { 121 | RTC->MODE2.Mode2Alarm[0].MASK.bit.SEL = match; 122 | while (RTCisSyncing()) 123 | ; 124 | } 125 | } 126 | 127 | void RTCZero::disableAlarm() 128 | { 129 | if (_configured) { 130 | RTC->MODE2.Mode2Alarm[0].MASK.bit.SEL = 0x00; 131 | while (RTCisSyncing()) 132 | ; 133 | } 134 | } 135 | 136 | void RTCZero::attachInterrupt(voidFuncPtr callback) 137 | { 138 | RTC_callBack = callback; 139 | } 140 | 141 | void RTCZero::detachInterrupt() 142 | { 143 | RTC_callBack = NULL; 144 | } 145 | 146 | void RTCZero::standbyMode() 147 | { 148 | // Entering standby mode when connected 149 | // via the native USB port causes issues. 150 | SCB->SCR |= SCB_SCR_SLEEPDEEP_Msk; 151 | __DSB(); 152 | __WFI(); 153 | } 154 | 155 | /* 156 | * Get Functions 157 | */ 158 | 159 | uint8_t RTCZero::getSeconds() 160 | { 161 | RTCreadRequest(); 162 | return RTC->MODE2.CLOCK.bit.SECOND; 163 | } 164 | 165 | uint8_t RTCZero::getMinutes() 166 | { 167 | RTCreadRequest(); 168 | return RTC->MODE2.CLOCK.bit.MINUTE; 169 | } 170 | 171 | uint8_t RTCZero::getHours() 172 | { 173 | RTCreadRequest(); 174 | return RTC->MODE2.CLOCK.bit.HOUR; 175 | } 176 | 177 | uint8_t RTCZero::getDay() 178 | { 179 | RTCreadRequest(); 180 | return RTC->MODE2.CLOCK.bit.DAY; 181 | } 182 | 183 | uint8_t RTCZero::getMonth() 184 | { 185 | RTCreadRequest(); 186 | return RTC->MODE2.CLOCK.bit.MONTH; 187 | } 188 | 189 | uint8_t RTCZero::getYear() 190 | { 191 | RTCreadRequest(); 192 | return RTC->MODE2.CLOCK.bit.YEAR; 193 | } 194 | 195 | uint8_t RTCZero::getAlarmSeconds() 196 | { 197 | return RTC->MODE2.Mode2Alarm[0].ALARM.bit.SECOND; 198 | } 199 | 200 | uint8_t RTCZero::getAlarmMinutes() 201 | { 202 | return RTC->MODE2.Mode2Alarm[0].ALARM.bit.MINUTE; 203 | } 204 | 205 | uint8_t RTCZero::getAlarmHours() 206 | { 207 | return RTC->MODE2.Mode2Alarm[0].ALARM.bit.HOUR; 208 | } 209 | 210 | uint8_t RTCZero::getAlarmDay() 211 | { 212 | return RTC->MODE2.Mode2Alarm[0].ALARM.bit.DAY; 213 | } 214 | 215 | uint8_t RTCZero::getAlarmMonth() 216 | { 217 | return RTC->MODE2.Mode2Alarm[0].ALARM.bit.MONTH; 218 | } 219 | 220 | uint8_t RTCZero::getAlarmYear() 221 | { 222 | return RTC->MODE2.Mode2Alarm[0].ALARM.bit.YEAR; 223 | } 224 | 225 | /* 226 | * Set Functions 227 | */ 228 | 229 | void RTCZero::setSeconds(uint8_t seconds) 230 | { 231 | if (_configured) { 232 | RTC->MODE2.CLOCK.bit.SECOND = seconds; 233 | while (RTCisSyncing()) 234 | ; 235 | } 236 | } 237 | 238 | void RTCZero::setMinutes(uint8_t minutes) 239 | { 240 | if (_configured) { 241 | RTC->MODE2.CLOCK.bit.MINUTE = minutes; 242 | while (RTCisSyncing()) 243 | ; 244 | } 245 | } 246 | 247 | void RTCZero::setHours(uint8_t hours) 248 | { 249 | if (_configured) { 250 | RTC->MODE2.CLOCK.bit.HOUR = hours; 251 | while (RTCisSyncing()) 252 | ; 253 | } 254 | } 255 | 256 | void RTCZero::setTime(uint8_t hours, uint8_t minutes, uint8_t seconds) 257 | { 258 | if (_configured) { 259 | setSeconds(seconds); 260 | setMinutes(minutes); 261 | setHours(hours); 262 | } 263 | } 264 | 265 | void RTCZero::setDay(uint8_t day) 266 | { 267 | if (_configured) { 268 | RTC->MODE2.CLOCK.bit.DAY = day; 269 | while (RTCisSyncing()) 270 | ; 271 | } 272 | } 273 | 274 | void RTCZero::setMonth(uint8_t month) 275 | { 276 | if (_configured) { 277 | RTC->MODE2.CLOCK.bit.MONTH = month; 278 | while (RTCisSyncing()) 279 | ; 280 | } 281 | } 282 | 283 | void RTCZero::setYear(uint8_t year) 284 | { 285 | if (_configured) { 286 | RTC->MODE2.CLOCK.bit.YEAR = year; 287 | while (RTCisSyncing()) 288 | ; 289 | } 290 | } 291 | 292 | void RTCZero::setDate(uint8_t day, uint8_t month, uint8_t year) 293 | { 294 | if (_configured) { 295 | setDay(day); 296 | setMonth(month); 297 | setYear(year); 298 | } 299 | } 300 | 301 | void RTCZero::setAlarmSeconds(uint8_t seconds) 302 | { 303 | if (_configured) { 304 | RTC->MODE2.Mode2Alarm[0].ALARM.bit.SECOND = seconds; 305 | while (RTCisSyncing()) 306 | ; 307 | } 308 | } 309 | 310 | void RTCZero::setAlarmMinutes(uint8_t minutes) 311 | { 312 | if (_configured) { 313 | RTC->MODE2.Mode2Alarm[0].ALARM.bit.MINUTE = minutes; 314 | while (RTCisSyncing()) 315 | ; 316 | } 317 | } 318 | 319 | void RTCZero::setAlarmHours(uint8_t hours) 320 | { 321 | if (_configured) { 322 | RTC->MODE2.Mode2Alarm[0].ALARM.bit.HOUR = hours; 323 | while (RTCisSyncing()) 324 | ; 325 | } 326 | } 327 | 328 | void RTCZero::setAlarmTime(uint8_t hours, uint8_t minutes, uint8_t seconds) 329 | { 330 | if (_configured) { 331 | setAlarmSeconds(seconds); 332 | setAlarmMinutes(minutes); 333 | setAlarmHours(hours); 334 | } 335 | } 336 | 337 | void RTCZero::setAlarmDay(uint8_t day) 338 | { 339 | if (_configured) { 340 | RTC->MODE2.Mode2Alarm[0].ALARM.bit.DAY = day; 341 | while (RTCisSyncing()) 342 | ; 343 | } 344 | } 345 | 346 | void RTCZero::setAlarmMonth(uint8_t month) 347 | { 348 | if (_configured) { 349 | RTC->MODE2.Mode2Alarm[0].ALARM.bit.MONTH = month; 350 | while (RTCisSyncing()) 351 | ; 352 | } 353 | } 354 | 355 | void RTCZero::setAlarmYear(uint8_t year) 356 | { 357 | if (_configured) { 358 | RTC->MODE2.Mode2Alarm[0].ALARM.bit.YEAR = year; 359 | while (RTCisSyncing()) 360 | ; 361 | } 362 | } 363 | 364 | void RTCZero::setAlarmDate(uint8_t day, uint8_t month, uint8_t year) 365 | { 366 | if (_configured) { 367 | setAlarmDay(day); 368 | setAlarmMonth(month); 369 | setAlarmYear(year); 370 | } 371 | } 372 | 373 | time_t RTCZero::getEpoch() 374 | { 375 | RTCreadRequest(); 376 | RTC_MODE2_CLOCK_Type clockTime; 377 | clockTime.reg = RTC->MODE2.CLOCK.reg; 378 | 379 | struct tm tm; 380 | 381 | tm.tm_isdst = -1; 382 | tm.tm_yday = 0; 383 | tm.tm_wday = 0; 384 | tm.tm_year = clockTime.bit.YEAR + EPOCH_TIME_YEAR_OFF; 385 | tm.tm_mon = clockTime.bit.MONTH - 1; 386 | tm.tm_mday = clockTime.bit.DAY; 387 | tm.tm_hour = clockTime.bit.HOUR; 388 | tm.tm_min = clockTime.bit.MINUTE; 389 | tm.tm_sec = clockTime.bit.SECOND; 390 | 391 | return mktime(&tm); 392 | } 393 | 394 | uint32_t RTCZero::getY2kEpoch() 395 | { 396 | return (getEpoch() - EPOCH_TIME_OFF); 397 | } 398 | 399 | void RTCZero::setAlarmEpoch(uint32_t ts) 400 | { 401 | if (_configured) { 402 | if (ts < EPOCH_TIME_OFF) { 403 | ts = EPOCH_TIME_OFF; 404 | } 405 | 406 | time_t t = ts; 407 | struct tm tmp; 408 | 409 | gmtime_r(&t, &tmp); 410 | setAlarmDate(tmp.tm_mday, tmp.tm_mon + 1, tmp.tm_year - EPOCH_TIME_YEAR_OFF); 411 | setAlarmTime(tmp.tm_hour, tmp.tm_min, tmp.tm_sec); 412 | } 413 | } 414 | 415 | void RTCZero::setEpoch(uint32_t ts) 416 | { 417 | if (_configured) { 418 | if (ts < EPOCH_TIME_OFF) { 419 | ts = EPOCH_TIME_OFF; 420 | } 421 | 422 | time_t t = ts; 423 | struct tm tmp; 424 | 425 | gmtime_r(&t, &tmp); 426 | 427 | RTC_MODE2_CLOCK_Type clockTime; 428 | 429 | clockTime.bit.YEAR = tmp.tm_year - EPOCH_TIME_YEAR_OFF; 430 | clockTime.bit.MONTH = tmp.tm_mon + 1; 431 | clockTime.bit.DAY = tmp.tm_mday; 432 | clockTime.bit.HOUR = tmp.tm_hour; 433 | clockTime.bit.MINUTE = tmp.tm_min; 434 | clockTime.bit.SECOND = tmp.tm_sec; 435 | 436 | RTC->MODE2.CLOCK.reg = clockTime.reg; 437 | 438 | while (RTCisSyncing()) 439 | ; 440 | } 441 | } 442 | 443 | void RTCZero::setY2kEpoch(uint32_t ts) 444 | { 445 | if (_configured) { 446 | setEpoch(ts + EPOCH_TIME_OFF); 447 | } 448 | } 449 | 450 | /* Attach peripheral clock to 32k oscillator */ 451 | void RTCZero::configureClock() { 452 | GCLK->GENDIV.reg = GCLK_GENDIV_ID(2)|GCLK_GENDIV_DIV(4); 453 | while (GCLK->STATUS.reg & GCLK_STATUS_SYNCBUSY) 454 | ; 455 | #ifdef CRYSTALLESS 456 | GCLK->GENCTRL.reg = (GCLK_GENCTRL_GENEN | GCLK_GENCTRL_SRC_OSCULP32K | GCLK_GENCTRL_ID(2) | GCLK_GENCTRL_DIVSEL ); 457 | #else 458 | GCLK->GENCTRL.reg = (GCLK_GENCTRL_GENEN | GCLK_GENCTRL_SRC_XOSC32K | GCLK_GENCTRL_ID(2) | GCLK_GENCTRL_DIVSEL ); 459 | #endif 460 | while (GCLK->STATUS.reg & GCLK_STATUS_SYNCBUSY) 461 | ; 462 | GCLK->CLKCTRL.reg = (uint32_t)((GCLK_CLKCTRL_CLKEN | GCLK_CLKCTRL_GEN_GCLK2 | (RTC_GCLK_ID << GCLK_CLKCTRL_ID_Pos))); 463 | while (GCLK->STATUS.bit.SYNCBUSY) 464 | ; 465 | } 466 | 467 | /* 468 | * Private Utility Functions 469 | */ 470 | 471 | /* Configure the 32768 Hz Oscillator */ 472 | void RTCZero::config32kOSC() 473 | { 474 | #ifndef CRYSTALLESS 475 | SYSCTRL->XOSC32K.reg = SYSCTRL_XOSC32K_ONDEMAND | 476 | SYSCTRL_XOSC32K_RUNSTDBY | 477 | SYSCTRL_XOSC32K_EN32K | 478 | SYSCTRL_XOSC32K_XTALEN | 479 | SYSCTRL_XOSC32K_STARTUP(6) | 480 | SYSCTRL_XOSC32K_ENABLE; 481 | #endif 482 | } 483 | 484 | /* Synchronise the CLOCK register for reading*/ 485 | inline void RTCZero::RTCreadRequest() { 486 | if (_configured) { 487 | RTC->MODE2.READREQ.reg = RTC_READREQ_RREQ; 488 | while (RTCisSyncing()) 489 | ; 490 | } 491 | } 492 | 493 | /* Wait for sync in write operations */ 494 | inline bool RTCZero::RTCisSyncing() 495 | { 496 | return (RTC->MODE2.STATUS.bit.SYNCBUSY); 497 | } 498 | 499 | void RTCZero::RTCdisable() 500 | { 501 | RTC->MODE2.CTRL.reg &= ~RTC_MODE2_CTRL_ENABLE; // disable RTC 502 | while (RTCisSyncing()) 503 | ; 504 | } 505 | 506 | void RTCZero::RTCenable() 507 | { 508 | RTC->MODE2.CTRL.reg |= RTC_MODE2_CTRL_ENABLE; // enable RTC 509 | while (RTCisSyncing()) 510 | ; 511 | } 512 | 513 | void RTCZero::RTCreset() 514 | { 515 | RTC->MODE2.CTRL.reg |= RTC_MODE2_CTRL_SWRST; // software reset 516 | while (RTCisSyncing()) 517 | ; 518 | } 519 | 520 | void RTCZero::RTCresetRemove() 521 | { 522 | RTC->MODE2.CTRL.reg &= ~RTC_MODE2_CTRL_SWRST; // software reset remove 523 | while (RTCisSyncing()) 524 | ; 525 | } 526 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | --------------------------------------------------------------------------------