aboutsummaryrefslogtreecommitdiff
path: root/docs/library/pyb.rst
AgeCommit message (Collapse)Author
2020-08-21docs: Change `\*` to `*` in argument lists.Zenix27
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
2019-12-04docs/library: Add docs for pyb.Flash class.Jim Mussared
2019-12-04docs: Remove spaces on lines that are empty.Damien George
2019-09-11docs/library/pyb.rst: Update pyb.usb_mode() to mention VCP+MSC+HID.Damien George
2019-09-10docs/library/pyb.rst: Update docs for pyb.usb_mode() function.Damien George
2018-09-20docs/library/pyb: Add deprecation warning for mount and old block proto.Peter Hinch
pyb.mount(None, mountpoint) functionality is also removed and replaced by uos.umount.
2018-07-18docs/library: Remove "only" directive from all pyb module docs.Damien George
By virtue of its name, the pyb module would only be available on a pyboard and so does not need to have conditional "only" directives throughout its documentation. These conditionals were added mostly in cfcf47c0644952358e1a260db159e807872a37e6 in the initial development of the cc3200 port, which had the pyb module before it switched to the machine module. And wipy only conditionals were removed from the pyb module documentation in 4542643025c77a7272bde348b89d5039aea28d23, so there's no need to retain any more conditionals.
2018-02-01docs/library/pyb.rst: Add note about availability of USB MSC-only mode.Damien George
2017-07-15docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen
2017-06-27docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-02-06stmhal: Add pyb.fault_debug() function, to control hard-fault behaviour.Damien George
This new function controls what happens on a hard-fault: - debugging disabled: board will do a reset - debugging enabled: board will print registers and stack and flash LEDs The default is disabled, ie to do a reset. This is different to previous behaviour which flashed the LEDs and waited indefinitely.
2016-08-29docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.Philip Potter
2016-08-02docs: Spelling mistakesMike Causer
2016-01-13docs: Several minor changes: network, pyb, ADCAll and inline asm.Peter Hinch
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora
2015-10-10docs: Describe properly how MCU can be woken from pyb.standby() state.Damien George
2015-06-16docs: Add more documentation for the CC3200 in the pyb module.Daniel Campora
2015-06-10docs: Add initial draft documentation for the WiPy.Daniel Campora
This makes all common files "port-aware" using the .. only directive.
2015-04-21docs: Document pyb.stop, pyb.standby and pyb.RTC.wakeup.Damien George
2015-04-09docs: Document pyb.main function to set main script.Damien George
2015-02-13stmhal: Add Python-configurable USB HID mode.Damien George
Different HID modes can be configured in Python. You can either use predefined mouse or keyboard, or write your own report descriptor.
2015-01-08docs: Add note about maximum frequency of busses.Damien George
2015-01-01docs: Add quickref info about Servo; improve Servo docs.Damien George
2014-12-27stmhal: Add ability to mount custom block device.Damien George
2014-12-08stmhal: Enhance pyb.freq to configure bus (AHB, APB1, APB2) freqs.Damien George
This is useful if you need precise control over the speed of peripherals (eg SPI clock).
2014-11-02stmhal: Improve pyb.freq to allow 8 and 16MHz (not usable with USB).Damien George
Also restrict higher frequencies to have a VCO_OUT frequency below 432MHz, as specified in the datasheet. Docs improved to list allowed frequencies, and explain about USB stability.
2014-10-31docs: Cleanup and update some docs.Damien George
2014-10-31docs: Import documentation from source-code inline comments.Damien George
The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.