Commit 6a943e60 authored by Marcel Stör's avatar Marcel Stör
Browse files

Proper structure for modules and more content

parent 0370cb8e
#Building the firmware
There are essentially three ways to build your NodeMCU firmware: cloud build service, Docker image, dedicated Linux environment (possibly VM). There are essentially three ways to build your NodeMCU firmware: cloud build service, Docker image, dedicated Linux environment (possibly VM).
##Cloud build serivce ## Cloud build serivce
NodeMCU "application developers" just need a ready-made firmware. There's a [cloud build service](http://nodemcu-build.com/) with a nice UI and configuration options for them. NodeMCU "application developers" just need a ready-made firmware. There's a [cloud build service](http://nodemcu-build.com/) with a nice UI and configuration options for them.
##Docker image ## Docker image
Occasional NodeMCU firmware hackers don't need full control over the complete tool chain. They might not want to setup a Linux VM with the build environment. Docker to the rescue. https://hub.docker.com/r/marcelstoer/nodemcu-build/ Occasional NodeMCU firmware hackers don't need full control over the complete tool chain. They might not want to setup a Linux VM with the build environment. Docker to the rescue. Give [Docker NodeMCU build](https://hub.docker.com/r/marcelstoer/nodemcu-build/) a try.
##Linux build environment ## Linux build environment
NodeMCU firmware developers commit or contribute to the project on GitHub and might want to build their own full fledged build environment with the complete tool chain. http://www.esp8266.com/wiki/doku.php?id=toolchain#how_to_setup_a_vm_to_host_your_toolchain NodeMCU firmware developers commit or contribute to the project on GitHub and might want to build their own full fledged build environment with the complete tool chain. There is a [post in the esp8266.com Wiki](http://www.esp8266.com/wiki/doku.php?id=toolchain#how_to_setup_a_vm_to_host_your_toolchain) that describes this.
\ No newline at end of file \ No newline at end of file
div.col-md-9 h1:first-of-type, div.section h1:first-of-type {
text-align: center;
font-size: 50px;
font-weight: 300;
}
div.col-md-9 p:first-of-type {
/*text-align: center;*/
}
div.col-md-9 p.admonition-title:first-of-type {
text-align: left;
}
div.col-md-9 h1:first-of-type .headerlink {
display: none;
}
code.no-highlight {
color: black;
}
This diff is collapsed.
## esptool
https://github.com/themadinventor/esptool
Supported platforms: OS X, Linux, Windows, anything that runs Python
## NodeMCU Flasher
https://github.com/nodemcu/nodemcu-flasher
Supported platforms: Windows
## ...
more
\ No newline at end of file
# Welcome to NodeMCU # NodeMCU Documentation
NodeMCU is a Lua based firmware for the ESP8266 WiFi SOC from Espressif. NodeMCU is an [eLua](http://www.eluaproject.net/) based firmware for the [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/). This is a companion project to the popular [NodeMCU dev kits](https://github.com/nodemcu/nodemcu-devkit-v1.0), ready-made open source development boards with ESP8266-12E chips.
## Commands The firmware is based on the Espressif SDK v1.4 and uses a file system based on [spiffs](https://github.com/pellepl/spiffs).
* `mkdocs new [dir-name]` - Create a new project. ## Getting started
* `mkdocs serve` - Start the live-reloading docs server. - [Build the firmeware](build) with the modules you need.
* `mkdocs build` - Build the documentation site. - [Flash the firmware](flash) to the chip.
* `mkdocs help` - Print this help message. - Load your code into the firmware.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
A list of modules
\ No newline at end of file
##node.restart() # node Module
## node.restart()
####Description ####Description
restart the chip. Restarts the chip.
####Syntax ####Syntax
node.restart() `node.restart()`
####Parameters ####Parameters
- `nil` `nil`
####Returns ####Returns
- `nil` `nil`
####Example ####Example
```lua ```lua
node.restart(); node.restart();
``` ```
___
## node.dsleep() ## node.dsleep()
####Description ####Description
Enter deep sleep mode, wake up when timed out. Enter deep sleep mode, wake up when timed out.
...@@ -39,17 +40,18 @@ More details as follows:<br /> ...@@ -39,17 +40,18 @@ More details as follows:<br />
- `option`: number(Integer) or nil. If option = nil, it will use last alive setting as default option. - `option`: number(Integer) or nil. If option = nil, it will use last alive setting as default option.
####Returns ####Returns
- `nil` `nil`
####Example ####Example
```lua ```lua
--do nothing --do nothing
node.dsleep() node.dsleep()
--sleep μs --sleep μs
node.dsleep(1000000) node.dsleep(1000000)
--set sleep option, then sleep μs --set sleep option, then sleep μs
node.dsleep(1000000, 4) node.dsleep(1000000, 4)
--set sleep option only --set sleep option only
node.dsleep(nil,4) node.dsleep(nil,4)
``` ```
\ No newline at end of file ___
\ No newline at end of file
# Getting started
## Obtain the firmware
[Build the firmware](build.html) or download it from ?
## Flash the firmware
There are a number of tools for flashing the firmware.
The [issues list on GitHub](https://github.com/nodemcu/nodemcu-firmware/issues) is **not** the right place to ask for help. Use it to report bugs and to place feature requests. "how do I ..." or a "I can't get this to work ..." should be directed to StackOverflow or esp8266.com.
## StackOverflow
StackOverflow is the perfect place to ask coding questions. Use one or several of the following tags: [esp8266](http://stackoverflow.com/tags/esp8266), [nodemcu](http://stackoverflow.com/tags/nodemcu) or [Lua](http://stackoverflow.com/tags/lua).
## esp8266.com Forums
esp8266.com has a few [NodeMCU specific forums](http://www.esp8266.com/viewforum.php?f=17).
\ No newline at end of file
...@@ -2,11 +2,15 @@ site_name: NodeMCU Documentation ...@@ -2,11 +2,15 @@ site_name: NodeMCU Documentation
site_description: Description of the NodeMCU documentation site_description: Description of the NodeMCU documentation
theme: readthedocs theme: readthedocs
repo_url: https://github.com/nodemcu/nodemcu-firmware/ repo_url: https://github.com/nodemcu/nodemcu-firmware/
strict: true
markdown_extensions: markdown_extensions:
- toc: - toc:
permalink: True permalink: True
pages: pages:
- Home: 'index.md' - Home: 'index.md'
- 'build.md' - Building the firmware: 'build.md'
- Flashing the firmware: 'flash.md'
- FAQ: 'faq.md'
- Support: 'support.md'
- Modules: - Modules:
- 'node': 'modules/node.md' - 'node': 'modules/node.md'
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment