Skip to content

Commit a3352fa

Browse files
committed
update software install instructions.
1 parent a6170b9 commit a3352fa

File tree

1 file changed

+92
-4
lines changed

1 file changed

+92
-4
lines changed

README.md

Lines changed: 92 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,96 @@ Possible capture examples:
9191

9292
There are 2 tools currently and a few dependencies required to deploy a MISRC.
9393

94+
- hsdaoh Driver
9495
- MISRC Capture
9596
- MISRC Extract
9697

98+
> [!WARNING]
99+
> The main hsdaoh branch (steve-m) does not have the required changes merged yet, ensure the above liked repo is used for install or your application will not build.
100+
101+
102+
<details closed>
103+
104+
<summary>hsdaoh Driver Install Linux</summary>
105+
<br>
106+
107+
To install the build dependencies on a distribution based on Debian (e.g. Ubuntu), run the following command:
108+
109+
sudo apt-get install build-essential cmake pkgconf libusb-1.0-0-dev libuvc-dev
110+
111+
To build hsdaoh:
112+
113+
git clone https://github.com/Stefan-Olt/hsdaoh.git
114+
mkdir hsdaoh/build
115+
cd hsdaoh/build
116+
cmake ../ -DINSTALL_UDEV_RULES=ON
117+
make -j 4
118+
sudo make install
119+
sudo ldconfig
120+
121+
To be able to access the USB device as non-root, the udev rules need to be installed (either use -DINSTALL_UDEV_RULES=ON or manually copy hsdaoh.rules to /etc/udev/rules.d/).
122+
123+
Before being able to use the device as a non-root user, the udev rules need to be reloaded:
124+
125+
sudo udevadm control -R
126+
sudo udevadm trigger
127+
128+
Furthermore, make sure your user is a member of the group 'plugdev'.
129+
To make sure the group exists and add your user to it, run:
130+
131+
sudo groupadd plugdev
132+
sudo usermod -a -G plugdev <your username>
133+
134+
If you haven't already been a member, you need to logout and login again for the group membership to become effective.
135+
136+
137+
</details>
138+
139+
140+
<details closed>
141+
142+
<summary>hsdaoh Driver Install Windows</summary>
143+
<br>
144+
145+
**Currently, this is highly experimental, noted here for testing and is not production implimented yet!**
146+
147+
Firstly download [Zadig](https://zadig.akeo.ie/) to force the installation of `WinUSB` driver on your MS2130/MS2131 adapter.
148+
149+
Install MSYS2 (https://www.msys2.org/)
150+
151+
Start `MSYS2 MINGW64` terminal from the application menu. (Blue Icon)
152+
153+
Update all packages:
154+
155+
pacman -Suy
156+
157+
Install the required dependencies:
158+
159+
pacman -S git zip mingw-w64-x86_64-libusb mingw-w64-x86_64-libwinpthread mingw-w64-x86_64-cc \ mingw-w64-x86_64-gcc-libs mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja
160+
161+
Clone & Build libuvc:
162+
163+
git clone https://github.com/steve-m/libuvc.git
164+
mkdir libuvc/build && cd libuvc/build
165+
cmake ../ -DCMAKE_INSTALL_PREFIX:PATH=/mingw64
166+
cmake --build .
167+
cmake --install .
168+
169+
Build libhsdaoh
170+
171+
cd ~
172+
git clone https://github.com/steve-m/hsdaoh.git
173+
mkdir hsdaoh/build && cd hsdaoh/build
174+
cmake ../
175+
cmake --build .
176+
177+
Gather all files required for release:
178+
179+
zip -j hsdaoh_win_release.zip src/*.exe src/*.dll /mingw64/bin/libusb-1.0.dll /mingw64/bin/libuvc.dll /mingw64/bin/libwinpthread-1.dll
180+
181+
182+
</details>
183+
97184
<details closed>
98185

99186
<summary>Software Install</summary>
@@ -105,10 +192,9 @@ Tested and built on Linux Mint 21.03 and 22 / Ubuntu 22.04
105192
First install dependencies
106193

107194
- `apt install libflac-dev`
108-
- Install [hsdaoh](https://github.com/Stefan-Olt/hsdaoh) this allows you to use the MS2130 & MS2131 chips directly.
195+
- `hsdaoh driver`
109196

110-
> [!CAUTION]
111-
> The main hsdaoh branch does not have the required changes merged yet, ensure the above liked repo is used for install or your application will not build.
197+
These allow you to use the MS2130 & MS2131 chips directly.
112198

113199
Restart and then continue
114200

@@ -137,8 +223,10 @@ There is a dedicated [sub-readme](/misrc_tools/README.md) for these tools.
137223

138224
</details>
139225

140-
<details closed>
141226

227+
</details>
228+
229+
<details closed>
142230
<summary>Firmware Flashing </summary>
143231
<br>
144232

0 commit comments

Comments
 (0)