Skip to content

Latest commit

 

History

History
85 lines (44 loc) · 3.51 KB

GetStarted.md

File metadata and controls

85 lines (44 loc) · 3.51 KB

Getting Started

Hardware

You'll need a ESP8266 or ESP32 microcontroller developer board or module.

USB Drivers

Don't forget to install proper drivers for the USB-to-serial converter. If needed!

If you're using a board along with a standalone FTDI adapter on Linux or Mac OS X, it should be shipped with the OS, for Windows drivers see FTDI website.

Silabs CP210x USB-to-serial chip (NodeMCU v2) for which you can get driver from here.

CH34x chip, Win driver (NodeMCU 0.9) can be found here.

Install the Arduino Desktop IDE

To get step-by-step instructions select one of the following link accordingly to your operating system.

Windows

Mac OS X

Linux

Install ESP Arduino Core

To get step-by-step instructions select one of the following links accordingly to your microcontroller board.

ESP8266

ESP32

Install Arduino spiffs filesystem uploader

You'll also need to download and install the spiffs upload tool.

See here for the ESP8266.

Or here fpr the ESP32.

Installing Additional Arduino Libraries

Import using the Library Manager

Using the Library Manager 'search' and 'install' the following libraries. See here for more information.

ArduinoJson (v5.x) important to use version 5.x

Adafruit_NeoPixel

elk

Importing a .zip Library

The next libraries can't be installed using the Library Manager and you'll have to download and install them from zip files. See here for more information.

ESPAsyncWebServer

select one of the following links accordingly to your microcontroller board.

ESP32 - AsyncTCP

ESP8266 - ESPAsyncTCP

Installing NeoJS Files

Download and install the NeoJS project files. The latest release can be download from here.

Extract the archive into you Arduino home folder or somewhere within your local filesystem.

Open the NeoJS.ino file within the Arduino IDE. For more information on using the Arduino IDE can be found here and here

You'll need to change the board and board options within the IDE before uploading the firware (make sure you selected an appropriate spiffs size)

Upload the Sketch using the menu (Sketch->Upload) or keyboard shortcut (Ctrl+U).

After uploading the firmware you next need to upload the filesystem. Select Tools > ESP8266 Sketch Data Upload menu item. See here for more information.

If eveything was successful continue reading "Using NeoJS"