Index
=====

1. microCOR Lab SDK Programming Interfaces
   1.1. C API
   1.2. C++ API
   1.3. MATLAB Module
   1.4. Octave Module
2. Linux Note
3. Firmware Update
4. Technical Specifications



1. microCOR Lab SDK Programming Interfaces
==========================================

micorCOR Lab SDK gives you control and ability of data acquisition on following
programming interfaces; C API, C++ API, and MATLAB Module.

Note : Library supports only one instance of application to access the USB
       gateway device.



1.1. C API
----------

Header Directory    : include/c/
Library             : lib/<platform>/microCORLab.(lib,dll)/libmicroCORLab.so
Dependent Library   : lib/<platform>/(QtCore4.dll/libQtCore4.so)

You can access to C API with microCORLab_...() functions. This is API a wrapper
for the C++ API. C API does not need any Qt development environment to build,
but needs it at runtime.

Warning : C API have a QCoreApplication in its implementation.
          Please use C++ API if you are planning to develop with Qt.

See "Modules > microCORLab C API" section of the documentation which is located
at doc/index.html.



1.2. C++ API
------------

Header Directory    : include/cpp/
Library             : lib/<platform>/microCORLab.(lib,dll)/libmicroCORLab.so
Dependent Library   : lib/<platform>/(QtCore4.dll/libQtCore4.so)

You can access to C++ API with microCORLab class. The C++ API build on top of
Qt4 Framework.

Precompiled Windows libraries has been compiled with Microsoft Visual
Studio 2010 and dependent to Qt4.8.x shared libraries (QtCore4.dll).

Precompiled Linux libraries has been compiled with official compiler and
dependent official Qt4 libraries for the distribution. Please refer to your
operating systems documentation to install required Qt4 runtime libraries
("lld microCORLab.so" may give you a hint).

You can find a precompiled Qt4.8 versions from:
http://download.qt.io/archive/qt/4.8

See "Modules > microCORLab C++ API" section of the documentation which is
located at doc/index.html.



1.3. MATLAB Module
------------------

Source Directory    : matlab/src/
Library             : lib/<platform>/mcl.mex<platform_suffix>
Dependent Library   : lib/<platform>/microCORLab.(lib,dll)/libmicroCORLab.so
                      lib/<platform>/(QtCore4.dll/libQtCore4.so)

You can use precompiled MATLAB Mex modules which are located at lib/<platform>/
directories. MATLAB module uses directly C API and indirectly C++ API. The
source code of the module is included in to the SDK. See matlab/src/BUILD.txt
at the SDK for module build instructions.

See matlab/README.txt for module documentation and usage example.



1.4. Octave Module
------------------

Source Directory    : matlab/src/
Library             : lib/<platform>/mcl_octave.mex<platform_suffix>
Dependent Library   : lib/<platform>/microCORLab.(lib,dll)/libmicroCORLab.so
                      lib/<platform>/(QtCore4.dll/libQtCore4.so)

Build same source code as the MATLAB Module to be able to use with Octave.



2. Linux Note
=============

To be able to use USB device, you need udev permissions. At Ubuntu, copy the 
udev rule file with this command :

    $ sudo cp tools/55-microcor.rules /etc/udev/rules.d/

Then, restart operating system or run this command to apply the copied rule :

    $ sudo udevadm control --reload-rules



3. Firmware Update
==================

There is a Firmware update tool in the bin/ directory. You can check and update
your firmware of your device.



4. Technical Specifications
===========================

You can find technical specifications at SPECS.txt files.


