Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Latest commit

 

History

History
executable file
·
91 lines (70 loc) · 4.48 KB

README.md

File metadata and controls

executable file
·
91 lines (70 loc) · 4.48 KB
Raw

Swim + MatrixOne Demo

Java9+ and NodeJS are required to run the application. Gradle is also required but handled by Gradle wrapper and so will install automatically. This application also needs to be running on the Matrix Creator device.

Getting Started

Device Setup

If you are starting fresh on a new Raspberry Pi, you need to be sure to setup your Matrix Creator device and install the code required for Matrix Lite

  • First, walk through the Matrix Creator Device Setup page available from Matrix.one
  • Next you will need install Matrix HAL on your Pi. This is required for Matrix Lite which is what we will be using for our data bridge into Swim.
  • Now you can install Matrix Lite. Be sure to install the JavaScript version since we will be using NodeJS in this example.

Install Java

We need java 9 or higher for swim. On Raspian Stretch we also need to add a new source in order to be able to install the correct version of Java. Follow the instructions below to add the new source.

Add deb source url to source list

echo "deb http://deb.debian.org/debian stretch-backports main" | sudo tee /etc/apt/sources.list.d/debian.list
sudo apt update
sudo apt install dirmngr

switch to root and add key for deb.debian.org

sudo su -
gpg --keyserver keys.gnupg.net --recv-keys 7638D0442B90D010 8B48AD6246925553
gpg --armor --export 7638D0442B90D010 | apt-key add -
gpg --armor --export 8B48AD6246925553 | apt-key add -
exit

Download and Setup App

  1. git clone https://github.com/swimos/matrixOne.git
  2. cd matrixOne
  3. chmod +x *.sh
  4. ./setup.sh
  5. chmod +x server/gradlew

Running the app

  1. ./runSwim.sh
  2. wait for app to start then hit ctrl-c
  3. ./runBridge.sh

Stopping the app

  1. ./stopall.sh - this will kill both java and node

Notes:

  • Log files are written to project base directory.

Basic App Folder Structure

  • /bridge - code for data bridge from Matrix Lite to Swim
  • /server - Swim Java Application codebase
  • /ui - codebase for web based UI

Swim Application Structure

  • Main entry point is /src/main/java/swim/matrixone/MatrixOnePlane.java
  • WebAgents live in /src/main/java/swim/matrixone/agents
    • /agents/SensorAgent.java is the main WebAgent in the app. Each sensor on the Creator will have its own WebAgent (digital twin) in the Swim Application.

Sensor Bridge

  • This demo uses NodeJS to bridge sensor data from Matrix Lite into Swim. Data is passed to each sensor WebAgant inside Swim using Swim Commands. Any processing done on sensor data is handled inside the Sensor WebAgent in Swim.
  • The bridge also handles updating the LED color by opening a link to the /settings/color WebAgent in Swim. When the UI sends new colors into swim, this downlink will automatically get those updates and pass it back to Matrix Lite to change the LED color
  • Lastly the bridge sets up the LED animation inside updateLedAnim()

Web UI

Web UI served by swim (not node) and so the pages are at the same address as Swim itself

  1. by Default the application runs at http://[device ip]:9001
    • Demo Pages can be found at:
      1. Color Picker: http://[device ip]:9001/colorPicker.html
      2. Sensor Data Gauges: http://[device ip]:9001/sensors.html
      3. WebGL Demo: http://[device ip]:9001/index.html
  2. The Web UI can also be served by NodeJS instead of Swim, however we use Swim in this example to keep things simple.
  3. The Swim Javascript Library and UI Components are all vanilla JS with no 3rd party requirements. This makes it easy to integrate into existing code bases and use in the way that works best for your project or environment.

More Useful Documentation

MatrixOne Documentation

Swim Documentation