aboutsummaryrefslogtreecommitdiff
path: root/docs/library/machine.rst
AgeCommit message (Collapse)Author
2020-10-20docs/library/machine.rst: Correct minor typo: timout to timeout.Howard Lovatt
2020-01-12docs/library: Add / to indicate positional-only args in library docs.Jason Neal
Removes the confusion of positional-only arguments which have defaults that look like keyword arguments.
2020-01-12docs/library/machine: Document machine.soft_reset() function.Thorsten von Eicken
2019-06-03docs/machine: Add initial docs for new machine.SDCard class.Nicko van Someren
2019-01-27docs/machine: Change sleep to lightsleep and add timeout arguments.Damien George
The machine.sleep() function can be misleading because it clashes with time.sleep() which has quite different semantics. So change it to machine.lightsleep() which shows that it is closer in behaviour to machine.deepsleep(). Also, add an optional argument to these two sleep functions to specify a maximum time to sleep for. This is a common operation and underlying hardware usually has a special way of performing this operation. The existing machine.sleep() function will remain for backwards compatibility purposes, and it can simply be an alias for machine.lightsleep() without arguments. The behaviour will be the same.
2018-07-20docs/library/machine: Remove conditionals in machine class index.Damien George
The machine module should be standard across all ports so should have the same set of classes in the docs. A special warning is added to the top of the machine.SD class because it is not standardised and only available on the cc3200 port.
2018-07-18docs/library/machine: Remove conditional docs for rng function.Damien George
And instead list its availability explicitly.
2018-07-18docs/library/machine: Remove conditional docs for wake_reason function.Damien George
And instead list its availability explicitly.
2017-06-25docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-03docs/machine: Sort machine classes in logical order, not alphabetically.Paul Sokolovsky
The list starts with the simplest functionality - GPIO, proceeds to communication interfaces (UART, SPI, I2C), the to time(r) related things, then everything else.
2017-05-14docs/machine.Signal: Add initial draft description of Signal class.Paul Sokolovsky
2017-04-16docs/library/machine: Typo fix in machine_callbacks section.Paul Sokolovsky
2017-04-16docs/machine: Move machine.main() misnomer to wipy's known issues.Paul Sokolovsky
2017-04-05cc3200/modmachine: Return frequency value directly, like other ports.Paul Sokolovsky
2017-02-28docs/machine: Fix formatting of Constants section.Paul Sokolovsky
Render related constants grouped together, with common description.
2017-02-13docs/library/machine: Make separate TOC for WiPy vs non-WiPy.Damien George
WiPy is the only port with ADC and SD, so they shouldn't be included in other ports' documentation.
2017-02-05extmod/machine_pulse: Make time_pulse_us() not throw exceptions.Paul Sokolovsky
machine.time_pulse_us() is intended to provide very fine timing, including while working with signal bursts, where each transition is tracked in row. Throwing and handling an exception may take too much time and "signal loss". So instead, in case of a timeout, just return negative value. Cases of timeout while waiting for initial signal stabilization, and during actual timing, are recognized. The documentation is updated accordingly, and rewritten somewhat to clarify the function behavior.
2017-01-28docs/machine: Add explicit note on machine module level and scope.Paul Sokolovsky
It's very low, hardware level, with associated constraints on operations and callbacks.
2016-09-23docs/library/machine: Update description of disable/enable IRQ funcs.Damien George
2016-09-08stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.Damien George
machine.POWER_ON is renamed to machine.PWRON_RESET to match other reset-cause constants that all end in _RESET. The cc3200 port keeps a legacy definition of POWER_ON for backwards compatibility.
2016-08-02docs: Spelling mistakesMike Causer
2016-05-31docs/library/machine: Add documentation for machine.time_pulse_us.Damien George
2016-05-26docs/machine: Make disable_irq and enable_irq docs available for all.Damien George
2016-05-03docs/machine: idle() description generalization.Paul Sokolovsky
2016-05-03docs/machine: More generic description of sleep's, WiPy details to its genref.Paul Sokolovsky
2016-05-03docs/machine: Move WiPy-specific hardware details to its general reference.Paul Sokolovsky
2016-05-03docs/machine: Generalize docs from just WiPy to other ports.Paul Sokolovsky
2016-04-17docs/machine: reset_cause() has been implemented for esp8266.Paul Sokolovsky
2016-04-15docs/machine: Start to update for esp8266 port.Paul Sokolovsky
2016-04-03docs/machine: Change wording to be a bit more port-neutral.Paul Sokolovsky
2015-10-21docs: Several corrections to the classes in the machine module.danicampora
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora