Paul Sokolovsky
d5b8825d5f
docs/machine.Pin: Add on() and off() methods.
8 years ago
Paul Sokolovsky
3496d9e4bd
docs/machine.Pin: Remove out_value() method.
This method isn't implemented in any port. It seemed to have originated
in cc3200 port, but actually never was implemented there either. In
general case, it's impossible to implement this method (for example, for
a perfect GPO, which has only output latch without any feedback look
into a CPU).
8 years ago
Paul Sokolovsky
3ebd67fc09
library/machine.Pin: Remove .id() method and .board class attr.
Both aren't part of generic Hardware API: It's impossible to implement
.id() method in a generic case (e.g., when Pin is instantiated by the
underlying OS/RTOS). .board attribute is an obvious space hog which
instead can be implemented on Python level if needed.
8 years ago
Paul Sokolovsky
c19f07bd52
docs/machine.Pin: There's no toggle() method in MicroPython hardware API.
May be a port-specific method, not portable, not part of the official
specification.
8 years ago
Damien George
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
8 years ago
Paul Sokolovsky
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
8 years ago
Paul Sokolovsky
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
8 years ago
Damien George
3e5e4f95b2
docs/library/machine.Pin: Update Pin docs to align with new HW API.
8 years ago
Mike Causer
ce166e6b68
docs: Spelling mistakes
8 years ago
Paul Sokolovsky
79b40d1127
docs/machine*: Remove explicit targets and "machine." prefixes on classes.
With currentmodule:: set properly, none are needed. Extra "machine." prefix
produces wrong indexing data.
9 years ago
Paul Sokolovsky
a0c296f6d5
docs/machine.Pin: Disambiguate object call method.
9 years ago
Paul Sokolovsky
bba77a2d01
docs/machine.Pin: Add class designator to all constants.
This makes rendered docs to not provide incorrect information and
consistent with how it's down for other machine classes.
9 years ago
Paul Sokolovsky
7d7243f44c
docs/machine.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class
name.
9 years ago
Paul Sokolovsky
0a4361ca67
docs/machine.Pin: Remove explicit target.
With currentmodule:: support, all targets should be generated properly by
Sphinx.
9 years ago
Paul Sokolovsky
c8b7628094
docs/machine.*: Add "currentmodule:: machine" directive.
Makes sure that classes described in these separate files are properly
designated as belonging to "machine" module in indexes.
9 years ago
Paul Sokolovsky
2c5fc681c8
docs/library/machine.Pin: Mention GPIO and cross-link .value() function.
9 years ago
Damien George
5036b6ad18
docs/library/machine.Pin: Update pin docs to reflect ESP8266 support.
9 years ago
danicampora
193795398d
docs: Correct pin interrupt example code for the WiPy.
9 years ago
danicampora
ceb169008d
docs: Several corrections to the classes in the machine module.
9 years ago
danicampora
4542643025
docs: Update all WiPy docs to reflect the new API.
9 years ago