Documentation du package de données spatiales de la réalité mixteMixed Reality Spatial Data Packager Documentation

Notes

DÉPRÉCIÉDEPRECATED

À partir de 8/1/2020 cet outil est désormais déconseillé et ne fonctionne plus sur les plateformes.As of 8/1/2020 this tool is now deprecated and no longer functions on any platform. Nous vous recommandons plutôt d’utiliser l’outil Gestionnaire de cartes dans le portail de l’appareil.We recommend using the Map Manager tool in the Device Portal instead.

Cet outil et son fonctionnement sont proposés tels quels.This tool and its operation are offered as-is. Elle est sujette à modification sans aucun préavis et peut ne pas être compatible avec les futures versions de Windows ou de Windows Mixed Reality HMD.It is subject to change without any notice and may not be compatible with future Windows or Windows Mixed Reality HMD releases.

TéléchargerDownload

Téléchargez MixedRealitySpatialDataPackager iciDownload MixedRealitySpatialDataPackager here

Prise en charge des appareilsDevice support

FonctionnalitéFeature HoloLens (1ère génération)HoloLens (1st gen) HoloLens 2HoloLens 2 Casques immersifsImmersive headsets
Package de données spatiales de réalité mixteMixed Reality Spatial Data Packager ✔️✔️

Démarrage rapideQuickstart

L’outil mélangeur de données spatiales de réalité mixte copie les données spatiales d’une application cible d’un ordinateur vers un autre à l’aide d’un processus d’exportation et d’importation en deux étapes.The Mixed Reality Spatial Data Packager tool copies the spatial data of a target app from one PC to another through a two step export and import process. L’outil doit être exécuté avec des privilèges d’administrateur et supprimer les données spatiales existantes lors de l’importation.The tool must be run with administrator privileges and deletes the existing spatial data on import. L’exportation laisse les données spatiales existantes intactes.Export leaves the existing spatial data intact.

Principales exigences et limitations :Key requirements and limitations:

  1. L’outil doit être exécuté avec des privilèges d’administrateurTool must be run with administrator privileges
  2. Vous devrez peut-être redémarrer le PC si le portail de réalité mixte est instable après l’exécution de l’outilYou may have to restart PC if Mixed Reality Portal is unstable after running the tool
  3. L’outil ne s’exécute pas quand des incompatibilités ou des incompatibilités de version de données spatiales sont rencontréesTool will not run when encountering spatial data version mismatches or incompatibilities
  4. L’outil efface les données spatiales existantes lors de l’importationTool will erase existing spatial data on import
  5. En cas d’échec du processus d’importation, les données précédentes ne peuvent pas être restaurées, sauf si elles ont été sauvegardées en l’exportant précédemmentIf import process fails previous data cannot be restored unless it has been backed up by exporting previously
  6. La qualité de la fonctionnalité d’importation est subordonné au mode « lecture seule » pour les données cartographiques spatialesQuality of import functionality contingent on “Read-Only” mode for spatial map data

Meilleures pratiques de mappageMapping Best Practices

  1. Effacer les mappages existants dans le panneau de configuration (paramètres-> réalité mixte-> environnement-> effacer les données d’environnement)Clear existing maps from the Control Panel (Settings -> Mixed Reality -> Environment -> Clear environment data)
  2. Garantir un éclairage suffisant pour un bon suivi et si l’exécution du mode de mappage verrouillé tente de maintenir le même éclairageEnsure sufficient lighting for good tracking and if running locked map mode try to maintain the same lighting
  3. Lorsque cela est possible, conservez la plage dynamique d’éclairage en évitant les zones d’éclairage élevé en regard des zones masquées et sombresWhen possible keep the lighting dynamic range low by avoiding areas of high illumination next to dark, shadowed areas
  4. Réduire les surfaces vides et sans texture, par exemple placer une plage de différentes affiches sur des murs blancsMinimize blank, textureless surfaces e.g. place a range of different posters on white walls
  5. Mapper l’espace sans objets dynamiques dans la scène, tels que le déplacement de personnesMap the space without dynamic objects in the scene such as moving people
  6. Verrouiller la carte lors de l’importation (disponible par le biais de la version préliminaire d’Insider)Lock the map on import (available via Insider Preview)
  7. Déverrouillez la carte et relancez l’analyse de l’environnement en cas de dégradation de la qualité et/ou d’évolution de l’environnement (éclairage ou modifications dans la disposition des objets).Unlock the map and rescan the environment when tracking quality degrades and/or there are changes in the environment (lighting or changes in object layout)

Exécution d’un package de données spatiales de réalité mixte avec un script compagnonRunning Mixed Reality Spatial Data Packager with Companion Script

Nous avons fourni MRSpatialPackagerHelperScript.ps1 qui exécute les outils de mappage de package.We have provided MRSpatialPackagerHelperScript.ps1 that runs the map packager the tools.

Les paramètres de script sont définis ci-dessous :The script parameters are defined below:

-AppName <String>
    On export: The spatial anchors from the app of interest
    On import: The target app that spatial anchors should be imported for
    Returns a list of apps containing the input string if a unique app is not found

-UserName <String>
    Target username, will return a list of users if a unique match is not found

-Mode <String>
    import or export

-MapxPath <String>
    On export: Directory to export your mapx files
    On import: Directory where import mapx are stored

-LockMap <Int32>
    0 to unlock map
    1 to lock map

-BinPath <String>
    Path to MixedRealitySpatialDataPackager.exe, default value is current directory

Utilisation et sortie de l’exemple de script PowerShellPowershell Script Example Usage and Output

.\MRSpatialPackagerHelperScript.ps1-AppName holoshell-nom_utilisateur mode administrateur Export-MapxPath D:\temp-LockMap 0.\MRSpatialPackagerHelperScript.ps1 -AppName holoshell -UserName Administrator -Mode export -MapxPath D:\temp\ -LockMap 0

Package Family Name for holoshell: HoloShell_cw5n1h2txyewy
User SID for Administrator: S-1-5-21-1279937937-3984375698-1043392598-499
Lock map value successfully set to 0

Running: C:\bin\MixedRealitySpatialDataPackager.exe export D:\temp\ HoloShell_cw5n1h2txyewy S-1-5-21-1279937937-3984375698-1043392598-499

Attempting to disable Windows MR driver
Driver disabled
Validating spatial data version information...
Device spatial data version OK
External spatial data version OK
Importing spatial anchors for user account phguan
Stopping SPECTRUM
Stopped SPECTRUM
Stopping SHAREDREALITYSVC
Stopped SHAREDREALITYSVC
Space ID is {00000000-4321-0000-0000-000000000000}
SUCCESS: Unpacked Space from D:\temp\map\het.mapx to
C:\ProgramData\WindowsHolographicDevices\SpatialStore\HoloLensSensors\{00000000-4321-0000-0000-000000000000}\
Space ID is {78FA06B5-4416-4815-BB00-B3CB5C983B7D}
SUCCESS: Unpacked Space from D:\temp\map\sa.mapx to
C:\ProgramData\Microsoft\Spectrum\PersistedSpatialAnchors\
Attempting to enable Windows MR driver
Driver enabled
Starting SHAREDREALITYSVC
Started SHAREDREALITYSVC
Starting SPECTRUM
Started SPECTRUM
IMPORT SUCCESS

Procédure d’exportation à l’aide de MixedRealitySpatialDataPackager.exeHow to Export using MixedRealitySpatialDataPackager.exe

MixedRealitySpatialDataPackager.exe export <folderpath to mapx files> <source package family name>    

L’exportation des mappages de l’appareil génère deux fichiers MapX, obtenir. MapX et sa. MapX.Exporting maps off device generates two mapx files, het.mapx and sa.mapx. Pendant le processus d’exportation, toutes les ancres spatiales sont supprimées, à l’exception de l’application spécifiée et de la limite créée par l’utilisateur (le cas échéant).During the export process all spatial anchors are removed except for the specified app and the user-created boundary (if it exists). Le nom de famille du package source doit correspondre à une application installée existante. sinon, le fichier exe échoue.The source package family name must match an existing installed app or the exe will fail.

Procédure d’importation à l’aide de MixedRealitySpatialDataPackager.exeHow to Import using MixedRealitySpatialDataPackager.exe

MixedRealitySpatialDataPackager.exe import <folderpath to mapx files> <target package family name> <user SID>

L’importation supprime les données spatiales existantes et les remplace par les données du répertoire spécifié.Import deletes the existing spatial data and replaces it with the data from the specified directory. L’entrée nom de l’application spécifie le nom du package de l’application cible qui doit être importé pour les ancres spatiales et le SID de l’utilisateur cible spécifie l’utilisateur qui doit avoir accès aux ancres spatiales importées.The app name input specifies the package name of the target app that like the spatial anchors should be imported for and the target user SID specifies the user that should have access to the imported spatial anchors. Le nom de la famille de packages cible et les SID d’utilisateur doivent correspondre aux valeurs existantes sur le PC. sinon, le fichier exe échoue.The target package family name and user SIDs must match existing values on the PC or the exe will fail.


Messages d'erreurError Messages

En outre, les messages d’erreur ci-dessous sont également accompagnés d’un HRESULTIn addition the error messages below failures will also be accompanied with an HRESULT

En cas d’erreur d’arguments non validesIf there was an error invalid arguments

Invalid command line parameters

Si l’exécutable n’a pas été exécuté en mode administrateurIf the executable was not run in administrator mode

1. Unable to determine elevation privileges 
2. Please run with administrator privileges 

Si une erreur s’est produite lors de l’activation ou de la désactivation du piloteIf there was an error enabling or disabling the driver

1. Could not find the specified driver with class GUID {d612553d-06b1-49ca-8938-e39ef80eb16f}
2. Could not find the device instance ID for specified driver with class GUID {d612553d-06b1-49ca-8938-e39ef80eb16f}
3. Could not find the specified driver with device instance ID <INSTANCE ID>
4. Failed to enable/disable driver

Si une erreur s’est produite lors de la validation de la version de la base de données spatialeIf there was an error validating the spatial database version

1. Could not read database version
2. This tool is not compatible with the current driver version of Windows Mixed Reality and/or the spatial data provided to replace the existing spatial data is an invalid version.
3. No spatial data is present on the current device please connect your Mixed Reality device to initialize spatial data. If the problem persists please restart your PC.

Si une erreur s’est produite lors de la validation du nom de famille de packages fourni pour l’application d’importation/exportation cibleIf there was an error validating the package family name provided for target import/export app

The package family name does not correspond to an installed app

Si une erreur s’est produite lors de la validation du SID de l’utilisateurIf there was an error validating the user SID

Failed to find local user for passed in user SID
1. Folder path to space store files doesn't exist 
2. het.mapx or sa.mapx file doesn't exist in <PATH> for import
3. Unable to create directory at <PATH> for export
1. Unable to open service manager <SERVICE>
2. Timed out trying to start/stop <SERVICE>