Notecard Error and Status Codes
Notecard API responses can include a set of error or status codes denoted by
curly braces, e.g. {sync-begin}. These codes are static and persist across API
versions.
Error Codes
If you encounter an error code not on this list, or have any other technical questions, please consult the Blues Developer Forum for assistance.
| Code | Definition | Resolution |
|---|---|---|
{auth} | Notehub unable to authenticate Notecard. | Check accompanying status for more details - if situation persists contact Blues. |
{connect-failure} | Notecard WiFi only - indicates possible Wi-Fi connection failure. | Check the SSID configuration using card.wifi. Try re-setting the password. |
{device-delay-5} | Notehub is throttling device connection for 5 minutes. | If situation persists for > 60 minutes, contact Blues. |
{device-delay-10} | Notehub is throttling device connection for 10 minutes. | If situation persists for > 60 minutes, contact Blues. |
{device-delay-15} | Notehub is throttling device connection for 15 minutes. | If situation persists for > 60 minutes, contact Blues. |
{device-delay-20} | Notehub is throttling device connection for 20 minutes. | If situation persists for > 60 minutes, contact Blues. |
{device-delay-30} | Notehub is throttling device connection for 30 minutes. | If situation persists for > 60 minutes, contact Blues. |
{device-delay-60} | Notehub is throttling device connection for 60 minutes. | If situation persists for > 60 minutes, contact Blues. |
{device-disabled} | This Notecard has been disabled on Notehub. | Unblock the device using this guide. |
{dfu-not-ready} | Waiting for Notecard internal DFU image storage to be ready. | Error should resolve after ~30 seconds. If situation persists contact Blues. |
{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-open} | Notecard filesystem file open error. | Check accompanying status for more details - if 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. |
{host-dfu-fatal} | Notecard Outboard Firmware Update was unable to complete. | Check accompanying status for more details - if situation persists contact Blues. |
{host-unreachable} | Unable to connect to Notehub TCP socket. | Check accompanying status for more details - if 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 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. |
{incompatible} | Incompatible JSON request fields. | Check accompanying status for more details - if 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. |
{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. |
{network} | General wireless connectivity error. | Check accompanying status for more details - if situation persists contact Blues. |
{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-handler} | Notehub internal error. | Check accompanying status for more details - if 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 situation persists contact Blues. |
{note-exists} | Cannot add a new Note that already exists. | Use a different name for the Notefile. |
{note-noexist} | Action cannot be performed on a Note 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-open-failure} | General error while opening Notehub. | Check accompanying status for more details - if situation persists contact Blues. |
{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 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 situation persists contact Blues. |
{service} | General error while attempting to sync with Notehub. | Check accompanying status for more details - if situation persists contact Blues. |
{session-closed} | Notehub session is closed. | Check accompanying status for more details - if situation persists contact Blues. |
{socket-connect-error} | Unable to connect to Notehub socket handler. | If situation persists contact Blues. |
{socket-dns-failure} | Unable to resolve Notehub IP address. | If situation persists contact Blues. |
{socket-tls-error} | Unable to authenticate with Notehub socket handler. | Can occur sporadically in poor signal conditions - if 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. |
{sync-error} | An error occurred during sync with Notehub. | Check accompanying status for more details - if situation persists contact Blues. |
{sync-local-error} | Potential local filesystem corruption. | If situation persists reset filesystem with card.restore. |
{sync-remote-error} | Unable to merge Notefile changes on Notehub. | If situation persists contact Blues. |
{syntax} | Syntax error in JSON request. | Verify request with Notecard API reference. |
{template-incompatible} | note.add operation is incompatible with Note 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 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-unreachable} | Unable to attempt a connection to Notehub. | Check accompanying status for more details - if situation persists contact Blues. |
{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. |
{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-error} | Unspecified Notecard WiFi error. | Check accompanying status for more details - if situation persists contact Blues. |
{wifi-fatal} | Unable to communicate with Notecard's Wi-Fi module (possible hardware error). | If situation persists contact Blues. |
{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. |
Status Codes
| Code | Definition |
|---|---|
{address-assigned} | Successful DHCP resolution and IP address assigned. |
{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). |
{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. |
{dfu-in-progress} | Notecard device firmware update is in progress. |
{disconnected} | Notecard is disconnected from the cellular network. |
{env-not-modified} | In response to env.set, indicates environment variables have not been modified. |
{gps} | The current status of GPS connectivity. |
{gps-active} | GPS has started and is currently active. |
{gps-inactive} | GPS is inactive. |
{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-retry} | Notecard is retrying a connection attempt. |
{hub-not-connected} | Device is not currently connected to Notehub. |
{idle} | Modem is currently disconnected and idle. |
{modem-off} | Wireless modem is off. |
{modem-on} | Wireless modem is on. |
{network-up} | Successfully connected to a network. |
{notehub-connected} | Successfully connected to Notehub. |
{notehub-disconnected} | Successfully disconnected from Notehub. |
{socket-closed-session} | TCP socket closed the session. |
{socket-connected} | Connection to Notehub service successful. |
{socket-connecting} | Connecting to Notehub service. |
{socket-disconnected} | Remote service has been disconnected. |
{socket-dns-success} | DNS lookup of Notehub service successful. |
{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-session} | Network socket session opened. |
{socket-opened-notification-session} | Opening network notification socket. |
{socket-tls} | TLS successfully authenticated. |
{socket-tls-connected} | Network socket connected over TLS. |
{socket-tls-connecting} | Network socket connecting over TLS. |
{sync-begin} | A sync with Notehub service is starting. |
{sync-disconnecting} | Disconnecting a partially-opened session (likely was used by GPS). |
{sync-end} | A sync with Notehub service has completed. |
{sync-get-remote-changes} | Retrieving remote (inbound) Notefile changes. |
{sync-get-local-changes} | Retrieving local (outbound) Notefile changes. |
{usb-disabled} | USB is disabled. |
{usb-enabled} | USB is enabled. |
{wait-data} | Notecard is waiting for a Wi-Fi or cellular connection. |
{wait-service} | Notecard is waiting for a Wi-Fi or cellular connection. |
{wifi-disconnect-begin} | Notecard WiFi is disconnecting session. |
{wifi-disconnected} | Notecard WiFi is disconnected. |
{wifi-join-wait} | Notecard WiFi is waiting to join network. |
{wifi-joined} | Notecard WiFi has joined network. |
