README.md 4.51 KB
Newer Older
1
# Automatakit API
Jake Read's avatar
Jake Read committed
2

Jake Read's avatar
Jake Read committed
3
4
aka project 'consistent-sandbox' 

Jake Read's avatar
Jake Read committed
5
6
![img software](doc/images/atkapi.png)
![img hardware](doc/images/machine-with-atkapi.jpg)
Jake Read's avatar
Jake Read committed
7

Jake Read's avatar
Jake Read committed
8
[Automatakit](http://gitlab.cba.mit.edu/jakeread/automatakit) is a system architecture for robotics where machine controllers are extensible, and organized around the principle of event propagation: things happen because of other things that have happened beforehand. 
Jake Read's avatar
Jake Read committed
9

Jake Read's avatar
Jake Read committed
10
We aim to take an event graph architecture down through multiple layers of computing, routing event propagation also through a message passing network between multiple cpus each operating modular hardware endpoints.
Jake Read's avatar
Jake Read committed
11

Paloma GR's avatar
Paloma GR committed
12
This project serves the developement environment / api we use to write and represent programs that are event graphs. [Install and Run.](https://gitlab.cba.mit.edu/jakeread/atkapi/blob/master/installing-node-sp-ws.md)
Jake Read's avatar
Jake Read committed
13

Jake Read's avatar
Jake Read committed
14
![img moving](doc/images/mothermother.gif)
Jake Read's avatar
Jake Read committed
15

Jake Read's avatar
Jake Read committed
16
17
## For MW

Jake Read's avatar
Jake Read committed
18
 - walk program units and change 
19
  - hardware, and consolidate ? 
Jake Read's avatar
OK    
Jake Read committed
20
21
22
 - what program units do we want?
 - try demo machine setup ... want flow control, better planning, this is actually a big thing 
 - jogging, etc ... keydown modules ? 
23

Jake Read's avatar
OK    
Jake Read committed
24
## Documentation
Jake Read's avatar
Jake Read committed
25
26
27
28
29
30
31
32
33
34
 - GIFS
  - load a program
  - drag around
  - zoom in and out 
  - add a module
  - hook events up
  - rm events
  - rm modules
  - change settings 

Jake Read's avatar
Jake Read committed
35
## Questionable Moves
Jake Read's avatar
...    
Jake Read committed
36
 - test load of dmz.json - unordered list / names / no mdl ? 
Jake Read's avatar
Jake Read committed
37
38
39
40
 - module deletion seems unclean
 - input / output objects should be able to unhook themselves: 
  - keep references of what-is-attached ? 

Jake Read's avatar
Jake Read committed
41
42
## WRT Representations

Jake Read's avatar
OK    
Jake Read committed
43
OK, should write this out properly at some point.
Jake Read's avatar
Jake Read committed
44
45
46
47
48
49
50
51
52
53
54
55

Module have 
 Inputs
 Outputs
 State (initial states are settings)

Also
 Names, IDs
 Paths-to-source 

Modules-that-represent-remote-computing also have
 Ports
Jake Read's avatar
Jake Read committed
56
 that connect to a
Jake Read's avatar
Jake Read committed
57
58
59
60
 Link 

To assemble a representation of these, we want to have a kind of 'netlist' that, for convenience, we'll treat like a JSON object. We want heirarchy, so consider the representation having 'top-level' outputs / inputs / state as well ? 

Jake Read's avatar
Jake Read committed
61
## Programming Notes
Jake Read's avatar
Jake Read committed
62

Jake Read's avatar
Jake Read committed
63
64
65
66
### 15 Minute Tasks 
 - @ views.js, uiRequestModuleMenu and uiRequestProgramMenu don't properly build trees from folder structure. similarly, reciprical fn's in client.js do the same 
 - @ these load / save functions could also reach into the modules' source to retrieve their proper names, as spec'd in description ... 
 - 's' for save program uses hack-asf DOM alert to ask for path
Jake Read's avatar
Jake Read committed
67

Jake Read's avatar
Jake Read committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
- once we can plan gcode sequence, work towards more
 - better hardware abstraction, i.e.
   stepper.port = bridge.port('0,1')
   stepper.port.onPacket = function(){ ... } 
   callbacks ? 
 - UI elements, i.e. demonstrating slider for individual axis movements, or just an arrow / keypad capture on mouseover thing 

## Deeply Missing
- delete modules / module context menu 
- load / save program 
- decent page nav 
- title bar / instructions 
- heirarchy zoom 
- states / uis / etc - one off / one-at-a-time for updates 
 - i.e. all f'n update calls are to single module-global state update
 - ! 
- states / getters / setters not applicable to sub-elements in an object within state
 - i.e. array access 
- consistent dereferencing, type checking implementation?

Jake Read's avatar
Jake Read committed
88
89
90
## Planner Bugs
 - trapezoid linking doesn't account for speed changes properly, i.e. doesn't ramp down into next move if next move's cruise speed is less than our exit speed 

Jake Read's avatar
Jake Read committed
91
92
## Want
- log() for logs-from-module tagged 
Jake Read's avatar
OK    
Jake Read committed
93
94
- off-screen divs get pointers-to so that we don't get lost
  - 'h' or something to zoom-to-extents
Jake Read's avatar
Jake Read committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

## Demo Desires 
- want to show immediacy of hardware: software representation
- want to show physical reconfigurability and software reconfigurability
 - i.e. mill, add rotary tool, pull normal vector from planner moves and route to r motor 
- want to have UI elements
 - button, terminal, 
- live motor torque display, vector from accelerometer 

## Network Desires
- c improvements / dma etc, would be very cool
- flow control probably desired ... what can we model with uart and implement with fpga?
- proper speed tests
- DMA not possible / not enough channels for router implementation / not portable enough ... 
- lights displaying activity

## Bugs
- when bridge has two addresses only one sends
 - add watch for identical addresses
 - besides we want a different network representation 
- cannot connect input to output w/o backwards bezier 
116

Jake Read's avatar
Jake Read committed
117
118
119
120
121
122
123
124
125
126
# The RPI

 - sudo apt-get update
 - sudo apt-get upgrade
 - install nvm
  -  
 - install git 

- https://cnc.js.org/ 
- https://github.com/cncjs/cncjs/wiki/Setup-Guide:-Raspberry-Pi-%7C-Install-Node.js-via-Node-Version-Manager-(NVM)