Skip to content

Commit

Permalink
🔧 private: false
Browse files Browse the repository at this point in the history
derwent-m committed Oct 5, 2020
1 parent 26e1666 commit 57a8e45
Showing 2 changed files with 6 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <https://www.balena.io/os/#download> 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

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",

0 comments on commit 57a8e45

Please sign in to comment.