2015-12-04 23:12:28 +01:00
|
|
|
site_name: NodeMCU Documentation
|
|
|
|
site_description: Description of the NodeMCU documentation
|
2015-12-05 01:05:14 +01:00
|
|
|
repo_url: https://github.com/nodemcu/nodemcu-firmware/
|
2015-12-14 21:41:06 +01:00
|
|
|
|
2015-12-17 17:33:43 +01:00
|
|
|
theme: readthedocs
|
2015-12-13 14:43:52 +01:00
|
|
|
strict: true
|
2015-12-17 17:33:43 +01:00
|
|
|
|
2015-12-05 01:05:14 +01:00
|
|
|
markdown_extensions:
|
2015-12-17 17:33:43 +01:00
|
|
|
#http://pythonhosted.org/Markdown/extensions/admonition.html
|
2015-12-14 21:41:06 +01:00
|
|
|
- admonition:
|
2015-12-05 01:05:14 +01:00
|
|
|
- toc:
|
|
|
|
permalink: True
|
2015-12-14 21:41:06 +01:00
|
|
|
|
2016-01-01 15:12:04 +01:00
|
|
|
#requird due to https://github.com/rtfd/readthedocs.org/issues/1313
|
2015-12-27 23:51:54 +01:00
|
|
|
#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
|
2015-12-27 23:49:11 +01:00
|
|
|
extra_css:
|
|
|
|
- css/extra.css
|
2015-12-27 23:51:54 +01:00
|
|
|
extra_javascript:
|
2015-12-27 23:49:11 +01:00
|
|
|
- js/extra.js
|
|
|
|
|
|
|
|
site_favicon: img/favicon.png
|
|
|
|
|
2015-12-04 23:12:28 +01:00
|
|
|
pages:
|
2015-12-27 23:32:07 +01:00
|
|
|
- Overview: 'index.md'
|
|
|
|
- English:
|
2015-12-28 17:25:00 +01:00
|
|
|
- Home: 'en/index.md'
|
|
|
|
- Building the firmware: 'en/build.md'
|
|
|
|
- Flashing the firmware: 'en/flash.md'
|
2016-01-16 23:11:40 +01:00
|
|
|
- Uploading code: 'en/upload.md'
|
Add New Tasking I/F and rework GPIO, UART, etc to support it
As with the last commit this rolls up the follwowing, but include the various
review comments on the PR.
- **Documentation changes**. I've added the taks FAQ as a stub new Extension
developer FAQ, and split the old FAQ into a Lua Developer FAQ and a Hardware
FAQ.
- **Tasking I/F**. New `app/task/Makefile`, `app/task/task.c`,
`app/include/task/task.h` and `app/Makefile` as per previous commit. Cascade
changes to `app/driver/uart.c`, `app/include/driver/uart.h`,
`app/user/user_main.c` and `app/modules/node.c`
- **GPIO Rework** to `app/modules/gpio.c` and `pin_map.[hc]`, `platform.[hc]`
in `app/platform`
- **Other Optimisations** Move the `platform_*_exists()` from
`app/platform/common.c` to static inline declarations in `platform.h` as
this generates faster, smaller code. Move lgc.a routines out of iram0.
2016-02-17 18:13:17 +01:00
|
|
|
- FAQs:
|
|
|
|
- Lua Developer FAQ: 'en/lua-developer-faq.md'
|
|
|
|
- Extension Developer FAQ: 'en/extn-developer-faq.md'
|
|
|
|
- Hardware FAQ: 'en/hardware-faq.md'
|
2015-12-28 17:25:00 +01:00
|
|
|
- Support: 'en/support.md'
|
2015-12-27 23:32:07 +01:00
|
|
|
- Modules:
|
2016-01-05 04:06:01 +01:00
|
|
|
- 'adc': 'en/modules/adc.md'
|
2016-02-13 12:57:19 +01:00
|
|
|
- 'am2320': 'en/modules/am2320.md'
|
2016-01-26 23:07:29 +01:00
|
|
|
- 'apa102': 'en/modules/apa102.md'
|
2016-01-05 06:07:29 +01:00
|
|
|
- 'bit': 'en/modules/bit.md'
|
2016-02-21 22:28:01 +01:00
|
|
|
- 'bme280': 'en/modules/bme280.md'
|
2016-01-14 22:37:22 +01:00
|
|
|
- 'bmp085': 'en/modules/bmp085.md'
|
2016-01-06 01:51:48 +01:00
|
|
|
- 'cjson': 'en/modules/cjson.md'
|
2016-01-16 06:25:54 +01:00
|
|
|
- 'coap': 'en/modules/coap.md'
|
2016-01-05 04:23:26 +01:00
|
|
|
- 'crypto': 'en/modules/crypto.md'
|
2016-01-13 23:27:16 +01:00
|
|
|
- 'dht': 'en/modules/dht.md'
|
2016-02-21 05:18:27 +01:00
|
|
|
- 'encoder': 'en/modules/encoder.md'
|
2016-01-10 22:52:05 +01:00
|
|
|
- 'enduser setup': 'en/modules/enduser-setup.md'
|
2016-01-05 02:21:19 +01:00
|
|
|
- 'file': 'en/modules/file.md'
|
2016-01-10 22:52:05 +01:00
|
|
|
- 'gpio': 'en/modules/gpio.md'
|
2016-01-16 12:59:08 +01:00
|
|
|
- 'http': 'en/modules/http.md'
|
2016-01-10 23:32:51 +01:00
|
|
|
- 'hx711' : 'en/modules/hx711.md'
|
2016-01-10 21:27:09 +01:00
|
|
|
- 'i2c' : 'en/modules/i2c.md'
|
2016-01-28 03:57:58 +01:00
|
|
|
- 'mdns': 'en/modules/mdns.md'
|
2016-01-17 11:10:51 +01:00
|
|
|
- 'mqtt': 'en/modules/mqtt.md'
|
2016-01-11 23:30:30 +01:00
|
|
|
- 'net': 'en/modules/net.md'
|
2016-01-10 22:52:05 +01:00
|
|
|
- 'node': 'en/modules/node.md'
|
2016-01-17 14:05:41 +01:00
|
|
|
- 'ow (1-Wire)': 'en/modules/ow.md'
|
2016-02-21 21:12:13 +01:00
|
|
|
- 'perf': 'en/modules/perf.md'
|
2016-01-10 21:44:50 +01:00
|
|
|
- 'pwm' : 'en/modules/pwm.md'
|
2016-03-05 10:47:01 +01:00
|
|
|
- 'rc' : 'en/modules/rc.md'
|
2016-02-28 20:48:41 +01:00
|
|
|
- 'rotary' : 'en/modules/rotary.md'
|
2016-03-05 10:47:01 +01:00
|
|
|
- 'rtcfifo': 'en/modules/rtcfifo.md'
|
2016-01-05 02:43:57 +01:00
|
|
|
- 'rtcmem': 'en/modules/rtcmem.md'
|
2016-01-05 02:56:46 +01:00
|
|
|
- 'rtctime': 'en/modules/rtctime.md'
|
2016-01-31 21:48:59 +01:00
|
|
|
- 'sigma delta': 'en/modules/sigma-delta.md'
|
2016-01-05 03:01:53 +01:00
|
|
|
- 'sntp': 'en/modules/sntp.md'
|
2016-01-09 14:57:03 +01:00
|
|
|
- 'spi': 'en/modules/spi.md'
|
2016-02-12 18:15:36 +01:00
|
|
|
- 'struct': 'en/modules/struct.md'
|
2016-06-03 23:47:36 +02:00
|
|
|
- 'tm1829': 'en/modules/tm1829.md'
|
2016-01-06 03:06:00 +01:00
|
|
|
- 'tmr': 'en/modules/tmr.md'
|
2016-01-12 21:08:46 +01:00
|
|
|
- 'tsl2561': 'en/modules/tsl2561.md'
|
2016-01-08 20:40:20 +01:00
|
|
|
- 'u8g': 'en/modules/u8g.md'
|
2016-01-05 04:38:41 +01:00
|
|
|
- 'uart': 'en/modules/uart.md'
|
2016-01-09 00:57:07 +01:00
|
|
|
- 'ucg': 'en/modules/ucg.md'
|
2016-01-13 11:55:18 +01:00
|
|
|
- 'wifi': 'en/modules/wifi.md'
|
2016-01-11 22:43:04 +01:00
|
|
|
- 'ws2801': 'en/modules/ws2801.md'
|
|
|
|
- 'ws2812': 'en/modules/ws2812.md'
|
2016-01-16 23:11:40 +01:00
|
|
|
#- Deutsch:
|
|
|
|
# - Home: 'de/index.md'
|