Knowledge Base

Software Development Kits

What Is a Software Development Kit?

A Software Development Kit (SDK) is a set of development tools that allows software engineers to create applications for use in combination with The Observer XT. The Observer XT has the following SDKs:

• The Observer XT SDK
• N-Linx SDK

To obtain an SDK, please contact [email protected]. Please note that support on the SDK, including help with making them, is only available to customers with a service contract.

The Observer XT SDK

The Observer XT SDK is a set of development tools that allows software engineers to create applications for use in combination with The Observer XT. The Observer XT SDK includes a debugging aid, an example tool plus C++ sample source code and supporting technical documentation.

The Observer XT has a default folder for plug-ins: C:\Program Files (x86)\Common Files\Noldus\Plugins. However it depends on the requirements of the plug-in where they must be stored. Plug-ins can only work with The Observer XT if they have been written with specific methods. These methods are described in The Observer XT Software Development Kit (SDK).

The SDK includes the following applications:

• External Application Control
• Observational Data XML (ODX)
• Automatic Synchronization
• Plug-in Viewer COM-Object
• Event Data Plug-in
• External Data Plug-in

External Application Control

The Observer XT can execute other (external) applications during the user actions New Observation, Start Observation, Stop Observation, and Close Observation. The Observer XT can execute a command with optional parameters, a batch file or Visual Basic scripting.

The SDK contains documentation with background information, examples of how to execute applications and a summary of batch file processing. The SDK also contains three pre-programmed command files.

Observational Data XML (ODX)

The SDK explains how to create an ODX file that can be imported into The Observer XT. An ODX file is an Observational Data file in XML format. With the SDK you can create your own ODX file to exchange information between your own application and The Observer XT.

The SDK contains documentation describing the contents and format of an ODX file. The SDK also contains an ODX file from The Observer XT, XSD schema definition files for an ODX file and a C++ header file with all tag names used in ODX files.

Automatic Synchronization

The Observer XT uses a serial binary data exchange mechanism for automatic synchronization of observational and external data. Two types of Sync Out signals are available to achieve this automatic synchronization. The SDK describes in detail the mechanism for automatic synchronization and the Sync Out signals. It enables you to decode the Sync Out signal and to use it with your own application.

The SDK contains a document describing the synchronization method, the Sync Out signals and a sample synchronization data file.

Plug-in Viewer COM-Object

With the SDK you can create a custom viewer in The Observer XT. To create a custom Observer XT viewer plug-in it must be a COM (Component Object Model) object according to the specifications described in the SDK document. Such a viewer can be used, for instance, to visualize the movement of a shoulder prosthesis, while simultaneously viewing a video of the patient and physiological data. For this plug-in your The Observer XT license must include the Media Module.

The SDK contains documentation describing how the Plug-in Viewer COM-Object works and how to work with plug-ins in The Observer XT.

To open viewer plug-in data while observing:

1. Create an observation or open an existing one.
2. Choose File > Import > Plug-in Data.
3. Select a plug-in from the list, choose an observation and click OK.
4. If the plug-in requires a file to be opened, a new window opens: select a file and click Open.
5. Start the observation and score or review the data as you usually do.

To open plug-in data while visualizing data:

1. Choose Analyze > Visualize Data.
2. Choose File > Import > Viewer Plug-in Data.
3. Select a plug-in from the list, choose an observation and click OK.
4. If the plug-in requires a file to be opened, a window opens: select a file and click Open.

Similarly you can open plug-in data in an Episode Selection. See Episode Selection for more information.

Event Data Plug-in

This plug-in offers the possibility to obtain event data from an external program while you carry out a live observation in The Observer XT. The external events are imported during your observation in The Observer XT.

In The Observer XT, these event data are stored in a separate Event Log. You can visualize and analyze the event data like any other event data in The Observer XT.

External Data Plug-in

This plug-in offers the possibility to obtain external data while you carry out a live observation in The Observer XT. The external data are imported during your observation in The Observer XT.

In The Observer XT, these external data are stored in the External Data Files folder of the observation. You can visualize and analyze the external data together with event data in The Observer XT.

N-Linx SDK

The N-Linx SDK allows you to control external applications with The Observer XT and import their data into the observation. The SDK makes use of the Noldus network communication protocol N-Linx. The SDK contains a protocol to start and stop an external application when you start and stop an observation in The Observer XT, and it contains a protocol for real-time import of data obtained by the external application into The Observer XT.

N-Linx Start Stop Protocol

This protocol offers the possibility to start and stop an external program while you carry out an observation in The Observer XT. This enables synchronization of external and event data.

The SDK contains documentation with background information and examples to set up communication.

N-Linx Event and Continuous Data Import Protocol

This protocol offers the possibility to obtain events and continuous data from an external program while you carry out a live observation in The Observer XT. The external events are imported during your observation in The Observer XT. In The Observer XT, these event data are stored in a separate Event Log. You can visualize and analyze the event data like any other event data in The Observer XT.

The SDK contains documentation with background information and examples to set up communication.

Source: The Observer XT 17 Help - Software Development Kits, Noldus Information Technology