Skip to content

Commit 57a8e45

Browse files
committed
🔧 private: false
1 parent 26e1666 commit 57a8e45

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ A rewrite of the [Telecortex](https://github.com/laserphile/telecortex) project
3333

3434
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.
3535

36-
## RaspberryPi Setup
37-
38-
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.
36+
## Setup
3937

4038
### Option 1: Balena Cloud (Recommended)
4139

40+
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.
41+
4242
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.
4343

4444
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
8383
#### Install build tools for node / yarn
8484

8585
```bash
86-
sudo apt-get install gcc g++ make cmake libopencv-dev
86+
sudo apt-get install gcc g++ make cmake python3
8787
```
8888

8989
#### Install Node
@@ -148,7 +148,7 @@ yarn
148148

149149
## OSX setup
150150

151-
This will not run on OSX. You need spidev for pi-spi to work
151+
This will only work as a PBX server on OSX. You need `/dev/spidev...` for `pi-spi` to work.
152152

153153
### Balena dev setup
154154

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "0.1.3",
44
"description": "A NodeJS server for controlling APA102/SK9822/WS281X LED strips over OPC",
55
"main": "src/main.js",
6+
"private": false,
67
"scripts": {
78
"test": "jest --watch --coverage",
89
"test-ci": "jest --ci --coverage",

0 commit comments

Comments
 (0)