Typical Implementation

Table of Contents

• Modules
  • Case 1
  • Case 2
  • Case 3
• Device initialization
  • Case 1
  • Case 2
• Properties initialization
• Property usage by Name
  • Case 1
  • Case 2
  • Case 3
  • Case 4
• Auto-updating a property
  • Case 1
  • Case 2
• Close Device
  • Case 1
  • Case 2

A typical implementation of the communication with an Okolab device using the SDK would consist of a sequence of function calls depending on the overall scenario.

Modules

Case 1

Detect all the available modules and collect their fixed details.

• oko_ModulesDetect Obtain the number of modules connected and their type as an array. For each module type
  • oko_ModuleGetDetails Gather the information about the specified module

Case 2

Using the already obtained types, periodically query setpoint and current value of each module.

• oko_ModuleGetCurrentValue
• oko_ModuleGetSetpointValue

Case 3

Using the already obtained types, change the setpoint of each module.

• oko_ModuleSetSetpointValue

Device initialization

Case 1

No previous knowledge of the connected device

• oko_DevicesDetect Obtain the number of device connected and their handles as an array. For each handle
  • oko_DeviceGetPortName Store the port name to avoid going through the detect procedure next time software is started

Case 2

Previous knowledge of the device ComPort# (e.g. by user input or previously stored by the application).

• oko_DeviceOpen Obtain the handle of the device connected to ComPort#.

Properties initialization

• oko_PropertiesGetNumber Get the total number of properties for the current device
• at this point the application should iterate calling oko_PropertyGetName to create an array of PropertyNames. For each PropertyName
  • oko_PropertyIsMain can be used to store main features only
  • oko_PropertyGetType the oko_prop_type of this property will be used to call the appropriate read/write function must be called
  • oko_PropertyGetReadOnly when this returns false the property can also be write, if it can be write
    • oko_PropertyHasLimits verify if the min and max of the property are available, if so
      • oko_PropertyGetLimits read the min and max of the property from the device
  • oko_PropertyGetDescription optional, used to obtain property additional info
  • oko_PropertyGetUnit optional, used to obtain property additional info

Property usage by Name

Case 1

Get the last value of a read only property

• oko_PropertyGetType check the property type (e.g. OKO_PROP_DOUBLE)
• call the appropriate function oko_PropertyReadDouble

Case 2

First update the value from the device and then read a property value of a known type

• oko_PropertyUpdate
• oko_PropertyReadDouble

Case 3

Synchronously change the value of a property (e.g. with double type)

• oko_PropertyWriteDouble with async = false

Case 4

Change the value of a property (e.g. with double type), without waiting for the result

• oko_PropertyWriteDouble with async = true, to avoid delay in the calling application execution

Auto-updating a property

A property can be auto-updated by an internal thread, so the application doesn't need to esplicity update it, calling oko_PropertyUpdate.

Case 1

Make a property auto-updating

• oko_PropertyAutoUpdate

Case 2

Read the last property value

• oko_PropertyReadDouble

Close Device

Case 1

No previous knowledge of the connected device

• oko_DevicesCloseAll Close the handles to all detected devices.

Case 2

Previous knowledge of the device

• oko_DeviceClose close the device related to the specified handle.