General Overview:

The various example programs can be built by creating a "win32 console application", importing the necessary files (see the file listings below) and building. One caveat is the header file inttypes.h. Prior to VS2015 this header file was either missing completely from Visual Studio or was incomplete. An opensource version of this header file has been included with the SDK. You are free to use this header file and it will work with all past and present versions of the SDK. Alternatively, if you are using VS2015 or newer you can use the inttypes.h file included with your system.

Currently in VS2017 for x86_64 builds you will need to add WIN32 to the project's preprocessor defintions.

See README.ckit for using VS2017 with cmake to build ckit.

Binaries and their required files

• Nilm - Command line test program for licensing and analytics
  • Required Files: dsoNSA.c dsoNSL.c dsoSHAFER.c getopt_long.c nalpArgs.c nalpHelper.c nilm.c dsoNSA.h dsoNSL.h dsoSHAFER.h getopt.h inttypes.h licType.h nalpArgs.h nalpArgsP.h NalpeironNSA.h NalpeironNSL.h nalpeironParams.h NalpeironSHAFER.h nalpHelper.h nilmErr.h
• nslTerm - Simple interactive, menu-driven program similar to Nilm.
  • Required Files: dsoNSA.c dsoNSL.c dsoSHAFER.c getopt_long.c dsoNSA.h dsoNSL.h dsoSHAFER.h inttypes.h licType.h NalpeironNSA.h NalpeironNSL.h nalpeironParams.h NalpeironSHAFER.h termHelper.h termHelper.c nslTerm.c nslTerm.h
• [nsaTest]
  • Required Files: dsoNSA.c dsoSHAFER.c getopt_long.c nalpArgs.c nalpHelper.c nsaTest.c dsoNSA.h dsoSHAFER.h getopt.h inttypes.h licType.h nalpArgs.h nalpArgsP.h NalpeironNSA.h nalpeironParams.h NalpeironSHAFER.h nalpHelper.h nilmErr.h
• [nsaTerm]
  • Required Files: dsoNSA.c dsoSHAFER.c getopt_long.c nalpArgs.c dsoNSA.h dsoSHAFER.h getopt.h inttypes.h licType.h nalpArgs.h nalpArgsP.h NalpeironNSA.h nalpeironParams.h NalpeironSHAFER.h termHelper.h termHelper.c nsaTerm.c nsaTerm.h nilmErr.h
• [ckit]
  • Required Files: ckit.c ckit.h auxFuncs.c dsoNSA.c dsoNSA.h dsoNSL.c dsoNSL.h dsoSHAFER.c dsoSHAFER.h libHelper.h NalpeironNSA.h NalpeironNSL.h NalpeironSHAFER.h
• plm - Command line test program for passive licensing
  • Required Files: dsoPSL.c getopt_long.c passArgs.c passHelper.c plm.c dsoPSL.h getopt.h inttypes.h licType.h passpArgs.h passArgsP.h NalpeironPSL.h nalpeironParams.h passHelper.h plm.h plmErr.h
• [pslTerm]
  • Required Files: dsoPSL.c dsoPSL.h inttypes.h licType.h NalpeironPSL.h nalpeironParams.h termHelper.c termHelper.h pslTerm.c pslTerm.h
• shaferExample - Simple program showing usage of the NSL and NSA libraries in a binary.
  • Required Files: dsoNSA.c dsoNSL.c dsoSHAFER.c dsoNSA.h dsoNSL.h dsoSHAFER.h inttypes.h licType.h NalpeironNSA.h NalpeironNSL.h nalpeironParams.h NalpeironSHAFER.h shaferExample.c shaferExample.h

Project Creation

Open Visual Studio and from the File->new->project menu select new. Select "Win32 Console Application" then choose a name for your project and a storage location. In the "Win32 Application Wizard" pop-up select "next" and in the resulting frame, under "Additional options" select "Empty project" and "finish".

In the Visual Studio "Solution Explorer" right click on your solution and choose Add->Existing Item and select all the files listed above for the binary you wish to compile.

Finally, right click on your solution and select "properties" from the resulting menu. The "Property Pages" window will open. From it

1.) Select "C/C++" -> General and in the "Additional Include Directories" on the right add your source directory (ie some\path\CSDK\src). Select "Apply" at the bottom of the page.

2.) Optional Select "C/C++" -> Advanced and enter 4996 into the "Disable Specific Warnings" box on the right. Select "Apply" at the bottom of the page. Microsoft renamed many of the POSIX standard function names. This action disables a warning for each function which is called with its POSIX name rather than the new names Microsoft asigned them. As the Nalpeiron libraries as POSIX complient all Nalpeiron code uses the POSIX names. The resulting spurious error messages hide meaningful errors and it is highly recommended that you suppress them. NOTE This step is not optional in VS2017 as C4996 has been promoted to an error.