djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #4407 from jposada202020/RTC_doc_corrections

Browse Source 
RTC and Touchin docs changes
This commit is contained in:
Jeff Epler 2021-03-14 20:52:19 -05:00 committed by GitHub
commit 3cbff45f9a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
shared-bindings/rtc/RTC.c
View File

@ -98,7 +98,13 @@ const mp_obj_property_t rtc_rtc_datetime_obj = {
//| """The RTC calibration value as an `int`.
//|
//| A positive value speeds up the clock and a negative value slows it down.
//| Range and value is hardware specific, but one step is often approximately 1 ppm."""
//| Range and value is hardware specific, but one step is often approximately 1 ppm::
//|
//| import rtc
//| import time
//|
//| r = rtc.RTC()
//| r.calibration = 1"""
//|
STATIC mp_obj_t rtc_rtc_obj_get_calibration(mp_obj_t self_in) {
int calibration = common_hal_rtc_get_calibration();

8
shared-bindings/touchio/TouchIn.c
View File

@ -153,7 +153,13 @@ const mp_obj_property_t touchio_touchin_raw_value_obj = {
//| When the **TouchIn** object is created, an initial `raw_value` is read from the pin,
//| and then `threshold` is set to be 100 + that value.
//|
//| You can adjust `threshold` to make the pin more or less sensitive."""
//| You can adjust `threshold` to make the pin more or less sensitive::
//|
//| import board
//| import touchio
//|
//| touch = touchio.TouchIn(board.A1)
//| touch.threshold = 7300"""
//|
STATIC mp_obj_t touchio_touchin_obj_get_threshold(mp_obj_t self_in) {
touchio_touchin_obj_t *self = MP_OBJ_TO_PTR(self_in);