QuickStart Guide

From Intrument Element Wiki

Jump to: navigation, search

The Tiny Instrument Element is a piece of skeleton software that makes it easy to expose the functioning of a generic instrument via a Web Service interface.


The term "tiny" refers not to the kind of instrument, but rather to the software implementation. The design is kept simple and intuitive, but hopefully not minimal. From a general point of view, one or more instruments can be controlled using an object that implements the Parameter Listener interface. These objects present new events to the Control Manager using the instrument Functionality interface. External components, like a control room or a workflow engine, can access the controlled instrument(s) in a service-oriented way, using a Web Service that retrieves the requested information via the instrument control interface. Depending on the equipment controlled, the control manager can be a complex set of objects that could perform fault tolerant or autonomic functionality. At the same time, in a minimal scenario only one instrument is controlled and the control manager just acts as a proxy for the information contained in the device. The project structure of the application follows the typical Maven format, and the integration of an instrument consists in the implementation of two interfaces. Instruments can work in a synchronous or asynchronous way, and they can be stateful or stateless. Everything is hidden behind the interfaces mentioned above. The JavaDoc provides a detailed description of each single package and class. For additional details, refer to the project homepage. You can refer to the User Guide for more information.

Personal tools