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

Jake Read's avatar
Jake Read committed
3
## what it do
Jake Read's avatar
Jake Read committed
4

Jake Read's avatar
Jake Read committed
5
javascript system for jake for building robot applications, 
Jake Read's avatar
Jake Read committed
6

Jake Read's avatar
Jake Read committed
7
8
.. rn: do terminal HTML? 
.. then: consider model for node.js server, model-view-controller or w/e ?
Jake Read's avatar
Jake Read committed
9

Jake Read's avatar
Jake Read committed
10
## links to things 
Jake Read's avatar
Jake Read committed
11

Jake Read's avatar
Jake Read committed
12
http://designmodo.github.io/Flat-UI/
Jake Read's avatar
Jake Read committed
13

Jake Read's avatar
Jake Read committed
14
http://workshop.chromeexperiments.com/examples/gui/#1--Basic-Usage 
Jake Read's avatar
Jake Read committed
15

Jake Read's avatar
Jake Read committed
16
bootstrap, numeric.js ... 
Jake Read's avatar
Jake Read committed
17

Jake Read's avatar
Jake Read committed
18
http://backbonejs.org/#Events
19

20
21
## Desires
 - load / keep state 
22

23
## Model Consistency
24

25
In Memory: array of modules
26

27
Saved / interfaced with: json of this - so to load from this, we need paths and ids attached to each module on load time.
28

29
To wrap / add heirarchy: this json object can be loaded the same as a program, given top level inputs and outputs, and made into another require()d module. 
30

31
Modules are tiny programs, specifics (inputs, outputs, state) are read by system and wrapped into UI. UI has access to write into state, and connect events together.
32

33
To wrap, we write a representation in api-type rep, with one connection. We output the 'text line' of a Terminal into the 'text input' input of a gcode parser, and see the output / state bubble through the UI.
34

35
36
37
38
 - to test, cleanup and write gcode obj
 - confirm state change comes down to server
 - confirm event bubbles through in server 
 - push event back to server ui ? dat.updatedisplay() ? 
39

40
For extra points, we read in the connection also with an SVG layer - iterating through connections of the represented program.
41