Merge pull request #1031 from AllenInstitute/feature/1031-pressure-sealed-message

Publish seal formation and more pressure entries in TPStorage

Author: timjarsky

Packages/MIES/MIES_AcquisitionStateHandling.ipf

@@ -149,8 +149,8 @@ Function AS_GetSweepNumber(string panelTitle)
 	switch(acqState)
 		case AS_INACTIVE:
 		case AS_EARLY_CHECK:
-			ASSERT(0, "Can not query the sweep number without data acqisition running")
-			break
+			// early return as this is not a valid sweep number
+			return NaN
 		case AS_PRE_DAQ:
 		case AS_PRE_SWEEP_CONFIG:
 		case AS_PRE_SWEEP:

Packages/MIES/MIES_Constants.ipf

@@ -633,7 +633,7 @@ Constant ANALYSISBROWSER_PANEL_VERSION    =  1
 /// - Changed names of entries
 /// - Changed units or meaning of entries
 /// - New/Changed layers of entries
-Constant LABNOTEBOOK_VERSION = 47
+Constant LABNOTEBOOK_VERSION = 48
 
 /// Version of the stimset wave note
 Constant STIMSET_NOTE_VERSION = 7
@@ -1566,7 +1566,14 @@ Constant LBN_TEXTUAL_KEYS     = 0x4
 Constant LBN_TEXTUAL_VALUES   = 0x8
 /// @}
 
-StrConstant PRESSURE_FILTER = "pressure:state"
+StrConstant PRESSURE_STATE_FILTER  = "pressure:state"
+StrConstant PRESSURE_SEALED_FILTER = "pressure:sealed"
 
 /// which is sufficient to represent each sample point time with a distinctive number up to rates of 10 MHz.
 Constant EPOCHTIME_PRECISION = 7
+
+/// @name Possible cell state values
+/// @anchor CellStateValues
+/// @{
+Constant TPSTORAGE_SEALED = 0x1
+/// @}

Packages/MIES/MIES_ForeignFunctionInterface.ipf

@@ -76,7 +76,7 @@ End
 /// @sa FFI_GetJSONTemplate
 Function/WAVE FFI_GetAvailableMessageFilters()
 
-	Make/FREE/T wv = {ZeroMQ_HEARTBEAT, IVS_PUB_FILTER, PRESSURE_FILTER}
+	Make/FREE/T wv = {ZeroMQ_HEARTBEAT, IVS_PUB_FILTER, PRESSURE_STATE_FILTER, PRESSURE_SEALED_FILTER}
 
 	Note/K wv "Heartbeat is sent every 5 seconds."
 

Packages/MIES/MIES_PressureControl.ipf

@@ -196,6 +196,22 @@ static Function P_FindLastSetEntry(WAVE wv, variable row, variable col, string n
 	return NaN
 End
 
+static Function P_AddSealedEntryToTPStorage(string panelTitle, variable headstage)
+	variable count
+
+	if(!P_ValidatePressureSetHeadstage(panelTitle, headstage) || !P_IsHSActiveAndInVClamp(panelTitle, headstage))
+		return NaN
+	endif
+
+	WAVE TPStorage = GetTPStorage(panelTitle)
+
+	count = GetNumberFromWaveNote(TPStorage, NOTE_INDEX)
+
+	TPStorage[count][headstage][%CellState] = TPSTORAGE_SEALED
+
+	SetNumberInWaveNote(TPStorage, NOTE_INDEX, ++count)
+End
+
 static Function P_PublishPressureMethodChange(string panelTitle, variable headstage, variable oldMethod, variable newMethod)
 
 	variable jsonID, err
@@ -216,7 +232,7 @@ static Function P_PublishPressureMethodChange(string panelTitle, variable headst
 	try
 		ClearRTError()
 #if exists("zeromq_pub_send")
-		zeromq_pub_send(PRESSURE_FILTER, payload); AbortOnRTE
+		zeromq_pub_send(PRESSURE_STATE_FILTER, payload); AbortOnRTE
 #else
 		ASSERT(0, "ZeroMQ XOP not present")
 #endif
@@ -226,6 +242,29 @@ static Function P_PublishPressureMethodChange(string panelTitle, variable headst
 	endtry
 End
 
+static Function P_PublishSealedState(string panelTitle, variable headstage)
+	variable jsonID, err
+	string payload
+
+	jsonID = FFI_GetJSONTemplate(panelTitle, headstage)
+	JSON_AddBoolean(jsonID, "/sealed", 1)
+
+	payload = JSON_Dump(jsonID)
+	JSON_Release(jsonID)
+
+	try
+		ClearRTError()
+#if exists("zeromq_pub_send")
+		zeromq_pub_send(PRESSURE_SEALED_FILTER, payload); AbortOnRTE
+#else
+		ASSERT(0, "ZeroMQ XOP not present")
+#endif
+	catch
+		err = ClearRTError()
+		BUG("Could not publish pressure seal state " + num2str(err))
+	endtry
+End
+
 /// @brief Sets the pressure to atmospheric
 static Function P_MethodAtmospheric(panelTitle, headstage)
 	string panelTitle
@@ -306,6 +345,8 @@ static Function P_MethodSeal(panelTitle, headStage)
 		// apply holding potential of SEAL_POTENTIAL
 		P_UpdateVcom(panelTitle, SEAL_POTENTIAL, headStage)
 		print "Seal on head stage:", headstage
+		P_PublishSealedState(panelTitle, headstage)
+		P_AddSealedEntryToTPStorage(panelTitle, headstage)
 	else // no seal, start, hold, or increment negative pressure
 		// if there is no neg pressure, apply starting pressure.
 		access = P_GetUserAccess(panelTitle, headStage, PRESSURE_METHOD_SEAL)

Packages/MIES/MIES_Utilities.ipf

@@ -699,7 +699,7 @@ threadsafe Function/DF createDFWithAllParents(dataFolder)
 	string dataFolder
 
 	variable i, numItems
-	string partialPath
+	string partialPath, component
 	DFREF dfr = $dataFolder
 
 	if(DataFolderRefStatus(dfr))
@@ -711,8 +711,10 @@ threadsafe Function/DF createDFWithAllParents(dataFolder)
 	// i=1 because we want to skip root, as this exists always
 	numItems = ItemsInList(dataFolder,":")
 	for(i=1; i < numItems ; i+=1)
-		partialPath += ":"
-		partialPath += StringFromList(i,dataFolder,":")
+		component = StringFromList(i,dataFolder,":")
+		ASSERT_TS(IsValidObjectName(component), "dataFolder must follow strict object naming rules.")
+
+		partialPath += ":" + component
 		if(!DataFolderExists(partialPath))
 			NewDataFolder $partialPath
 		endif

Packages/MIES/MIES_WaveDataFolderGetters.ipf

@@ -2295,18 +2295,19 @@ End
 /// - 21: UserPressureTimeStampUTC timestamp since Igor Pro epoch in UTC where
 ///       the user pressure was acquired
 /// - 22: TPMarker unique number identifying this set of TPs
+/// - 23: Cell state: Pressure control values defining the cell state, one of @ref CellStateValues
 Function/Wave GetTPStorage(panelTitle)
 	string panelTitle
 
 	dfref dfr = GetDeviceTestPulse(panelTitle)
-	variable versionOfNewWave = 12
+	variable versionOfNewWave = 13
 
 	WAVE/Z/SDFR=dfr/D wv = TPStorage
 
 	if(ExistsWithCorrectLayoutVersion(wv, versionOfNewWave))
 		return wv
 	elseif(WaveExists(wv))
-		Redimension/N=(-1, NUM_HEADSTAGES, 23)/D wv
+		Redimension/N=(-1, NUM_HEADSTAGES, 24)/D wv
 
 		if(WaveVersionIsSmaller(wv, 10))
 			wv[][][17]    = NaN
@@ -2315,8 +2316,11 @@ Function/Wave GetTPStorage(panelTitle)
 		if(WaveVersionIsSmaller(wv, 11))
 			wv[][][22]    = NaN
 		endif
+		if(WaveVersionIsSmaller(wv, 13))
+			wv[][][23]    = NaN
+		endif
 	else
-		Make/N=(MINIMUM_WAVE_SIZE_LARGE, NUM_HEADSTAGES, 23)/D dfr:TPStorage/Wave=wv
+		Make/N=(MINIMUM_WAVE_SIZE_LARGE, NUM_HEADSTAGES, 24)/D dfr:TPStorage/Wave=wv
 
 		wv = NaN
 
@@ -2348,6 +2352,7 @@ Function/Wave GetTPStorage(panelTitle)
 	SetDimLabel LAYERS, 20, UserPressureType          , wv
 	SetDimLabel LAYERS, 21, UserPressureTimeStampUTC  , wv
 	SetDimLabel LAYERS, 22, TPMarker                  , wv
+	SetDimLabel LAYERS, 23, CellState                 , wv
 
 	SetNumberInWaveNote(wv, AUTOBIAS_LAST_INVOCATION_KEY, 0)
 	SetNumberInWaveNote(wv, DIMENSION_SCALING_LAST_INVOC, 0)

Packages/Testing-MIES/UTF_HelperFunctions.ipf

@@ -56,3 +56,21 @@ Function AdditionalExperimentCleanup()
 	NVAR bugCount = $GetBugCount()
 	KillVariables bugCount
 End
+
+Function WaitForPubSubHeartbeat()
+	variable i, foundHeart
+	string msg, filter
+
+	// wait until we get the first heartbeat
+	for(i = 0; i < 200; i += 1)
+		msg = zeromq_sub_recv(filter)
+		if(!cmpstr(filter, ZEROMQ_HEARTBEAT))
+			PASS()
+			return NaN
+		endif
+
+		Sleep/S 0.1
+	endfor
+
+	FAIL()
+End

Packages/Testing-MIES/UTF_IVSCC.ipf

@@ -21,23 +21,12 @@ End
 
 Function CheckThatPublishingWorks()
 	string msg, filter, expected, actual
-	variable found, i, jsonID, foundHeart
+	variable found, i, jsonID
 
 	zeromq_sub_add_filter("")
 	zeromq_sub_connect("tcp://127.0.0.1:" + num2str(ZEROMQ_BIND_PUB_PORT))
 
-	// wait until we get the first heartbeat
-	for(i = 0; i < 200; i += 1)
-		msg = zeromq_sub_recv(filter)
-		if(!cmpstr(filter, ZeroMQ_HEARTBEAT))
-			foundHeart += 1
-			break
-		endif
-
-		Sleep/S 0.1
-	endfor
-
-	CHECK(foundHeart > 0)
+	WaitForPubSubHeartbeat()
 
 	MIES_IVSCC#IVS_PublishQCState(123, "some text")
 

Packages/Testing-MIES/UTF_Main.ipf

@@ -23,6 +23,7 @@
 #include "UTF_WaveBuilder"
 #include "UTF_WaveBuilderRegression"
 #include "UTF_WaveVersioning"
+#include "UTF_Pressure"
 
 // include examples here so that these are compile tested as well
 #include "example-stimulus-set-api"
@@ -62,6 +63,7 @@ Function RunWithOpts([string testcase, string testsuite, variable allowdebug])
 	list = AddListItem("UTF_Labnotebook.ipf", list, ";", inf)
 	list = AddListItem("UTF_Macros.ipf", list, ";", inf)
 	list = AddListItem("UTF_PGCSetAndActivateControl.ipf", list, ";", inf)
+	list = AddListItem("UTF_Pressure.ipf", list, ";", inf)
 	list = AddListItem("UTF_StimsetAPI.ipf", list, ";", inf)
 	list = AddListItem("UTF_SweepFormula.ipf", list, ";", inf)
 	list = AddListItem("UTF_TraceUserData.ipf", list, ";", inf)

Packages/Testing-MIES/UTF_Pressure.ipf

@@ -0,0 +1,89 @@
+#pragma TextEncoding = "UTF-8"
+#pragma rtGlobals=3 // Use modern global access method and strict wave access.
+#pragma rtFunctionErrors=1
+#pragma ModuleName=PressureTests
+
+static Function TEST_CASE_BEGIN_OVERRIDE(string testname)
+
+	StartZeroMQSockets(forceRestart = 1)
+
+	zeromq_sub_add_filter("")
+	zeromq_sub_connect("tcp://127.0.0.1:" + num2str(ZEROMQ_BIND_PUB_PORT))
+End
+
+static Function TEST_CASE_END_OVERRIDE(string testname)
+
+	StartZeroMQSockets(forceRestart = 1)
+	zeromq_sub_add_filter("")
+End
+
+static Function CheckPressureStatePublishing()
+	string device, msg, filter, expected, actual
+	variable headstage, i, jsonID
+
+	WaitForPubSubHeartbeat()
+
+	device = "my_device"
+	headstage = 0
+
+	MIES_P#P_PublishPressureMethodChange(device, headstage, PRESSURE_METHOD_ATM, PRESSURE_METHOD_APPROACH)
+
+	for(i = 0; i < 100; i += 1)
+		msg = zeromq_sub_recv(filter)
+
+		if(!cmpstr(filter, PRESSURE_STATE_FILTER))
+			break
+		endif
+
+		Sleep/S 0.1
+	endfor
+
+	expected = PRESSURE_STATE_FILTER
+	actual   = filter
+	CHECK_EQUAL_STR(actual, expected)
+
+	jsonID = JSON_Parse(msg)
+
+	expected = MIES_P#P_PressureMethodToString(PRESSURE_METHOD_ATM)
+	actual   = JSON_GetString(jsonID, "/pressure method/old")
+	CHECK_EQUAL_STR(actual, expected)
+
+	expected = MIES_P#P_PressureMethodToString(PRESSURE_METHOD_APPROACH)
+	actual   = JSON_GetString(jsonID, "/pressure method/new")
+	CHECK_EQUAL_STR(actual, expected)
+
+	JSON_Release(jsonID)
+End
+
+static Function CheckPressureSealPublishing()
+	string device, msg, filter, expected, actual
+	variable headstage, i, jsonID, value
+
+	WaitForPubSubHeartbeat()
+
+	device = "my_device"
+	headstage = 0
+
+	MIES_P#P_PublishSealedState(device, headstage)
+
+	for(i = 0; i < 100; i += 1)
+		msg = zeromq_sub_recv(filter)
+
+		if(!cmpstr(filter, PRESSURE_SEALED_FILTER))
+			break
+		endif
+
+		Sleep/S 0.1
+	endfor
+
+	expected = PRESSURE_SEALED_FILTER
+	actual   = filter
+	CHECK_EQUAL_STR(actual, expected)
+
+	jsonID = JSON_Parse(msg)
+
+	value = JSON_GetVariable(jsonID, "/sealed")
+	CHECK_EQUAL_VAR(value, 1)
+
+	JSON_Release(jsonID)
+End