Skip to content

Commit 835787c

Browse files
authored
Merge pull request #112 from blues/alex-update-apis
Update note.python fluent APIs
2 parents a4ebb76 + cbe69af commit 835787c

3 files changed

Lines changed: 689 additions & 64 deletions

File tree

API.md

Lines changed: 104 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,86 +4,126 @@
44

55
`from notecard import card`
66

7-
| Notecard API | Python Library API |
8-
| -----------------------| -------------------|
9-
| `card.attn` | card.attn |
10-
| `card.aux` | NOT IMPLEMENTED |
11-
| `card.contact` | NOT IMPLEMENTED |
12-
| `card.location.mode` | NOT IMPLEMENTED |
13-
| `card.location.track` | NOT IMPLEMENTED |
14-
| `card.motion.mode` | NOT IMPLEMENTED |
15-
| `card.motion.sync` | NOT IMPLEMENTED |
16-
| `card.motion.track` | NOT IMPLEMENTED |
17-
| `card.restart` | NOT IMPLEMENTED |
18-
| `card.restore` | NOT IMPLEMENTED |
19-
| `card.status` | card.status |
20-
| `card.temp` | card.temp |
21-
| `card.time` | card.time |
22-
| `card.usage.get` | NOT IMPLEMENTED |
23-
| `card.usage.test` | NOT IMPLEMENTED |
24-
| `card.version` | card.version |
25-
| `card.voltage` | card.voltage |
26-
| `card.wireless` | card.wireless |
7+
| Notecard API | Python Library API |
8+
| ----------------------- | ------------------- |
9+
| `card.attn` | card.attn |
10+
| `card.aux` | card.aux |
11+
| `card.aux.serial` | card.auxSerial |
12+
| `card.binary` | card.binary |
13+
| `card.binary.get` | card.binaryGet |
14+
| `card.binary.put` | card.binaryPut |
15+
| `card.carrier` | card.carrier |
16+
| `card.contact` | card.contact |
17+
| `card.dfu` | card.dfu |
18+
| `card.illumination` | card.illumination |
19+
| `card.io` | card.io |
20+
| `card.led` | card.led |
21+
| `card.location` | card.location |
22+
| `card.location.mode` | card.locationMode |
23+
| `card.location.track` | card.locationTrack |
24+
| `card.monitor` | NOT IMPLEMENTED |
25+
| `card.motion` | NOT IMPLEMENTED |
26+
| `card.motion.mode` | NOT IMPLEMENTED |
27+
| `card.motion.sync` | NOT IMPLEMENTED |
28+
| `card.motion.track` | NOT IMPLEMENTED |
29+
| `card.power` | card.power |
30+
| `card.restart` | NOT IMPLEMENTED |
31+
| `card.restore` | NOT IMPLEMENTED |
32+
| `card.sleep` | NOT IMPLEMENTED |
33+
| `card.status` | card.status |
34+
| `card.temp` | card.temp |
35+
| `card.time` | card.time |
36+
| `card.trace` | NOT IMPLEMENTED |
37+
| `card.transport` | card.transport |
38+
| `card.triangulate` | NOT IMPLEMENTED |
39+
| `card.usage.get` | NOT IMPLEMENTED |
40+
| `card.usage.test` | NOT IMPLEMENTED |
41+
| `card.version` | card.version |
42+
| `card.voltage` | card.voltage |
43+
| `card.wifi` | NOT IMPLEMENTED |
44+
| `card.wireless` | card.wireless |
45+
| `card.wireless.penalty` | NOT IMPLEMENTED |
2746

28-
## Note Commands
47+
## DFU Commands
2948

30-
`from notecard import note`
49+
| Notecard API | Python Library API |
50+
| ------------ | ------------------ |
51+
| `dfu.get` | NOT IMPLEMENTED |
52+
| `dfu.set` | NOT IMPLEMENTED |
53+
54+
## Env Commands
3155

32-
| Notecard API | Python Library API |
33-
| -----------------------| -------------------|
34-
| `note.add` | note.add |
35-
| `note.changes` | note.changes |
36-
| `note.delete` | note.delete |
37-
| `note.get` | note.get |
38-
| `note.update` | note.update |
39-
| `note.template` | note.template |
56+
`from notecard import env`
57+
58+
| Notecard API | Python Library API |
59+
| -------------- | ------------------ |
60+
| `env.default` | env.default |
61+
| `env.get` | env.get |
62+
| `env.modified` | env.modified |
63+
| `env.set` | env.set |
64+
| `env.template` | NOT IMPLEMENTED |
65+
66+
## File Commands
67+
68+
`from notecard import file`
69+
70+
| Notecard API | Python Library API |
71+
| ---------------------- | ------------------- |
72+
| `file.changes` | file.changes |
73+
| `file.delete` | file.delete |
74+
| `file.stats` | file.stats |
75+
| `file.changes.pending` | file.pendingChanges |
4076

4177
## Hub Commands
4278

4379
`from notecard import hub`
4480

45-
| Notecard API | Python Library API |
46-
| -----------------------| -------------------|
47-
| `hub.get` | hub.get |
48-
| `hub.log` | hub.log |
49-
| `hub.set` | hub.set |
50-
| `hub.status` | hub.status |
51-
| `hub.sync` | hub.sync |
52-
| `hub.sync.status` | hub.syncStatus |
81+
| Notecard API | Python Library API |
82+
| ----------------- | ------------------ |
83+
| `hub.get` | hub.get |
84+
| `hub.log` | hub.log |
85+
| `hub.set` | hub.set |
86+
| `hub.status` | hub.status |
87+
| `hub.sync` | hub.sync |
88+
| `hub.sync.status` | hub.syncStatus |
5389

54-
## DFU Commands
90+
## Note Commands
5591

56-
| Notecard API | Python Library API |
57-
| -----------------------| -------------------|
58-
| `dfu.get` | NOT IMPLEMENTED |
59-
| `dfu.set` | NOT IMPLEMENTED |
92+
`from notecard import note`
6093

61-
## Env Commands
94+
| Notecard API | Python Library API |
95+
| --------------- | ------------------ |
96+
| `note.add` | note.add |
97+
| `note.changes` | note.changes |
98+
| `note.delete` | note.delete |
99+
| `note.get` | note.get |
100+
| `note.update` | note.update |
101+
| `note.template` | note.template |
62102

63-
`from notecard import env`
103+
## NTN Commands
64104

65-
| Notecard API | Python Library API |
66-
| -----------------------| -------------------|
67-
| `env.default` | env.default |
68-
| `env.get` | env.get |
69-
| `env.modified` | env.modified |
70-
| `set` | env.set |
105+
`from notecard import ntn`
71106

72-
## File Commands
107+
| Notecard API | Python Library API |
108+
| ------------ | ------------------ |
109+
| `ntn.gps` | NOT IMPLEMENTED |
110+
| `ntn.reset` | NOT IMPLEMENTED |
111+
| `ntn.status` | NOT IMPLEMENTED |
73112

74-
`from notecard import file`
113+
## Var Commands
75114

76-
| Notecard API | Python Library API |
77-
| -----------------------| -------------------|
78-
| `file.changes` | file.changes |
79-
| `file.delete` | file.delete |
80-
| `file.stats` | file.stats |
81-
| `file.changes.pending` | file.pendingChanges|
115+
| Notecard API | Python Library API |
116+
| ------------ | ------------------ |
117+
| `var.delete` | NOT IMPLEMENTED |
118+
| `var.get` | NOT IMPLEMENTED |
119+
| `var.set` | NOT IMPLEMENTED |
82120

83121
## Web Commands
84122

85-
| Notecard API | Python Library API |
86-
| -----------------------| -------------------|
87-
| `web.get` | NOT IMPLEMENTED |
88-
| `web.post` | NOT IMPLEMENTED |
89-
| `web.put` | NOT IMPLEMENTED |
123+
| Notecard API | Python Library API |
124+
| ------------ | ------------------ |
125+
| `web.get` | NOT IMPLEMENTED |
126+
| `web.post` | NOT IMPLEMENTED |
127+
| `web.put` | NOT IMPLEMENTED |
128+
| `web.delete` | NOT IMPLEMENTED |
129+
| `web` | NOT IMPLEMENTED |

0 commit comments

Comments
 (0)