Skip to content

Commit

Permalink
Read Me for SmallRTC Version 2.3.8.
Browse files Browse the repository at this point in the history
  • Loading branch information
GuruSR authored Jul 14, 2024
1 parent f767f68 commit 1b51a48
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Use this function to request the RTC to wake up on the hour and minute. The Min

**uint8_t getType():** Returns the rtcType as it is no longer exposed.

**uint32_t getADCPin():** Returns the ADC_PIN, so your BatteryVoltage function can look like:
**uint32_t getADCPin():** Returns the ADC_PIN, to see an example, see NOTE below. [^1]

**uint16_t getLocalYearOffset():** Returns the Year Offset, hard coded to 1900.

Expand Down Expand Up @@ -69,7 +69,7 @@ Use this function to request the RTC to wake up on the hour and minute. The Min

**NOTE:** To use the getADCPin(): `getBatteryVoltage() { return analogReadMilliVolts(RTC.getADCPin()) / 500.0f; }`

**NOTE:** For the PCF8563, there are 2 variants, use the RTC.getADCPin() to determine where the UP Button is.
[^1]:**NOTE:** For the PCF8563, there are 2 variants, use the RTC.getADCPin() to determine where the UP Button is.

All `bool Internal` parameters are optional, though if you do not choose true, the useESP32 function's value is used.

Expand Down

0 comments on commit 1b51a48

Please sign in to comment.