diff options
| author | sommersoft <sommersoft@gmail.com> | 2019-03-02 18:33:37 -0600 |
|---|---|---|
| committer | sommersoft <sommersoft@gmail.com> | 2019-03-02 18:33:37 -0600 |
| commit | 8de4cf6b10b48c982ec67dcc60e4eb96f394409f (patch) | |
| tree | bce61f50f76f9114652575419b277a23c38bccf5 | |
| parent | b7b74d1f78dfd2f9c9a294e45fcf5663f54c6ff4 (diff) | |
update RTD documentation
| -rw-r--r-- | shared-bindings/frequencyio/FrequencyIn.c | 15 | ||||
| -rw-r--r-- | shared-bindings/index.rst | 1 |
2 files changed, 11 insertions, 5 deletions
diff --git a/shared-bindings/frequencyio/FrequencyIn.c b/shared-bindings/frequencyio/FrequencyIn.c index fb1698fa2..908cb307d 100644 --- a/shared-bindings/frequencyio/FrequencyIn.c +++ b/shared-bindings/frequencyio/FrequencyIn.c @@ -41,9 +41,12 @@ //| ======================================================== //| //| FrequencyIn is used to measure the frequency, in hertz, of a digital signal -//| on an incoming pin. Accuracy has shown to be within 1kHz, if not better. -//| Current maximum detectable frequency is ~512kHz. -//| It will not determine pulse width (use ``PulseIn``). +//| on an incoming pin. Accuracy has shown to be within 10%, if not better. It +//| is recommended to utilize an average of multiple samples to smooth out readings. +//| +//| Frequencies below 1KHz are not currently detectable. +//| +//| FrequencyIn will not determine pulse width (use ``PulseIn``). //| //| .. class:: FrequencyIn(pin, capture_period=10) //| @@ -51,7 +54,7 @@ //| //| :param ~microcontroller.Pin pin: Pin to read frequency from. //| :param int capture_period: Keyword argument to set the measurement period, in -//| milliseconds. Default is 10ms; maximum is 500ms. +//| milliseconds. Default is 10ms; range is 1ms - 500ms. //| //| Read the incoming frequency from a pin:: //| @@ -166,7 +169,9 @@ MP_DEFINE_CONST_FUN_OBJ_1(frequencyio_frequencyin_clear_obj, frequencyio_frequen //| .. attribute:: capture_period //| -//| The capture measurement period. +//| The capture measurement period. Lower incoming frequencies will be measured +//| more accurately with longer capture periods. Higher frequencies are more +//| accurate with shorter capture periods. //| //| .. note:: When setting a new ``capture_period``, all previous capture information is //| cleared with a call to ``clear()``. diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst index 9641d73d1..4f2e28702 100644 --- a/shared-bindings/index.rst +++ b/shared-bindings/index.rst @@ -42,6 +42,7 @@ Module Supported Ports `bleio` **nRF** `busio` **All Supported** `digitalio` **All Supported** +`frequencyio` **SAMD51** `gamepad` **SAMD Express, nRF** `hashlib` **ESP8266** `i2cslave` **SAMD Express** |