Skip to main content Link Menu Expand (external link) Document Search Copy Copied
ednaUI Documentation

Firmware Installation

Table of contents
  1. Firmware Installation
    1. Non-Git Method (recommended for non-programmers)
      1. Required Toolings
      2. Download ZIP Files from GitHub
    2. Git Method (recommended for development or users with programming experience)
      1. Required Toolings
      2. Clone Git Repository

Required Toolings

  1. Install VSCode
  2. Install PlatformIO extension platformio.platformio-ide

Download ZIP Files from GitHub

  1. Get the GitHub repository branch link that is relavent to your version in the Sampler History Document under Firmware.

  2. Download a ZIP file for that branch of code that you plan on using, and then unzip.

  3. Download the ZIP file for the Git Submodule of the code. After unzipping this file, copy and paste the contents of the main folder inside of the lib/Framework folder from the download of step 2.

  4. Open the code from step 2 inside of VSCode by going to File => Open Folder...

  5. Next, click on platformio.ini configuration file located in the file explorer.

  6. Next, please comment the [env:debug] section and uncomment [env:live]. The file should look like the following. Notice that we have ; in front of the commented line.

     ;[env:debug]
 ; build_type = debug
 ;build_unflags = -std=gnu++11
 ;build_flags = -D DEBUG=1 -Wall -Wno-unknown-pragmas -std=c++14

 ; [env:release]
 ; build_unflags = -std=gnu++11
 ; build_flags = -D RELEASE=1 -Wall -Wno-unknown-pragmas -std=c++14

 [env:live]
 build_unflags = -std=gnu++11
 build_flags = -D LIVE=1 -Wall -Wno-unknown-pragmas -std=c++14

  7. optional Optionally you can change the server name and password by going to src/configuration.hpp. It is recommended if you have multiple samplers to change the SERVER_NAME to "ednaServer-###", where ### is the serial number on the electronics box of the sampler. Otherwise, the server will default to the following values:

     #define SERVER_NAME     "ednaServer"
 #define SERVER_PASSWORD "password"

  8. We are now ready to upload the firmware to the micro-controller. After connecting the micro-controller to your computer, please click on the right-arrow button located at the bottom of the status bar.

Required Toolings

  1. Install VSCode
  2. Install PlatformIO extension platformio.platformio-ide
  3. Install Git

Clone Git Repository

  1. The following code clone development git repo to your local computer. Switch to the relavent branch based on the Sampler History Document. The Master branch, which the repo is on by default, is the latest version.

     git clone https://github.com/OPEnSLab-OSU/ednaServer 
 cd ednaServer
 git checkout <branch>

  2. Initialize git submodule. This will pull in another git repo that the server relies on.

     git submodule init
 git submodule update
 git submodule foreach "git checkout develop"
 code .

  3. You should now have VSCode opened automatically. Next, click on platformio.ini configuration file located in the file explorer.

  4. Next, please comment the [env:debug] section and uncomment [env:live]. The file should look like the following. Notice that we have ; in front of the commented line.

     ;[env:debug]
 ; build_type = debug
 ;build_unflags = -std=gnu++11
 ;build_flags = -D DEBUG=1 -Wall -Wno-unknown-pragmas -std=c++14

 ; [env:release]
 ; build_unflags = -std=gnu++11
 ; build_flags = -D RELEASE=1 -Wall -Wno-unknown-pragmas -std=c++14

 [env:live]
 build_unflags = -std=gnu++11
 build_flags = -D LIVE=1 -Wall -Wno-unknown-pragmas -std=c++14

  5. optional Optionally you can change the server name and password by going to src/configuration.hpp. It is recommended if you have multiple samplers to change the SERVER_NAME to "ednaServer-###", where ### is the serial number on the electronics box of the sampler. Otherwise, the server will default to the following values:

     #define SERVER_NAME     "ednaServer"
 #define SERVER_PASSWORD "password"

  6. We are now ready to upload the firmware to the micro-controller. Please click on the right-arrow button located at the bottom of the status bar.