Skip to content

Update note helper to support port and compact format #85

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
haydenroche5 merged 2 commits into from
Jul 29, 2024
Merged

Update note helper to support port and compact format #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d46b80
Update note helper to support port and compact format
drrk Apr 10, 2024
d354640
Update note add helper to support port
drrk Apr 10, 2024
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
17 changes: 15 additions & 2 deletions notecard/note.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


@validate_card_object
def add(card, file=None, body=None, payload=None, sync=None):
def add(card, file=None, body=None, payload=None, sync=None, port=None):
"""Add a Note to a Notefile.

Args:
Expand All @@ -23,6 +23,8 @@ def add(card, file=None, body=None, payload=None, sync=None):
body (JSON object): A developer-defined tracker ID.
payload (string): An optional base64-encoded string.
sync (bool): Perform an immediate sync after adding.
port (int): If provided, a unique number to represent a notefile.
Required for Notecard LoRa.

Returns:
string: The result of the Notecard request.
Expand All @@ -34,6 +36,8 @@ def add(card, file=None, body=None, payload=None, sync=None):
req["body"] = body
if payload:
req["payload"] = payload
if port:
req["port"] = port
if sync is not None:
req["sync"] = sync
return card.Transaction(req)
Expand Down Expand Up @@ -150,7 +154,7 @@ def update(card, file=None, note_id=None, body=None, payload=None):


@validate_card_object
def template(card, file=None, body=None, length=None):
def template(card, file=None, body=None, length=None, port=None, compact=False):
"""Create a template for new Notes in a Notefile.

Args:
Expand All @@ -160,6 +164,11 @@ def template(card, file=None, body=None, length=None):
values as "hints" for the data type.
length (int): If provided, the maximum length of a payload that
can be sent in Notes for the template Notefile.
port (int): If provided, a unique number to represent a notefile.
Required for Notecard LoRa.
compact (boolean): If true, sets the format to compact to tell the
Notecard to omit this additional metadata to save on storage
and bandwidth. Required for Notecard LoRa.

Returns:
string: The result of the Notecard request.
Expand All @@ -171,4 +180,8 @@ def template(card, file=None, body=None, length=None):
req["body"] = body
if length:
req["length"] = length
if port:
req["port"] = port
if compact:
req["format"] = "compact"
return card.Transaction(req)