Skip to content

chore: minor updates/clarifications for card.aux req/rsp #287

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
rdlauer merged 1 commit into from
Apr 30, 2026
Merged

chore: minor updates/clarifications for card.aux req/rsp #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions card.aux.req.notecard.api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@
"minApiVersion": "3.4.1"
},
"max": {
"description": "When in `gpio` mode, if an `AUX` pin is configured as a `count` type, the maximum number of samples of duration `seconds`, after which all subsequent counts are added to the final sample. Passing `0` or omitting this value will provide a single incrementing count of rising edges on the pin.",
"description": "When in `gpio` mode, if an `AUX` pin is configured as a `count` type, the maximum number of `seconds`-long sample buckets to collect. Once `max` buckets have been filled, additional counts roll into the final bucket. Passing `0` or omitting this value will provide a single incrementing count of rising edges on the pin.",
"type": "integer",
"minimum": -1
},
"mode": {
"description": "The AUX mode. Must be one of the following keywords. Some keywords are only supported on certain types of Notecards.",
"description": "The AUX mode. If specified, must be one of the following keywords. Some keywords are only supported on certain types of Notecards.",
"type": "string",
"enum": [
"dfu",
Expand Down Expand Up @@ -328,7 +328,7 @@
"type": "boolean"
},
"sync": {
"description": "If `true`, for pins set as `input` by `usage`, the Notecard will autonomously report any state changes as new notes in `file`. For pins used as `counter`, the Notecard will use an interrupt to count pulses and will report the total in a new note in `file` unless it has been noted in the previous second.",
"description": "If `true`, for pins set as `input` by `usage`, the Notecard will autonomously report any state changes as new notes in `file`. For pins used as `count`, the Notecard will use an interrupt to count pulses and will report the total in a new note in `file` unless it has been noted in the previous second.",
"type": "boolean",
"skus": [
"CELL",
Expand Down
7 changes: 6 additions & 1 deletion card.aux.rsp.notecard.api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"type": "integer"
},
"state": {
"description": "When in AUX `gpio` mode, the state of each AUX pin.",
"description": "When in AUX `gpio` mode, the array element for each pin reflects its current configuration. The label below each example object identifies the corresponding `usage` value the pin was configured with.",
"type": "array",
"items": {
"type": "object",
Expand Down Expand Up @@ -74,6 +74,7 @@
"CELL",
"CELL+WIFI",
"LORA",
"SKYLO",
"WIFI"
]
},
Expand All @@ -84,6 +85,7 @@
"CELL",
"CELL+WIFI",
"LORA",
"SKYLO",
"WIFI"
]
},
Expand All @@ -94,6 +96,7 @@
"CELL",
"CELL+WIFI",
"LORA",
"SKYLO",
"WIFI"
]
},
Expand All @@ -104,6 +107,7 @@
"CELL",
"CELL+WIFI",
"LORA",
"SKYLO",
"WIFI"
]
},
Expand All @@ -113,6 +117,7 @@
"skus": [
"CELL",
"CELL+WIFI",
"SKYLO",
"WIFI"
]
}
Expand Down
Loading