Skip to content

Update note.python fluent APIs #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bucknalla merged 7 commits into from
Jul 31, 2025
Merged

Update note.python fluent APIs #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cb254ae
feat: add card.location.*
Bucknalla Jul 31, 2025
da340e8
fix: Update API.md doc to latest APIs
Bucknalla Jul 31, 2025
b003b29
feat: adds card.binary.* APIs
Bucknalla Jul 31, 2025
80a481a
feat: adds card.contact and card.carrier APIs
Bucknalla Jul 31, 2025
5f861a8
feat: adds card.aux and card.aux.serial
Bucknalla Jul 31, 2025
aadeeb2
fix: use camelCase for APIs
Bucknalla Jul 31, 2025
cbe69af
feat: adds card APIs for dfu, illumination, io and led
Bucknalla Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 104 additions & 64 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,86 +4,126 @@

`from notecard import card`

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `card.attn` | card.attn |
| `card.aux` | NOT IMPLEMENTED |
| `card.contact` | NOT IMPLEMENTED |
| `card.location.mode` | NOT IMPLEMENTED |
| `card.location.track` | NOT IMPLEMENTED |
| `card.motion.mode` | NOT IMPLEMENTED |
| `card.motion.sync` | NOT IMPLEMENTED |
| `card.motion.track` | NOT IMPLEMENTED |
| `card.restart` | NOT IMPLEMENTED |
| `card.restore` | NOT IMPLEMENTED |
| `card.status` | card.status |
| `card.temp` | card.temp |
| `card.time` | card.time |
| `card.usage.get` | NOT IMPLEMENTED |
| `card.usage.test` | NOT IMPLEMENTED |
| `card.version` | card.version |
| `card.voltage` | card.voltage |
| `card.wireless` | card.wireless |
| Notecard API | Python Library API |
| ----------------------- | ------------------- |
| `card.attn` | card.attn |
| `card.aux` | card.aux |
| `card.aux.serial` | card.auxSerial |
| `card.binary` | card.binary |
| `card.binary.get` | card.binaryGet |
| `card.binary.put` | card.binaryPut |
| `card.carrier` | card.carrier |
| `card.contact` | card.contact |
| `card.dfu` | card.dfu |
| `card.illumination` | card.illumination |
| `card.io` | card.io |
| `card.led` | card.led |
| `card.location` | card.location |
| `card.location.mode` | card.locationMode |
| `card.location.track` | card.locationTrack |
| `card.monitor` | NOT IMPLEMENTED |
| `card.motion` | NOT IMPLEMENTED |
| `card.motion.mode` | NOT IMPLEMENTED |
| `card.motion.sync` | NOT IMPLEMENTED |
| `card.motion.track` | NOT IMPLEMENTED |
| `card.power` | card.power |
| `card.restart` | NOT IMPLEMENTED |
| `card.restore` | NOT IMPLEMENTED |
| `card.sleep` | NOT IMPLEMENTED |
| `card.status` | card.status |
| `card.temp` | card.temp |
| `card.time` | card.time |
| `card.trace` | NOT IMPLEMENTED |
| `card.transport` | card.transport |
| `card.triangulate` | NOT IMPLEMENTED |
| `card.usage.get` | NOT IMPLEMENTED |
| `card.usage.test` | NOT IMPLEMENTED |
| `card.version` | card.version |
| `card.voltage` | card.voltage |
| `card.wifi` | NOT IMPLEMENTED |
| `card.wireless` | card.wireless |
| `card.wireless.penalty` | NOT IMPLEMENTED |

## Note Commands
## DFU Commands

`from notecard import note`
| Notecard API | Python Library API |
| ------------ | ------------------ |
| `dfu.get` | NOT IMPLEMENTED |
| `dfu.set` | NOT IMPLEMENTED |

## Env Commands

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `note.add` | note.add |
| `note.changes` | note.changes |
| `note.delete` | note.delete |
| `note.get` | note.get |
| `note.update` | note.update |
| `note.template` | note.template |
`from notecard import env`

| Notecard API | Python Library API |
| -------------- | ------------------ |
| `env.default` | env.default |
| `env.get` | env.get |
| `env.modified` | env.modified |
| `env.set` | env.set |
| `env.template` | NOT IMPLEMENTED |

## File Commands

`from notecard import file`

| Notecard API | Python Library API |
| ---------------------- | ------------------- |
| `file.changes` | file.changes |
| `file.delete` | file.delete |
| `file.stats` | file.stats |
| `file.changes.pending` | file.pendingChanges |

## Hub Commands

`from notecard import hub`

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `hub.get` | hub.get |
| `hub.log` | hub.log |
| `hub.set` | hub.set |
| `hub.status` | hub.status |
| `hub.sync` | hub.sync |
| `hub.sync.status` | hub.syncStatus |
| Notecard API | Python Library API |
| ----------------- | ------------------ |
| `hub.get` | hub.get |
| `hub.log` | hub.log |
| `hub.set` | hub.set |
| `hub.status` | hub.status |
| `hub.sync` | hub.sync |
| `hub.sync.status` | hub.syncStatus |

## DFU Commands
## Note Commands

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `dfu.get` | NOT IMPLEMENTED |
| `dfu.set` | NOT IMPLEMENTED |
`from notecard import note`

## Env Commands
| Notecard API | Python Library API |
| --------------- | ------------------ |
| `note.add` | note.add |
| `note.changes` | note.changes |
| `note.delete` | note.delete |
| `note.get` | note.get |
| `note.update` | note.update |
| `note.template` | note.template |

`from notecard import env`
## NTN Commands

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `env.default` | env.default |
| `env.get` | env.get |
| `env.modified` | env.modified |
| `set` | env.set |
`from notecard import ntn`

## File Commands
| Notecard API | Python Library API |
| ------------ | ------------------ |
| `ntn.gps` | NOT IMPLEMENTED |
| `ntn.reset` | NOT IMPLEMENTED |
| `ntn.status` | NOT IMPLEMENTED |

`from notecard import file`
## Var Commands

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `file.changes` | file.changes |
| `file.delete` | file.delete |
| `file.stats` | file.stats |
| `file.changes.pending` | file.pendingChanges|
| Notecard API | Python Library API |
| ------------ | ------------------ |
| `var.delete` | NOT IMPLEMENTED |
| `var.get` | NOT IMPLEMENTED |
| `var.set` | NOT IMPLEMENTED |

## Web Commands

| Notecard API | Python Library API |
| -----------------------| -------------------|
| `web.get` | NOT IMPLEMENTED |
| `web.post` | NOT IMPLEMENTED |
| `web.put` | NOT IMPLEMENTED |
| Notecard API | Python Library API |
| ------------ | ------------------ |
| `web.get` | NOT IMPLEMENTED |
| `web.post` | NOT IMPLEMENTED |
| `web.put` | NOT IMPLEMENTED |
| `web.delete` | NOT IMPLEMENTED |
| `web` | NOT IMPLEMENTED |
Loading