diff --git a/notecard/dfu.py b/notecard/dfu.py index b757ba5..a25a283 100644 --- a/notecard/dfu.py +++ b/notecard/dfu.py @@ -18,7 +18,7 @@ def get(card, binary=None, length=None, offset=None): Args: card (Notecard): The current Notecard object. - binary (bool): If `true`, the Notecard places the firmware data in the binary storage area instead of the response `payload` field, and returns `cobs`, `length`, and `status` fields instead. Read it out with card.binary.get, then clear the area with a `card.binary` request and `delete` set to `true`. Learn more in this guide on Sending and Receiving Large Binary Objects. + binary (bool): If `true`, the Notecard places the firmware data in the binary storage area instead of the response `payload` field, and returns `cobs`, `length`, and `status` fields instead. Read it out with card.binary.get, then clear the area with a `card.binary` request and `delete` set to `true`. Learn more in this guide on Sending and Receiving Large Binary Objects. Not available while NTN is the active transport. See Send Binary Data over Cellular or WiFi. length (int): The number of bytes of firmware data to read and return to the host, up to a maximum of 8192 per request. Set to `0` to verify that the Notecard is ready to serve firmware data without retrieving any. offset (int): The offset to use before performing a read of firmware data. diff --git a/notecard/note.py b/notecard/note.py index 5ef3548..35dfd9c 100644 --- a/notecard/note.py +++ b/notecard/note.py @@ -18,7 +18,7 @@ def add(card, binary=None, body=None, file=None, full=None, key=None, limit=None Args: card (Notecard): The current Notecard object. - binary (bool): If `true`, the Notecard will send all the data in the binary buffer to Notehub. Learn more in this guide on Sending and Receiving Large Binary Objects. + binary (bool): If `true`, the Notecard will send all the data in the binary buffer to Notehub. Learn more in this guide on Sending and Receiving Large Binary Objects. Not available while NTN is the active transport. See Send Binary Data over Cellular or WiFi. body (dict): A JSON object to be enqueued. A Note must have either a `body` or a `payload`, and can have both. file (str): The name of the Notefile. On Notecard for LoRa this argument is required. On all other Notecards this field is optional and defaults to `data.qo` if not provided. When using this request on the Notecard the Notefile name must end in one of: `.qo` for a queue outgoing (Notecard to Notehub) with plaintext transport `.qos` for a queue outgoing with encrypted transport `.db` for a bidirectionally synchronized database with plaintext transport `.dbs` for a bidirectionally synchronized database with encrypted transport `.dbx` for a local-only database full (bool): If set to `true`, and the Note is using a Notefile Template, the Note will bypass usage of omitempty and retain `null`, `0`, `false`, and empty string `""` values. diff --git a/notecard/web.py b/notecard/web.py index 9da7c40..78a3302 100644 --- a/notecard/web.py +++ b/notecard/web.py @@ -53,7 +53,7 @@ def get(card, binary=None, body=None, content=None, file=None, max=None, name=No Args: card (Notecard): The current Notecard object. - binary (bool): If `true`, the Notecard will return the response stored in its binary buffer. Learn more in this guide on Sending and Receiving Large Binary Objects. + binary (bool): If `true`, the Notecard will return the response stored in its binary buffer. Learn more in this guide on Sending and Receiving Large Binary Objects. Not available while NTN is the active transport. See Send Binary Data over Cellular or WiFi. body (dict): The JSON body to send with the request. content (str): The MIME type of the body or payload of the response. Default is `application/json`. file (str): The name of a local-only Database Notefile (.dbx) where the response will be stored when the web request is executed as a queued web transaction (e.g. if the request is made when Notecard is not in continuous mode and not online). If `file` is not specified, queued web transaction responses are discarded. This argument is not used when the Notecard is in `continuous` mode and online, as responses in that case are returned directly to the host. @@ -98,7 +98,7 @@ def post(card, async_=None, binary=None, body=None, content=None, file=None, max Args: card (Notecard): The current Notecard object. async_ (bool): If `true`, the Notecard performs the web request asynchronously, and returns control to the host without waiting for a response from Notehub. This argument only applies when the Notecard is in `continuous` mode and currently online. - binary (bool): If `true`, the Notecard will send all the data in the binary buffer to the specified proxy route in Notehub. Learn more in this guide on Sending and Receiving Large Binary Objects. + binary (bool): If `true`, the Notecard will send all the data in the binary buffer to the specified proxy route in Notehub. Learn more in this guide on Sending and Receiving Large Binary Objects. Not available while NTN is the active transport. See Send Binary Data over Cellular or WiFi. body (dict): The JSON body to send with the request. content (str): The MIME type of the body or payload of the response. Default is `application/json`. file (str): The name of a local-only Database Notefile (.dbx) where the response will be stored when the web request is executed as a queued web transaction (e.g. if the request is made when Notecard is not in continuous mode and not online). If `file` is not specified, queued web transaction responses are discarded. This argument is not used when the Notecard is in `continuous` mode and online, as responses in that case are returned directly to the host. @@ -157,7 +157,7 @@ def put(card, async_=None, binary=None, body=None, content=None, file=None, max= Args: card (Notecard): The current Notecard object. async_ (bool): If `true`, the Notecard performs the web request asynchronously, and returns control to the host without waiting for a response from Notehub. This argument only applies when the Notecard is in `continuous` mode and currently online. - binary (bool): If `true`, the Notecard will send all the data in the binary buffer to the specified proxy route in Notehub. Learn more in this guide on Sending and Receiving Large Binary Objects. + binary (bool): If `true`, the Notecard will send all the data in the binary buffer to the specified proxy route in Notehub. Learn more in this guide on Sending and Receiving Large Binary Objects. Not available while NTN is the active transport. See Send Binary Data over Cellular or WiFi. body (dict): The JSON body to send with the request. content (str): The MIME type of the body or payload of the response. Default is `application/json`. file (str): The name of a local-only Database Notefile (.dbx) where the response will be stored when the web request is executed as a queued web transaction (e.g. if the request is made when Notecard is not in continuous mode and not online). If `file` is not specified, queued web transaction responses are discarded. This argument is not used when the Notecard is in `continuous` mode and online, as responses in that case are returned directly to the host.