diff options
| author | danicampora <daniel@wipy.io> | 2015-10-14 12:32:01 +0200 |
|---|---|---|
| committer | danicampora <daniel@wipy.io> | 2015-10-17 23:29:04 +0200 |
| commit | 4542643025c77a7272bde348b89d5039aea28d23 (patch) | |
| tree | bf9fb006f46b96d2ea9ecf4aa190c4e4cc2abfc8 /docs/library/pyb.rst | |
| parent | fca3308cc376f2c1c66fa3cef82e30c55c9acca2 (diff) | |
docs: Update all WiPy docs to reflect the new API.
Diffstat (limited to 'docs/library/pyb.rst')
| -rw-r--r-- | docs/library/pyb.rst | 59 |
1 files changed, 5 insertions, 54 deletions
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst index 98cb763ee..546e7e578 100644 --- a/docs/library/pyb.rst +++ b/docs/library/pyb.rst @@ -63,25 +63,14 @@ Time related functions Reset related functions ----------------------- -.. only:: port_pyboard - - .. function:: hard_reset() - - Resets the pyboard in a manner similar to pushing the external RESET - button. - -.. only:: port_wipy +.. function:: hard_reset() - .. function:: reset() - - Resets the WiPy in a manner similar to pushing the external RESET - button. + Resets the pyboard in a manner similar to pushing the external RESET + button. -.. only:: port_pyboard +.. function:: bootloader() - .. function:: bootloader() - - Activate the bootloader without BOOT\* pins. + Activate the bootloader without BOOT\* pins. Interrupt related functions --------------------------- @@ -175,15 +164,6 @@ Power related functions See :meth:`rtc.wakeup` to configure a real-time-clock wakeup event. -.. only:: port_wipy - - .. function:: freq([sysclk]) - - Returns a tuple of clock frequencies: ``(sysclk)`` - These correspond to: - - - sysclk: frequency of the CPU - Miscellaneous functions ----------------------- @@ -256,12 +236,6 @@ Miscellaneous functions Return a 30-bit hardware generated random number. -.. only:: port_wipy - - .. function:: rng() - - Return a 24-bit software generated random number. - .. function:: sync() Sync all file systems. @@ -272,13 +246,6 @@ Miscellaneous functions Returns a string of 12 bytes (96 bits), which is the unique ID of the MCU. -.. only:: port_wipy - - .. function:: unique_id() - - Returns a string of 6 bytes (48 bits), which is the unique ID of the MCU. - This also corresponds to the ``MAC address`` of the WiPy. - Classes ------- @@ -303,19 +270,3 @@ Classes pyb.Timer.rst pyb.UART.rst pyb.USB_VCP.rst - -.. only:: port_wipy - - .. toctree:: - :maxdepth: 1 - - pyb.ADC.rst - pyb.HeartBeat.rst - pyb.I2C.rst - pyb.Pin.rst - pyb.RTC.rst - pyb.SD.rst - pyb.SPI.rst - pyb.Timer.rst - pyb.UART.rst - pyb.WDT.rst |