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
a6cf45864f
docs/network: esp8266: MAC address is set via .config() method.
2016-05-03 01:04:40 +03:00
ae845f13de
docs: Use getaddrinfo() result in easy way.
...
Instead of extracting 4th element, extact last. Much easier to remember!
2016-05-03 00:48:04 +03:00
c816b89353
docs/library/machine.I2C: Update to reflect ESP8266 implementation.
...
This machine.I2C documentation is now closer to a more port-neutral
description, although there are still differences between WiPy and
ESP8266.
2016-05-02 12:31:17 +01:00
621c644205
docs: _io and _collections were renamed to have standard "u" prefix.
2016-05-02 14:02:54 +03:00
70ff7350e7
stmhal, cc3200: Change i2c.scan() method to scan addresses 0x08-0x77.
...
A standard I2C address is 7 bits but addresses 0b0000xxx and 0b1111xxx
are reserved. The scan() method is changed to reflect this, along with
the docs.
2016-05-02 11:15:36 +01:00
8ebdbcfb27
docs: Add _io module reference.
2016-05-02 00:39:36 +03:00
348caaf940
docs: Add _collections module reference.
2016-05-02 00:36:58 +03:00
fd283eba64
docs/sys: Describe sys.platform is port-neutral manner.
2016-05-01 14:39:38 +03:00
e9b7610748
docs/sys: Describe sys.maxsize.
2016-05-01 14:31:08 +03:00
59603a2e89
docs/sys: Describe sys.implementation.
2016-05-01 13:59:34 +03:00
4fb9452bff
docs/sys: Clean up print_exception() description.
2016-05-01 13:44:06 +03:00
ad2889c141
docs/sys: Clarify description of sys.exit().
2016-05-01 13:42:36 +03:00
8ad1659f68
docs/sys: Make module variable descriptions proper sentences.
2016-05-01 13:38:45 +03:00
7781caf8d3
docs/sys: Remove port-specific details from description of stdin/out/err.
2016-05-01 13:37:28 +03:00
c468fe65c5
docs/ustruct: Fix argument formatting.
...
Per current CPython docs conventions, arguments are in italics. Follow
that.
2016-05-01 13:34:16 +03:00
a9ed42b3b4
docs/sys: Document sys.modules.
2016-05-01 13:32:15 +03:00
6b6acc5b5d
docs/ustruct: Document pack_into(), unpack_from().
2016-05-01 13:17:07 +03:00
83e99f88cb
docs/utime: Clarify module purpose.
2016-05-01 01:48:30 +03:00
613fd0a1ca
docs/library/utime: Elaborate on epochs and calendar time maintenance.
2016-05-01 00:16:47 +03:00
6d8156ae28
docs/network: esp8266: Describe wlan.config() method.
2016-04-28 00:11:55 +03:00
06deec9d35
docs/network: esp8266: Add wlan.ifconfig() method.
2016-04-28 00:10:29 +03:00
1b45670c69
docs/ubinascii: Clean up grammar.
2016-04-27 15:47:33 +03:00
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
2016-04-27 15:43:48 +03:00
31300b5144
docs/utime: Describe sleep() peculiarities in MicroPython.
...
Not all ports accept floating-point value.
2016-04-27 15:28:46 +03:00
c564169c8f
docs/utime: Describe time() peculiarities in MicroPython.
2016-04-27 15:23:11 +03:00
556e5dfd35
docs/library/utime: Add more time functions for unix and esp8266 ports.
2016-04-27 12:30:59 +01:00
e0f7e001e8
docs: Fix uos and utime heading underlines to be the correct length.
...
Otherwise Sphinx gives a warning.
2016-04-27 12:11:27 +01:00
351ec6d4ab
docs/library: "os" module is actually "uos".
2016-04-27 01:55:06 +03:00
0df2ee0126
docs/library/index: Order sections from the most to least standard modules.
2016-04-27 01:38:59 +03:00
492bf12499
docs/library/index: Make single section for "micro-ified" modules.
...
Even the modules whose names don't start with "u" prefix are micro-ified
anyway, i.e. provide only subset of CPython's functionality (and sometimes
extensions to it). So, it doesn't make much sense to devide them by
criteria of having/not having "u" prefix.
2016-04-27 01:38:59 +03:00
678f3a1e05
docs: Module "time" is actually "utime".
2016-04-27 01:38:59 +03:00
a119983328
docs/library/index: esp8266 has the same set of stdlibs as pyboard/unix.
2016-04-27 01:17:28 +03:00
88ed518390
docs/library/index: Move WiPy "micro-libraries" under corresponding heading.
2016-04-27 01:14:16 +03:00
8b8c32c09b
docs/library: Group MicroPython-specific modules under separate heading.
2016-04-27 01:11:24 +03:00
650df97c06
docs/network: esp8266: scan(): Add note that bssid is bytes object.
2016-04-26 01:09:11 +03:00
0d10e5310a
docs/usocket: Describe address format once at the beginning.
...
Different ports may have different formats.
2016-04-23 00:31:05 +03:00
92497bff94
docs/usocket: socket.IPPROTO_SEC is WiPy-specific.
2016-04-23 00:17:34 +03:00
955b8526f4
docs/usocket: Socket-specific exceptions are for WiPy only.
2016-04-23 00:17:09 +03:00
71c6f93016
docs/library/usocket: Add link to CPython's socket module.
2016-04-23 00:08:43 +03:00
bbe5245028
docs: esp8266: Include usocket module reference.
2016-04-23 00:08:11 +03:00
3bc9b571bb
docs/ustruct: There's no complete "struct" module, only "ustruct" subset.
...
"ustruct" is good example of micro-ified module, so rather should belong
to the corresponding list.
2016-04-22 22:37:14 +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
b122ed0732
docs/esp: Enumerate flash access functions.
2016-04-15 14:01:22 +03:00
22cbcd55f0
stmhal: Properly handle RTS/CTS flow control for buf/unbuf transfers.
...
Fixes issues #1912 and #1913 . UART documentation is also updated.
2016-04-13 08:42:32 +01:00
9c04299da1
docs: esp8266: Enable "machine" module docs.
...
The docs are still heavily biased towards WiPy, so will need a lot of
exclusions.
2016-04-07 16:44:10 +03:00
5e7fa7c80c
docs/ubinascii: Document non-standard "sep" argument to hexlify().
2016-04-07 12:39:00 +03:00
f81ea6307c
docs/ubinascii: Document a2b_base64(), b2a_base64().
2016-04-05 14:00:12 +03:00
28d4b94dce
docs/machine: Change wording to be a bit more port-neutral.
2016-04-03 20:49:29 +03:00
69b702276b
docs/os: Change wording to be a bit more port-neutral.
2016-04-03 20:49:25 +03:00
e24674d44e
docs: esp8266: esp.socket is deprecated, remove from docs.
2016-04-03 20:19:39 +03:00
f50d9477c1
docs: network: esp8266: .scan() is now synchronous and returns result list.
2016-03-30 11:56:20 +03:00
d7019d0628
docs: network: esp8266: status is WLAN object method.
2016-03-30 11:53:45 +03:00
193795398d
docs: Correct pin interrupt example code for the WiPy.
2016-03-28 13:12:58 +02:00
87c783b454
docs/esp8266: esp.mac() replaced with network.WLAN.mac().
2016-03-27 06:59:39 +03:00
679fe0abae
docs/esp8266: esp.wifi_mode() replaced with network.WLAN.active().
2016-03-27 06:59:00 +03:00
eda8746324
docs/esp8266: phy_mode() moved to network module.
2016-03-27 06:58:06 +03:00
e589cddcd4
docs/esp: Remove getaddrinfo(), now in socket module as expected.
2016-03-25 16:39:18 +02:00
6e6488530e
docs: More standard modules for esp8266.
2016-03-25 16:33:05 +02:00
4b5606bc09
docs/network: esp8266: Update docs on WLAN constructor.
2016-03-25 16:30:06 +02:00
ee6fcc6f91
docs: Add standard modules list for esp8266.
2016-03-25 15:17:55 +02:00
2b302dad51
docs: Update pyb.UART.any() to mention that it returns character count.
2016-03-17 20:19:36 +00:00
6d5a549067
docs: Mention that pyb.SPI constructor accepts "X" and "Y" arguments.
2016-03-17 20:19:08 +00:00
b8133c4c0f
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
2016-03-17 20:18:36 +00:00
85d3b6165a
docs: Update details on using ADCAll object for vref/vbat channels.
2016-03-11 16:33:09 +00:00
6bb9d3ea3e
docs/uctypes.rst: Fix typo (steamlined -> streamlined).
2016-03-02 00:25:10 +02:00
57b96a7be2
docs: Correct machine.Timer code examples related to duty cycle.
2016-02-23 20:22:26 +01:00
8e1fdf2eb3
docs: Add note on machine.Timer class regarding PWM output pins.
2016-02-23 19:53:59 +01:00
add930c4b5
cc3200: Rename 'server' class to 'Server' for consistency.
2016-02-22 22:54:34 +01:00
12547ce737
docs: Minor change to improve clarity in machine.Timer docs.
2016-02-22 19:16:30 +01:00
0d210a0be8
docs: Correct WiPy Timer docs.
2016-02-21 21:53:20 +01:00
73c9f85b4c
cc3200: Simplify the Timer API and correct the documents.
...
Make the PWM duty cycle configurable from 0.00 to 100.00 by
accepting values from 0 to 10000.
Add automatic Pin assignment when operating in PWM mode.
2016-02-21 21:53:16 +01:00
0f87a010e3
docs: Update to say that Timer(3) is free, and detail LED intensity.
2016-01-29 23:06:13 +00:00
c13b2f2d00
docs: Several minor changes: network, pyb, ADCAll and inline asm.
2016-01-13 21:53:26 +00:00
67f40fb237
docs: Include extra functions in time documentation for pyboard.
2016-01-04 22:57:21 +00:00
67a5bfc6d8
docs/library: Add network server example.
2015-12-16 22:35:14 +01:00
00960133c2
docs: Update docs for WiPy wlan.connect().
...
- The link establishment timeout is infinite by default
- Fix typo in notes about the auth kwarg
2015-11-18 19:47:40 +01:00
549c79d11e
docs/select: Document POLLIN/OUT/ERR/HUP.
2015-11-09 22:10:32 +02:00
43efb46328
docs/library/index.rst: Minimally adapt for unix port.
2015-10-31 01:15:25 +03:00
98b6d35c4f
docs: select: Describe poll.poll() return value in detail.
2015-10-29 22:08:10 +03:00
b7ab70c71c
docs: USB_VCP: Always in non-blocking mode, clarify stream method returns.
...
They return None if no data available.
2015-10-25 13:24:29 +03:00
cf6daa0966
docs: Explicitly specify behavior of UART stream protocol methods on timeout.
2015-10-25 08:25:34 +03:00
ee7bebc94f
docs: Correct machine.RTC examples.
2015-10-22 20:23:28 +02:00
4efed58df1
docs: Fix typos on wipy docs.
2015-10-22 16:35:04 +02:00
e954604ae0
docs: Add remark about ssl sockets and standard sockets.
2015-10-21 22:52:36 +02:00
ee0058d174
docs: Remove remaining references to 'af', which is now 'alt'.
2015-10-21 15:30:57 +02:00
ceb169008d
docs: Several corrections to the classes in the machine module.
2015-10-21 15:30:56 +02:00
04db848dc7
docs: Add usocket and ussl modules' documentation.
2015-10-21 15:30:56 +02:00
9c72c71c05
cc3200: WLAN class can retrieve the existing instance.
2015-10-19 21:17:15 +02:00
8faf2dc75b
docs/wipy: Add wipy tutorials section.
2015-10-19 21:17:15 +02:00
36ae417c9f
docs: Add wipy and network.server documentation.
2015-10-19 21:17:15 +02:00
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
d6442407f5
docs: Fix formatting of DAC code examples.
2015-10-13 14:44:00 +01:00
b5c43be135
stmhal: Allow to set bits resolution for DAC; 8 is default, can have 12.
...
This patch allows to configure the DAC resolution in the constructor and
in the init function, eg:
dac = DAC(1, bits=12).
The default resolution is 8 bits for backwards compatibility. The bits
sets the maximum value accepted by write and write_timed methods, being
2**bits - 1.
When using write_timed with 12-bit resolution, the input buffer is
treated as an unsigned half-word array, typecode 'H'.
See PR #1130 for discussion.
2015-10-13 14:33:04 +01:00
845b5a2a58
docs: Describe properly how MCU can be woken from pyb.standby() state.
2015-10-10 00:03:14 +01:00
37ab061f4d
docs: Update esp8266 documentation to match the code.
...
* Move the esp.status() to network module.
* Describe the wifi.isconnected() method.
* Describe esp.mac(), esp.wifi_mode(), esp.phy_mode(), esp.sleep_type(),
esp.deepsleep(), and esp.flash_id() functions.
2015-10-06 23:25:35 +01:00
861fad5819
docs: Adapt WiPy's ADC doc and quickref to the new API.
2015-09-16 10:10:40 +02:00
aba75e1233
cc3200: New SPI API.
2015-09-16 10:10:33 +02:00
624cdeacc4
docs/wipy: Add pins to the I2C constructor.
2015-09-16 10:10:31 +02:00
41f6948545
cc3200: New WDT API.
2015-09-16 10:10:29 +02:00
8332044f75
cc3200: Add UART.ODD and UART.EVEN to select parity.
2015-09-16 10:10:26 +02:00
d5ec336eef
cc3200: Replace Pin.PULL_NONE with None.
2015-09-16 10:10:24 +02:00
f38d16483a
docs: Update I2C and UART docs to match the new API.
2015-09-16 10:10:22 +02:00
f91f212d9f
cc3200: New UART API plus related test.
2015-09-10 07:59:47 +02:00
36821d095a
cc3200: Add alternate functions list to Pin object.
...
Also remove pin.high() and pin.low() methods.
2015-09-10 07:59:41 +02:00
d5e256486e
cc3200: Re-work Pin class according to the new API.
...
Also add relevant test.
2015-09-10 07:59:35 +02:00
11d21081b4
cc3200: Rework SD API. Increase heap to avoid malloc failures.
2015-08-16 20:17:58 +02:00
34c290b678
cc3200: Rename SPI nss param to cs.
...
The nss param in the pyboard has a different meaning that doesn't
apply to the WiPy.
2015-08-16 20:17:55 +02:00
ea5061e409
cc3200: Improve callback API.
...
Rename "wakes" param to "wake_from" and make "value" an object
instead of an integer.
2015-08-16 20:17:52 +02:00
7027fd5343
cc3200: Make ADC API compatible with the pyboard.
2015-08-10 23:42:05 +02:00
e54a4f1f48
cc3200: Improve support for WEP security.
...
Key is always entered as a string, but if security is WEP, the key
is converted automatically to hex before connecting or configuring
the device as an AP.
2015-08-09 19:22:16 +02:00
d43019163d
docs: Add i2c keywork arguments only indication.
2015-08-09 19:22:14 +02:00
00c4d6562e
cc3200: Add nic.iwconfig() to set/get WLAN configuration.
...
Changes are based on this post:
https://github.com/micropython/micropython/issues/876#issuecomment-115255551
The constructor can optionally take the same params of iwconfig in
order to configure WiFi when creating the object. Params are
keyworkd only. The WiPy accepts:
- mode (int -> WLAN.AP or WLAN.STA)
- ssdi (string)
- security (int -> WLAN.OPEN, WLAN.WEP, WLAN.WPA, WLAN.WPA2)
- key (string)
- channel (int (1-11))
- antenna (int -> WLAN.INTERNAL, WLAN.EXTERNAL)
2015-08-09 19:22:12 +02:00
c6926c374d
cc3200: Make I2C and SPI API the same as in stmhal.
2015-08-02 20:22:15 +02:00
007878781c
cc3200: Rename pins from GPIO to just GP.
...
This is how the names will be printed on the sticker that goes on top
of the EMI shield. The shorter names also help saving a few bytes of
RAM and ROM.
2015-07-30 00:43:08 +02:00
7693ef3bd6
stmhal: Allow ADC.read_timed to take Timer object in place of freq.
...
This allows a user-specified Timer for the triggering of the ADC read,
mirroring the new behaviour of DAC.write_timed.
Addresses issue #1129 .
2015-07-22 19:41:13 +01:00
abc24c1876
stmhal: Allow DAC.write_timed to take Timer object in place of freq.
...
This allows the DAC to use a user-specified Timer for the triggering
(instead of the default Timer(6)), while still supporting original
behaviour.
Addresses issues #1129 and #1388 .
2015-07-21 23:39:49 +01:00
7463442e58
docs: Update pyb.Accel doc to reflect changes and explain filtered_xyz.
2015-07-08 11:10:51 +01:00
5161239c9f
cc3200: time.sleep() now receives seconds, like CPython.
2015-07-02 17:23:22 +02:00
813b581127
cc3200: Add `Pin.name()` method.
2015-06-28 14:14:22 +02:00
fa1cdb09fc
docs: Fix duplicate label error for network.WLAN.
2015-06-27 13:42:00 +01:00
7c61249ae6
esp8266: Updated documentation for scan() and moved to network
2015-06-17 23:16:28 +03:00
ea2cc2b907
docs: Add more documentation for the CC3200 in the pyb module.
2015-06-16 15:45:24 +02:00
05c6fbcae6
esp8266: Fix the documentation for esp.connect() and esp.disconnect()
...
Since the commit that moved those two functions failed to update
the documentation, this is a fix for that.
2015-06-13 23:03:06 +03:00
cfcf47c064
docs: Add initial draft documentation for the WiPy.
...
This makes all common files "port-aware" using the .. only directive.
2015-06-10 23:37:56 +02:00
06e85ecfa6
docs/uctype: Update for constructor argument order changes.
...
Also, other small cleanups/improvements.
2015-06-06 22:58:04 +03:00
3eece29807
docs: Change "Micro Python" to "MicroPython" in all places in docs.
2015-06-04 23:53:26 +01:00
32ce72cb9e
docs/uctypes: Typo fix.
2015-06-02 10:35:06 +03:00
f8bce131c0
docs/uctypes: Fix API description errors.
...
"Structure class" is its descriptor, encoded as a dictionary. Then,
uctypes.struct() instantiates an actual object, and thus requires memory
address.
2015-06-02 10:30:01 +03:00
78ccb44a90
docs: Document esp module for ESP8266.
...
I document as much as I could guess from experiments and reading the
code for the ``esp`` module for the ESP8266 port of Micropython.
For now the tag has to be set manually with -t option when building,
when we have properly split documentation, there will be a separate
config file for esp8266 with that the tag "port_esp8266" set.
To build use:
make SPHINXOPTS="-t port_esp8266" html
2015-05-30 12:49:58 +01:00
3ad94d6072
extmod: Add ubinascii.unhexlify
...
This also pulls out hex_digit from py/lexer.c and makes unichar_hex_digit
2015-05-20 09:29:22 +01:00
0bfc57022d
docs: Document USB_VCP file-like methods.
2015-05-13 20:42:12 +01:00
c7df9c6c47
stmhal: Add os.rename function.
2015-05-12 23:43:11 +01:00
5df81de7af
sthmal/rtc.c: Add calibration() method to get/set RTC fine-tuning value.
2015-05-11 23:48:39 +01:00
dea853d3a3
docs: Document pyb.stop, pyb.standby and pyb.RTC.wakeup.
2015-04-21 22:35:17 +01:00
e3cd154317
stmhal: Add support for sending and receiving CAN RTR messages.
2015-04-18 14:53:00 +01:00
7d5e34287c
stmhal: Allow sending CAN messages with timeout=0.
...
Thanks to Henrik Sölver for this patch.
2015-04-16 23:52:43 +01:00
e97dddcdca
docs: Document pyb.main function to set main script.
2015-04-09 10:08:25 +01:00
344057ac50
docs: uctypes: Bullet list formatting fixes.
2015-03-31 01:29:07 +03:00
9d2c0c231c
docs: uctypes: Describe how to instantiate struct objects.
2015-03-31 01:16:14 +03:00
e178ef2520
docs: Add additional example/note for Timer's callback usage.
...
Add example: using named function for the Timer's callback.
Add note: improving traceback inside interrupt timers.
2015-03-30 00:43:04 +01:00
47098efbda
docs: Provide initial documentation for micropython module.
2015-03-30 00:32:29 +01:00
c260836beb
docs: uctypes: Describe bytes_at(), bytearray_at().
2015-03-27 00:19:23 +02:00
ec1b1cf834
docs: uctypes: Describe couple more functions.
2015-03-24 22:42:54 +02:00
b4c9a25eab
stmhal: Add support for quadrature encoder mode to pyb.TimerChannel.
2015-03-09 13:23:14 +00:00
b57b56f293
docs: Update pyb.Timer.rst to fix pulse widths that exceed the period.
2015-03-09 12:14:32 +00:00
4fddbe5ab6
docs: Correct the documentation for math.frexp.
2015-02-23 22:15:11 +00:00
Paul Sokolovsky
Damien George
Peter Hinch
danicampora
Noah Rosamilia
Henrik Sölver
Noah
Radomir Dopieralski
Bill Owens
Dave Hylands
Steve Zatz
blmorris
Ivan Pejić
Peter Hinch