oaklabs/app-serialport-io repository overview

⁠app-serialport-io

An example app that can be used to log serial events to an OakOS unit

⁠Running locally

Make sure that you are running the right version of Node locally. You will find the required version in the .nvmrc file If you are not running the same version (node -v) then you will need to run

nvm install $(cat .nvmrc)
npm run rebuild

⁠Now you can run locally

npm run dev

⁠Running in a docker container

xhost +
docker-compose up --build

⁠Shutting down the docker container

docker-compose down

⁠Example Installation

{
  "services": [
    {
      "image": "index.docker.io/oaklabs/app-serialport-io:latest",
      "environment": {
        "TZ": "America/Los_Angeles",
        "SERIAL_DEVICE": "/dev/ttyUSB0"
      }
    }
  ]
}

This snippet results can be seen in the application logs on the OakOS Dashboard