Skip to content

Add basic troubleshooting step when lock cannot be acquired #538

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add basic troubleshooting step when lock cannot be acquired #538

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45acfb0
Add basic troubleshooting step when lock cannot be acquired
bparks13 Oct 31, 2025
ed67822
Indicate that manually specifying voltage is not the first step
bparks13 Nov 3, 2025
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
5 changes: 3 additions & 2 deletions OpenEphys.Onix1/ConfigurePortController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ public override IObservable<ContextTask> Process(IObservable<ContextTask> source
.GetCustomAttribute<DescriptionAttribute>()?
.Description ?? "Address " + deviceAddress.ToString();
var message = portVoltage.Requested.HasValue ?
$"Unable to acquire communication lock on {portString}" :
$"Unable to acquire communication lock on {portString}. You may need to manually specify a PortVoltage greater than {PortVoltage.Applied} volts, the maximum automatic value for this device.";
$"Unable to acquire communication lock on {portString}. Confirm the headstage port is turned on." :
$"Unable to acquire communication lock on {portString}. Confirm the headstage port is turned on."
+ $"\n\nYou may need to manually specify a PortVoltage greater than {PortVoltage.Applied} volts, the maximum automatic value for this device.";
Copy link
Member

@cjsha cjsha Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wary to recommend applying a higher voltage than the maximum automatic value without caveats about how this should only need to be done in experiments that involve extra long/thin wires or something like that. But this might require more explanation than what we'd want in an exception dialog or whateva.

Copy link
Collaborator

@aacuevas aacuevas Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. It's a fine line between being informative enough and too verbose. And it's unfortunate that we cannot add working links to the dialog, so we cannot just link to an explanation website.

Copy link
Member Author

@bparks13 bparks13 Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we need to add a link so that we can move the nuance from the pop-up to a web browser, I can create a custom message box with a LinkLabel so we can link out to the documentation. That might be outside the scope of this current issue, but we can move the discussion to a new issue and work out the specifics there

Copy link
Member Author

@bparks13 bparks13 Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind, this message is being passed up to the Bonsai exception handler. Unable to create a custom message box


dispose();
throw new InvalidOperationException(message);
Expand Down