Uploading IoT Application From Command Line: Difference between revisions

Latest revision as of 09:39, 6 June 2025

Uploading Code to NodeMCU (ESP8266) via Command Line

This guide explains how to compile and upload code to a NodeMCU (ESP8266) board using the command line, and how to monitor its serial output without using the Arduino IDE interface.

Prerequisites

Install Python from: https://www.python.org/downloads

 - Make sure to check "Add Python to PATH" during installation.

Open a command prompt and install the required Python packages:

pip install esptool

Install the Arduino IDE from: https://www.arduino.cc/en/software

Step 1: Compile the Sketch

Open your `.ino` sketch in the Arduino IDE.
Go to:

Tools → Board → NodeMCU 1.0 (ESP-12E Module)

Then export the compiled binary:

Sketch → Export Compiled Binary

The binary file (e.g., MySketch.ino.bin) will appear in the same folder as your sketch.

Step 2: Identify the COM Port

Connect your NodeMCU via USB.
Open the command prompt and type:

mode

Look for a line similar to:

Status for device COM3: - Note the COM port (e.g., COM3), which will be used in later steps.

Step 3: Flash the Code to NodeMCU

Navigate to the folder where your `.bin` file is saved:

cd "C:\Users\YourName\Documents\Arduino\MySketch"

Run the following command to upload the binary:

python -m esptool --port COM3 --baud 115200 write_flash 0x00000 MySketch.ino.bin

- Replace COM3 with your actual COM port. - Replace MySketch.ino.bin with the correct filename if different.

(Optional) Erase Flash Before Uploading

If you want to erase previous data on the chip before uploading new code:

python -m esptool --port COM3 erase_flash

Notes

Close the Arduino IDE's serial monitor before using the command-line monitor to avoid port conflicts.
If the command esptool or miniterm is not recognized, make sure Python's Scripts folder is added to your system PATH.
USB-to-Serial drivers such as CH340 or CP210x may be required depending on your NodeMCU model.

@@ Line 1: / Line 1: @@
-== Deploy NodeMCU (ESP8266) Code via Command Line ==
+== Uploading Code to NodeMCU (ESP8266) via Command Line ==
+This guide explains how to compile and upload code to a NodeMCU (ESP8266) board using the command line, and how to monitor its serial output without using the Arduino IDE interface.
 === Prerequisites ===
-# Install Python: https://www.python.org/downloads
+# Install Python from: https://www.python.org/downloads
-# Install esptool:
+  - Make sure to check "Add Python to PATH" during installation.
+# Open a command prompt and install the required Python packages:
 <code>
 pip install esptool
 </code>
-# Install Arduino IDE: https://www.arduino.cc/en/software
+# Install the Arduino IDE from: https://www.arduino.cc/en/software
-# (Optional) Install USB-to-Serial Drivers:
-* CH340: https://sparks.gogo.co.nz/ch340.html
-* CP210x: https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers
-=== Step 1: Compile Code ===
+=== Step 1: Compile the Sketch ===
-# Open your sketch in Arduino IDE
+# Open your `.ino` sketch in the Arduino IDE.
-# Go to: <code>Sketch → Export Compiled Binary</code>
+# Go to:
-# Find the <code>.bin</code> file in your sketch folder (e.g., <code>MySketch.ino.bin</code>)
+<code>
+Tools → Board → NodeMCU 1.0 (ESP-12E Module)
-=== Step 2: Identify COM Port ===
+</code>
-# Plug in NodeMCU
+# Then export the compiled binary:
-# Open Command Prompt and run:
 <code>
-mode
+Sketch → Export Compiled Binary
 </code>
-# Note your device COM port (e.g., <code>COM3</code>)
+# The binary file (e.g., <code>MySketch.ino.bin</code>) will appear in the same folder as your sketch.
-=== Step 3: Flash Firmware ===
+=== Step 2: Identify the COM Port ===
-# Navigate to your compiled sketch folder:
+# Connect your NodeMCU via USB.
+# Open the command prompt and type:
 <code>
-cd "C:\Users\<YourName>\Documents\Arduino\MySketch"
+mode
 </code>
-# Flash the firmware:
+# Look for a line similar to:
 <code>
-python -m esptool --port COM3 --baud 115200 write_flash 0x00000 MySketch.ino.bin
+Status for device COM3:
 </code>
+- Note the COM port (e.g., COM3), which will be used in later steps.
-=== Optional: Erase Flash Before Writing ===
+=== Step 3: Flash the Code to NodeMCU ===
+# Navigate to the folder where your `.bin` file is saved:
 <code>
-python -m esptool --port COM3 erase_flash
+cd "C:\Users\YourName\Documents\Arduino\MySketch"
 </code>
+# Run the following command to upload the binary:
+<code>
+python -m esptool --port COM3 --baud 115200 write_flash 0x00000 MySketch.ino.bin</code>
+- Replace <code>COM3</code> with your actual COM port.
+- Replace <code>MySketch.ino.bin</code> with the correct filename if different.
-=== Step 4: View Serial Monitor Output ===
+=== (Optional) Erase Flash Before Uploading ===
-# Install pyserial (if not already):
+# If you want to erase previous data on the chip before uploading new code:
 <code>
-pip install pyserial
+python -m esptool --port COM3 erase_flash
-</code>
-# View Serial Monitor:
-<code>
-python -m serial.tools.miniterm COM3 115200
 </code>
-# Press <code>Ctrl + ]</code> to exit
 === Notes ===
-* Ensure no other serial monitor (like Arduino IDE) is open when using miniterm.
+* Close the Arduino IDE's serial monitor before using the command-line monitor to avoid port conflicts.
-* Make sure baud rate matches your <code>Serial.begin()</code> setting.
+* If the command <code>esptool</code> or <code>miniterm</code> is not recognized, make sure Python's <code>Scripts</code> folder is added to your system PATH.
+* USB-to-Serial drivers such as CH340 or CP210x may be required depending on your NodeMCU model.