Skip to end of metadata
Go to start of metadata

Overview of "Activate Instrument Driver" Use Case

Bring driver for an instrument model from conception through decommissioning.

Tip: Key Points
UC Priority= 4 or 5: Critical, is in R2
Only boldface steps are required
<#> before a step —> lower priority
(optional) —> run-time option

Related Jira Issues:   Open   •   All


Refer to the Product Description and Product Description Release 2 pages for metadata definitions.

Actors Integrated Observatory Operator, Marine Asset Operator, Integrated Observatory Manager, System Process Developer
References CIAD COI OV Resource Lifecycle
Is Used By UC.R2.08 Manage Instrument Lifecycle, AS.R2.04C Instrument Experts Drive Core Instrument Operations
Is Extended By  
In Acceptance Scenarios AS.R2.02C Instrument Life Cycle Support
Technical Notes While many of the instrument driver's life cycle activities are performed offline, the instrument driver is a resource of the system and is registered and managed just like other resources.
Lead Team SA
Primary Service Instrument Activation Services
Version 2.3
UC Priority 4
UC Status Mapped + Ready
UX Exposure PGM


This information summarizes the Use Case functionality.

Bring driver for a specific instrument type from conception through decommissioning. Includes association with instrument type definitions, development, test, configuration and deployment of instrument drivers within instrument agents.


  • An instrument has been identified for inclusion in the CI, meaning that a driver and associated basic data transformations will be built for it.
    • For OOI-provided instruments, there are 3 authoritative (but modifiable) Sensor Sets, with instrument classes in each. The exact instrument model(s) chosen for a instrument class is determined through a procurement process.
    • Externally provided instruments may be introduced by anyone, subject to conformance to OOI policies and interfaces; this is not an R2 concern.
    • Instrument driver development is assigned to a developer.
  • The actual instrument may be provided to the developer, but in many cases (e.g., where the sensor's size or operation prevents delivering the unit to the developer, or where it is convenient to support development remotely) the instrument is installed remotely in an operating configuration. In that case the developer is given remote access.
  • The primary data outputs desired from the instrument, and the calibrations and other inputs needed to produce Level 1 science data, are defined by the OOI science team in a separate document, the Data Product Specification (DPS). (This used to be the Sensor Algorithm Theoretical Basic Document (ATBD).)
  • OL representatives have verified that the instrument can be safely deployed, according to an OL-defined process, independent of the implementation of the driver software.

Initial State

A specific instrument model has been identified and work is set to begin.

Scenario for "Activate Instrument Driver" Use Case

(Underlined Content) describes the corresponding resource lifecycle activity, and is not normative.

The (Development-X) steps do not involve the Integrated Observatory, and so are not normative.

  1. (Development-Design) The System Process Developer characterizes the instrument and specifies a driver design based on the instrument agent/driver framework.
    1. Primary objectives for the driver functionality will be driven by the interface of the relevant agent, and the DPSs that use it.
    2. The developer may seek input from the OOI science community, the instrument provider or manufacturer, and potential operators or users.
    3. Ultimately, the developer finalizes the data outputs and device features the driver will provide access to. These are made available for review and comment by the OOI science community, and are approved by the CI Marine Integration Senior Developer.
  2. (Development-Implement) The System Process Developer implements the driver by assembling existing elements from the framework and developing code unique to the target sensor.
    1. Development follows a specific flow of modifying aspects of the driver design pattern. For example, if the sensor provides data in a streaming mode, the developer would step through the aspects of the state machine where received data is announced, parsed, then published.
  3. (Development-Test) The System Process Developer tests the driver using an instrument on a local or remote testbed.
    1. In practice, testing occurs concurrently and iteratively with driver implementation. If the driver is determined to have defects or deficiencies, the developer returns to the implementation step or revisits the agreed data outputs and device features (changes must be reviewed following the original process).
    2. The development activity is complete when the driver is determined to meet the defined data outputs and features.
  4. (Register) The System Process Developer registers the completed driver in the Integrated Observatory.
    1. A UI may or may not be provided for this registration.
    2. The registration process may guide the developer to submit the required instrument characterization.
    3. Instruments can be registered to serve as data providers.
  5. <3> (Commission and Activate) An appropriate member of the CI team validates resource usability and activates it in the Integrated Observatory system.
    1. The appropriate member likely needs to be an Integrated Observatory Operator (this will be determined later).
    2. Confirmation includes validation of the driver's correct operation with an actual instrument in an integrated system. (In-situ verification of instrument performance is included when possible.)
    3. The activation is likely to be represented/implemented by the transition of the resource's life cycle state (e.g., to Integrated).
    4. The CI development team will establish a permanent testbed for use in offline daily-build testing; only currently implemented drivers are tested with daily builds.
  6. <3> (Announce) The driver is advertised as a system resource.
    1. The Integrated Observatory system may take this step automatically, based on the previous step's completion.
    2. A system-internal process certifies that the announcement is valid (or it flags an error to the provider).
    3. A system-internal process advertises the resource registration in the appropriate catalog and the announcement is propagated throughout the system.
    4. A system-internal process may publish a formal announcement of driver readiness.
  7. <3> (Driver Use and Management) The driver is made available for application by any Observatory Operator.
    1. Use includes discovery and association, including association with specific instruments as they are installed.
    2. This lets the instrument provider use the instrument with that driver.
  8. (Driver Use and Management) An Observatory Operator associates the driver with a specific instrument.
    1. This makes it possible to instantiate an instrument agent for the specific instrument and begin communicating with the instrument.
    2. The instantiation of the instrument agent with the driver/instrument is not described in this scenario.
    3. May be a developer acting in place of an observatory operator.
  9. <3> (Deactivate) An Integrated Observatory Operator determines that a driver should no longer be available and disables its use by the Integrated Observatory system.
    1. In deactivating a resource, the provider must assess the appropriateness, costs, and user expectations of using that resource.
    2. One reason for deactivating a driver temporarily is that it is not appropriate to use (e.g., risking the instrument) until a bug fix is made.
    3. Deactivation is a necessary precursor step when the driver is to be decommissioned.
    4. A driver that is being replaced should be deactivated only after the replacement driver has been activated and the instrument can be associated with it.
  10. <3> (Decommission) The Integrated Observatory Manager determines that the driver should no longer be used at all, and effectively removes it from the system.
    1. The driver will no longer be available for use although its activation history and past associations will remain accessible.
    2. A driver is decommissioned when, for instance, it has been replaced by a more current driver. (Reactivation is possible at a later date, but awkward.)
    3. Before decommissioning, any instruments using the driver should be identified by the system and flagged to the Cyber Manager, as these instruments will no longer be functional without the commissioned driver. This test would be skipped if the deactivation is simultaneous with the successful Activation of a new driver.

Final State

The driver is in use, or has been removed from the system and decommissioned.


Instrument Variants

Some instruments behave and communicate similarly to others and a decision can be made to enhance an existing driver or develop an entirely separate but still similar new driver. For example, a Garmin GPS and an Ashtech GPS both provide standard NMEA0183 output sentences.

  • Each manufacturer has unique output sentences not possible in the other's device. If this were the only difference, clearly both devices could share the same driver; when run on a Garmin the driver would simply never parse an Ashtech-only sentence and vice versa.
  • Ashtech and Garmin each use their own proprietary method for configuration and changing parameters. In this case, the developer must make the decision based on the differences in communications whether the driver requires enough enhancement to be developed into a unique, separate driver.

(click on # to go to R2 use case)
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
61     27B


r2-usecase r2-usecase Delete
usecase usecase Delete
productdescription productdescription Delete
openissue openissue Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Oct 21, 2011

    Alan Chave says:

    This use case is a specific instance of the resource life cycle, and could be su...

    This use case is a specific instance of the resource life cycle, and could be subsumed into a use case (not acceptance procedure) for the resource life cycle.

    The sensor variant comment seems very specific to a how instance, and is not necessary