Commit 3743db70 authored by Jake Read's avatar Jake Read

cp2102n note

parent 5e9015a6
......@@ -17,7 +17,7 @@ It's in the early stages, so bear with us. Everything is going to be great.
To Run DMC, you'll need to install node.js, and then the packages serialport and ws (websocket).
## Install Node.js
### Install Node.js
Node.js is a runtime environment for javascript, so you can write and run js locally. [Download and install it here](https://nodejs.org/en/download/).
......@@ -27,7 +27,7 @@ To check that node is installed, you can use
In Windows check that in *Environment Variables, System Variables, Path* there is a path for C:\Users\yourusername\npm folder. If the folder does not exist, create it and set the path.
## Install Serialport
### Install Serialport
Node comes with a package controller called 'npm' - node package manager. You can use this to install dependencies for node programs.
......@@ -37,7 +37,7 @@ Navigate to the directory where you'll be running from (atkapi). Do
``npm install serialport``
## Install WS (WebSocket)
### Install WS (WebSocket)
WebSockets are very simple web connections. We use them to chat between the 'server' / heap (node) and the 'view' (your browser).
......@@ -45,12 +45,20 @@ To install ws, do
``npm install ws``
## Install MathJS
### Install MathJS
MathJS is just a node package that does maths. To install, you guessed it, do
```npm install mathjs```
## Installing Serial Port Drivers
The ATKRouter uses a ```CP2102N``` USB-to-UART bridge to transmit and receive serial characters.
[**Drivers are available for all platforms at SiLabs' Website**](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
Download and install drivers, and check in your system's device manager that a 'CP210x USB to UART Bridge' appears.
# Running DMC
To run the program, we launch the main.js file with node, from the command line. One of the things this does is run a tiny HTTP server that we can use to access the UI.
......@@ -75,9 +83,6 @@ In a browser open *localhost:8080* you will see the mods and this msg in the ter
![img moving](doc/images/mothermother.gif)
- those GIFs tho
- steppers gotta step
- load a program
- drag around
- zoom in and out
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment