Sedona Tools terms

The following is a list of terms and abbreviations used in this document when describing Sedona Framework TXS Sedona Tools and Sedona Framework devices. Complete Sedona Framework documentation is available at http://sedonadev.org. For general NiagaraAX terms, see the Glossary in the Niagara AX User Guide.

Glossary

app

For application. The app in a Sedona Framework device is its collection of Sedona Framework components, including links between them, plus configuration properties.

bundle

Sedona Framework TXS software is distributed in a “bundle”. A bundle is a special image (set of files) that is available from Niagara-Central (www.niagara-central.com) or from Sedona OEM manufacturers. You use the Sedona Installer tool in Workbench to install a bundle. For complete details, refer to the NiagaraAX Sedona Installer Guide.

DASP

For Datagram Authenticated Session Protocol. This is the low-level, session-based protocol that Sox utilizes.

kit

Sedona Framework kits are the basic unit of modularity of Sedona Framework software, encapsulating code, types, and metadata. A kit is analogous to a module on a NiagaraAX platform. The app in a device instantiates components and services contained in its installed kits. You must have the appropriate kits available on your Workbench to change the kits on a device. Sedona Framework Sedona Tools in Workbench include a “Kit Manager” view to manage kits on a Sedona Framework device.

manifest

Each kit has a corresponding manifest, with all metadata needed by tools like Workbench to connect via Sox to a Sedona Framework device, and for a station to support Sedona Framework proxy points in that device. Manifest files are compact XML files, named using a kitName-checksum convention similar to kit files, but with an .xml extension. To manage kit manifests on a Niagara AX host (JACE or Supervisor), right click on a Sedona Network node in the nav tree and select the Manifest Manager view. You can manage manifests on your Workbench host by using the Sedona Manifest Manager view in Workbench tools. For more details see the Sedona Manifest Manager document.

PAR

For Platform Archive, or PAR file. This is a zip file with a .par extension that provides a way of organizing various files and metadata about a platform into a single entity. The term “platform” is used to refer to the Sedona capabilities of a given device or class of devices. It does not specify what kits are loaded onto the device at a given time, however it does define which kits are supported (i.e. that may be added to the device if desired). The platform archive contains an XML file that describes the platform. A PAR file may also contain a device simulator SVM. Par files can be imported using the Sedona Installer tool in Workbench.

SAB

For Sedona App Binary. This is a compact binary representation of a Sedona Framework app suitable for storage and execution on a Sedona Framework device. One of two file formats (.sab) for a Sedona Framework app.

SAX

For Sedona App XML. This is a simple XML representation of a Sedona Framework app that is easily generated and consumed by Sedona Framework software tools. One of two file formats (.sax) for a Sedona Framework app.

schema

The specific collection of Sedona Framework kits installed in a device (each at some particular checksum revision) is called a schema. It also describes the set of kits required by a specific Sedona app. The schema of the app must be compatible with the schema of the device where it is to run. You can see the schema table when you access the Sedona Tools view when Sox-connected to a device.

scode

An scode image is a binary file containing the kits of a particular schema compiled together. It is executed by the Sedona Virtual Machine (SVM). The Kit Manager tool is used to modify the kits.scode on a Sedona Framework device.

SEDONA HOME

The term SEDONA HOME is a system “variable” for the installation-specific directory of your Workbench computer's “root” folder for Sedona Framework files used in Sox connections from Workbench. To see this location, search for “sedona.home” in the !/lib/system.properties file. When using the Sedona Installer to install a bundle, the SEDONA HOME system variable is set correctly for you.

Sox

Sox is the standard protocol used to communicate with Sedona Framework devices. It runs over UDP via the lower-level DASP protocol. Workbench always uses Sox to open a connection to a Sedona Framework device. A Niagara station also uses Sox to discover as well as read and write to Sedona Framework proxy points.

SVM

The SVM (Sedona Virtual Machine or VM) executes the compiled scode image in a device along with its app.