Difference between revisions of "Binaries and downloads"

From Neurotech Software Development Kit
Jump to: navigation, search
(Libraries installer)
 
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span style="font-size:180%">Current stable version is '''[https://github.com/NeuroMD/neuro-sdk/releases/tag/0.16 0.16]'''</span>
+
<span style="font-size:180%">Current stable version is '''[https://github.com/NeuroMD/neuro-sdk/releases/tag/1.3 1.3]'''</span>
  
<span style="font-size:180%">Current stable version of extended SDK is '''0.16.1'''</span>
+
<span style="font-size:180%">Current stable version of extended SDK is '''1.2'''</span>
  
  
 
'''Previous versions'''
 
'''Previous versions'''
 
+
[https://github.com/NeuroMD/neuro-sdk/releases/tag/1.2 1.2]
 +
[https://github.com/NeuroMD/neuro-sdk/releases/tag/1.1 1.1]
 +
[https://github.com/NeuroMD/neuro-sdk/releases/tag/1.0 1.0]
 +
[https://github.com/NeuroMD/neuro-sdk/releases/tag/0.17 0.17]
 +
[https://github.com/NeuroMD/neuro-sdk/releases/tag/0.16 0.16]
 
  [https://github.com/NeuroMD/neuro-sdk/releases/tag/0.15 0.15]
 
  [https://github.com/NeuroMD/neuro-sdk/releases/tag/0.15 0.15]
  
 
=Android=
 
=Android=
Standard and extended versions of SDK have different ways of publishing libraries
+
Android software development kit libraries for NeuroMD devices could be linked into project from JCenter repository, or could be downloaded as .aar files from server
==Base version of SDK==
+
===JCenter repository===
You are able to get neuro-sdk for Android development through JitPack or by downloading latest aar library from direct link
+
Extended SDK binaries could be obtained from JCenter repository. To use it, check if you have following lines in gradle script of your project
===JitPack===
+
 
To get a Git project into your build:
+
<syntaxhighlight lang='bash'>
 +
allprojects {
 +
    repositories {
 +
        jcenter()
 +
  }
 +
}
 +
</syntaxhighlight>
  
Step 1. Add the JitPack repository to your build file
+
To link Base SDK library to your project add following line to your dependencies list
 +
<syntaxhighlight lang='bash'>
 +
compile 'com.neuromd.neurosdk:neuro-sdk:1.3.0'
 +
</syntaxhighlight>
  
Add it in your root build.gradle at the end of repositories:
+
To link Extended SDK library to your project add following line to your dependencies list
 
<syntaxhighlight lang='bash'>
 
<syntaxhighlight lang='bash'>
allprojects {
+
compile 'com.neuromd.neurosdk:neuro-sdk-ext:1.2.0'
repositories {
 
...
 
maven { url 'https://jitpack.io' }
 
}
 
}
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
==Notes==
 +
Constructor of [[DeviceScanner (Java)|DeviceScanner]] class needs [https://developer.android.com/reference/android/content/Context Context] object to get access to Bluetooth system service. All operations with Bluetooth data are performed in main UI thread of application, so doing too much work in it may cause connection issues and data packets loss.
 +
 +
=Windows=
 +
Software development kit for Windows operating system is represented as native C++ libraries, C-wrapper libraies and C#-wrapper .NET assemblies. Supported operating systems is Windows 8.1 and 10. There is only 64-bit platform support now, 32-bit libraries is comming soon.
 +
 +
==Libraries installer==
 +
Use the following links to obtain windows installers of SDK libraries and samples. This installers set environment variables NEUROSDK_64 and NEUROSDK_86 to the path where libraries are installed. Installed samples use this variable to get libraries and it can be used in custom projects configurations.
  
Step 2. Add the dependency
+
'''Windows 10 1803 at least is required'''
 +
 
 +
====Base SDK versions====
 +
'''Current release x86:'''  <span style="font-size:120%">[https://drive.google.com/file/d/1o4YeZXD0zPXSa9sz6VWUUo7SMGQjqiXG/view?usp=sharing neurosdk-setup-win-x86-v1.3.exe]</span>
 +
 
 +
'''Current release x64:'''  <span style="font-size:120%">[https://drive.google.com/file/d/1s-g6YH_fTc72zJlnrCtnQ2IgQjcyuWxs/view?usp=sharing neurosdk-setup-win-x64-v1.3.exe]</span>
 +
 
 +
 
 +
'''Previous versions:'''
 +
 
 +
[https://yadi.sk/d/6tOVriie3ZkPX6 neurosdk-setup-win-x64-v1.2.exe]
 +
 
 +
[https://yadi.sk/d/UiS8TgVU3ZPk7V neurosdk-setup-win-x64-v1.1.exe]
 +
 
 +
===Using CMake to create Visual Studio sample projects===
 +
Samples for native C++ SDK library and for C-wrapper library is made as CMake projects. To build and run them first you need to create VS projects. These projects require at least CMake of version 3.3.
 +
 
 +
1. Run CMake and point to needed sample directory
 +
 
 +
[[File:cmakesamples1.png]]
  
<syntaxhighlight lang='bash'>
 
dependencies {
 
implementation 'com.github.NeuroMD:neuro-sdk:0.16'
 
}
 
</syntaxhighlight>
 
  
That's it! The first time you request a project JitPack checks out the code, builds it and serves the build artifacts.
+
2. Press "Configure" and select Win64 generator, then press finish
  
===Binaries download links===
+
[[File:cmakesamples2.png]]
Following links could be used to obtain SDK libraries
 
  
[[File:libneurosdk-release.aar|libneurosdk-release-0.16.aar]]
 
  
====Previous versions====
+
3. Remove redundant configuration types from config.  Use Debug and Release only. Press "Configure" again
None
 
  
==Extended SDK versions==
+
[[File:cmakesamples3.png]]
===JCenter repository===
 
Extended SDK binaries could be obtained from JCenter repository. To use it, check if you have following lines in gradle script of your project
 
  
<syntaxhighlight lang='bash'>
 
allprojects {
 
    repositories {
 
        jcenter()
 
  }
 
}
 
</syntaxhighlight>
 
  
To link Extended SDK library to your project add following line to your dependencies list
+
4. Press "Generate" and when generating is doe press "Open Project". Set runnable project as startup project and press "F6" to build it (or right-clict on project name in solution explorer and click "Build")
<syntaxhighlight lang='bash'>
 
compile 'com.neuromd.neurosdk:neuro-sdk-ext:0.16.1'
 
</syntaxhighlight>
 
  
===Binaries download===
+
[[File:cmakesamples4.png]]
Use the following link to get latest vesion of extended SDK library:
 
  
[[File:neuro-sdk-ext-0.16.1.aar]]
 
  
====Previous versions====
+
5. Press "F5" to run project
None
 

Latest revision as of 02:39, 12 December 2018

Current stable version is 1.3

Current stable version of extended SDK is 1.2


Previous versions

1.2
1.1
1.0
0.17
0.16
0.15

Android

Android software development kit libraries for NeuroMD devices could be linked into project from JCenter repository, or could be downloaded as .aar files from server

JCenter repository

Extended SDK binaries could be obtained from JCenter repository. To use it, check if you have following lines in gradle script of your project

allprojects {
    repositories {
        jcenter()
   }
}

To link Base SDK library to your project add following line to your dependencies list

compile 'com.neuromd.neurosdk:neuro-sdk:1.3.0'

To link Extended SDK library to your project add following line to your dependencies list

compile 'com.neuromd.neurosdk:neuro-sdk-ext:1.2.0'

Notes

Constructor of DeviceScanner class needs Context object to get access to Bluetooth system service. All operations with Bluetooth data are performed in main UI thread of application, so doing too much work in it may cause connection issues and data packets loss.

Windows

Software development kit for Windows operating system is represented as native C++ libraries, C-wrapper libraies and C#-wrapper .NET assemblies. Supported operating systems is Windows 8.1 and 10. There is only 64-bit platform support now, 32-bit libraries is comming soon.

Libraries installer

Use the following links to obtain windows installers of SDK libraries and samples. This installers set environment variables NEUROSDK_64 and NEUROSDK_86 to the path where libraries are installed. Installed samples use this variable to get libraries and it can be used in custom projects configurations.

Windows 10 1803 at least is required

Base SDK versions

Current release x86: neurosdk-setup-win-x86-v1.3.exe

Current release x64: neurosdk-setup-win-x64-v1.3.exe


Previous versions:

neurosdk-setup-win-x64-v1.2.exe

neurosdk-setup-win-x64-v1.1.exe

Using CMake to create Visual Studio sample projects

Samples for native C++ SDK library and for C-wrapper library is made as CMake projects. To build and run them first you need to create VS projects. These projects require at least CMake of version 3.3.

1. Run CMake and point to needed sample directory

Cmakesamples1.png


2. Press "Configure" and select Win64 generator, then press finish

Cmakesamples2.png


3. Remove redundant configuration types from config. Use Debug and Release only. Press "Configure" again

Cmakesamples3.png


4. Press "Generate" and when generating is doe press "Open Project". Set runnable project as startup project and press "F6" to build it (or right-clict on project name in solution explorer and click "Build")

Cmakesamples4.png


5. Press "F5" to run project