sdk as class, and example app

Author: Grix

sdk/example/HeliosDacAPI.cpp sdk/HeliosDacClass.cppsdk/example/HeliosDacAPI.cpp renamed to sdk/HeliosDacClass.cpp

@@ -1,18 +1,19 @@
-/*
-Driver API for Helios Laser DACs
-By Gitle Mikkelsen, Creative Commons Attribution-NonCommercial 4.0 International Public License
+#include "HeliosDacClass.h"
 
-See HeliosDacAPI.h for documentation
 
-Dependencies: 
-Libusb 1.0 (GNU Lesser General Public License, see libusb.h)
-HeliosDAC class (part of this driver)
-*/
+HeliosDacClass::HeliosDacClass()
+{
+	inited = false;
+}
+
 
-#include "HeliosDacAPI.h"
+HeliosDacClass::~HeliosDacClass()
+{
+	CloseDevices();
+}
 
 
-int OpenDevices()
+int HeliosDacClass::OpenDevices()
 {
 	CloseDevices();
 
@@ -25,13 +26,11 @@ int OpenDevices()
 	else
 		inited = true;
 
-	printf("OpenDevices() found: %d", result);
-
 	return result;
 }
 
 
-int WriteFrame(int dacNum, int pps, uint8_t flags, HeliosPoint* points, int numOfPoints)
+int HeliosDacClass::WriteFrame(int dacNum, int pps, uint8_t flags, HeliosPoint* points, int numOfPoints)
 {
 	if ((!inited) || (points == NULL))
 		return 0;
@@ -60,7 +59,7 @@ int WriteFrame(int dacNum, int pps, uint8_t flags, HeliosPoint* points, int numO
 	return dacController->SendFrame(dacNum, &frameBuffer[0], bufPos);
 }
 
-int Stop(int dacNum)
+int HeliosDacClass::Stop(int dacNum)
 {
 	if (!inited)
 		return 0;
@@ -73,7 +72,7 @@ int Stop(int dacNum)
 }
 
 
-int GetName(int dacNum, char* name)
+int HeliosDacClass::GetName(int dacNum, char* name)
 {
 	if (!inited)
 		return  -1;
@@ -101,7 +100,7 @@ int GetName(int dacNum, char* name)
 	return 0;
 }
 
-int SetName(int dacNum, char* name)
+int HeliosDacClass::SetName(int dacNum, char* name)
 {
 	if (!inited)
 		return  -1;
@@ -112,7 +111,7 @@ int SetName(int dacNum, char* name)
 }
 
 
-int GetStatus(int dacNum)
+int HeliosDacClass::GetStatus(int dacNum)
 {
 	if (!inited)
 		return -1;
@@ -133,12 +132,12 @@ int GetStatus(int dacNum)
 				return 0;
 		}
 	}
-	else
-		return -1;
+
+	return -1;
 }
 
 
-int SetShutter(int dacNum, bool value)
+int HeliosDacClass::SetShutter(int dacNum, bool value)
 {
 	if (!inited)
 		return 0;
@@ -147,7 +146,7 @@ int SetShutter(int dacNum, bool value)
 	return dacController->SendControl(dacNum, &ctrlBuffer[0], 2);
 }
 
-int GetFirmwareVersion(int dacNum)
+int HeliosDacClass::GetFirmwareVersion(int dacNum)
 {
 	if (!inited)
 		return -1;
@@ -163,16 +162,16 @@ int GetFirmwareVersion(int dacNum)
 		if ((ctrlBuffer[0]) == 0x84) //if received control byte is as expected
 		{
 			return ((ctrlBuffer[1] << 0) |
-					(ctrlBuffer[2] << 8) |
-					(ctrlBuffer[3] << 16) |
-					(ctrlBuffer[4] << 24));
+				(ctrlBuffer[2] << 8) |
+				(ctrlBuffer[3] << 16) |
+				(ctrlBuffer[4] << 24));
 		}
 	}
 	else
 		return 0;
 }
 
-int EraseFirmware(int dacNum)
+int HeliosDacClass::EraseFirmware(int dacNum)
 {
 	if (!inited)
 		return  -1;
@@ -181,7 +180,7 @@ int EraseFirmware(int dacNum)
 	return dacController->SendControl(dacNum, &ctrlBuffer[0], 2);
 }
 
-int CloseDevices()
+int HeliosDacClass::CloseDevices()
 {
 	if (inited)
 	{
@@ -191,4 +190,4 @@ int CloseDevices()
 	}
 	else
 		return 0;
-}
+}

sdk/HeliosDacClass.h

@@ -0,0 +1,76 @@
+#include "HeliosDac.h"
+
+#pragma once
+class HeliosDacClass
+{
+public:
+	HeliosDacClass();
+	~HeliosDacClass();
+
+	bool inited;
+	HeliosDac* dacController;
+
+	//point data structure
+	typedef struct
+	{
+		uint16_t x; //12 bit (from 0 to 0xFFF)
+		uint16_t y; //12 bit (from 0 to 0xFFF)
+		uint8_t r;	//8 bit	(from 0 to 0xFF)
+		uint8_t g;	//8 bit (from 0 to 0xFF)
+		uint8_t b;	//8 bit (from 0 to 0xFF)
+		uint8_t i;	//8 bit (from 0 to 0xFF)
+	} HeliosPoint;
+
+	//initializes drivers, opens connection to all devices. 
+	//Returns number of available devices.
+	int OpenDevices();
+
+	//Gets status from the specified dac. 
+	//Return 1 if ready to receive new frame, 0 if not, -1 if communcation failed
+	int GetStatus(int dacNum);
+
+	//writes and outputs a frame to the speficied dac
+	//dacNum: dac number (0 to n where n+1 is the return value from OpenDevices() )
+	//pps: rate of output in points per second
+	//flags: (default is 0)
+	//	Bit 0 (LSB) = if true, start output immediately, instead of waiting for current frame (if there is one) to finish playing
+	//	Bit 1 = if true, play frame only once, instead of repeating until another frame is written
+	//	Bit 2-7 = reserved
+	//points: pointer to point data. See point structure documentation in main.h
+	//numOfPoints: number of points in the frame
+	//returns 1 if successful
+	int WriteFrame(int dacNum, int pps, uint8_t flags, HeliosPoint* points, int numOfPoints);
+
+	//sets the shutter of the specified dac. 
+	//value 1 = shutter on, value 0 = shutter off
+	//returns 1 if successful
+	int SetShutter(int dacNum, bool shutterValue);
+
+	//Returns the firmware version number. Returns -1 if communcation failed.
+	int GetFirmwareVersion(int dacNum);
+
+	//gets a descriptive name of the specified dac
+	//name is max 32 bytes long, char needs to be able to hold 32 bytes
+	//returns 1 if successful, return 0 if the proper name couldn't be fetched from the DAC, but name is
+	//still populated with a fallback numbered name based on order of discovery by the library
+	//return -1 if unsuccessful and name is not populated.
+	int GetName(int dacNum, char* name);
+
+	//gets a descriptive name of the specified dac
+	//name is max 31 bytes long including null terminator
+	//returns 1 if successful, return 0 if the transfer failed
+	int SetName(int dacNum, char* name);
+
+	//stops, blanks and centers output on the specified dac
+	//returns 1 if successful
+	int Stop(int dacNum);
+
+	//closes connection to all dacs and frees resources
+	//should be called when library is no longer needed (program exit for example)
+	int CloseDevices();
+
+	//Clears the GPNVM1 bit on the DACs microcontroller. This will cause the DAC to boot into SAM-BA bootloader
+	//which allows new firmware to be uploaded over USB. 
+	int EraseFirmware(int dacNum);
+};
+