Added funtions to class RTC_PCF8563 for controlling the timer and int…#218
Open
songspire wants to merge 2 commits intoadafruit:masterfrom
Open
Added funtions to class RTC_PCF8563 for controlling the timer and int…#218songspire wants to merge 2 commits intoadafruit:masterfrom
songspire wants to merge 2 commits intoadafruit:masterfrom
Conversation
added 2 commits
January 16, 2021 17:44
…errupt functionality of PCF8563. Also addedd required definition for the respective registers.
edgar-bonet
reviewed
Jan 16, 2021
|
|
||
| /** PCF8563 Timer clock source settings */ | ||
| enum PCF8563TimerClockFreq { | ||
| PCF8563_TimerClk4096kHz = 0x00, /**< 4096 kHz */ |
Contributor
There was a problem hiding this comment.
It's not 4096 kilohertz, but 4096 Hz (or, as the datasheet puts it, “4.096 kHz”.
|
|
||
| /**************************************************************************/ | ||
| /*! | ||
| @brief Enable the Countdown Timer Interrupt on the PCF8563. |
Contributor
There was a problem hiding this comment.
It would be nice if each method had a non-empty @details documentation. And also to have the parameters documented.
Comment on lines
1464
to
1472
| //write_i2c_register(PCF8563_ADDRESS, PCF8563_TIMER_CONTROL, timer_ctlreg & ~0x03 | clkFreq); | ||
|
|
||
| // Sets the enable bit TE and the clock source bits TD[1:0] in the timer control register | ||
| write_i2c_register(PCF8563_ADDRESS, PCF8563_TIMER_CONTROL, (timer_ctlreg & ~0x03) | clkFreq | (1 << 7)); | ||
|
|
||
| // uint8_t timer_ctlreg = read_i2c_register(PCF8563_ADDRESS, PCF8563_TIMER_CONTROL); | ||
| // //if (timer_ctlreg & (1 << 5)) { | ||
| // write_i2c_register(PCF8563_ADDRESS, PCF8563_TIMER_CONTROL, timer_ctlreg | (1 << 7)); | ||
| // //} |
Contributor
There was a problem hiding this comment.
Please, no not commit commented-out code.
RTClib.cpp
Outdated
| uint8_t ctlreg = read_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2); | ||
|
|
||
| // Reset the enable bit TIE in the control status 2 register leaving other bits unchanged | ||
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~1); |
Contributor
There was a problem hiding this comment.
The intent should be clearer like this:
Suggested change
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~1); | |
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~PCF8563_CONTROL2_TIE); |
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~1); | ||
| } | ||
|
|
||
| uint8_t RTC_PCF8563::getAndClearIntFlags(void) { |
Contributor
There was a problem hiding this comment.
This method also should be documented.
| uint8_t ctlreg = read_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2); | ||
|
|
||
| // Clear the AF and TF interrupt flags in control status register 2 | ||
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~12); |
Contributor
There was a problem hiding this comment.
Clearer intent:
Suggested change
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~12); | |
| write_i2c_register(PCF8563_ADDRESS, PCF8563_CONTROL_2, ctlreg & ~(PCF8563_CONTROL2_AF | PCF8563_CONTROL2_TF)); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please review my code and consider this PR.
I've implemented functionality to control the timer and timer interrupt facilities of PCF8563. For this I added the following functions to class RTC_PCF8563:
void enableCountdownTimer(PCF8563TimerClockFreq clkFreq, uint8_t numPeriods);
void disableCountdownTimer(void);
void enableCountdownTimerInt(bool pulse);
void disableCountdownTimerInt(void);
uint8_t getAndClearIntFlags(void);
Also added required definitions in RTClib.h.
This does not cover functionality of alarms and alarm interrupt. Adafruit's own PCF8563 breakout doesn't expose the INT pin, but this might be useful for other boards that ise the functionality or in the future if Adafruit produces a breakout board that exposes the INT pin.
I've successfully tested all the added functionality on a PCF8563 breakout from ANGEEK connected to an arduino UNO. Examples are not included. I'm happy to add any if required.