docs/machine: Generalize docs from just WiPy to other ports.
This commit is contained in:
parent
cfc94bec9f
commit
06ec96b47b
|
@ -18,23 +18,25 @@ Reset related functions
|
||||||
|
|
||||||
Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values.
|
Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values.
|
||||||
|
|
||||||
Interrupt related functions
|
.. only:: port_wipy
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. function:: disable_irq()
|
Interrupt related functions
|
||||||
|
---------------------------
|
||||||
|
|
||||||
Disable interrupt requests.
|
.. function:: disable_irq()
|
||||||
Returns the previous IRQ state: ``False``/``True`` for disabled/enabled IRQs
|
|
||||||
respectively. This return value can be passed to enable_irq to restore
|
|
||||||
the IRQ to its original state.
|
|
||||||
|
|
||||||
.. function:: enable_irq(state=True)
|
Disable interrupt requests.
|
||||||
|
Returns the previous IRQ state: ``False``/``True`` for disabled/enabled IRQs
|
||||||
|
respectively. This return value can be passed to enable_irq to restore
|
||||||
|
the IRQ to its original state.
|
||||||
|
|
||||||
Enable interrupt requests.
|
.. function:: enable_irq(state=True)
|
||||||
If ``state`` is ``True`` (the default value) then IRQs are enabled.
|
|
||||||
If ``state`` is ``False`` then IRQs are disabled. The most common use of
|
Enable interrupt requests.
|
||||||
this function is to pass it the value returned by ``disable_irq`` to
|
If ``state`` is ``True`` (the default value) then IRQs are enabled.
|
||||||
exit a critical section.
|
If ``state`` is ``False`` then IRQs are disabled. The most common use of
|
||||||
|
this function is to pass it the value returned by ``disable_irq`` to
|
||||||
|
exit a critical section.
|
||||||
|
|
||||||
Power related functions
|
Power related functions
|
||||||
-----------------------
|
-----------------------
|
||||||
|
@ -69,31 +71,37 @@ Power related functions
|
||||||
|
|
||||||
Stops the CPU and all peripherals including WLAN. Execution is resumed from main, just
|
Stops the CPU and all peripherals including WLAN. Execution is resumed from main, just
|
||||||
as with a reset. The reset cause can be checked to know that we are coming from
|
as with a reset. The reset cause can be checked to know that we are coming from
|
||||||
from ``machine.DEEPSLEEP``. Wake sources are ``Pin`` and ``RTC``. Current consumption
|
``machine.DEEPSLEEP``. Wake sources are ``Pin`` and ``RTC``. Current consumption
|
||||||
is reduced to ~5uA.
|
is reduced to ~5uA.
|
||||||
|
|
||||||
.. function:: wake_reason()
|
.. only:: port_wipy
|
||||||
|
|
||||||
Get the wake reason. See :ref:`constants <machine_constants>` for the possible return values.
|
.. function:: wake_reason()
|
||||||
|
|
||||||
|
Get the wake reason. See :ref:`constants <machine_constants>` for the possible return values.
|
||||||
|
|
||||||
Miscellaneous functions
|
Miscellaneous functions
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
.. function:: main(filename)
|
.. only:: port_wipy
|
||||||
|
|
||||||
Set the filename of the main script to run after boot.py is finished. If
|
.. function:: main(filename)
|
||||||
this function is not called then the default file main.py will be executed.
|
|
||||||
|
|
||||||
It only makes sense to call this function from within boot.py.
|
Set the filename of the main script to run after boot.py is finished. If
|
||||||
|
this function is not called then the default file main.py will be executed.
|
||||||
|
|
||||||
.. function:: rng()
|
It only makes sense to call this function from within boot.py.
|
||||||
|
|
||||||
Return a 24-bit software generated random number.
|
.. function:: rng()
|
||||||
|
|
||||||
|
Return a 24-bit software generated random number.
|
||||||
|
|
||||||
.. function:: unique_id()
|
.. function:: unique_id()
|
||||||
|
|
||||||
Returns a string of 6 bytes (48 bits), which is the unique ID of the MCU.
|
Returns a byte string with a unique idenifier of a board/SoC. It will vary
|
||||||
This also corresponds to the network ``MAC address``.
|
from a board/SoC instance to another, if underlying hardware allows. Length
|
||||||
|
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.
|
||||||
|
|
||||||
.. _machine_constants:
|
.. _machine_constants:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue