Installation instructions

[trentgill]

Trying to install pools on 3 different computers & documentation of what was necessary to get running on each.

X1 Yoga
X1 Carbon
Elitebook

(all on ubuntu)

////

Changing communications permissions should not be first. I don't think it's necesasry on mac at all, and might not be for some users.

Reference for structuring a toolchain setup / getting started / installation:
https://github.com/monome/crow/blob/master/readme-development.md

Prerequisites:
node/npm. get from nodejs.org. download the 'LTS' version. 10.16.3 as of this writing. do it via command line, see here: https://nodejs.org/en/download/package-manager/

# Using Ubuntu
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs

Check it's installed with:
node -v -> v12.8.1 npm -v->6.10.2`

Get & build the project:
git clone https://github.com/isaacpearl/pools
cd pools
cd main && npm install
cd ../renderer && npm install

Run (in debug mode):
In 2 separate terminals, from the pools root directory:

cd renderer
npm start

and

cd main
npm start

This gives independent debug info for each process.

[trentgill]

After git cloning pools & entering the pools folder, run the following to install the project:

for FOLDER in main renderer
do
  cd $FOLDER
  npm install
  cd ..
done

[trentgill]

If you see the error:

CONNECTING TO CROW
error [Error: Error: No such file or directory, cannot open /dev/ttyACM0]

crow is probably not connected

If you see:

CONNECTING TO CROW
error [Error: Error: Device or resource busy, cannot open /dev/ttyACM0]
INITIATING RECONNECT

Umm... try again?

If you see:

CONNECTING TO CROW
error [Error: Error: Permission denied, cannot open /dev/ttyACM0]
INITIATING RECONNECT

You don't have permissions to talk to crow's USB port.

Fix that with this magic command:

//
The magic sequence:

open druid `sudo python druid.py`
> r
> p (confirm no user script loaded)
> q

Then return to trying npm start in main.

[trentgill]

monome/crow#81

Speaks about the potential cause & solution for the junk characters on boot. They are caused by Ubuntu thinking that crow is a USB modem & thus sending AT commands in order to query it's capabilities. Crow can't respond to them, and they are difficult to ignore on the crow FW side.

[trentgill]

@isaacpearl definitely look at the above crow issue #81. All you have to do is create that file in the rules.d folder, then reload the rules (or restart computer), and there are no more ~ parse errors! Should mean you don't have to do the restarting dance, and hopefully not the running-druid thing either.

need to think about how to best handle these things for our end users, rather than having to make them run these commands manually by hand.