Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added license to OpenFlexure project #487

Merged
merged 7 commits into from
Sep 27, 2024
Merged

Added license to OpenFlexure project #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
df24d1e
Added license to OpenFlexure.h
samdrea Aug 31, 2024
42000b5
Added license to OpenFlexure.cpp
samdrea Aug 31, 2024
50be5ca
added board test during initialization
samdrea Sep 23, 2024
9485c87
Merge branch 'pr' of https://github.com/samdrea/mmCoreAndDevices into pr
samdrea Sep 23, 2024
6aeac35
Merge branch 'micro-manager:main' into pr
samdrea Sep 23, 2024
86716b5
fixed license and added board test during initialization
samdrea Sep 23, 2024
295bb10
Merge branch 'pr' of https://github.com/samdrea/mmCoreAndDevices into pr
samdrea Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 36 additions & 13 deletions DeviceAdapters/OpenFlexure/OpenFlexure.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
//////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// FILE: OpenFlexure.cpp
// PROJECT: Micro-Manager
// SUBSYSTEM: DeviceAdapters
//-----------------------------------------------------------------------------
// DESCRIPTION: Adapter for the OpenFlexure Microscope. This adapter is used on the v5 Sangaboard.
// DESCRIPTION: Adapter for the OpenFlexure Microscope. This adapter is used on the v5 Sangaboard.
// - Tested with Sangaboard Firmware v1.0.1-dev || Sangaboard v0.5.x
//
// AUTHOR: Samdrea Hsu, [email protected], 09/23/2024
//
// COPYRIGHT: Samdrea Hsu
//
// AUTHOR: Samdrea Hsu, [email protected], 06/22/2024
// LICENSE: This file is distributed under the BSD license.
// License text is included with the source distribution.
//
// This file is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
//
//////////////////////////////////////////////////////////////////////////////

Expand Down Expand Up @@ -72,7 +84,8 @@ SangaBoardHub::SangaBoardHub() : initialized_(false), port_("Undefined"), portAv

// Pre-initialization property: port name
CPropertyAction* pAct = new CPropertyAction(this, &SangaBoardHub::OnPort);
CreateProperty(MM::g_Keyword_Port, "Undefined", MM::String, false, pAct, true);
int ret = CreateProperty(MM::g_Keyword_Port, "Undefined", MM::String, false, pAct, true);

}

SangaBoardHub::~SangaBoardHub()
Expand All @@ -82,24 +95,33 @@ SangaBoardHub::~SangaBoardHub()

int SangaBoardHub::Initialize()
{
// Send a command to check if Sangaboard is connected
SendCommand("version", _serial_answer); // Example response is "Sangaboard v0.5.x"

// Check if the response contains "Sangaboard"
if (_serial_answer.find("Sangaboard") == std::string::npos) {
// If not found, return an error code
return DEVICE_NOT_CONNECTED;
}

initialized_ = true;

// Set up Manual Command Interface to send command directly to SangaBoard
CPropertyAction* pCommand = new CPropertyAction(this, &SangaBoardHub::OnManualCommand);
int ret = CreateProperty(g_Keyword_Command, "", MM::String, false, pCommand);
assert(DEVICE_OK == ret);
if (DEVICE_OK != ret) return DEVICE_CAN_NOT_SET_PROPERTY;

// Set up property to display most recent serial response (read-only)
ret = CreateProperty(g_Keyword_Response, "", MM::String, false);
assert(DEVICE_OK == ret);
if (DEVICE_OK != ret) return DEVICE_CAN_NOT_SET_PROPERTY;

// Initialize the cache values to the current values stored on hardware
this->SyncState();

// Set up Step Delay property for changing velocity
CPropertyAction* pStepDel = new CPropertyAction(this, &SangaBoardHub::OnStepDelay);
ret = CreateIntegerProperty(g_Keyword_StepDelay, step_delay_, false, pStepDel);
assert(DEVICE_OK == ret);
if (DEVICE_OK != ret) return DEVICE_CAN_NOT_SET_PROPERTY;
AddAllowedValue(g_Keyword_StepDelay, "1000");
AddAllowedValue(g_Keyword_StepDelay, "2000");
AddAllowedValue(g_Keyword_StepDelay, "3000");
Expand All @@ -109,7 +131,7 @@ int SangaBoardHub::Initialize()
// Set up Ramp Time property for changing acceleration
CPropertyAction* pRampTime = new CPropertyAction(this, &SangaBoardHub::OnRampTime);
ret = CreateIntegerProperty(g_Keyword_RampTime, ramp_time_, false, pRampTime);
assert(DEVICE_OK == ret);
if (DEVICE_OK != ret) return DEVICE_CAN_NOT_SET_PROPERTY;
AddAllowedValue(g_Keyword_RampTime, "0", 0);
AddAllowedValue(g_Keyword_RampTime, "100000"); // Not really sure if these values really do much for acceleration...
AddAllowedValue(g_Keyword_RampTime, "200000");
Expand All @@ -118,7 +140,7 @@ int SangaBoardHub::Initialize()
// Set up extra functions drop down menu
CPropertyAction* pExtras= new CPropertyAction(this, &SangaBoardHub::OnExtraCommands);
ret = CreateStringProperty(g_Keyword_Extras, g_Keyword_None, false, pExtras);
assert(DEVICE_OK == ret);
if (DEVICE_OK != ret) return DEVICE_CAN_NOT_SET_PROPERTY;
AddAllowedValue(g_Keyword_Extras, g_ExtraCommand_Stop);
AddAllowedValue(g_Keyword_Extras, g_ExtraCommand_Zero);
AddAllowedValue(g_Keyword_Extras, g_ExtraCommand_Release);
Expand Down Expand Up @@ -321,7 +343,8 @@ int SangaBoardHub::SendCommand(std::string cmd, std::string& ans)
}

// Reflect the command in the serial response property
SetProperty(g_Keyword_Response, ans.c_str());
ret = SetProperty(g_Keyword_Response, ans.c_str());
if (DEVICE_OK != ret) return DEVICE_CAN_NOT_SET_PROPERTY;

return DEVICE_OK;

Expand Down Expand Up @@ -447,7 +470,7 @@ int XYStage::Initialize()
std::string cmd = "blocking_moves false";
pHub->SendCommand(cmd, _serial_answer);
if (_serial_answer.find("done") == -1) {
return DEVICE_ERR;
return DEVICE_SERIAL_INVALID_RESPONSE;
}

// Set the current stage position
Expand Down Expand Up @@ -653,7 +676,7 @@ int ZStage::Initialize()
std::string cmd = "blocking_moves false";
pHub->SendCommand(cmd, _serial_answer);
if (_serial_answer.find("done") == -1) {
return DEVICE_ERR;
return DEVICE_SERIAL_INVALID_RESPONSE;
}

// Set the current stagePosition
Expand Down Expand Up @@ -940,4 +963,4 @@ int LEDIllumination::SetBrightness()
pHub->SendCommand(cmd, _serial_answer);

return DEVICE_OK;
}
}
18 changes: 15 additions & 3 deletions DeviceAdapters/OpenFlexure/OpenFlexure.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
//////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
// FILE: OpenFlexure.h
// PROJECT: Micro-Manager
// SUBSYSTEM: DeviceAdapters
//-----------------------------------------------------------------------------
// DESCRIPTION: Adapter for the OpenFlexure Microscope. This adapter is used on the v5 Sangaboard.
// DESCRIPTION: Adapter for the OpenFlexure Microscope. This adapter is used on the v5 Sangaboard.
// - Tested with Sangaboard Firmware v1.0.1-dev || Sangaboard v0.5.x
//
// AUTHOR: Samdrea Hsu, [email protected], 09/23/2024
//
// COPYRIGHT: Samdrea Hsu
//
// AUTHOR: Samdrea Hsu, [email protected], 06/22/2024
// LICENSE: This file is distributed under the BSD license.
// License text is included with the source distribution.
//
// This file is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
//
//////////////////////////////////////////////////////////////////////////////

Expand Down