From 57a8e45c98a828517e9257b19aabd332cf9c9936 Mon Sep 17 00:00:00 2001 From: Derwent McElhinney Date: Mon, 5 Oct 2020 22:50:35 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20private:=20false?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 +++++----- package.json | 1 + 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cb962c1..42c6171 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,12 @@ A rewrite of the [Telecortex](https://github.com/laserphile/telecortex) project Our Balena image running on a Raspberry Pi 3 can control 4 channels of 300 SK9822 pixels pixels with UDP over on-board WiFi at about 200 FPS. -## RaspberryPi Setup - -We've created a docker image that sets up your Raspberry Pi 3B+ as an Open Pixel Control server with 4 SPI ports. The docker image is designed to run on [BalenaOS](https://www.balena.io/os/). This is the recommended way of using TeleCortex if you don't need to do development on the server. Otherwise, there's a lot of messing around required. +## Setup ### Option 1: Balena Cloud (Recommended) +We've created a docker image that sets up your Raspberry Pi 3B+ as an Open Pixel Control server with 4 SPI ports. The docker image is designed to run on [BalenaOS](https://www.balena.io/os/). This is the recommended way of using TeleCortex if you don't need to do development on the server. Otherwise, there's a lot of messing around required. + Sign up for [BalenaCloud](https://www.balena.io/cloud/) (it's free!) and set up an application. Use its wizard to make an image with your network details. Or you can download and configure your own image as long as it runs docker. Head over to and get yourself a BalenaOS image. @@ -83,7 +83,7 @@ sudo apt-get install vim git zip #### Install build tools for node / yarn ```bash -sudo apt-get install gcc g++ make cmake libopencv-dev +sudo apt-get install gcc g++ make cmake python3 ``` #### Install Node @@ -148,7 +148,7 @@ yarn ## OSX setup -This will not run on OSX. You need spidev for pi-spi to work +This will only work as a PBX server on OSX. You need `/dev/spidev...` for `pi-spi` to work. ### Balena dev setup diff --git a/package.json b/package.json index e70e677..231dbf9 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,7 @@ "version": "0.1.3", "description": "A NodeJS server for controlling APA102/SK9822/WS281X LED strips over OPC", "main": "src/main.js", + "private": false, "scripts": { "test": "jest --watch --coverage", "test-ci": "jest --ci --coverage",