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

docs/library/machine: Add documentation for machine.time_pulse_us.

Browse Source
This commit is contained in:
Damien George 2016-05-31 14:06:33 +01:00
parent 4940bee62a
commit 93a9c2e840
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/library/machine.rst
View File

@ -101,6 +101,19 @@ Miscellaneous functions
varies by hardware (so use substring of a full value if you expect a short
ID). In some MicroPython ports, ID corresponds to the network MAC address.
.. function:: time_pulse_us(pin, pulse_level, timeout_us=1000000)
Time a pulse on the given `pin`, and return the duration of the pulse in
microseconds. The `pulse_level` argument should be 0 to time a low pulse
or 1 to time a high pulse.
The function first waits while the pin input is different to the `pulse_level`
parameter, then times the duration that the pin is equal to `pulse_level`.
If the pin is already equal to `pulse_level` then timing starts straight away.
The function will raise an OSError with ETIMEDOUT if either of the waits is
longer than the given timeout value (which is in microseconds).
.. _machine_constants:
Constants