ephys_link.common

Commonly used functions and dictionaries

Contains globally used helper functions and typed dictionaries (to be used as callback parameters)

Functions

dprint	Print message if debug is enabled
set_debug	Set debug flag

Classes

CanWriteInputDataFormat	Data format for server.set_can_write()
DriveToDepthInputDataFormat	Data format for server.drive_to_depth()
DriveToDepthOutputData	Output format for depth driving (depth, error)
GetManipulatorsOutputData	Output format for (manipulators)
GotoPositionInputDataFormat	Data format for server.goto_pos()
InsideBrainInputDataFormat	Data format for server.set_inside_brain()
PositionalOutputData	Output format for (position, error)
StateOutputData	Output format for (state, error)

set_debug(debug: bool) → None

Set debug flag

Parameters:

debug (bool) – True to enable debug mode, False to disable

Returns:

None

dprint(message: str) → None

Print message if debug is enabled

Parameters:

message (str) – Message to print

Returns:

None

class GotoPositionInputDataFormat

Bases: TypedDict

Data format for server.goto_pos()

manipulator_id: str

pos: list[float]

speed: int

class InsideBrainInputDataFormat

Bases: TypedDict

Data format for server.set_inside_brain()

manipulator_id: str

inside: bool

class DriveToDepthInputDataFormat

Bases: TypedDict

Data format for server.drive_to_depth()

manipulator_id: str

depth: float

speed: int

class CanWriteInputDataFormat

Bases: TypedDict

Data format for server.set_can_write()

manipulator_id: str

can_write: bool

hours: float

class GetManipulatorsOutputData(manipulators: list, error: str)

Bases: dict

Output format for (manipulators)

Parameters:

• manipulators (list) – Tuple of manipulator IDs (as strings)

• error (str) – Error message

Example:

Example generated dictionary {"manipulators": ["1", "2"], "error": ""}

class PositionalOutputData(position: list, error: str)

Bases: dict

Output format for (position, error)

Parameters:

• position (list) – Position in mm (as a tuple, can be empty tuple)

• error (str) – Error message

Example:

Example generated dictionary {"position": [10429, 12332, 2131, 12312], "error": ""}

class DriveToDepthOutputData(depth: float, error: str)

Bases: dict

Output format for depth driving (depth, error)

Parameters:

• depth (float) – Depth

• error (str) – Error message

Example:

Example generated dictionary {"depth": 123, "error": ""}

class StateOutputData(state: bool, error: str)

Bases: dict

Output format for (state, error)

Parameters:

• state (bool) – State of the event

• error (str) – Error message

Example:

Example generated dictionary {"state": True, "error": ""}