File tree Expand file tree Collapse file tree 1 file changed +67
-0
lines changed Expand file tree Collapse file tree 1 file changed +67
-0
lines changed Original file line number Diff line number Diff line change 1+ # Documentation plan/structure
2+
3+ ## Basic usage
4+
5+ * create_app
6+ * LabThing class
7+ * Server class
8+ * current_labthing
9+
10+ ### HTTP API structure
11+
12+ * Thing Description (root)
13+ * Swagger-UI
14+ * Action queue
15+ * Extension list
16+
17+ ### WebSocket API structure
18+
19+ * Not yet implemented
20+
21+ ### Serialising data
22+
23+ * fields
24+ * schema
25+ * semantics
26+
27+ ### Action tasks
28+
29+ * Preamble (all actions are tasks, etc)
30+ * Labthing.actions TaskPool
31+ * current_task
32+ * update_task_progress
33+ * update_task_data
34+ * Stopping tasks
35+ * TaskThread.stopped event
36+ * TaskKillException
37+
38+ ### Synchronisation
39+
40+ * StrictLock
41+ * CompositeLock
42+ * ClientEvent
43+
44+ ## Advanced usage
45+
46+ ### View classes
47+
48+ * labthings.views
49+
50+ ### Components
51+
52+ * Access to Python objects by name
53+ * Used to access hardware from within Views
54+ * registered_components, find_component
55+
56+ ### Encoders
57+
58+ * labthings.json.LabThingsJSONEncoder
59+
60+ ## Extension system
61+
62+ * labthings.extensions.BaseExtension
63+ * labthings.extensions.find_extensions
64+
65+ ### Find functions
66+
67+ * registered_extensions, find_extension
You can’t perform that action at this time.
0 commit comments