Notecard Error and Status Codes
Notecard API responses may include one or more error or status codes denoted by
curly braces, e.g. {sync-begin}. These codes are static and persist across API
versions.
noteIf you encounter a code not on this list, or have any other technical questions, please consult the Blues Developer Forum for assistance.
| Code | Definition | Resolution |
|---|---|---|
{address-assigned} | Successful DHCP resolution and IP address assigned. | |
{auth} | Notehub unable to authenticate Notecard. | Check accompanying status for more details - if the situation persists contact Blues. |
{auth-retry} | Notehub authentication failed. System is attempting to retry auth. | Check accompanying status for more details - if the situation persists contact Blues. |
{bad-bin} | Binary data is corrupted or in an unexpected format. | Check accompanying status for more details - if the situation persists contact Blues. |
{cell-disconnect-begin} | Modem disconnection requested. | |
{cell-disconnected} | Modem disconnected. | |
{cell-registered} | Wireless service successfully registered. | |
{cell-registration-wait} | Waiting for wireless service to be registered. | |
{cell-scan} | Waiting for wireless triangulation (can take up to 2 minutes). | |
{cell-scan-wait} | Waiting for wireless triangulation (can take up to 2 minutes). | |
{checkpointed} | Notecard config state has been saved/checkpointed. | |
{connect-aborted} | Connection attempt was manually aborted. | |
{connect-failure} | Notecard WiFi only - indicates possible Wi-Fi connection failure. | Check the SSID configuration using card.wifi. Try re-setting the password. |
{connect-ll-failure} | Notecard WiFi only - indicates a low-level connection failure occurred. | Retry the Wi-Fi connection. |
{connected} | Notecard is connected to the cellular network. | |
{connected-closed} | Notecard has closed its connection to the cellular network. | |
{connecting} | Notecard is connecting to the cellular network. | |
{crc} | CRC check failed, indicating possible data corruption during transport or storage. | Attempt the request again and if the situation persists contact Blues. |
{device-delay-5}{device-delay-10}{device-delay-15}{device-delay-20}{device-delay-30}{device-delay-60} | Notehub is throttling device connection for [n] minutes. | If the situation persists for > 60 minutes, contact Blues. |
{dead} | Notecard power source is in a critically low power state. | |
{device-disabled} | This Notecard has been disabled on Notehub. | Unblock the device using this guide. |
{dfu-bad-target} | The requested Notecard firmware isn't appropriate for this type of Notecard. | Verify that you are using the correct Notecard firmware binary for the type of Notecard you are using. |
{dfu-config-backup} | Failed to backup config prior to switching to the new Notecard firmware. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-dl} | Too many consecutive errors when downloading the firmware image from Notehub. | Re-check the firmware binary on Notehub and if the situation persists contact Blues. |
{dfu-dl-chunk-length} | Image chunk from Notehub doesn't have a requested length. | Re-check the firmware binary on Notehub and if the situation persists contact Blues. |
{dfu-ext-chunk} | Error getting a chunk from external storage. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-ext-get-length} | Failed to get the length of the image in external storage. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-ext-length} | The number of bytes actually stored in external storage doesn't match the length of the image according to the metadata from Notehub. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-ext-written} | The number of bytes allegedly written to external storage doesn't match the length of the image according to the metadata from Notehub. "allegedly" because the "actual" length check is done later. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-in-progress} | Notecard device firmware update is in progress. | |
{dfu-int-append} | Appending image bytes to internal storage failed. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-int-chunk} | Error getting a chunk from internal storage. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-int-chunk-length} | Image chunk from internal storage doesn't have a requested length. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-modem-fs} | When using the modem for external storage, failed to use the modem's filesystem. | Attempt the DFU again and if the situation persists contact Blues. |
{dfu-not-ready} | Waiting for Notecard internal DFU image storage to be ready. | Error should resolve after ~30 seconds. If the situation persists contact Blues. |
{dfu-post-md5} | After booting up new Notecard firmware, the firmware's MD5 is bad. | Verify the Notecard firmware binary matches the MD5 checksum documented in Firmware Releases. |
{dfu-pre-md5} | Before switching to the new Notecard firmware, the firmware's MD5 is bad. | Verify the Notecard firmware binary matches the MD5 checksum documented in Firmware Releases. |
{dfu-sig} | The new Notecard firmware image doesn't contain the Notecard firmware signature. | Verify the Notecard firmware binary matches the MD5 checksum documented in Firmware Releases. |
{dfu-superseded} | The DFU was interrupted by another type of DFU (e.g. a host DFU superseded a Notecard DFU, or vice-versa). | Verify your DFU process to avoid conflicts. |
{dfu-total-length} | The total number of image bytes, meaning both internal and external storage, doesn't match the number of image bytes read from Notehub. | Re-check the firmware binary on Notehub and if the situation persists contact Blues. |
{dfu-watchdog} | The DFU process did not advance the work timer quickly enough, triggering a watchdog timeout. | Attempt the DFU again and if the situation persists contact Blues. |
{disconnected} | Notecard is disconnected from the network. | |
{disconnecting} | Notecard is in the process of disconnecting from the network. | |
{env-not-modified} | In response to env.set, indicates environment variables have not been modified. | |
{extended-network-failure} | Modem unable to connect to network after an extended time period and Notecard is in a Network Registration Failure Penalty Box. | Consult our guides on Diagnosing Cellular Connectivity Issues and Understanding Notecard Penalty Boxes. |
{extended-service-failure} | Unable to connect to Notehub after an extended time period and Notecard is in an Inability to Connect to Notehub Penalty Box | Check the Notehub.io Status Page for updates and consult our guide on Understanding Notecard Penalty Boxes. |
{file-max} | Triggered when certain Notecard operations enforce a maximum "chunk" size and a specific chunk is larger than expected. | Check accompanying status for more details - if the situation persists contact Blues. |
{file-min} | Triggered when certain Notecard operations enforce a minimum "chunk" size and a specific chunk is smaller than expected. | Check accompanying status for more details - if the situation persists contact Blues. |
{file-open} | Notecard filesystem file open error. | Check accompanying status for more details - if the situation persists contact Blues. |
{file-storage-full} | Notecard filesystem is full. | Notecard must be synced to Notehub before more Notes can be added. |
{file-write-failure} | Notecard filesystem is full. | Notecard must be synced to Notehub before more Notes can be added. |
{filesys-reinit} | Notecard filesystem is being reinitialized. | |
{full} | Notecard filesystem is full. | Notecard must be synced to Notehub before more Notes can be added. |
{gps} | The current status of GPS connectivity. | |
{gps-active} | GPS has started and is currently active. | |
{gps-inactive} | GPS is inactive. | |
{gps-penalty} | GPS is in a penalty box. | |
{gps-sats} | The number of GPS satellites visible by the device. | |
{gps-signal} | Information about the current GPS signal strength. | |
{gps-starting} | GPS is starting. | |
{host-dfu-fatal} | Notecard Outboard Firmware Update was unable to complete. | Check accompanying status for more details - if the situation persists contact Blues. |
{host-retry} | Notecard is retrying a connection attempt. | |
{host-unreachable} | Unable to connect to Notehub TCP socket. | Check accompanying status for more details - if the situation persists contact Blues. |
{hub-mode} | The JSON request requires the Notecard to be in a particular hub.set mode. | Check accompanying status for more details - if the situation persists contact Blues. |
{hub-not-connected} | JSON request requires that Notecard be connected to Notehub. | Notecard must be in continuous mode to use this request. |
{idle} | Modem is currently disconnected and idle. | |
{incompatible} | Incompatible JSON request fields. | Check accompanying status for more details - if the situation persists contact Blues. |
{io} | Notecard could not parse received JSON. | This is usually due to dropped characters or corruption, host should retry the request. |
{joining-network} | Notecard is in the process of joining a network. | |
{modem-off} | Wireless modem is off. | |
{modem-on} | Wireless modem is on. | |
{modem-power-failure} | Insufficient battery current available for power-on of modem and Notecard is in an Insufficient Power Supply Penalty Box. | Check the Notecard datasheet for power requirements and consult the guide on Understanding Notecard Penalty Boxes. |
{net-init} | Wireless network interface is initializing. | |
{network} | General wireless connectivity error. | Check accompanying status for more details - if the situation persists contact Blues. |
{network-error-wait} | Waiting to retry after a network error. | |
{network-timeout} | Network connection timed out. | |
{network-up} | Successfully connected to a network. | |
{no-address} | Notecard WiFi is unable to obtain IP address from access point. | Try re-setting the password using card.wifi or SoftAP feature. |
{no-changes} | Indicates a sync was performed, but no new changes were detected to process. | |
{no-handler} | Notehub internal error. | Check accompanying status for more details - if the situation persists contact Blues. |
{no-mojo} | Making a card.power request without an attached Mojo. | |
{no-ntn-module} | NTN (Non-Terrestrial Network) module (e.g. Starnote) not detected. | Verify Starnote is paired with Notecard in Notecarrier. |
{no-session} | There is no active Notehub session when one is currently required. | Verify a successful connection with Notehub and retry request. |
{no-status} | No status information returned from a request to a connected NTN device. | Check accompanying status for more details - if the situation persists contact Blues. |
{no-time} | The network time has not been set or synchronized on Notecard. | Perform a sync with Notehub to set the time. |
{normal} | The request operation completed successfully. | |
{not-connected} | Notecard is not connected to a network. | |
{not-encrypted} | Data or network connection is not encrypted. | |
{not-implemented} | Requested feature is not yet implemented. | Check accompanying status for more details - if the situation persists contact Blues. |
{not-ready} | Notecard is not ready for the requested operation. | Check accompanying status for more details - if the situation persists contact Blues. |
{not-supported} | Request not supported due to Notecard hardware or incompatible with existing Notecard configuration. | Verify Notecard hardware and settings. If the situation persists contact Blues. |
{note-exists} | Cannot add a new Notefile that already exists. | Use a different name for the Notefile. |
{note-noexist} | Action cannot be performed on a Notefile that doesn't exist. | Validate that the Notefile exists before performing this action. |
{note-paused} | The _note_pause environment variable is set on Notehub to prevent a possible runaway device. | If device is not in runaway mode, delete this environment variable on Notehub. |
{notefile-bad-name} | Invalid Notefile name (e.g. may be using a reserved character). | Be sure the Notefile name does not include ,. |
{notefile-exists} | Cannot add a new Notefile that already exists. | Use a different name for the Notefile you are trying to create. |
{notefile-in-use} | Cannot delete a Notefile that is currently in use. | Wait for the current action on the Notefile to complete. |
{notefile-noexist} | Action cannot be performed on a Notefile that doesn't exist. | Validate that the Notefile exists before performing this action. |
{notefile-queue-disallowed} | Specified operation not allowed on queue Notefiles. | Contact Blues for assistance. |
{notehub-connected} | Successfully connected to Notehub. | |
{notehub-disconnected} | Successfully disconnected from Notehub. | |
{notehub-open-failure} | General error while opening Notehub. | Check accompanying status for more details - if the situation persists contact Blues. |
{ntn-connected} | NTN module (Starnote) has established a connection. | |
{ntn-connecting} | NTN module (Starnote) is establishing a connection. | |
{ntn-disconnecting} | NTN module (Starnote) is closing a connection. | |
{ntn-idle} | NTN module (Starnote) is powered but not actively communicating. | |
{ntn-initializing} | NTN module (Starnote) is initializing. | |
{ntn-power} | NTN module (Starnote) is powered up and available. | |
{odfu-aux-mode} | Current AUX mode isn't compatible with using Notecard Outboard Firmware Update to update the host MCU via AUX. | Consult the Notecard Outboard Firmware Update docs to verify the proper card.aux request is in use. |
{odfu-fail} | Failed to use Notecard Outboard Firmware Update to update the host MCU. | Attempt the DFU again and if the situation persists contact Blues. |
{odfu-init} | Notecard Outboard Firmware Update feature initializing. | |
{product-noexist} | ProductUID does not exist. | Check that the Notehub project has a valid ProductUID. |
{receive-timeout} | The most recent Notehub transaction timed out. | Check accompanying status for more details - if the situation persists contact Blues. |
{registration-failure} | Cellular Notecard unable to register with network. | Consult our guide on Diagnosing Cellular Connectivity Issues. |
{request-failure} | General error while attempting to sync with Notehub. | Check accompanying status for more details - if the situation persists contact Blues. |
{rts-not-necessary} | Request to Send (RTS) not required in current context. | |
{service} | General error while attempting to sync with Notehub. | Check accompanying status for more details - if the situation persists contact Blues. |
{session-closed} | Notehub session is closed. | Check accompanying status for more details - if the situation persists contact Blues. |
{socket-closed-session} | TCP socket closed the session. | |
{socket-connect-error} | Unable to connect to Notehub socket handler. | If the situation persists contact Blues. |
{socket-connected} | Connection to Notehub service successful. | |
{socket-connecting} | Connecting to Notehub service. | |
{socket-disconnected} | Remote service has been disconnected. | |
{socket-dns-failure} | Unable to resolve Notehub IP address. | If the situation persists contact Blues. |
{socket-dns-success} | DNS lookup of Notehub service successful. | |
{socket-invalid-cert} | Invalid TLS/SSL certificate detected. | If the situation persists contact Blues. |
{socket-ip-init} | Network socket IP initialized. | |
{socket-ip-term} | TCP socket terminated IP address. | |
{socket-open-session} | Opening a session to Notehub service. | |
{socket-opened-notification-session} | Opening network notification socket. | |
{socket-opened-session} | Network socket session opened. | |
{socket-tls} | TLS successfully authenticated. | |
{socket-tls-connected} | Network socket connected over TLS. | |
{socket-tls-connecting} | Network socket connecting over TLS. | |
{socket-tls-error} | Unable to authenticate with Notehub socket handler. | Can occur sporadically in poor signal conditions - if the situation persists contact Blues. |
{softap} | JSON request not supported while Notecard WiFi is in SoftAP mode. | Press SoftAP button or wait 10 minutes for automatic timeout of SoftAP mode. |
{suppress-rsp} | Request was processed successfully, but the operation is intentionally configured to not generate a response. | |
{sync} | General sync status information (check accompanying status). | |
{sync-begin} | A sync with Notehub service is starting. | |
{sync-completed} | Data synchronization with Notehub completed successfully. | |
{sync-disconnecting} | Disconnecting a partially-opened session (likely was used by GPS). | |
{sync-end} | A sync with Notehub service has completed. | |
{sync-error} | An error occurred during sync with Notehub. | Check accompanying status for more details - if the situation persists contact Blues. |
{sync-get-local-changes} | Retrieving local (outbound) Notefile changes. | |
{sync-get-remote-changes} | Retrieving remote (inbound) Notefile changes. | |
{sync-local-error} | Potential local filesystem corruption. | If the situation persists reset filesystem with card.restore. |
{sync-remote-error} | Unable to merge Notefile changes on Notehub. | If the situation persists contact Blues. |
{syntax} | Syntax error in JSON request. | Verify request with Notecard API reference. |
{template} | Notefile template-related status (check accompanying status). | |
{template-incompatible} | note.add operation is incompatible with Notefile template. | Refer to the Note Template guide for assistance. |
{ticket} | Transient error due to Notehub being restarted as part of update. | Check accompanying status for more details - if the situation persists contact Blues. |
{tracker-exists} | Cannot add a new tracker that already exists. | Contact Blues for assistance. |
{tracker-noexist} | Action cannot be performed on a tracker that doesn't exist. | Contact Blues for assistance. |
{transport} | General transport status information (check accompanying status). | |
{transport-unreachable} | Unable to attempt a connection to Notehub. | Check accompanying status for more details - if the situation persists contact Blues. |
{unavailable} | Requested resource or service is unavailable. | If the situation persists contact Blues. |
{usb-disabled} | USB is disabled. | |
{usb-enabled} | USB is enabled. | |
{version} | The Notecard does not meet the version requirement of card.version API. | Update the Notecard firmware or check the card.version api argument is correct. |
{wait-data} | Notecard is waiting for a Wi-Fi or cellular connection. | |
{wait-gateway} | Notecard is waiting for Wi-Fi or cellular gateway connection. | |
{wait-service} | Notecard is waiting for a Wi-Fi or cellular connection. | |
{web-payload} | Payload corruption was detected during a web request operation. | Check the host-to-Notecard connection integrity. |
{wifi-ap} | Notecard WiFi was not able to detect the configured SSID. | Check the current SSID with card.wifi and verify Notecard is within range of access point. |
{wifi-auth} | Notecard WiFi connection failed, most likely due to incorrect password. | Use card.wifi or SoftAP mode to configure the SSID and password. |
{wifi-config} | Notecard WiFi does not have an SSID configured. | Use card.wifi or SoftAP mode to configure the SSID and password. |
{wifi-disconnect-begin} | Notecard WiFi is disconnecting session. | |
{wifi-disconnected} | Notecard WiFi is disconnected. | |
{wifi-error} | Unspecified Notecard WiFi error. | Check accompanying status for more details - if the situation persists contact Blues. |
{wifi-fatal} | Unable to communicate with Notecard's Wi-Fi module (possible hardware error). | If the situation persists contact Blues. |
{wifi-join-wait} | Notecard WiFi is waiting to join network. | |
{wifi-joined} | Notecard WiFi has joined network. | |
{wifi-softap} | Notecard is operating in Wi-Fi soft access point mode. | |
{wifi-unavailable} | Use of card.wifi request on a Notecard that does not have Wi-Fi hardware. | Only use this request on a Notecard with Wi-Fi capabilities. |
