From e9053cd2bd5557ebae420ed79f27cf76f1ee4bde Mon Sep 17 00:00:00 2001 From: Rob Lauer Date: Wed, 29 Apr 2026 15:48:44 -0500 Subject: [PATCH] minor updates/clarifications for card.aux req/rsp --- card.aux.req.notecard.api.json | 6 +++--- card.aux.rsp.notecard.api.json | 7 ++++++- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/card.aux.req.notecard.api.json b/card.aux.req.notecard.api.json index cfc5237..850e342 100644 --- a/card.aux.req.notecard.api.json +++ b/card.aux.req.notecard.api.json @@ -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", @@ -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", diff --git a/card.aux.rsp.notecard.api.json b/card.aux.rsp.notecard.api.json index f2deb85..fb6f477 100644 --- a/card.aux.rsp.notecard.api.json +++ b/card.aux.rsp.notecard.api.json @@ -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", @@ -74,6 +74,7 @@ "CELL", "CELL+WIFI", "LORA", + "SKYLO", "WIFI" ] }, @@ -84,6 +85,7 @@ "CELL", "CELL+WIFI", "LORA", + "SKYLO", "WIFI" ] }, @@ -94,6 +96,7 @@ "CELL", "CELL+WIFI", "LORA", + "SKYLO", "WIFI" ] }, @@ -104,6 +107,7 @@ "CELL", "CELL+WIFI", "LORA", + "SKYLO", "WIFI" ] }, @@ -113,6 +117,7 @@ "skus": [ "CELL", "CELL+WIFI", + "SKYLO", "WIFI" ] }