Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.2 KB

README.md

File metadata and controls

92 lines (61 loc) · 3.2 KB
Raw

insighioNode

The core libraries, utilities and application scenario for insigh.io nodes to operate with insigh.io console

The project is based on MicroPython and tested on Pycom and ESP32 devices.

API reference

A complete description of all the supported APIs along with tutorials can be found in insigh.io docs.

Install

Release binaries

Download the latest release binary and extract localy. The archive can be found in the release assets and its file name is:

  • insighio-<release-version>-<commit-hash>-<board-version>.tar.gz
  • example: insighio-v2.2.0-f49e354-esp32s3.tar.gz

The archive includes the required binaries including a flash script.

The flash script uses esptool to download the binaries on the board, so before proceeding make sure esptool is installed.

# 1) power on device into download mode
#    hold "boot" button and click "reset" button. Ready to download the binary

# 2) donwload binaries

bash flash_usb0.sh
#   or
# bash flash.sh /dev/ttyUSB0

# 3) click "reset" button once and wait till the initialization finishes. 
#
# 4) When ready the device will light up the RGB led. 
#       - If it is the first boot, it will directly enter configuration mode. 
#       - If the device is already configured, it will continue the normal execution circle.

For extended instructions, see documentation.

From source code

First thing first, clone repository and get all required submodules:

git clone https://github.com/insighio/insighioNode

cd insighioNode
git submodule update --init --recursive

Code upload via Pymakr

  1. Install Pymakr addon for VSCode or Atom
  2. Open project folder insighioNode/insighioNode
  3. Upload the code

Code upload via ampy

ampy is a command line tool to operate on micropython devices. To upload the code follow the commands:

cd insighioNode/insighioNode

# for ESP32 devices
ROOT_PATH=""
# for Pycom devices
#ROOT_PATH="/flash"

ampy -p /dev/ttyUSB0 -b 115200 put apps $ROOT_PATH/apps
ampy -p /dev/ttyUSB0 -b 115200 put boot.py $ROOT_PATH/boot.py
ampy -p /dev/ttyUSB0 -b 115200 put lib $ROOT_PATH/lib
ampy -p /dev/ttyUSB0 -b 115200 put main.py $ROOT_PATH/main.py
ampy -p /dev/ttyUSB0 -b 115200 put web_server.py $ROOT_PATH/web_server.py
ampy -p /dev/ttyUSB0 -b 115200 put www $ROOT_PATH/www

Configure

The configuration of the device operation, security keys, network connection etc. can be done through the implemented Web UI configuration wizard.

After following the Getting Started steps, the device will be ready to measure and upload!

Future Work

  • Security enhancements (TLS)
  • < Name your desired feature! >

Issues

In case of bug reports or feature requests feel free to open an issue.