homechevron_rightDocschevron_rightGuides & Tutorialschevron_rightNotecard Guideschevron_rightUsing Notecard Trace Mode

Using Notecard Trace Mode

All Notecards can be placed into trace mode. When enabled, a Notecard's trace mode generates a stream of messages that can help with debugging or understanding Notecard behavior.

You can utilize trace mode using the In-Browser Terminal or in serial terminal apps.

warning

Notecard's trace mode is available for debugging purposes only. The format of the output is not standardized and is subject to change at any time. If you need help interpreting a Notecard's trace output to debug an issue, reach out in our community forum or contact Blues support .

In-Browser Terminal

Complete the following steps to use trace mode via the In-Browser Terminal.

  1. Visit the In-Browser Terminal.

  2. Connect your Notecard to the terminal.

  3. Enable trace mode with the following request:

    {"req":"card.trace","mode":"on"}

  4. Perform actions that you want to debug. For example, to debug network connectivity issues you may wish to run a hub.sync request.

    {"req":"hub.sync"}

  5. Disable trace mode with the following request:

    {"req":"card.trace","mode":"off"}

  6. (Optional) Download the trace log using the Save History button in the top-left corner of the Terminal. This will download the contents of the Terminal history to a .log file. Saving history via Notecard In-Browser Terminal

Serial Terminal Apps

Complete the following steps to use trace mode via a serial terminal app.

  1. Connect a Notecard to your serial terminal app using one of the following serial port configurations.

    ConnectionSerial ConfigurationAbbreviated
    USBBaud Rate: 9600, 8 bit, no parity, 1 stop bit9600 8N1
    AUX RX/TXBaud Rate: 115200, 8 bit, no parity, 1 stop bit115200 8N1
    note

    Refer to our guides on using Tera Term and CoolTerm for more specific instructions on connecting to Notecard via those applications:

  2. Enable trace mode with the following request:

    {"req":"card.trace","mode":"on"}

  3. Perform actions that you want to debug. For example, to debug network connectivity issues you may wish to run a hub.sync request.

    {"req":"hub.sync"}

  4. Disable trace mode with the following request:

    {"req":"card.trace","mode":"off"}