Merge branch 'main' into issue-97

Author: aacuevas

Source/Devices/AuxiliaryIO.cpp

@@ -29,6 +29,8 @@ using namespace OnixSourcePlugin;
 AuxiliaryIO::AuxiliaryIO(std::string name, std::string hubName, const oni_dev_idx_t analogIndex, const oni_dev_idx_t digitalIndex, std::shared_ptr<Onix1> oni_ctx)
 	: CompositeDevice(name, hubName, AuxiliaryIO::getCompositeDeviceType(), createAuxiliaryIODevices(hubName, analogIndex, digitalIndex, oni_ctx), oni_ctx)
 {
+	analogIO = getDevice<AnalogIO>(OnixDeviceType::ANALOGIO);
+	digitalIO = getDevice<DigitalIO>(OnixDeviceType::DIGITALIO);
 }
 
 // NB: This constructor assumes that the digitalIO device is located at one index above the analogIndex
@@ -47,11 +49,13 @@ OnixDeviceVector AuxiliaryIO::createAuxiliaryIODevices(std::string hubName, cons
 	return devices;
 }
 
-void AuxiliaryIO::processFrames()
+bool AuxiliaryIO::isEnabled() const
 {
-	auto analogIO = getAnalogIO();
-	auto digitalIO = getDigitalIO();
+	return analogIO->isEnabled();
+}
 
+void AuxiliaryIO::processFrames()
+{
 	if (!digitalIO->isEnabled() && !analogIO->isEnabled())
 	{
 		return;
@@ -99,10 +103,10 @@ CompositeDeviceType AuxiliaryIO::getCompositeDeviceType()
 
 std::shared_ptr<AnalogIO> AuxiliaryIO::getAnalogIO()
 {
-	return getDevice<AnalogIO>(OnixDeviceType::ANALOGIO);
+	return analogIO;
 }
 
 std::shared_ptr<DigitalIO> AuxiliaryIO::getDigitalIO()
 {
-	return getDevice<DigitalIO>(OnixDeviceType::DIGITALIO);
+	return digitalIO;
 }

Source/Devices/AuxiliaryIO.h

@@ -40,6 +40,8 @@ namespace OnixSourcePlugin
 
 		AuxiliaryIO(std::string name, std::string hubName, const oni_dev_idx_t analogIndex, const oni_dev_idx_t digitalIndex, std::shared_ptr<Onix1> oni_ctx);
 
+		bool isEnabled() const override;
+
 		static OnixDeviceType getDeviceType();
 		static CompositeDeviceType getCompositeDeviceType();
 
@@ -52,6 +54,9 @@ namespace OnixSourcePlugin
 
 		static OnixDeviceVector createAuxiliaryIODevices(std::string hubName, const oni_dev_idx_t analogIndex, const oni_dev_idx_t digitalIndex, std::shared_ptr<Onix1> oni_ctx);
 
+		std::shared_ptr<AnalogIO> analogIO;
+		std::shared_ptr<DigitalIO> digitalIO;
+
 		JUCE_LEAK_DETECTOR(AuxiliaryIO);
 	};
 }

Source/Devices/PortController.cpp

@@ -34,7 +34,64 @@ int PortController::configureDevice()
 {
 	if (deviceContext == nullptr || !deviceContext->isInitialized()) return 1;
 
-	return deviceContext->writeRegister(deviceIdx, (uint32_t)PortControllerRegister::ENABLE, 1);
+	return deviceContext->writeRegister(deviceIdx, (uint32_t)PortControllerRegister::ENABLE, 1u);
+}
+
+bool PortController::resetLinkFlags()
+{
+	if (deviceContext == nullptr || !deviceContext->isInitialized()) return false;
+
+	int rc = deviceContext->writeRegister(deviceIdx, (uint32_t)PortControllerRegister::LINKFLAGS, 0b11);
+	if (rc != ONI_ESUCCESS)
+	{
+		Onix1::showWarningMessageBoxAsync("Port Controller Error", "Unable to set the link flags for " + getName());
+		return false;
+	}
+
+	return true;
+}
+
+uint32_t PortController::getLinkFlags()
+{
+	uint32_t linkFlags;
+	int rc = deviceContext->readRegister(deviceIdx, (uint32_t)PortControllerRegister::LINKFLAGS, &linkFlags);
+
+	if (rc != ONI_ESUCCESS)
+	{
+		Onix1::showWarningMessageBoxAsync("Port Controller Error", "Unable to read the link flags for " + getName());
+		return false;
+	}
+
+	return linkFlags; 
+}
+
+bool PortController::updateSettings()
+{
+	return getLinkFlags() == 0; 
+}
+
+void PortController::addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers)
+{
+}
+
+std::string PortController::getPortNameString() const
+{
+	return OnixDevice::getPortName(port);
+}
+
+PortName PortController::getPort() const
+{
+	return port;
+}
+
+bool PortController::getErrorFlag()
+{
+	return errorFlag; 
+}
+
+double PortController::getLastVoltageSet() const
+{ 
+	return lastVoltageSet;
 }
 
 void PortController::startAcquisition()

Source/Devices/PortController.h

@@ -39,7 +39,8 @@ namespace OnixSourcePlugin
 		DESPWR = 2,
 		PORTVOLTAGE = 3,
 		SAVEVOLTAGE = 4,
-		LINKSTATE = 5
+		LINKSTATE = 5,
+		LINKFLAGS = 7,
 	};
 
 	enum class PortStatusCode : uint32_t
@@ -83,14 +84,10 @@ namespace OnixSourcePlugin
 		PortController(PortName port_, std::shared_ptr<Onix1> ctx_);
 
 		int configureDevice() override;
-
-		bool updateSettings() override { return true; }
-
+		bool updateSettings() override;
 		void startAcquisition() override;
-
 		void processFrames() override;
-
-		void addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers) override {};
+		void addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers) override;
 
 		void updateDiscoveryParameters(DiscoveryParameters parameters);
 
@@ -106,12 +103,20 @@ namespace OnixSourcePlugin
 
 		static DiscoveryParameters getHeadstageDiscoveryParameters(std::string headstage);
 
-		std::string getPortName() const { return OnixDevice::getPortName(port); }
+		std::string getPortNameString() const;
+
+		PortName getPort() const;
+
+		/** Check if the port status changed during acquisition and there is an error reported */
+		bool getErrorFlag();
+
+		double getLastVoltageSet() const;
 
-		/** Check if the port status changed and there is an error reported */
-		bool getErrorFlag() { return errorFlag; }
+		/** Writes to the link flags register to reset the flags. This should be called after headstages are locked. */
+		bool resetLinkFlags();
 
-		double getLastVoltageSet() const { return lastVoltageSet; }
+		/** Returns the link flags value, which is zero unless the lock or pass was lost outside of acquisition */
+		uint32_t getLinkFlags();
 
 	private:
 
@@ -135,7 +140,7 @@ namespace OnixSourcePlugin
 	{
 	public:
 		ConfigureVoltageWithProgressBar(DiscoveryParameters params, PortController* port)
-			: ThreadWithProgressWindow("Configuring voltage on " + port->getPortName(), true, false)
+			: ThreadWithProgressWindow("Configuring voltage on " + port->getPortNameString(), true, false)
 		{
 			m_params = params;
 			m_port = port;

Source/Onix1.h

@@ -35,7 +35,7 @@ namespace OnixSourcePlugin
 {
 	constexpr char* NEUROPIXELSV1F_HEADSTAGE_NAME = "Neuropixels 1.0f Headstage";
 	constexpr char* NEUROPIXELSV1E_HEADSTAGE_NAME = "Neuropixels 1.0e Headstage";
-	constexpr char* NEUROPIXELSV2E_HEADSTAGE_NAME = "Neuropixels 2.0 Headstage";
+	constexpr char* NEUROPIXELSV2E_HEADSTAGE_NAME = "Neuropixels 2.0e Headstage";
 	constexpr char* BREAKOUT_BOARD_NAME = "Breakout Board";
 
 	class error_t : public std::exception

Source/OnixDevice.cpp

@@ -153,9 +153,9 @@ int OnixDevice::getPortOffset(PortName port)
 	return (uint32_t)port << 8;
 }
 
-std::string OnixDevice::getPortName(int offset)
+std::string OnixDevice::getPortName(oni_dev_idx_t index)
 {
-	switch (offset)
+	switch (getOffset(index))
 	{
 	case 0:
 		return "";
@@ -173,11 +173,6 @@ std::string OnixDevice::getPortName(PortName port)
 	return getPortName(getPortOffset(port));
 }
 
-std::string OnixDevice::getPortName(oni_dev_idx_t index)
-{
-	return getPortName(getOffset(index));
-}
-
 PortName OnixDevice::getPortFromIndex(oni_dev_idx_t index)
 {
 	return index & (1 << 8) ? PortName::PortA : PortName::PortB;
@@ -270,6 +265,18 @@ bool CompositeDevice::compareIndex(uint32_t index)
 	return false;
 }
 
+bool CompositeDevice::isEnabled() const
+{
+	bool enabled = true;
+
+	for (const auto& device : devices)
+	{
+		enabled &= device->isEnabled();
+	}
+
+	return enabled;
+}
+
 bool CompositeDevice::isEnabled(uint32_t index)
 {
 	for (const auto& device : devices)
@@ -286,6 +293,14 @@ bool CompositeDevice::isEnabled(uint32_t index)
 	return false;
 }
 
+void CompositeDevice::setEnabled(bool newState)
+{
+	for (const auto& device : devices)
+	{
+		device->setEnabled(newState);
+	}
+}
+
 void CompositeDevice::setEnabled(uint32_t index, bool newState)
 {
 	for (const auto& device : devices)

Source/OnixDevice.h

@@ -168,8 +168,8 @@ namespace OnixSourcePlugin
 		virtual bool compareIndex(uint32_t index);
 
 		const std::string getName() { return name; }
-		bool isEnabled() const { return enabled; }
-		void setEnabled(bool newState) { enabled = newState; }
+		virtual bool isEnabled() const { return enabled; }
+		virtual void setEnabled(bool newState) { enabled = newState; }
 		oni_dev_idx_t getDeviceIdx(bool getPassthroughIndex = false);
 
 		/** Creates a stream name using the provided inputs, returning a string following the pattern: name[0]-name[1]-name[2]-etc., with all spaces removed */
@@ -187,7 +187,6 @@ namespace OnixSourcePlugin
 		void setHubName(std::string hubName) { m_hubName = hubName; }
 
 		static int getPortOffset(PortName port);
-		static std::string getPortName(int offset);
 		static std::string getPortName(PortName port);
 		static std::string getPortName(oni_dev_idx_t index);
 		static PortName getPortFromIndex(oni_dev_idx_t index);
@@ -250,7 +249,9 @@ namespace OnixSourcePlugin
 		CompositeDeviceType getCompositeDeviceType() const;
 
 		bool compareIndex(uint32_t index) override;
+		bool isEnabled() const override;
 		bool isEnabled(uint32_t index);
+		void setEnabled(bool newState) override;
 		void setEnabled(uint32_t index, bool newState);
 		int configureDevice() override;
 		bool updateSettings() override;