Documentação do pacote de dados espaciais da realidade misturadaMixed Reality Spatial Data Packager Documentation

Observação

Essa ferramenta e sua operação são oferecidas no estado em que se encontram.This tool and its operation are offered as-is. Ele está sujeito a alterações sem aviso e pode não ser compatível com versões futuras do Windows ou do 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.

BaixarDownload

Baixe o MixedRealitySpatialDataPackager aquiDownload MixedRealitySpatialDataPackager here

Suporte a dispositivosDevice support

RecursoFeature HoloLens (1ª geração)HoloLens (1st gen) HoloLens 2HoloLens 2 Headsets imersivosImmersive headsets
Empacotador de dados espaciais da realidade misturadaMixed Reality Spatial Data Packager ✔️✔️

Início RápidoQuickstart

A ferramenta de pacote de dados espaciais da realidade misturada copia os dados espaciais de um aplicativo de destino de um PC para outro por meio de um processo de exportação e importação de duas etapas.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. A ferramenta deve ser executada com privilégios de administrador e exclui os dados espaciais existentes na importação.The tool must be run with administrator privileges and deletes the existing spatial data on import. A exportação deixa os dados espaciais existentes intactos.Export leaves the existing spatial data intact.

Principais requisitos e limitações:Key requirements and limitations:

  1. A ferramenta deve ser executada com privilégios de administradorTool must be run with administrator privileges
  2. Talvez seja necessário reiniciar o PC se o portal de realidade misturada estiver instável após a execução da ferramentaYou may have to restart PC if Mixed Reality Portal is unstable after running the tool
  3. A ferramenta não será executada ao encontrar incompatibilidades de versão de dados espaciais ou incompatíveisTool will not run when encountering spatial data version mismatches or incompatibilities
  4. A ferramenta apagará os dados espaciais existentes na importaçãoTool will erase existing spatial data on import
  5. Se o processo de importação falhar, os dados anteriores não poderão ser restaurados, a menos que tenha sido feito o backup exportando anteriormenteIf import process fails previous data cannot be restored unless it has been backed up by exporting previously
  6. Qualidade da funcionalidade de importação contingente no modo "somente leitura" para dados de mapa espacialQuality of import functionality contingent on “Read-Only” mode for spatial map data

Práticas recomendadas de mapeamentoMapping Best Practices

  1. Limpe os mapas existentes no painel de controle (configurações-> realidade misturada-> ambiente-> limpar dados do ambiente)Clear existing maps from the Control Panel (Settings -> Mixed Reality -> Environment -> Clear environment data)
  2. Garanta uma iluminação suficiente para um bom acompanhamento e, se estiver executando o modo de mapa bloqueado, tente manter a mesma iluminaçãoEnsure sufficient lighting for good tracking and if running locked map mode try to maintain the same lighting
  3. Quando possível, mantenha o intervalo dinâmico de iluminação baixo, evitando áreas de alta iluminação ao lado de áreas sombreadas e escurasWhen possible keep the lighting dynamic range low by avoiding areas of high illumination next to dark, shadowed areas
  4. Minimize as superfícies em branco e não texturas, por exemplo, colocar uma variedade de pôsteres diferentes em paredes brancasMinimize blank, textureless surfaces e.g. place a range of different posters on white walls
  5. Mapear o espaço sem objetos dinâmicos na cena, como mover pessoasMap the space without dynamic objects in the scene such as moving people
  6. Bloquear o mapa na importação (disponível por meio do insider Preview)Lock the map on import (available via Insider Preview)
  7. Desbloquear o mapa e examinar novamente o ambiente quando o rastreamento de qualidade degrada e/ou se há alterações no ambiente (iluminação ou alterações no layout do objeto)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)

Executando o Gerenciador de dados espaciais da realidade misturada com o script complementarRunning Mixed Reality Spatial Data Packager with Companion Script

Fornecemos MRSpatialPackagerHelperScript.ps1 que executa o MAP Packager das ferramentas.We have provided MRSpatialPackagerHelperScript.ps1 that runs the map packager the tools.

Os parâmetros de script são definidos abaixo: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

Uso e saída de exemplo de script do PowerShellPowershell Script Example Usage and Output

.\MRSpatialPackagerHelperScript.ps1-AppName holoshell-nome do administrador 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

Como exportar usando MixedRealitySpatialDataPackager.exeHow to Export using MixedRealitySpatialDataPackager.exe

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

A exportação de mapas fora do dispositivo gera dois arquivos MapX, Het. MapX e SA. MapX.Exporting maps off device generates two mapx files, het.mapx and sa.mapx. Durante o processo de exportação, todas as âncoras espaciais são removidas, exceto o aplicativo especificado e o limite criado pelo usuário (se existir).During the export process all spatial anchors are removed except for the specified app and the user-created boundary (if it exists). O nome da família do pacote de origem deve corresponder a um aplicativo instalado existente, ou o exe falhará.The source package family name must match an existing installed app or the exe will fail.

Como importar usando MixedRealitySpatialDataPackager.exeHow to Import using MixedRealitySpatialDataPackager.exe

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

A importação exclui os dados espaciais existentes e os substitui pelos dados do diretório especificado.Import deletes the existing spatial data and replaces it with the data from the specified directory. A entrada do nome do aplicativo especifica o nome do pacote do aplicativo de destino que, como as âncoras espaciais, deve ser importado para o e o SID do usuário de destino especifica o usuário que deve ter acesso às âncoras espaciais importadas.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. O nome da família de pacotes de destino e os SIDs de usuário devem corresponder aos valores existentes no computador ou o exe falhará.The target package family name and user SIDs must match existing values on the PC or the exe will fail.


Mensagens de erroError Messages

Além disso, as mensagens de erro abaixo também serão acompanhadas por um HRESULTIn addition the error messages below failures will also be accompanied with an HRESULT

Se houvesse um erro de argumentos inválidosIf there was an error invalid arguments

Invalid command line parameters

Se o executável não foi executado no modo de administradorIf the executable was not run in administrator mode

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

Se houvesse um erro ao habilitar ou desabilitar o driverIf 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

Se houve um erro ao validar a versão espacial do banco de dadosIf 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.

Se houve um erro ao validar o nome da família de pacotes fornecido para o aplicativo de importação/exportação de destinoIf 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

Se houve um erro ao validar o SID do usuárioIf 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>