nodemcu-firmware/docs/upload.md

54 lines
3.7 KiB
Markdown
Raw Permalink Normal View History

2016-01-16 23:11:40 +01:00
As with [flashing](flash.md) there are several ways to upload code from your computer to the device.
2016-03-01 23:15:03 +01:00
Note that the NodeMCU serial interface uses 115200bps at boot time. To change the speed after booting, issue `uart.setup(0,9600,8,0,1,1)`. ESPlorer will do this automatically when changing the speed in the dropdown list. If the device panics and resets at any time, errors will be written to the serial interface at 115200 bps.
2016-01-31 14:31:15 +01:00
2017-12-28 23:56:13 +01:00
# Tools
Transferring application code to ESP32 is an essential task, one that you'll perform quite frequently. Hence, it does make sense to try a few different uploading tools until you find one you feel comfortable with. [https://frightanic.com/iot/tools-ides-nodemcu/](https://frightanic.com/iot/tools-ides-nodemcu/) lists almost a dozen classical uploaders - in addition to IDEs or IDE-like applications which of course transfer code as well.
2017-12-31 11:46:57 +01:00
!!! note
Most of the listed tools and IDEs target the ESP8266 and might also work for the ESP32-based firmware. Be prepared to encounter random issues for tools that do not claim to support the ESP32 Lua in their feature list.
2017-12-28 23:56:13 +01:00
The NodeMCU firmware team does not give any recommendations as for which uploader to use nor are there any "NodeMCU approved" tools. The below listed tools are just three, in no particular order, which seem popular and/or reasonably well maintained.
## ESPlorer
2016-01-16 23:11:40 +01:00
> The essential multiplatforms tools for any ESP8266 developer from luatool authors, including Lua for NodeMCU and MicroPython. Also, all AT commands are supported. Requires Java (Standard Edition - SE ver 7 and above) installed.
![ESPlorer](img/ESPlorer.jpg "ESPlorer")
2016-01-16 23:11:40 +01:00
2016-01-31 14:31:15 +01:00
Source: [https://github.com/4refr0nt/ESPlorer](https://github.com/4refr0nt/ESPlorer)
2016-01-16 23:11:40 +01:00
Supported platforms: OS X, Linux, Windows, anything that runs Java
2017-12-28 23:56:13 +01:00
## ChiliPeppr ESP32 Web IDE
2017-12-28 23:56:13 +01:00
> This is a new method via the browser of editing/uploading your Lua code to your ESP32 devices. The workspace has a Serial Port JSON Server that you run locally or remotely on your computer to let your browser talk direct to your serial ports. The Ace editor is embedded which does code highlighting and intellisense for Lua. There is a file browser for your ESP32, a serial port console, restart button, file saving, run, upload/run, and upload all. [...] There is also an XBM image creator for OLED displays that let you cut/paste PNG, JPEG, or GIF images or even drag/drop of animated GIFs to create Lua code.
![ChiliPeppr ESP32 Workspace](https://github.com/chilipeppr/workspace-esp32-lua/raw/master/screenshot.png "ChiliPeppr ESP32 Workspace")
Source: [https://github.com/chilipeppr/workspace-esp32-lua](https://github.com/chilipeppr/workspace-esp32-lua)
Supported platforms: OS X, Linux, Windows
2017-12-28 23:56:13 +01:00
Location: [http://chilipeppr.com/esp32](http://chilipeppr.com)
# Compiling Lua on your PC for Uploading
If you install lua on your development PC or Laptop then you can use the standard Lua
2017-12-31 11:46:57 +01:00
compiler to syntax check any Lua source before downloading it to the ESP32 module. However,
the nodemcu compiler output uses different data types (e.g. it supports ROMtables) so the
2017-12-31 11:46:57 +01:00
compiled output cannot run on the ESP32.
2017-12-31 11:46:57 +01:00
Compiling source on one platform for use on another (e.g. Intel x38 Window to ESP32) is
known as _cross-compilation_ and the nodemcu firmware supports the compilation of `luac.cross`
on \*nix patforms which have Lua 5.1, the Lua filesystem module (lfs), and the essential
GCC tools. Simply change directory to the firmware root directoy and run the command:
lua tools/cross-lua.lua
2017-12-31 11:46:57 +01:00
This will generate a `luac.cross` executable in your root directory which can be used to
compile and to syntax-check Lua source on the Development machine for execution under
2017-12-31 11:46:57 +01:00
nodemcu lua on the ESP32.