Skip to content

Commit c48fc1c

Browse files
kjy5Copilot
andauthored
Fix sensapex lib location (#504)
* Fix um.dll and update deps * Fix docs build warnings * Update docs/development/jackhammer_mode.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent a31b5b3 commit c48fc1c

File tree

7 files changed

+19
-20
lines changed

7 files changed

+19
-20
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ __pycache__/
55

66
# C extensions
77
*.so
8-
!libum.so
8+
!um.so
99

1010
# Distribution / packaging
1111
.Python

docs/development/adding_a_manipulator.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ As described in the [system overview](../home/how_it_works.md), Ephys Link conve
2828
common "unified space" which is
2929
the [left-hand cartesian coordinate system](https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/coordinate-systems.html).
3030
The two methods [
31-
`platform_space_to_unified_space`](../../reference/ephys_link/utils/base_binding/#ephys_link.utils.base_binding.BaseBinding.platform_space_to_unified_space)
31+
`platform_space_to_unified_space`](../reference/ephys_link/utils/base_binding.md#ephys_link.utils.base_binding.BaseBinding.platform_space_to_unified_space)
3232
and [
33-
`unified_space_to_platform_space`](../../reference/ephys_link/utils/base_binding/#ephys_link.utils.base_binding.BaseBinding.unified_space_to_platform_space)
33+
`unified_space_to_platform_space`](../reference/ephys_link/utils/base_binding.md#ephys_link.utils.base_binding.BaseBinding.unified_space_to_platform_space)
3434
are used to convert between your manipulator's coordinate system and the unified space.
3535

3636
!!! tip
@@ -44,9 +44,9 @@ are used to convert between your manipulator's coordinate system and the unified
4444
### Binding Names
4545

4646
The two naming methods [
47-
`get_display_name`](../../reference/ephys_link/utils/base_binding/#ephys_link.utils.base_binding.BaseBinding.get_display_name)
47+
`get_display_name`](../reference/ephys_link/utils/base_binding.md#ephys_link.utils.base_binding.BaseBinding.get_display_name)
4848
and [
49-
`get_cli_name`](../../reference/ephys_link/utils/base_binding/#ephys_link.utils.base_binding.BaseBinding.get_cli_name)
49+
`get_cli_name`](../reference/ephys_link/utils/base_binding.md#ephys_link.utils.base_binding.BaseBinding.get_cli_name)
5050
are used to identify the binding in the user interface. As described by their documentation, `get_display_name` should
5151
return a human-readable name for the binding, while `get_cli_name` should return the name used to launch the binding
5252
from the command line (what is passed to the `-t` flag). For example, Sensapex uMp-4 manipulator's `get_cli_name`

docs/development/jackhammer_mode.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ pip install .
1616

1717
## 2. Change the Sensapex SDK to support Jackhammer Mode
1818

19-
You need to replace the `libum.dll` file in the Sensapex library folder. This is located at `<virtual env>\Lib\site-packages\sensapex`. If you made a virtual environment named `venv` in the previous step, it would be `.\venv\Lib\site-packages\sensapex`.
19+
You need to replace the `um.dll` file in the Sensapex library folder. This is located at `<virtual env>\Lib\site-packages\sensapex`. If you made a virtual environment named `venv` in the previous step, it would be `.\venv\Lib\site-packages\sensapex`.
2020

21-
1. Download the custom SDK [here](../assets/libum.dll).
22-
2. (Optional) Make a backup of the old `libum.dll` in the Sensapex library folder by renaming it to `libum.dll.bck` or something like that.
23-
3. Copy the downloaded `libum.dll` to the Sensapex library folder.
21+
1. Download the custom SDK [here](../assets/um.dll).
22+
2. (Optional) Make a backup of the old `um.dll` in the Sensapex library folder by renaming it to `um.dll.bck` or something like that.
23+
3. Copy the downloaded `um.dll` to the Sensapex library folder.
2424
4. Modify `sensapex.py` in the Sensapex library folder to enable using this custom DLL. Set the `max_version` variable at line `398` to `(1, 510)`.
2525

2626
You can (optionally) test if everything is still working by [running Ephys Link](../usage/starting_ephys_link.md) and checking to see if it can still see and control Sensapex manipulators.

ephys_link.spec

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# -*- mode: python ; coding: utf-8 -*-
21

32
from argparse import ArgumentParser
43
from importlib import resources
@@ -17,15 +16,15 @@ FILE_NAME = f"EphysLink-v{version}"
1716
bindings = [binding for binding in collect_submodules("ephys_link.bindings") if binding != "ephys_link.bindings"]
1817

1918
# Collect Sensapex SDK.
20-
ump_sdk_path = str(resources.files('sensapex').joinpath('libum.dll'))
19+
ump_sdk_path = str(resources.files('sensapex').joinpath('um.dll'))
2120

2221
# noinspection PyUnresolvedReferences
2322
a = Analysis(
2423
['src\\ephys_link\\__main__.py'],
2524
pathex=[],
2625
binaries=[(ump_sdk_path, 'sensapex')],
2726
datas=[],
28-
hiddenimports=['engineio.async_drivers.aiohttp'] + bindings,
27+
hiddenimports=['engineio.async_drivers.aiohttp', *bindings],
2928
hookspath=[],
3029
hooksconfig={},
3130
runtime_hooks=[],

pyproject.toml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ exclude = ["/.github", "/.idea", "/docs"]
5858
installer = "uv"
5959
python = "3.14"
6060
dependencies = [
61-
"pyinstaller==6.16.0",
62-
"basedpyright==1.32.1",
63-
"pytest==8.4.2",
61+
"pyinstaller==6.17.0",
62+
"basedpyright==1.36.2",
63+
"pytest==9.0.2",
6464
"pytest-cov==7.0.0",
6565
"pytest-mock==3.15.1",
66-
"pytest-asyncio==1.2.0"
66+
"pytest-asyncio==1.3.0"
6767
]
6868
[tool.hatch.envs.default.scripts]
6969
exe = "pyinstaller.exe ephys_link.spec -y -- -d && pyinstaller.exe ephys_link.spec -y"
@@ -78,9 +78,9 @@ installer = "uv"
7878
python = "3.14"
7979
skip-install = true
8080
dependencies = [
81-
"mkdocs-material==9.6.19",
82-
"mkdocstrings-python==1.18.2",
83-
"mkdocs-gen-files==0.5.0",
81+
"mkdocs-material==9.7.1",
82+
"mkdocstrings-python==2.0.1",
83+
"mkdocs-gen-files==0.6.0",
8484
"mkdocs-literate-nav==0.6.2",
8585
"mkdocs-section-index==0.3.10"
8686
]

src/ephys_link/__about__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "2.2.0"
1+
__version__ = "2.2.1"

0 commit comments

Comments
 (0)