Skip to content
serg3295 edited this page Feb 12, 2024 · 4 revisions

Welcome to the nodemcu-tools wiki

Russian version

Introduction

This extension for Visual Studio Code provides interaction with NodeMCU, with Lua-based firmware for ESP8266 and ESP32 chips.

Most users, when working with ESP8266 and ESP32, use the well-known Esplorer application to download and upload files, as well as for interactive debugging of scripts. However, the capabilities of the built-in Esplorer editor are significantly less than a number of modern code editors, for example, VS Code. Users have to edit scripts in their favorite editor, copy, or save code snippets to a file. Then, switch between applications to write files to ESP, or to debug a code snippet. That is, the workflow is unreasonably complicated.

Features

In order to exclude Esplorer from the workflow, you can use this cross-platform extension, which implements the following features:

  • works with both ESP8266 and ESP32 with firmware based on IDFv4.4 and IDFv5.0
  • connect to many devices simultaneously, and browse them in a special TreeView in the VS Code panel
  • uses dedicated terminal for each connected device
  • send commands to device from the terminal command line
  • send line of Lua code to device directly from editor window (without copying to the terminal command line)
  • send the selected Lua code fragment to device from editor window
  • upload files to device
  • download files from device
  • compile, delete, run Lua files on device
  • works on all platforms (Windows, Linux, macOS)

Install

In the Extensions view, type 'nodemcu-tools' in the search box to filter the Marketplace offerings to extensions with 'nodemcu-tools' in the title or metadata. To install the extension, select the Install button.

Minimum requirements:

  • VS Code >= v1.74
  • node.js >= v18

Recommendation.
To perform code auto-completion for NodeMCU modules, it is proposed to use the sumneko's LuaLS with addons nodemcu-esp32 and nodemcu-esp8266.


Описание

Данное расширение для Visual Studio Code, обеспечивает взаимодействие с NodeMCU, с прошивкой на базе Lua для чипов ESP8266 и ESP32.

Большинство пользователей при работе с ESP8266 и ESP32 для загрузки и выгрузки файлов, а также для интерактивной отладки скриптов используют широко известное приложение Esplorer. Однако, возможности встроенного редактора Esplorer'a существенно меньше, чем целого ряда современных редакторов кода, например, VS Code. Пользователям приходится редактировать скрипты в своём любимом редакторе, копировать, или сохранять в файл фрагменты кода. Затем, переключаться между приложениями для записи файлов на esp, или для отладки фрагмента кода. То есть, рабочий процесс необоснованно усложняется.

Функции

Для того, чтобы исключить Esplorer из рабочего процесса можно использовать это кроссплатформенное расширение для VS Code, реализующее следующие функции:

  • работа как с ESP8266, так и с ESP32 с прошивкой на базе IDFv4.4 и IDFv5.0;
  • подключение к нескольким устройствам одновременно, и отображение их в виде дерева в панели VS Code;
  • использование выделенного терминала для каждого подключенного устройства;
  • отправка команд в устройство из командной строки терминала;
  • отправка на устройство строки кода непосредственно из открытого окна с файлом Lua (без копирования в командную строку терминала);
  • отправка выделенного фрагмента кода на устройство;
  • выгрузка файлов на устройство;
  • загрузка файлов из устройства;
  • компиляция, удаление, запуск файлов Lua на устройстве;
  • работа на всех платформах (Windows, Linux, MacOS).

Установка

Установить расширение можно прямо из VS Code. Для этого в окне Extensions необходимо набрать 'nodemcu-tools' в строке поиска расширений для фильтрации предложений из Marketplace. Затем, нажать кнопку Install.

Минимальные требования:

  • версия VS Code >= 1.74
  • версия node.js >= 18

Рекомендация.
Для реализации автодополнения функций NodeMCU в редакторе VS Code предлагается использовать расширение sumneko LuaLS с подключенными addons nodemcu-esp32 и nodemcu-esp8266.