3e0d587a49
docs/library/machine: Remove conditional docs for rng function.
...
And instead list its availability explicitly.
2018-07-18 16:28:30 +10:00
163cc66a0b
docs/library/machine: Remove conditional docs for wake_reason function.
...
And instead list its availability explicitly.
2018-07-18 16:23:34 +10:00
7c0e1f1a08
docs/machine*: Use markup adhering to the latest docs conventions.
2017-06-25 13:30:29 +03:00
f245f5d7cc
docs/machine: Sort machine classes in logical order, not alphabetically.
...
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-06-03 14:50:54 +03:00
0ba136fbe9
docs/machine.Signal: Add initial draft description of Signal class.
2017-05-14 23:12:06 +03:00
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
2017-04-16 10:14:05 +03:00
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
2017-04-16 10:12:01 +03:00
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
2017-04-05 11:58:17 +03:00
ed81574fe9
docs/machine: Fix formatting of Constants section.
...
Render related constants grouped together, with common description.
2017-02-28 00:38:15 +03:00
0c821f7def
docs/library/machine: Make separate TOC for WiPy vs non-WiPy.
...
WiPy is the only port with ADC and SD, so they shouldn't be included in
other ports' documentation.
2017-02-13 13:06:51 +11:00
d5e9ab6e61
extmod/machine_pulse: Make time_pulse_us() not throw exceptions.
...
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-02-05 14:20:17 +03:00
0aa83142a4
docs/machine: Add explicit note on machine module level and scope.
...
It's very low, hardware level, with associated constraints on operations
and callbacks.
2017-01-28 12:08:25 +03:00
eeb9d99333
docs/library/machine: Update description of disable/enable IRQ funcs.
2016-09-23 13:15:58 +10:00
f3b5480be7
stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.
...
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-09-08 12:50:38 +10:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
93a9c2e840
docs/library/machine: Add documentation for machine.time_pulse_us.
2016-05-31 14:06:33 +01:00
a3dc2c6031
docs/machine: Make disable_irq and enable_irq docs available for all.
2016-05-26 15:47:47 +01:00
81a99eb388
docs/machine: idle() description generalization.
2016-05-03 12:53:57 +03:00
bb6458bf43
docs/machine: More generic description of sleep's, WiPy details to its genref.
2016-05-03 12:48:20 +03:00
db99ae00a2
docs/machine: Move WiPy-specific hardware details to its general reference.
2016-05-03 12:26:55 +03:00
06ec96b47b
docs/machine: Generalize docs from just WiPy to other ports.
2016-05-03 12:15:29 +03:00
67ece47121
docs/machine: reset_cause() has been implemented for esp8266.
2016-04-17 17:40:08 +03:00
f474e956d7
docs/machine: Start to update for esp8266 port.
2016-04-15 17:06:11 +03:00
28d4b94dce
docs/machine: Change wording to be a bit more port-neutral.
2016-04-03 20:49:29 +03:00
ceb169008d
docs: Several corrections to the classes in the machine module.
2015-10-21 15:30:56 +02:00
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
Damien George
Paul Sokolovsky
Mike Causer
danicampora