diff options
| author | Jeff Epler <jeff@adafruit.com> | 2021-03-14 20:52:19 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-14 20:52:19 -0500 |
| commit | 3cbff45f9aac5ea2855bbc888083d356a91c80fe (patch) | |
| tree | a1b60d217bb2cf1d9b45cf05bdbbef3de556ba05 /shared-bindings | |
| parent | 4fdcddaa4df2a3706542e0d92ea8ee9eaaf0e180 (diff) | |
| parent | 1386a8104a1164694ef4beed46ac7db917f88e51 (diff) | |
Merge pull request #4407 from jposada202020/RTC_doc_corrections
RTC and Touchin docs changes
Diffstat (limited to 'shared-bindings')
| -rw-r--r-- | shared-bindings/rtc/RTC.c | 8 | ||||
| -rw-r--r-- | shared-bindings/touchio/TouchIn.c | 8 |
2 files changed, 14 insertions, 2 deletions
diff --git a/shared-bindings/rtc/RTC.c b/shared-bindings/rtc/RTC.c index 4a792484d..5e6b00c6e 100644 --- a/shared-bindings/rtc/RTC.c +++ b/shared-bindings/rtc/RTC.c @@ -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(); diff --git a/shared-bindings/touchio/TouchIn.c b/shared-bindings/touchio/TouchIn.c index ff723ccc7..904589a48 100644 --- a/shared-bindings/touchio/TouchIn.c +++ b/shared-bindings/touchio/TouchIn.c @@ -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); |
