summaryrefslogtreecommitdiff
path: root/docs/library/machine.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-06-25 13:30:29 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-06-25 13:30:29 +0300
commit7c0e1f1a08949920ede272ae4ac7120ee8a77bc6 (patch)
treec82df840d10ac20d2ff76449f7427f184ab9bc02 /docs/library/machine.rst
parentcfce7d784e2dbf0d74b1ea7ce0a06b6597337800 (diff)
docs/machine*: Use markup adhering to the latest docs conventions.
Diffstat (limited to 'docs/library/machine.rst')
-rw-r--r--docs/library/machine.rst28
1 files changed, 14 insertions, 14 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
index 7ea7f565e..087f19cc6 100644
--- a/docs/library/machine.rst
+++ b/docs/library/machine.rst
@@ -13,7 +13,7 @@ damage.
.. _machine_callbacks:
-A note of callbacks used by functions and class methods of ``machine`` module:
+A note of callbacks used by functions and class methods of :mod:`machine` module:
all these callbacks should be considered as executing in an interrupt context.
This is true for both physical devices with IDs >= 0 and "virtual" devices
with negative IDs like -1 (these "virtual" devices are still thin shims on
@@ -38,14 +38,14 @@ Interrupt related functions
Disable interrupt requests.
Returns the previous IRQ state which should be considered an opaque value.
- This return value should be passed to the ``enable_irq`` function to restore
- interrupts to their original state, before ``disable_irq`` was called.
+ This return value should be passed to the `enable_irq()` function to restore
+ interrupts to their original state, before `disable_irq()` was called.
.. function:: enable_irq(state)
Re-enable interrupt requests.
- The ``state`` parameter should be the value that was returned from the most
- recent call to the ``disable_irq`` function.
+ The *state* parameter should be the value that was returned from the most
+ recent call to the `disable_irq()` function.
Power related functions
-----------------------
@@ -71,8 +71,8 @@ Power related functions
Stops the CPU and all peripherals (including networking interfaces, if any). Execution
is resumed from the main script, just as with a reset. The reset cause can be checked
- to know that we are coming from ``machine.DEEPSLEEP``. For wake up to actually happen,
- wake sources should be configured first, like ``Pin`` change or ``RTC`` timeout.
+ to know that we are coming from `machine.DEEPSLEEP`. For wake up to actually happen,
+ wake sources should be configured first, like `Pin` change or `RTC` timeout.
.. only:: port_wipy
@@ -98,18 +98,18 @@ Miscellaneous functions
.. 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
+ 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.
- If the current input value of the pin is different to `pulse_level`,
- the function first (*) waits until the pin input becomes equal to `pulse_level`,
- 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.
+ If the current input value of the pin is different to *pulse_level*,
+ the function first (*) waits until the pin input becomes equal to *pulse_level*,
+ 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 return -2 if there was timeout waiting for condition marked
(*) above, and -1 if there was timeout during the main measurement, marked (**)
- above. The timeout is the same for both cases and given by `timeout_us` (which
+ above. The timeout is the same for both cases and given by *timeout_us* (which
is in microseconds).
.. _machine_constants: