Introduction

Table of Contents

• Files
• Concepts
  • Module
  • Device
  • Property
• Usage
• Information

This documentation describes the SDK specification used to operate devices manufactured by Okolab.The SDK will include an example C/C++ file showing typical usage and a description of the API interface with the Okolab devices.

Files

The SDK consists of the following files:

• Headers: okolib.h
• Binaries: okolib.dll, okolib.lib, libserialport.dll
• Resources: okolib.db

To access a device, the calling applications has to call functions of okolib.dll. Some compilers requires a lib file (okolib.lib) to build. The interface to the library is described by okolib.h.

Some files are needed for development purposes only. The calling built application needs:

• okolib.dll and libserialport.dll: they must reside in the same directory of the calling application
• okolib.db: it is a db configuration file and can be moved in a different path (see oko_LibInit)

Concepts

Module

A module is a main controlled physical quantity (Temperature, CO2, O2), with a name, a dimension unit, a current measured value, a setpoint and other features. Modules are a basic way to use the library, the usage is very simple but a little bit limited.

Device

A device is strictly related to a communication port and it is made up by one or more physical controller units (e.g. Bold Line stacked units). A device can be manually (oko_DeviceOpen) or automatically (oko_DevicesDetect) opened.

Property

Each device has several properties. Each property has some information (Property information) and can be read or write.

Usage

The operations that are supported are:

• Library access functions. Prepare the library to be used and queried
• Modules. Allow to detect the available modules and use them.
• Devices and Properties.
  • Opening, closing and detecting devices (prepare a device to be used)
  • Device information (query status of the device)
  • Property information (for the selected device)
  • Auto-updating properties
  • Reading property value
  • Changing property value
  • Commands

See also: Typical Implementation

Information

Author

Domenico Mastronardi mastr.nosp@m.onar.nosp@m.di@ok.nosp@m.o-la.nosp@m.b.com

Giulio Pasquariello pasqu.nosp@m.arie.nosp@m.llo@o.nosp@m.ko-l.nosp@m.ab.co.nosp@m.m

Marco Di Pasqua

Copyright

Okolab S.r.l. oko-lab.com softw.nosp@m.are..nosp@m.suppo.nosp@m.rt@o.nosp@m.ko-la.nosp@m.b.co.nosp@m.m

This software uses code of libserialport licensed under the GNU LGPL, version 3 and its source can be downloaded here