Sox Manager

The Sox Manager is the initial view seen in the Sedona Workbench after opening a Sedona node in sox. Use this view for all Sedona platform provisioning of the node, including all management of apps and kits, as well as making backups and restores from Workbench.

This view consists of a Schema table and Sedona provisioning buttons along the bottom.

Sedona Schema

The main area in the Sox Manager shows the Sedona schema or collection of “kits” used by the opened app, as shown in Figure 31.

Figure 31. Schema area in Sedona Manager


Schema area in Sedona Manager


Each row represents a kit, which contains some number of named types, where each type declares zero or more slots. For any given version of kit, there is a fixed list of types and their declared slots. The checksum for each kit is generated when the Sedona Framework compiler creates a kit zip file.

The specific list of kit parts (kits at a specific checksum revision) is called a schema. Matching schemas guarantee binary compatibility.

Sedona provisioning buttons

Along the bottom of the Sox Manager are buttons (Figure 32).

Figure 32. Sox Manager view buttons


Sox Manager view buttons

From left-to-right, these buttons are as follows:

Get App, Put App, Manage Kits, Backup, Restore

Get App

Click to launch a Get App dialog, in which you are prompted for the location and file name to use to save the app. By default, the SedonaHome\sedona\apps folder is used, with a default app file name of appYYMMDD.sax, where YY is year, MM is month, DD is day. As needed, use the Browse button for the standard File Chooser dialog to change location and/or name. An OK or Save saves the opened app to your local file system.

Put App

Click to launch a Put App dialog, in which you are prompted for the location and file name of the app to install in the node. By default, the SedonaHome\sedona\apps folder is shown. Click the Browse button for the standard File Chooser dialog to find and select and app. After selecting an app, an OK produces the Manage Kits dialog, as shown in Figure 33.

Figure 33. Manage Kits dialog example in Put App operation (showing missing kit)


Manage Kits dialog example in Put App operation (showing missing kit)

NoteIf the selected app requires kits not already installed, the bottom “Verifier” pane lists such kit or kits, by dependencies (Figure 33 example shows missing kit “pulse”.) Scroll down and select the named kit(s) until the Verifier pane is clear. Only then will the OK button become available.

There are also two checkboxes available:

  • Rebuild Scode

    Check this if you made any recent changes in any of the checked kits. This ensures such changes are included in the recompiled binary .scode image.

  • Upgrade all kits to latest version

    Check this if you have older kits in the current app, and you want to upgrade all kits to the most recent versions available on your Sedona Workbench PC. If checked, all older kits will show the “upgrade” icon beside them, with “Upgrade to 1.0.n” in the Action column.

    NoteIndividual actions are also available on each separate installed kit, by clicking on the drop-down control in the right of the Action value, as shown in Figure 34.

    Figure 34. Action on each installed kit lets you keep at current version, upgrade, or downgrade


    Action on each installed kit lets you keep at current version, upgrade, or downgrade

Click OK when the Verifier pane is free of errors, and kits are at the desired revision level. The Manage Kits dialog changes to a small dialog box with a progress bar that indicates the status of included operations as the app is installed.

When finished, a Success message is seen, with an available View Log button. Click the button for step-by-step details performed in the Put App function, or click OK to close the dialog.

NoteInstalling an app restarts the node, which disconnects your sox session. To re-open your sox connection, double-click the ghosted Sedona (appName) node in the Nav Tree, and enter the login credentials. This should work unless the installed app uses a different PanId than the previous app (“Pan Id” is a property of the “plat” component in an app’s “service” folder—in the case of the SED-M0x based node, this is the JennicPlatform component). If needed, re-configure your wireless USB adapter’s PanId to match the value of that property in the newly-installed app. See Jennic Serial Port Tool.

Manage Kits

Click to launch the Match Kits dialog, in which you can make changes to kits currently installed in the Sedona node, including adding new kits, deleting kits, and/or changing version levels of kits.

  • To specify an installed kit to delete, click its checkbox to clear the check.

    NoteIf the installed app is dependent on that kit, an error entry line appears in the lower “Verifier” pane. Accompanying text explains how the app and/or another installed kit is dependent on that kit. You cannot proceed (OK button remains unavailable) if such errors exist in the Verifier. However, you could choose to install another app with fewer used kits (using Put App instead), and in the integral Manage Kits dialog, delete any unused kits. See Put App.

  • To specify a kit to add, scroll down and click its checkbox to set the check.

    NoteOn any SED-M0x based node, there is limited space to install kits. In some cases, attempting to install a large kit (for example: control) may not only be unsuccessful, but might also hamper subsequent sox connectivity to the node. In these cases, you may need to recover either by starting the Sedona dev board with the “fallback app”, or perhaps even using the “flasher” utility to serially download a firmware archive file to the unit. For related details, see About the fallback app and Jennic Serial Port Tool.

Again, there are two checkboxes available:

  • Rebuild Scode

    Check this if you made any recent changes in any of the checked kits. This ensures such changes are included in the recompiled binary .scode image.

  • Upgrade all kits to latest version

    Check this if you have older kits in the current app, and you want to upgrade all kits to the most recent versions available on your Sedona Workbench PC. If checked, all older kits will show the “upgrade” icon beside them, with “Upgrade to 1.0.n” in the Action column.

    NoteIndividual actions are also available on each separate installed kit, by clicking on the drop-down control in the right of the Action value, as shown in Figure 35.

    Figure 35. Action on each installed kit lets you keep at current version, upgrade, or downgrade


    Action on each installed kit lets you keep at current version, upgrade, or downgrade

Click OK when the Verifier pane is free of errors, and kits are at the desired revision level. The Manage Kits dialog changes to a small dialog box with a progress bar that indicates the status of included operations as kit operations occur.

When finished, a Success message is seen, with an available View Log button. Click the button for step-by-step details performed in the Manage Kits function, or click OK to close the dialog.

NoteKit changes end in a node reset, which disconnects your sox session. To re-open your sox connection, double-click the ghosted Sedona (appName) node in the Nav Tree, and enter the login credentials.

Backup

Click to launch a Backup dialog, in which you select the areas for backup to your Sedona Workbench PC, also the location and file name for the backup zip file. By default, all three areas are selected for backup, and the SedonaHome\sedona\backup folder is used, with a default backup file name of backupYYMMDD.zip, where YY is year, MM is month, DD is day.

NoteClear the (top) “Backup Sedona VM” selection for any SED-M0x based node (Sedona Dev Board); otherwise the backup operation will fail. Typically, you leave the other two areas (kits.scode and app.sab) selected.

As needed, use the Browse button for the standard File Chooser dialog to change location and/or name. An OK or Save saves the backup zip file to your local file system.

Restore

Click to launch a Restore dialog, in which you are prompted for the location and file name of a backup zip to install in the node. By default, the SedonaHome\sedona\backup folder is shown. Click the Browse button for the standard File Chooser dialog to find and select a backup zip file.

An OK installs the backup zip file from you local file system to the Sedona node, showing a dialog with a progress bar that indicates the status of included operations for the restore.

NoteRestoring a backup restarts the node, which disconnects your sox session. To re-open your sox connection, double-click the ghosted Sedona (appName) node in the Nav Tree, and enter the login credentials. This should work unless the installed app uses a different PanId than the previous app (“Pan Id” is a property of the “plat” component in an app’s “service” folder—in the case of the SED-M0x based node, this is the JennicPlatform component). If needed, re-configure your wireless USB adapter’s PanId to match the value of that property in the newly-installed app. See Jennic Serial Port Tool.