lowsync manual

A tool to program the neonious one and other low.js for ESP32 based devices with external IDEs. Allows the user to sync directories to the device, change settings, start/stop programs and more.

Getting started

First, install lowsync, by calling the following as Administrator/root:

npm install --unsafe-perm -g lowsync

The option –unsafe-perm lets the install script run as root instead of letting npm change the user to nobody before running the install script. This is required for the serialport module.

Alternativly, install as normal user into your local node_modules directory:

npm install lowsync

You then have to always call lowsync with path however:

node_modules/.bin/lowsync [your parameters...]

After installing lowsync, run

lowsync init

The program will ask you some questions and the configuration file lowsync.config.json will be created in the current working directory.

You may be able to configure your configuration further by reading the section about configuration and editing your configuration manually.

After configuring the program, you may now run one of the many other commands.

For most commands the program will need to authenticate with the device. It will automatically guide you through the process, but here is a quick explaination on what exactly happens. Before executing a command, the password will be read from lowsync.auth.config.json in the current working directory or a parent directory. If the file is found, authentication is attempted. If the file cannot be found or the password is incorrect, the user will be asked for the password. Authentication is attempted again and if the password is correct and the user gives permission, the password is saved to the file.