Commit Graph

277 Commits

Author SHA1 Message Date
philip 0e9a0d43d4 Direct port of the struct module that provides access to
packed structures in strings. Very useful for network protocol
packing/unpacking. The docs are directly converted from the original.

Review feedback

Fix typo
2016-02-13 08:32:25 -05:00
Arnim Läuger 6623b9e3fd spi.CPOL_HIGH supported
with bf74b617d0
2016-02-09 20:30:58 +01:00
Marcel Stör e9cde6eb34 Correct secure option in MQTT documentation
Fixes #996
2016-02-06 22:28:07 +01:00
Arnim Läuger d760a5e29c Merge pull request #940 from devsaurus/dev-ssd1327
implement architecture dependent delay functions for u8glib
2016-02-06 21:46:01 +01:00
cheloftus 58dd15e1d1 Added crypto.fhash function for hashing files 2016-02-05 22:19:00 +00:00
Johny Mattsson fcb14a33b3 Merge pull request #987 from DiUS/enduser_enhanced
Enhancements to enduser_setup module
2016-02-02 00:39:47 +11:00
Johny Mattsson 86839d6e71 Fixes and enchancements for enduser_setup module.
Fixes:

* Removed spurious \0 bytes being sent to the client in many cases.

* Properly terminated 404 header.

* Now including Content-length: header for index.html (including built-in).

  Clients otherwise had to wait for their own timeout before considering
  the page load complete, which resulting in an unpleasant sluggish
  experience.

* Switched form submission to GET, as iOS sometimes does not include the
  body in the same packet as the POST header, which led to the module
  not finding the form values.

* Added redirect after form submission to avoid blank-page-in-browser.

* Moved common "enduser_setup" prefix to a lua_pushfstring() to reduce
  string literal overhead.

* Replaced cached lua_State* with calls to lua_getstate(), as in other
  modules.

* Fixed broken appending of MAC to the SSID.

* Fixed up macro definitions to not break `if` clauses unintentionally.

Enhancements:

* Support for scanning for available WiFi networks, and picking from the list.

* Support for retrieving the current WiFi station status.

* Added "manual" mode, where the module does not (re)configure the AP setup,
  nor shut down automatically. Default is still automatic, as before.

* Updated docs for new `enduser_setup.manual()` function.
2016-02-01 14:42:24 +11:00
Arnim Läuger d083122688 remove space in heading for gpio.write() 2016-01-31 21:58:49 +01:00
Marcel Stör 9e861313e9 Add chapter about firmware files and flash address
Had to slightly tweak the Markdown headers due to
https://github.com/mkdocs/mkdocs/issues/770 :(.

Fixes #990.
2016-01-31 14:33:49 +01:00
Marcel Stör ccd556be68 Add note about UART speed 2016-01-31 14:31:15 +01:00
Arnim Läuger 53f1761cfb add notes about upgrading from old fw 2016-01-31 11:54:58 +01:00
Arnim Läuger f42fdb1a76 also fix cb prototype description 2016-01-30 10:23:27 +01:00
philip 76b28c1f74 Simple mdns implementation using the Espressif code 2016-01-29 21:37:19 -05:00
Arnim Läuger 1697126a15 terminate example 2016-01-29 22:40:15 +01:00
devsaurus 8db93bcabf make delay optional 2016-01-29 18:52:38 +01:00
devsaurus 9741c8f1b5 fix #527 2016-01-28 23:46:35 +01:00
devsaurus 1c32d20502 improve error checking in mqtt module
connect(), close(), subscribe(), publish()
2016-01-28 21:36:38 +01:00
Marcel Stör c3e49940eb Fix a few titles on doc pages 2016-01-27 22:06:24 +01:00
Johny Mattsson 8f7055d030 Updated http module docs for #977. 2016-01-27 10:52:13 +11:00
Marcel Stör 51352ed782 Merge branch 'dev' of https://github.com/nodemcu/nodemcu-firmware into dev 2016-01-26 23:07:53 +01:00
Marcel Stör e23e07fd16 Make the APA102 docs available on RTD 2016-01-26 23:07:29 +01:00
Arnim Läuger 3124a0e6a8 add autoconnect option for publish() and update optional parameters 2016-01-26 22:55:33 +01:00
Robert Foss 0f3c0ffbb0 Added support for the APA102 LED. 2016-01-25 20:54:27 -05:00
Terry Ellison aac9824364 Merge pull request #955 from zhujunsan/dev
Fix example code in WiFi Module Doc
2016-01-20 10:25:34 +00:00
San 598b098184 Fix example code in WiFi Module Doc 2016-01-20 09:34:45 +08:00
Terry Ellison 5cbea0a61f Merge pull request #952 from DiUS/crypto-aes
Added AES support to crypto module.
2016-01-19 15:28:11 +00:00
San 3983dbcac9 Fix example code in HTTP Module
syntax error
2016-01-19 16:34:25 +08:00
Johny Mattsson 5b381d2f1e Added AES support to crypto module.
Merely a wrapper around the (undocumented) internal SDK AES functions.
2016-01-19 15:19:11 +11:00
Keith Fieldhouse 339f71ad75 Fix sample code bug (inconsistent variable names) in DHT example 2016-01-17 15:31:37 -05:00
Marcel Stör 96a05dcd41 Fix syntax for optional parameters for a few modules 2016-01-17 14:14:34 +01:00
Marcel Stör e86347acf3 Minor syntax fixes for the 1-wire docs 2016-01-17 14:05:41 +01:00
Arnim Läuger c7a40ea3ae fix introductory sentences for toc 2016-01-17 11:20:09 +01:00
Arnim Läuger cc975a947e move ow.reset 2016-01-17 11:13:11 +01:00
devsaurus 66eb0dfdb2 transferred ow module documentation 2016-01-17 11:10:51 +01:00
Marcel Stör 15577af881 Deactivate DE translation that was used for testing 2016-01-16 23:14:27 +01:00
Marcel Stör 9969c6b285 Final polishing on several pages 2016-01-16 23:11:40 +01:00
Marcel Stör 1dcb71618f Minor tweaks to FAQ 2016-01-16 15:26:19 +01:00
Marcel Stör 4609a88230 Fix font-size, it's odd and inconsistent in the theme 2016-01-16 15:25:48 +01:00
Marcel Stör 4afac3f5ab Replace I2C with I²C in the prose text 2016-01-16 15:09:44 +01:00
Marcel Stör b93f2ee8b1 Fix syntax in coap doc 2016-01-16 15:03:22 +01:00
Marcel Stör 8cbc5d6a05 Merge pull request #943 from funshine/newdocs
add a doc for coap module
2016-01-16 14:44:19 +01:00
Arnim Läuger e5f351e59b fix md links 2016-01-16 13:42:05 +01:00
devsaurus e48be07d8b ucg constants 2016-01-16 13:18:43 +01:00
devsaurus ce8b26501f feed the toc for u8g and ucg 2016-01-16 13:18:43 +01:00
Johny Mattsson bf0dc5e65f Avoid hard-coding the SDK version number in RTD. 2016-01-16 23:07:54 +11:00
Johny Mattsson a3ac4c80ba Documented HTTP module. 2016-01-16 22:59:08 +11:00
Marcel Stör 9efc4d5445 Add fix in TOC JavaScript for in-page anchors 2016-01-16 10:02:06 +01:00
Zeroday 57f8c1a25c add a doc for coap module
typo fix
2016-01-16 14:01:27 +08:00
Marcel Stör b03a669683 Add documentation for new wifi functions 2016-01-15 23:06:09 +01:00
Marcel Stör 6cc5af2fae Add JavaScript function to generate TOC on each module page 2016-01-15 22:34:33 +01:00
Johny Mattsson 0900958e92 Updated node.bootreason() to match latest dev merge. 2016-01-15 11:54:45 +11:00
Marcel Stör e1733f8d3a Remove extra comma in wifi docs 2016-01-15 00:00:49 +01:00
Marcel Stör 6480ba7282 Complete wifi docs transition 2016-01-14 23:27:38 +01:00
Marcel Stör d98b19daa2 Minor style fixes in the bm085 docs 2016-01-14 22:46:12 +01:00
Konrad Beckmann 5922fdba21 BMP085: Added documentation 2016-01-14 22:22:43 +01:00
Arnim Läuger 517faf44e3 note note 2016-01-13 23:30:39 +01:00
Arnim Läuger b9280ea6d1 note 2016-01-13 23:29:24 +01:00
devsaurus 3ba64bd768 transferred dht module documentation 2016-01-13 23:27:16 +01:00
Johny Mattsson 5fc553c7ce Transferred top-level WiFi module docs.
Note that this does not include wifi.sta, wifi.ap or wifi.ap.dhcp docs.
2016-01-13 21:55:18 +11:00
Johny Mattsson f53ba03967 Updated node.bootreason() documentation. 2016-01-13 16:04:59 +11:00
Marcel Stör d0da51f5a7 Minor fix with list syntax 2016-01-12 22:17:07 +01:00
devsaurus bd7a986d73 transferred tsl2561 module documentation 2016-01-12 21:08:46 +01:00
Marcel Stör 6c75dd40a9 Add net module documentation 2016-01-12 00:01:24 +01:00
devsaurus 762e803fdb fix br 2016-01-11 23:57:42 +01:00
devsaurus 36522d59a5 transferred ws2801 module documentation 2016-01-11 22:37:08 +01:00
devsaurus 75580f5dda transferred ws2812 module documentation 2016-01-11 22:36:25 +01:00
Marcel Stör ee80236053 Register updated HX711 doc file 2016-01-10 23:32:51 +01:00
Marcel Stör a9dee9e74c Merge pull request #919 from christakahashi/newdocs-hx711
docs for hx711
2016-01-10 23:27:13 +01:00
christakahashi 3c069b900a docs for hx711 2016-01-10 14:09:31 -08:00
Marcel Stör 6ef4fe1840 Transfer enduser-setup and mqtt docs 2016-01-10 22:52:05 +01:00
devsaurus 839dbc4dd6 add uart.alt() from wiki update 2016-01-10 21:54:37 +01:00
devsaurus 4fc088c88c transferred pwm module documentation 2016-01-10 21:54:37 +01:00
devsaurus e11cbaf889 transferred i2c module 2016-01-10 21:54:37 +01:00
Marcel Stör 7d1d10dc46 Update for consistency with the other docs 2016-01-10 21:39:02 +01:00
Marcel Stör 7eba3cbcf3 Update for consistency with the other docs 2016-01-10 16:04:23 +01:00
Johny Mattsson 8d38cef044 Documented max timer interval value. 2016-01-10 17:39:43 +11:00
Marcel Stör befff81868 Update for consistency with the other docs 2016-01-09 23:02:58 +01:00
Marcel Stör 7d965b2b24 Small doc-syntax fixes 2016-01-09 22:46:56 +01:00
Marcel Stör fe3a6490f6 Add reference to original lib documentation for CJSON 2016-01-09 21:22:39 +01:00
devsaurus bd20f15dfe transferred spi module documentation 2016-01-09 14:57:03 +01:00
devsaurus c60e243962 apply changes from #914 2016-01-09 14:03:04 +01:00
Marcel Stör 243ba446aa Small doc-syntax fixes 2016-01-09 12:37:56 +01:00
devsaurus b06a3cd5e7 comply with new rules 2016-01-09 01:10:27 +01:00
devsaurus 9ca35b1fff transferred ucg module documentation 2016-01-09 00:58:32 +01:00
devsaurus c69ea9b2a5 transferred ucg module documentation 2016-01-09 00:57:07 +01:00
Marcel Stör 008c17ef7d Update for consistency with the other docs 2016-01-08 23:39:50 +01:00
Marcel Stör affa61ecd2 Re-add syntax where missing and remove example if trivial 2016-01-08 22:39:07 +01:00
Marcel Stör 94f407a269 Fix merge conflicts 2016-01-08 21:17:16 +01:00
Marcel Stör f1461c2e14 Tweak theme and update a few modules for consistency 2016-01-08 20:49:56 +01:00
devsaurus b2b23c3240 u8g fix links 2016-01-08 20:38:04 +01:00
devsaurus 63ba40b791 transferred u8g module documentation 2016-01-08 20:31:14 +01:00
devsaurus ebcf6b771e fix delimiters after list 2016-01-07 00:33:52 +01:00
Johny Mattsson f2babb9c81 Rewrote tmr module documentation, including new API. 2016-01-06 13:06:00 +11:00
Johny Mattsson e5de056756 Transferred cjson module documentation. 2016-01-06 11:51:48 +11:00
Johny Mattsson d3331c2057 Removed left-over non-EN node.md. 2016-01-06 11:20:17 +11:00
Johny Mattsson ee23e46068 Transferred bit module documentation. 2016-01-05 16:07:29 +11:00
Johny Mattsson 3430e9faf6 Documented previously undocumented gpio.serout(). 2016-01-05 15:54:20 +11:00
Johny Mattsson 17c9873268 Transferred gpio module documentation. 2016-01-05 15:39:53 +11:00
Johny Mattsson 9072f8afe7 Transferred the uart module documentation. 2016-01-05 14:38:41 +11:00
Johny Mattsson 1357e9424a Transferred crypto module documentation. 2016-01-05 14:23:26 +11:00
Johny Mattsson d7a83c65c2 Documented previously undocumented adc module. 2016-01-05 14:06:01 +11:00
Johny Mattsson e814fceb29 Transferred rtcfifo module documentation. 2016-01-05 13:43:59 +11:00
Johny Mattsson 5f7db01842 Transferred sntp module documentation. 2016-01-05 13:01:53 +11:00
Johny Mattsson 12ad557b5d Transferred rtctime module documentation. 2016-01-05 12:56:46 +11:00
Johny Mattsson 4df7dcb3ee Transferred rtcmem module documentation. 2016-01-05 12:43:57 +11:00
Johny Mattsson 802e1179cd Added node about maximum dsleep time to node docs. 2016-01-05 12:26:41 +11:00
Johny Mattsson 4877cb2b1a Transferred file module documentation. 2016-01-05 12:21:19 +11:00
Johny Mattsson f35ea62670 Documented previously undocumented node functions. 2016-01-05 11:17:20 +11:00
Johny Mattsson 63ccdd0608 Transferred node module documentation. 2016-01-05 11:00:16 +11:00
Marcel Stör 277ee1c6d3 JavaScript clean-up and documenting 2015-12-28 23:36:58 +01:00
Marcel Stör 8bb0b69e5d Experiment with MutationObserver 2015-12-28 23:12:04 +01:00
Marcel Stör eca92afdbe Experiment with MutationObserver 2015-12-28 22:51:57 +01:00
Marcel Stör d848976f31 Experiment with MutationObserver 2015-12-28 22:38:59 +01:00
Marcel Stör 10e602e5bd Experiment with MutationObserver 2015-12-28 22:33:48 +01:00
Marcel Stör 6a8fb8fe28 Fix fly-out menu content and add temporary debugger 2015-12-28 21:57:38 +01:00
Marcel Stör 046ad545ae Fix String#split to determine selected language code 2015-12-28 21:38:09 +01:00
Marcel Stör 3e68026d7b Rename DIR to dir and improve JavaScript for RTD 2015-12-28 17:25:00 +01:00
Marcel Stör 7eac090aa3 Add experimental localized content structure 2015-12-27 23:32:07 +01:00
Marcel Stör c62cf1b3f7 Fix blockquote style and admonition 2015-12-17 20:00:23 +01:00
Marcel Stör 37d3e8ec5e Minor changes to flash and support 2015-12-17 20:00:23 +01:00
Marcel Stör 7aa4012165 Change links to use '.md' suffix 2015-12-17 20:00:23 +01:00
Marcel Stör c10e81c292 Remove 'Description' header for module function description 2015-12-17 20:00:23 +01:00
Marcel Stör 23ce3e5451 Proper structure for modules and more content 2015-12-17 20:00:23 +01:00
Marcel Stör f2cadcb18d More tinkering 2015-12-17 20:00:23 +01:00
Marcel Stör cb5ac20889 Playing with page structure 2015-12-17 20:00:22 +01:00
Marcel Stör 51ab3910ad Playing with page structure 2015-12-17 20:00:22 +01:00
Marcel Stör b736f70147 Add first MkDocs skeleton 2015-12-17 20:00:22 +01:00