Commit c58e2ab1 authored by Jake Read's avatar Jake Read
Browse files

add op video

parent 7d7020ab
......@@ -4,18 +4,82 @@ The Clank-LZ Controller is a standalone / adhoc implementation of an ongoing exp
### Circuits & Firmware
### Software
The software that runs Clank is a mixture of 'server-side' javascript (running in node.js), client-side js (in the browser) and embedded c++ in the hardware modules.
### Circuits
... PSU breakout, circuit, CAD and firmware
... ESC breakout, circuit, and firmware
... Steppers, circuit and firmware
### Bootloader and Building
### Firmware
... have the feather-m4 bootloader, link to... std JTAG pinout. one pin on stepper motor board removed when loading code.
... vscode, code in the repo's above, load via usb
### Software
### Operation
#### Generating GCode
- flatcam
- mods
- feeds & speeds
- engraving bit or 1/64" flat endmill
- 0.003" total depth in one pass
- 0.15" feedrate: inch/sec
- 10k rpm
- 1/32" flat endmill
- 0.070" total depth in one pass
- 0.1" inch / sec
- 10k rpm
#### Homing & Running GCode
#### Tool Change
#### Installation
To install software needed to communicate with and run clank, you first need to download `node.js` [at this link]( - get the LTS version, not the latest.
On windows, I use git bash to do this: you can download it by reading [here]( You should be able to use whatever terminal interface you are familiar with.
Download this repository and navigate to it in your terminal. Do `cd tool` to drop into the javascript folder. Now you'll need to install a few `npm` (node's package manager) dependencies.
`npm install express`
`npm install serialport`
`npm install ws`
To run the same code in the browser (which uses ES6 modules) and in node (which doesn't) I run a package that sets some node flags automatically on the local side. To install that ([from here](, do:
`npm init esm`
This *should* work, and you should now be able to run the boot file:
`node clank`
Your terminal should report:
clank-tool available on: <your ip>:8080
clank-tool available on:
You can navigate to the latter address (your local host) in the browser, and the controller should appear. When you plug the machine in, it should connect automatically, and you'll see something like:
`SERPORT at <name> OPEN`
... runs a mixture of virtual machines / distributed control: JS handles for low level machine interface, UI wrap. serves from folder in here, auto-connects USB, reads GCodes.
\ No newline at end of file
\ No newline at end of file
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