Skip to content

Commit 9547c20

Browse files
Update Notecard API from upstream schema changes (49fbe4948b3df7a59c752d92708ce885427480ca) (#172)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 5c7932d commit 9547c20

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

notecard/card.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ def auxSerial(card, duration=None, limit=None, max=None, minutes=None, mode=None
115115
116116
Args:
117117
card (Notecard): The current Notecard object.
118-
duration (int): If using `"mode": "accel"`, specify a sampling duration for the Notecard accelerometer.
118+
duration (int): If using `"mode": "notify,accel"`, specify a sampling duration (in milliseconds) for the Notecard accelerometer.
119119
limit (bool): If `true`, along with `"mode":"gps"` the Notecard will disable concurrent modem use during GPS tracking.
120-
max (int): The maximum amount of data, in bytes, that can be sent in a single transmission before the Notecard pauses to allow the host to process incoming data. This value should be set to the size of the host's serial receive buffer minus `1`, which represents the number of bytes the host can absorb before the sender must delay due to the absence of flow control. For example, `note-arduino`` uses a buffer size of `(SERIALRXBUFFER_SIZE - 1)`.
120+
max (int): The maximum amount of data, in bytes, that can be sent in a single transmission before the Notecard pauses to allow the host to process incoming data. This value should be set to the size of the host's serial receive buffer minus `1`, which represents the number of bytes the host can absorb before the sender must delay due to the absence of flow control. For example, `note-arduino` uses a buffer size of `(SERIALRXBUFFER_SIZE - 1)`.
121121
minutes (int): When using `"mode": "notify,dfu"`, specify an interval for notifying the host.
122122
mode (str): The AUX mode. Must be one of the following:
123123
ms (int): The delay in milliseconds before sending a buffer of `max` size.
@@ -404,8 +404,8 @@ def locationTrack(card, file=None, heartbeat=None, hours=None, payload=None, sta
404404
Args:
405405
card (Notecard): The current Notecard object.
406406
file (str): The Notefile in which to store tracked location data. See the `_track.qo` Notefile's documentation for details on the format of the data captured.
407-
heartbeat (bool): When `start` is `true`, set to `true` to enable tracking even when motion is not detected. If using `heartbeat`, also set the `hours` below.
408-
hours (int): If `heartbeat` is true, add a heartbeat entry at this hourly interval. Use a negative integer to specify a heartbeat in minutes instead of hours.
407+
heartbeat (bool): When `start` is `true`, set to `true` to capture a tracking Note on a fixed interval even when no motion has been detected. The interval is configured with the `hours` field below.
408+
hours (int): When `heartbeat` is `true`, the interval at which to capture a heartbeat tracking Note. A positive value sets the interval in hours (e.g. `2` captures a Note every two hours). To configure an interval shorter than one hour, pass a negative integer whose absolute value is the number of minutes (e.g. `-30` captures a Note every 30 minutes).
409409
payload (str): A base64-encoded binary payload to be included in the next `_track.qo` Note. See the guide on Sampling at Predefined Intervals for more details.
410410
start (bool): Set to `true` to start Notefile tracking.
411411
stop (bool): Set to `true` to stop Notefile tracking.
@@ -744,7 +744,7 @@ def transport(card, allow=None, method=None, seconds=None, umin=None):
744744
card (Notecard): The current Notecard object.
745745
allow (bool): Set to `true` to allow adding Notes to non-compact Notefiles while connected over a non-terrestrial network. See Define NTN vs non-NTN Templates.
746746
method (str): The connectivity method to enable on the Notecard.
747-
seconds (int): The amount of time a Notecard will spend on any fallback transport before retrying the first transport specified in the `method`. The default is `3600` or 60 minutes.
747+
seconds (int): The amount of time (in seconds) a Notecard will spend on any fallback transport before retrying the first transport specified in the `method`. The default is `3600` or 60 minutes.
748748
umin (bool): Set to `true` to force a longer network transport timeout when using Wideband Notecards.
749749
750750
Returns:

0 commit comments

Comments
 (0)