Skip to content

Commit fda2442

Browse files
authored
Merge pull request #7234 from keveleigh/remoting-docs
Add some docs around various HL2 remoting troubleshooting scenarios and getting help
2 parents f784c6a + 40770c1 commit fda2442

File tree

5 files changed

+46
-3
lines changed

5 files changed

+46
-3
lines changed

Documentation/GettingStartedWithTheMRTK.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,13 @@ Here are some suggested next steps:
186186
* Learn about the [MRTK's Tools](../README.md#tools) that will empower your mixed reality design and development.
187187
* Read through [input simulation guide](InputSimulation/InputSimulationService.md) to learn how to simulate hand input in editor.
188188

189+
## Getting help
190+
191+
If you run into issues caused by MRTK or otherwise have questions about how to do something, there are a few resources that can help:
192+
193+
* For bug reports, please [file an issue](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/new/choose) on the GitHub repo.
194+
* For questions, please reach out on either [StackOverflow](https://stackoverflow.com/questions/tagged/mrtk) or the [mixed-reality-toolkit channel](https://holodevelopers.slack.com/messages/C2H4HT858) on Slack. You can join the Slack community via the [automatic invitation sender](https://holodevelopersslack.azurewebsites.net/).
195+
189196
## Upgrading from the HoloToolkit (HTK/MRTK v1)
190197

191198
There is not a direct upgrade path from the HoloToolkit to Mixed Reality Toolkit v2 due to the rebuilt framework. However, it is possible to import the MRTK into your HoloToolkit project and migrate your implementation. For more information, see the [HoloToolkit to Mixed Reality Toolkit Porting Guide](HTKToMRTKPortingGuide.md)
12.8 KB
Loading
3.59 KB
Loading
19.4 KB
Loading

Documentation/Tools/HolographicRemoting.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ To enable remoting to a HoloLens, it is important to ensure that the project is
1010
- Verify that latest version of the **Windows Mixed Reality** package is installed.
1111
1. Ensure the latest Holographic Remoting application is installed, on the HoloLens, via the Microsoft Store.
1212

13+
### HoloLens 2
14+
1315
When using a HoloLens 2, support for remoting articulated hand and eye tracking data has been added to MRTK. To enable these features,
1416
configure the project using the following steps.
1517

@@ -21,6 +23,40 @@ configure the project using the following steps.
2123
1. Ensure that **Enable MSBuild for Unity** is selected
2224
1. Click **Apply**
2325

26+
### Debugging HoloLens 2 remoting via Unity package import
27+
28+
If HoloLens 2 hand joints and eye tracking aren't working over remoting, there are three common points of potential issues. They're listed below in the order they should be checked.
29+
30+
#### MSBuildForUnity package import via writing into the package.manifest
31+
32+
For the first point, the best way to check is to open Window -> Package Manager and make sure MSBuild for Unity shows up in the packages list. If it's there, assume this step succeeded. If it's not there, try running Mixed Reality Toolkit -> Utilities -> Configure Unity and repeat the steps above for running the MRTK Configurator.
33+
34+
![MSB4U Package Manager](../Images/Tools/Remoting/MSB4UPackageManager.png)
35+
36+
#### DotNetWinRT NuGet package resolution
37+
38+
For the second point, the best way to check is to search the Assets folder for DotNetWinRT.dll. If this doesn't exist, navigate to MixedRealityToolkit.Providers / WindowsMixedReality / Shared / DotNetAdapter in the Project view and select DotNetAdapter.csproj. Assuming part 1 did succeed, there should be a custom inspector with Build, Rebuild, and Clean buttons. Try clicking Build or Rebuild, and then re-search for DotNetWinRT.dll. If that DLL now exists, this step succeeded.
39+
40+
![DotNetAdapter Inspector](../Images/Tools/Remoting/DotNetAdapterInspector.png)
41+
42+
#### `DOTNETWINRT_PRESENT` #define written into player settings
43+
44+
For the third point, navigate to the Unity Player Settings. From there, under the UWP tab, check under Other Settings for the Scripting Define Symbols. Make sure DOTNETWINRT_PRESENT is properly written in that list. If that's there, this step succeeded.
45+
46+
![DotNetWinRT Present](../Images/Tools/Remoting/DotNetWinRTPresent.png)
47+
48+
After all three of those, hand joints over remoting should be working! If not, there might be something misconfigured in the profiles for general hand joints on-device. In that case, please [reach out on one of our help resources](../GettingStartedWithTheMRTK.md#getting-help).
49+
50+
### Removing HoloLens 2-specific remoting support
51+
52+
If you're running into conflicts or other issues due to the presence of the DotNetWinRT adapter, please [reach out on one of our help resources](../GettingStartedWithTheMRTK.md#getting-help).
53+
54+
You can also temporarily remove the adapter to workaround your issue via the following steps:
55+
56+
1. In Unity, go to Window -> Package Manager and uninstall MSBuild for Unity
57+
1. Search for DotNetWinRT.dll in your assets list in Unity and either delete the DLL or delete the Plugins (MRTK 2.2 or earlier) or Dependencies (MRTK 2.3 or later) folder that contains it a few levels up. That should remove these conflicting namespaces, while keeping MRTK around
58+
1. If you run the MRTK Configurator again, make sure you don't re-enable MSBuild for Unity
59+
2460
## Connecting to the HoloLens
2561

2662
Once the project has been configured, a connection can be established to the HoloLens.
@@ -44,17 +80,17 @@ Once the project has been configured, a connection can be established to the Hol
4480
![Enter IP Address](../Images/Tools/Remoting/EnterIPAddress.png)
4581

4682
1. Click **Connect**.
47-
> [!Note]
48-
> If you cannot connect, make sure your HoloLens2 is not plugged in and restart Unity.
4983

84+
> [!NOTE]
85+
> If you cannot connect, make sure your HoloLens 2 is not plugged in to your PC and restart Unity.
5086
5187
## Starting a remoting session
5288

5389
With Unity connected to the HoloLens, enter play mode in the editor.
5490

5591
When the session is complete, exit play mode.
5692

57-
> [!Note]
93+
> [!NOTE]
5894
> There is a known issue with some versions of Unity where the editor may hang upon entering play mode during a remoting session. This issue may manifest if the Holographic window is open when the project is loaded. To ensure this issue does not occur, always close the Holographic dialog prior to exiting Unity.
5995
6096
## See also

0 commit comments

Comments
 (0)