Merge pull request #41 from Fluigent/version-22.0.0.0

Update SDK to version 22.0.0.0

C#/fgt_sdk_csharp.sln

@@ -5,7 +5,7 @@ VisualStudioVersion = 16.0.30204.135
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "fgt_sdk", "fgt_sdk_csharp\fgt_sdk.csproj", "{33B38AD3-45AB-47A7-A60A-FEF1F5F2C680}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnitTests", "UnitTests\UnitTests.csproj", "{CCFEDF28-2E32-4486-A939-B8D48C3E2169}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UnitTests", "UnitTests\UnitTests.csproj", "{CCFEDF28-2E32-4486-A939-B8D48C3E2169}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Examples", "Examples", "{D0B23A9F-ECEC-45DB-998C-FD00A8C96626}"
 EndProject
@@ -25,7 +25,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Basic Sensor Regulation", "
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Basic Set Pressure", "Examples\Basic Set Pressure\Basic Set Pressure.csproj", "{BC5CFC73-73E5-4589-99E9-D2FA6ED0D1C6}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Basic Set Valve Position", "Examples\Basic Set Valve Position\Basic Set Valve Position.csproj", "{3BAF2C97-A143-4F04-9D17-8BF28380BF13}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Basic Set Valve Position", "Examples\Basic Set Valve Position\Basic Set Valve Position.csproj", "{3BAF2C97-A143-4F04-9D17-8BF28380BF13}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{FD111F64-AE9B-41B6-98E5-6BF1A8BF86A2}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

C#/fgt_sdk_csharp/Enums/fgt_INSTRUMENT_TYPE.cs

@@ -13,5 +13,6 @@ public enum fgt_INSTRUMENT_TYPE
         LineUP,
         IPS,
         ESS,
+        F_OEM,
     }
 }

C#/fgt_sdk_csharp/Enums/fgt_SENSOR_TYPE.cs

@@ -18,5 +18,7 @@ public enum fgt_SENSOR_TYPE
         Pressure_S,
         Pressure_M,
         Pressure_XL,
+        Flow_M_plus_dual,
+        Flow_L_plus_dual,
     }
-}
+}

C#/fgt_sdk_csharp/Enums/fgt_VALVE_TYPE.cs

@@ -11,5 +11,8 @@ public enum fgt_VALVE_TYPE
         TwoSwitch,
         LSwitch,
         PSwitch,
+        M_X,
+        Two_X,
+        L_X,
     }
-}
+}

C#/fgt_sdk_csharp/fgt_sdk.csproj

@@ -5,16 +5,16 @@
     <Authors>Fluigent</Authors>
     <Product>Fluigent Software Development Kit</Product>
     <Description>C# Software Development Kit for Fluigent instruments</Description>
-    <Version>21.4.0.0</Version>
+    <Version>22.0.0.0</Version>
     <PackageTags>Microfluidics, Control</PackageTags>
     <Platforms>AnyCPU;x64;x86</Platforms>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <AssemblyVersion>21.4.0.0</AssemblyVersion>
+    <AssemblyVersion>22.0.0.0</AssemblyVersion>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-    <Copyright>Copyright (c) Fluigent 2021</Copyright>
+    <Copyright>Copyright (c) Fluigent 2022</Copyright>
     <RepositoryUrl>https://github.com/Fluigent/fgt-SDK</RepositoryUrl>
     <PackageProjectUrl>https://www.fluigent.com/</PackageProjectUrl>
-    <FileVersion>21.4.0.0</FileVersion>
+    <FileVersion>22.0.0.0</FileVersion>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">

C++/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.13)
 
-project(SDK_cpp_examples VERSION 21.4.0.0)
+project(SDK_cpp_examples VERSION 22.0.0.0)
 set(CMAKE_CXX_STANDARD 11)
 
 add_subdirectory(fgt_SDK_Cpp)

C++/fgt_SDK_Cpp/dlls/fgt_SDK.h

@@ -1,13 +1,13 @@
 /*============================================================================
 *                   Fluigent Software Developement Kit                       
 *----------------------------------------------------------------------------
-*         Copyright (c) Fluigent 2021.  All Rights Reserved.                 
+*         Copyright (c) Fluigent 2022.  All Rights Reserved.                 
 *----------------------------------------------------------------------------
 *                                                                            
 * Title:   fgt_SDK.h                                                         
 * Purpose: Functions API for Fluigent instruments                            
-* Version: 21.4.0.0
-* Date:	12/2021
+* Version: 22.0.0.0
+* Date:	04/2022
 *============================================================================*/
 
 #ifndef _FGT_SDK_H
@@ -71,13 +71,15 @@ extern "C"
 	};
 
 	/** @Description Instrument controller type */
-	enum class fgt_INSTRUMENT_TYPE { None, MFCS, MFCS_EZ, FRP, LineUP, IPS, ESS };
+	enum class fgt_INSTRUMENT_TYPE { None, MFCS, MFCS_EZ, FRP, LineUP, IPS, ESS, F_OEM };
 
 	/** @Description Sensor type */
 	enum class fgt_SENSOR_TYPE { 
 		None, 
 		Flow_XS_single, Flow_S_single, Flow_S_dual, Flow_M_single, Flow_M_dual, Flow_L_single, Flow_L_dual, Flow_XL_single, 
-		Pressure_S, Pressure_M, Pressure_XL };
+		Pressure_S, Pressure_M, Pressure_XL,
+		Flow_M_plus_dual, Flow_L_plus_dual,
+	};
 
 	/** @Description Sensor calibration table */
 	enum class fgt_SENSOR_CALIBRATION { None, H2O, IPA, HFE, FC40, OIL };
@@ -92,7 +94,7 @@ extern "C"
 	enum class fgt_LINK_MODULE { None, FlowEZ, PSwitch = 3, SwitchEZ = 4 };
 
 	/** @Description Valve type */
-	enum class fgt_VALVE_TYPE { None, MSwitch, TwoSwitch, LSwitch, PSwitch };
+	enum class fgt_VALVE_TYPE { None, MSwitch, TwoSwitch, LSwitch, PSwitch, M_X, Two_X, L_X };
 
 	/** @Description Switch direction type */
 	enum class fgt_SWITCH_DIRECTION { Shortest, Anticlockwise, Clockwise };
@@ -351,6 +353,16 @@ typedef struct
 	 */
 	unsigned char FGT_API fgt_get_sensorValueEx(unsigned int sensorIndex, float* value, unsigned short* timeStamp);
 
+	/**
+	 * @Description Read the flag indicating whether the flow rate sensor detects an air bubble. Only 
+		available on Flow Unit sensor ranges M+ and L+.
+	 * @param sensorIndex Index of sensor channel or unique ID
+	 * @out detected 1 if an air bubble was detected, 0 otherwise.
+	 * @return fgt_ERROR_CODE
+	 * @see fgt_get_sensorStatus
+	 */
+	unsigned char FGT_API fgt_get_sensorAirBubbleFlag(unsigned int sensorIndex, unsigned char* detected);
+
 	/**
 	 * @Description Read the position of a specific valve channel.
 	 * @param valveIndex Index of valve channel
@@ -660,6 +672,24 @@ typedef struct
 	 */
 	unsigned char FGT_API fgt_set_manual(unsigned int pressureIndex, float value);
 
+	/**
+	 * @Description Set the digital output ON or OFF on a controller
+	 * This feature is only available on the F-OEM device.
+	 * @param controllerIndex Index of controller or unique ID
+	 * @param port Address of the digital output to toggle. For F-OEM: 0: Pump, 1: LED
+	 * @param state 0: OFF, 1:ON
+	 * @return fgt_ERROR_CODE
+	 */
+	unsigned char FGT_API fgt_set_digitalOutput(unsigned int controllerIndex, unsigned char port, unsigned char state);
+
+	/**
+	 * @Description Returns the pressure measured at the device's inlet.
+	 * This feature is only available on LineUP Flow EZ and FOEM Pressure Module instruments.
+	 * @param pressureIndex Index of pressure channel or unique ID
+	 * @out pressure Inlet pressure value in selected unit, default is "mbar"
+	 * @return fgt_ERROR_CODE
+	 */
+	unsigned char FGT_API fgt_get_inletPressure(unsigned int pressureIndex, float* pressure);
 
 #ifdef __cplusplus
 }

C++/fgt_SDK_Cpp/fgt_SDK_Cpp.cpp

@@ -60,6 +60,7 @@ std::ostream& operator<<(std::ostream& str, fgt_INSTRUMENT_TYPE instrType)
 	case fgt_INSTRUMENT_TYPE::LineUP: str << "LineUP"; break;
 	case fgt_INSTRUMENT_TYPE::IPS: str << "IPS"; break;
 	case fgt_INSTRUMENT_TYPE::ESS: str << "ESS"; break;
+    case fgt_INSTRUMENT_TYPE::F_OEM: str << "F_OEM"; break;
 	default: str << "Unknown instrument type (" << int(instrType) << ")";
 	}
 	return str;
@@ -82,6 +83,8 @@ std::ostream& operator<<(std::ostream& str, fgt_SENSOR_TYPE sensorType)
 	case fgt_SENSOR_TYPE::Pressure_S: str << "Pressure_S"; break;
 	case fgt_SENSOR_TYPE::Pressure_M: str << "Pressure_M"; break;
 	case fgt_SENSOR_TYPE::Pressure_XL: str << "Pressure_XL"; break;
+	case fgt_SENSOR_TYPE::Flow_M_plus_dual: str << "Flow_M_plus_dual"; break;
+	case fgt_SENSOR_TYPE::Flow_L_plus_dual: str << "Flow_L_plus_dual"; break;
 	default: str << "Unknown sensor type (" << int(sensorType) << ")";
 	}
 	return str;
@@ -140,6 +143,9 @@ std::ostream& operator<<(std::ostream& str, fgt_VALVE_TYPE valveType)
 	case fgt_VALVE_TYPE::TwoSwitch: str << "TwoSwitch"; break;
 	case fgt_VALVE_TYPE::LSwitch: str << "LSwitch"; break;
 	case fgt_VALVE_TYPE::PSwitch: str << "PSwitch"; break;
+	case fgt_VALVE_TYPE::M_X: str << "M_X"; break;
+	case fgt_VALVE_TYPE::Two_X: str << "Two_X"; break;
+	case fgt_VALVE_TYPE::L_X: str << "L_X"; break;
 	default: str << "Unknown valve type (" << int(valveType) << ")";
 	}
 	return str;
@@ -1090,6 +1096,51 @@ fgt_ERROR_CODE Fgt_set_manual(unsigned int pressureIndex, float value)
 	return returnCode;
 }
 
+/**
+ * @Description Set the digital output ON or OFF on a controller
+ * This feature is only available on the F-OEM device.
+ * @param controllerIndex Index of controller or unique ID
+ * @param port Address of the digital output to toggle. For F-OEM: 0: Pump, 1: LED
+ * @param state 0: OFF, 1:ON
+ * @return fgt_ERROR_CODE
+ */
+fgt_ERROR_CODE Fgt_set_digitalOutput(unsigned int controllerIndex, unsigned char port, unsigned char state)
+{
+    fgt_ERROR_CODE returnCode = fgt_ERROR_CODE(fgt_set_digitalOutput(controllerIndex, port, state));
+	Fgt_Manage_Generic_Status(returnCode, "Fgt_set_digitalOutput");
+	return returnCode;
+}
+
+/**
+ * @Description Read the flag indicating whether the flow rate sensor detects an air bubble. Only 
+    available on Flow Unit sensor ranges M+ and L+.
+ * @param sensorIndex Index of sensor channel or unique ID
+ * @out detected 1 if an air bubble was detected, 0 otherwise.
+ * @return fgt_ERROR_CODE
+ * @see fgt_get_sensorStatus
+ */
+fgt_ERROR_CODE Fgt_get_sensorAirBubbleFlag(unsigned int sensorIndex, unsigned char* detected)
+{
+	fgt_ERROR_CODE returnCode = fgt_ERROR_CODE(fgt_get_sensorAirBubbleFlag(sensorIndex, detected));
+	Fgt_Manage_Sensor_Status(sensorIndex, "Fgt_get_sensorAirBubbleFlag");
+	return returnCode;
+}
+
+/**
+ * @Description Returns the pressure measured at the device's inlet.
+ * This feature is only available on LineUP Flow EZ and FOEM Pressure Module instruments.
+ * @param pressureIndex Index of pressure channel or unique ID
+ * @param *pressure Inlet pressure value in selected unit, default is "mbar"
+ * @return errorCode
+ * @see fgt_get_pressureStatus
+ */
+fgt_ERROR_CODE Fgt_get_inletPressure(unsigned int pressureIndex, float* pressure)
+{
+	fgt_ERROR_CODE returnCode = fgt_ERROR_CODE(fgt_get_inletPressure(pressureIndex, pressure));
+	Fgt_Manage_Pressure_Status(pressureIndex, "Fgt_get_inletPressure");
+	return returnCode;
+}
+
 fgt_ERROR_CODE Fgt_set_errorReportMode(fgt_ERROR_REPORT_MODE mode)
 {
 	error_report_mode = mode;

C++/fgt_SDK_Cpp/fgt_SDK_Cpp.h

@@ -1,14 +1,14 @@
 /*============================================================================
 *               Fluigent Software Developement Kit for C++                   
 *----------------------------------------------------------------------------
-*         Copyright (c) Fluigent 2021.  All Rights Reserved.                 
+*         Copyright (c) Fluigent 2022.  All Rights Reserved.                 
 *----------------------------------------------------------------------------
 *                                                                            
 * Title:    fgt_SDK_Cpp.h                                                     
 * Purpose:  Wrapper to fgt_SDK library
 *			Contains an interface to each dll function and type conversions
-* Version:  21.4.0.0
-* Date:	    12/2021
+* Version:  22.0.0.0
+* Date:	    04/2022
 *============================================================================*/
 
 #ifndef _FGT_SDK_CPP_H
@@ -601,6 +601,36 @@ fgt_ERROR_CODE Fgt_set_purge(unsigned int controllerIndex, unsigned char purge);
  */
 fgt_ERROR_CODE Fgt_set_manual(unsigned int pressureIndex, float value);
 
+/**
+ * @Description Set the digital output ON or OFF on a controller
+ * This feature is only available on the F-OEM device.
+ * @param controllerIndex Index of controller or unique ID
+ * @param port Address of the digital output to toggle. For F-OEM: 0: Pump, 1: LED
+ * @param state 0: OFF, 1:ON
+ * @return fgt_ERROR_CODE
+ */
+fgt_ERROR_CODE Fgt_set_digitalOutput(unsigned int controllerIndex, unsigned char port, unsigned char state);
+
+/**
+ * @Description Read the flag indicating whether the flow rate sensor detects an air bubble. Only 
+    available on Flow Unit sensor ranges M+ and L+.
+ * @param sensorIndex Index of sensor channel or unique ID
+ * @out detected 1 if an air bubble was detected, 0 otherwise.
+ * @return fgt_ERROR_CODE
+ * @see fgt_get_sensorStatus
+ */
+fgt_ERROR_CODE FGT_API Fgt_get_sensorAirBubbleFlag(unsigned int sensorIndex, unsigned char* detected);
+
+/**
+ * @Description Returns the pressure measured at the device's inlet.
+ * This feature is only available on LineUP Flow EZ and FOEM Pressure Module instruments.
+ * @param pressureIndex Index of pressure channel or unique ID
+ * @param *pressure Inlet pressure value in selected unit, default is "mbar"
+ * @return errorCode
+ * @see fgt_get_pressureStatus
+ */
+fgt_ERROR_CODE Fgt_get_inletPressure(unsigned int pressureIndex, float* pressure);
+
 /**
  * @Description Sets a flag that defines how SDK errors should be reported.
  * @param mode The report mode to use.

LabVIEW/dlls/fgt_SDK.h

@@ -1,13 +1,13 @@
 /*============================================================================
 *                   Fluigent Software Developement Kit                       
 *----------------------------------------------------------------------------
-*         Copyright (c) Fluigent 2021.  All Rights Reserved.                 
+*         Copyright (c) Fluigent 2022.  All Rights Reserved.                 
 *----------------------------------------------------------------------------
 *                                                                            
 * Title:   fgt_SDK.h                                                         
 * Purpose: Functions API for Fluigent instruments                            
-* Version: 21.4.0.0
-* Date:	12/2021
+* Version: 22.0.0.0
+* Date:	04/2022
 *============================================================================*/
 
 #ifndef _FGT_SDK_H
@@ -71,13 +71,15 @@ extern "C"
 	};
 
 	/** @Description Instrument controller type */
-	enum class fgt_INSTRUMENT_TYPE { None, MFCS, MFCS_EZ, FRP, LineUP, IPS, ESS };
+	enum class fgt_INSTRUMENT_TYPE { None, MFCS, MFCS_EZ, FRP, LineUP, IPS, ESS, F_OEM };
 
 	/** @Description Sensor type */
 	enum class fgt_SENSOR_TYPE { 
 		None, 
 		Flow_XS_single, Flow_S_single, Flow_S_dual, Flow_M_single, Flow_M_dual, Flow_L_single, Flow_L_dual, Flow_XL_single, 
-		Pressure_S, Pressure_M, Pressure_XL };
+		Pressure_S, Pressure_M, Pressure_XL,
+		Flow_M_plus_dual, Flow_L_plus_dual,
+	};
 
 	/** @Description Sensor calibration table */
 	enum class fgt_SENSOR_CALIBRATION { None, H2O, IPA, HFE, FC40, OIL };
@@ -92,7 +94,7 @@ extern "C"
 	enum class fgt_LINK_MODULE { None, FlowEZ, PSwitch = 3, SwitchEZ = 4 };
 
 	/** @Description Valve type */
-	enum class fgt_VALVE_TYPE { None, MSwitch, TwoSwitch, LSwitch, PSwitch };
+	enum class fgt_VALVE_TYPE { None, MSwitch, TwoSwitch, LSwitch, PSwitch, M_X, Two_X, L_X };
 
 	/** @Description Switch direction type */
 	enum class fgt_SWITCH_DIRECTION { Shortest, Anticlockwise, Clockwise };
@@ -351,6 +353,16 @@ typedef struct
 	 */
 	unsigned char FGT_API fgt_get_sensorValueEx(unsigned int sensorIndex, float* value, unsigned short* timeStamp);
 
+	/**
+	 * @Description Read the flag indicating whether the flow rate sensor detects an air bubble. Only 
+		available on Flow Unit sensor ranges M+ and L+.
+	 * @param sensorIndex Index of sensor channel or unique ID
+	 * @out detected 1 if an air bubble was detected, 0 otherwise.
+	 * @return fgt_ERROR_CODE
+	 * @see fgt_get_sensorStatus
+	 */
+	unsigned char FGT_API fgt_get_sensorAirBubbleFlag(unsigned int sensorIndex, unsigned char* detected);
+
 	/**
 	 * @Description Read the position of a specific valve channel.
 	 * @param valveIndex Index of valve channel
@@ -660,6 +672,24 @@ typedef struct
 	 */
 	unsigned char FGT_API fgt_set_manual(unsigned int pressureIndex, float value);
 
+	/**
+	 * @Description Set the digital output ON or OFF on a controller
+	 * This feature is only available on the F-OEM device.
+	 * @param controllerIndex Index of controller or unique ID
+	 * @param port Address of the digital output to toggle. For F-OEM: 0: Pump, 1: LED
+	 * @param state 0: OFF, 1:ON
+	 * @return fgt_ERROR_CODE
+	 */
+	unsigned char FGT_API fgt_set_digitalOutput(unsigned int controllerIndex, unsigned char port, unsigned char state);
+
+	/**
+	 * @Description Returns the pressure measured at the device's inlet.
+	 * This feature is only available on LineUP Flow EZ and FOEM Pressure Module instruments.
+	 * @param pressureIndex Index of pressure channel or unique ID
+	 * @out pressure Inlet pressure value in selected unit, default is "mbar"
+	 * @return fgt_ERROR_CODE
+	 */
+	unsigned char FGT_API fgt_get_inletPressure(unsigned int pressureIndex, float* pressure);
 
 #ifdef __cplusplus
 }