Digi-SE Debug Console

Overview

Use the Debug Console to send and receive RPC messages directly to a Digi gateway. See RPC Requests and Responses for more information.

The Debug Console settings in the Smart Energy Gateway web app (https://digi-se.appspot.com) allow you to:

Requirements

Make sure your Digi Smart Energy gateway is connected to Device Cloud. See Getting Started for more information.

Discover Available Commands

  1. Sign in to https://digi-se.appspot.com. This is the same user name and password you use to sign in to Device Cloud.

  2. Click Debug and select your Digi gateway from the Gateway menu.

    ../../_images/debug_console-blank.png

  3. Click Refresh in the Commands pane to see the available commands on your gateway. This may take a few seconds. If there is a failure, an error message appears. Make sure your gateway is connected to Device Cloud and running the Smart Energy Framework.

    All available commands are listed in the Commands pane. These commands are organized by interface type. See Interface Reference to learn more.

    ../../_images/debug_console-commands.png

You can now send and receive messages.

Send and Receive Messages

  1. Complete Discover Available Commands if you have not already loaded the available commands.

  2. Select the command you want to send. This loads the command as XML in the Input pane where you can make changes.

    For example, we selected the get_version command.

    ../../_images/debug_console-get_version-load.png

  3. Click Docs for additional information about the selected command.

  4. Click Execute to send the command to the gateway. The sent command appears in the Output pane.

  5. Click the command in the Output pane to display it.

    ../../_images/debug_console-get_version-executed.png

    After a few seconds, “Received: <command name>” appears in the Output pane. Click the Received message to display the contents of the response.

    ../../_images/debug_console-get_version-response.png

  6. (Optional) Disable asynchronous messages:

    • When Polling has a check, messages appear without first sending a message. See Asynchronous Message Reference to learn more.

    • To disable asynchronous messages, click Polling to clear the check.

      ../../_images/debug_console_Polling.png

Save Output to File

  1. Complete Discover Available Commands if you have not already loaded the available commands.

  2. Click Save All on the Output pane. This downloads a text file containing all of the Output messages.

    ../../_images/debug_console-save_to_file.png

Save Commands

  1. Complete Discover Available Commands if you have not already loaded the available commands.

  2. Select the command you want to customize and save. This loads the command as XML in the Input pane where you can make changes.

    For example, we selected the add_device command.

    ../../_images/debug_console-add_device-load.png

  3. Make the necessary changes and click Save to save your customized command. A dialog appears where you can enter a Name for this command. For example, “Add Example Device 1”.

    ../../_images/debug_console-add_device-custom-dialog.png

  4. Click Save Custom XML to save the command. The updates appear in the Input command tab and in the Saved Commands section of the Commands pane.

    ../../_images/debug_console-add_device-custom-saved.png

    Note the following:

    • You can select the saved command at any time from the Saved Commands section.
    • The saved commands are linked to your account and gateway. They do not appear for other gateways and will not appear if you move the gateway to another account.
    • The Refresh button does not affect saved commands.

  5. Click Remove next to the saved command in the Commands pane to remove it.