Psyleron SDK (PsyREG)

1.0

(SDK FAQ is available here )

1. INTRODUCTION

The Psyleron SDK is provided to allow you to build your own custom applications and utilities that access the REG Device. Please remember that applications created with this SDK may be used for personal use only, unless permission is otherwise granted by Psyleron. If you have any questions about the SDK, please contact support@psyleron.com.

2. DEVELOPER FILES INSTALLATION

Thes API development files have been tested with Microsoft Visual Studio .NET 2003 in Windows XP Professional 32bit. They are not guaranteed to work on any particular system.

Compiling the examples or writing your own applications:
Copy the contents of "PsyREG API\lib to your Compiler's lib directory. (e.g. C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib)
Copy the contents of "PsyREG API\\include" to your Compiler's include directory. (e.g. C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\include)
To run any PsyREG API-based application
Perform Either A or B (A is preferred)
A) Copy the contents of "PsyREG API\\bin" to the directory where the executable that you are building will reside. This will simplify any redistribution of the application. The neccessary binary files are already in the sample project bin folders.
B) Copy the contents of "PsyREG API\\bin" to your system directory. (e.g. C:\windows\System32)
You should now be able to build and run the sample C and VB.NET programs.

3. USAGE

Step 1: Startup

To get started quickly, we have provided 2 sample projects.

For Visual C++ 2003 .NET or later, see

                \PsyREG Sample\CSample\src\CSample.vcproj

If you have an earlier version of Visual C++ or are using another C/C++ compiler, the source code is avaialable in sample.c

                \PsyREG Sample\CSample\src\sample.c

For Visual Basic 2003 .NET or later, the PsyREG Module file PsyREG.vb and Sample App Sample.vb are available through

                \PsyREG Sample\VBSample\VBSample.vbproj

If you have an earlier version of Visual Basic, you may be able to utilize the PsyREG function and subroutine declarations, but this is untested and unsupported.

Step 2: API

For actual API documentation, see: psyreg.h. All of the API functionality is provided in this one file.

Visual Basic .NET Applications do not utilize psyreg.h, but do work with the same function calls. All of these functions and constants are declared in

                \PsyREG Samples\VBSample\PsyREG.vB

Step 3: Developing New Applications

You can base a new application off of one of the samples or create your own.

Assuming you configured your C/C++ build environment by copying the .h and .lib files correctly, the only requirement for a new project is to add the additional dependencies to your linker.

                PsyREG.lib (for Release Mode)
                PsyREGd.lib (for Debug Mode)
And Include psyreg.h in your source code

In a VB .NET project, all you should have to do is copy the PsyREG.vb module into your project.

4. REDISTRIBUTION

REDISTRUBUTION ALERT / LICENSE REFERENCE GOES HERE

When moving a built program to another computer, remember to move these files along with the actual executable. They are initially stored in "PsyREG API\bin".

                PsyREG.dll
                ftd2xx.dll
You may also need to redistribute these files if the target computer does not have them
                C:\windows\system32\msvcr71.dll
                C:\windows\system32\msvcp71.dll
All of these dependencies can be placed in the same directory as the executable.

Generated on Wed Apr 9 16:59:16 2008 for Psyleron SDK by  doxygen 1.5.5