HTC Vive Enterprise Quick guide

Batch configuration for your headset

Contents
Setup
Downloading the config file 4
Downloading the batch configuration template package 4
Batch configuration
What is Kiosk mode? 5
Activating Kiosk mode 5
Enabling and disabling features 6
Choosing the apps to show on the headset 9
Packaging the files for installation 10
Installing the batch configuration file on the headset 10
Appendix
Country codes 13
Feature version requirements 14
Trademarks and copyrights
2 Contents

About this guide
We use the following symbols to indicate useful and important information:
This is a note. It provides detailed information for setup, common questions, and what to do in
specific situations.
This is a tip. It will give you an alternative way to do a particular step or procedure that you may
find helpful.
This indicates important information that you need in order to accomplish a certain task or to
get a feature to work properly.
This is a warning. Take note to avoid potential problems or prevent damage to your hardware.
Information contained in this guide may have changed. For the most up-to-date information,
including the latest version of this guide, contact HTC.
3 About this guide

Setup
Downloading the config file
You need the config file to run batch configure on the headset.
All registered VIVE™Focus headsets are included in the config file. You do not need different
config files for each registered headset.
1. On your computer's Web browser, go to https://enterprise.vive.com/portal/advantage/
focus/kioskmode.
2. Click Download config file to save the config file to your computer.
3. Copy cota_config.xml into the xml folder of the batch configuration template
package. To learn where to download the template package from, see Downloading the
batch configuration template package on page 4.
Downloading the batch configuration template package
The batch configuration template package contains the file structure and files you need to
customize features on the headset.
1. On your computer's Web browser, go to https://enterprise.vive.com/portal/advantage/
focus/kioskmode.
2. Click Download Template Package to save the template files to your computer.
3. Extract the contents of the ZIP file to a folder on your computer. You will see 3 folders,
apk,xml, and files.
Do not delete Kiosk_Enabler.apk inside the apk folder.
4 Setup

Batch configuration
What is Kiosk mode?
Kiosk mode lets your business fine tune the VIVE Focus headset to cater to your business needs.
With Kiosk mode, lock down the apps customers can experience when using the headset.
You need to register the headset serial number first to be able to use Kiosk mode on your
headset.
Activating Kiosk mode
Enable and customize Kiosk mode to suit your business's needs.
1. In the folder where you extracted the contents of the batch configuration template
package, open the xml folder. See Downloading the batch configuration template
package on page 4.
2. Inside the folder, open the mns.xml file using a text editor app.
3. Choose whether to enable or disable Kiosk mode.
<item name="enabled" type="boolean">xxxx</item>
Enter true to enable Kiosk mode. Enter false to disable Kiosk mode.
4. Choose whether to use a custom home or VIVE home.
<item name="enter" type="boolean">xxxx</item>
Enter true to use your custom home. Enter false to use VIVE home.
5. Set a passcode so one needs to be entered to leave Kiosk mode. This helps prevent users
from exiting Kiosk mode on their own.
<item name="passcode">xxxx</item>
The passcode must have 4 digits [0-9].
6. Enter the country code where VIVE Focus is used. Entering the country code helps VIVE
Focus connect to a Wi-Fi®network. For a list of country codes, see Country codes on page
13.
<item name="code">xx</item>
5 Batch configuration

7. Enter the names for the app and app package.
<set name="plenty">
<item name="app name">xxxx</item>
<item name="app_package_name">xxxx</item>
</set>
§To find the package name, enter #adb dumpsys app | grep package.
§Duplicate <set/> to add more app entries.
8. Save the file.
Enabling and disabling features
Turn on or off features such as the virtual wall, Wi-Fi settings, custom boot-up animation, and
automatic system updates.
1. In the folder where you extracted the contents of the batch configuration template
package, open the xml folder. See Downloading the batch configuration template
package on page 4.
2. Inside the folder, open the cc_config.xml file using a text editor app.
3. Enter the corresponding text and value of each feature to enable or disable a feature.
Update the xvalue in each setting to 1(enabled) or 0(disabled).
For example, <enableUSBdebug>1</enableUSBdebug>.
See Available features on page 7 for a complete list of features that be configured for
the headset.
4. Save the file.
§See Feature version requirements on page 14 to check the system version requirement for
each feature.
§To connect VIVE Focus to a specificWi-Fi network, the <hasWIFISettings> value must be
set to 1. See Configuring the Wi-Fi settings file on page 8.
§If the <hasAnimationZip> value is set to 1, you need to prepare your custom boot-up
animation for packaging. See Preparing the custom boot-up animation on page 8.
§If you have an alternative headset tracking solution, in addition to the current one being used
by the headset, set the <DisableLostTracking> value to 1.
§For <SetPlayareaSize>, you can enter 2x2, 3x3, or 4x4. Dimensions are in meters.
6 Batch configuration

Available features
These are the features that can be configured for the headset.
Feature name Setting text
USB Debug Enable or disable USB debugging for the headset.
<enableUSBdebug>x</enableUSBdebug>
Virtual Wall Show or hide the virtual wall for the play area.
<enableVirtualWall>x</enableVirtualWall>
Wi-Fi settings Set up Wi-Fi to connect the headset to a specific Wi-Fi network. See
Configuring the Wi-Fi settings file on page 8.
<hasWIFISettings>x</hasWIFISettings>
Pairing user
interface
Enable or disable the recenter feature for the controller.
<disablePairingUI>x</disablePairingUI>
3 DoF controller
update
Enable or disable automatic updates for the 3DoF controller.
<ThreeDoFController_update_enabled>x</
ThreeDoFController_update_enabled>
Chirp controller
update (For 6 DoF
controller)
Enable or disable automatic updates for the Chirp controller.
<ChirpController_update_enabled>x</
ChirpController_update_enabled>
System update Enable or disable automatic system updates for the headset.
<System_update_enabled>x</System_update_enabled>
VIVE home
(Launcher) update
Enable or disable updates for VIVE home and VIVEPORT™.
<Launcher_update_enabled>x</Launcher_update_enabled>
COTA Persistence See Configuring COTA Persistence settings on page 8 for details.
<cotaPersistence>x</cotaPersistence>
Boot up animation Add a custom boot up animation for the headset. See Preparing the
custom boot-up animation on page 8.
<hasAnimationZip>x</hasAnimationZip>
Don't show lost
tracking warnings
Show or hide lost tracking warning messages.
<DisableLostTracking>x</DisableLostTracking>
Wi-Fi and cast
options on power
menu
Show the Wi-Fi settings and cast options on the Power menu.
<ShowWIFICastOption>x</ShowWIFICastOption>
Show developer
options
Enable or disable developer options.
<EnableDevelopOption>x</EnableDevelopOption>
Play area size Set the play area size.
7 Batch configuration

Feature name Setting text
<SetPlayareaSize>2x2</SetPlayareaSize>
See Feature version requirements on page 14 to check the system version requirement for
each feature.
Configuring the Wi-Fi settings file
Edit the Wi-Fi configuration file so you can connect VIVE Focus to a specific Wi-Fi network.
1. In the folder where you extracted the contents of the batch configuration template
package, open the xml folder. See Downloading the batch configuration template
package on page 4.
2. Inside the folder, open the wifi_config.xml file using a text editor app.
3. Update the tag values according to your Wi-Fi network settings.
Each tag must have a value. Check the notes for each tag to see the values that you can enter.
4. Save the file.
Configuring COTA Persistence settings
Use the COTA Persistence feature to create a partition to keep the batch configuration package
on the headset. Once this feature is enabled, the batch configuration package will be copied to
the /cota partition of the headset after installing the batch configuration package using a
storage card. If you do a factory reset and there is no batch configuration package in the storage
card, the headset will automatically execute the batch configuration package in the /cota
partition.
Preparing the custom boot-up animation
You can add your company specific launch animation.
1. In the folder where you extracted the contents of the batch configuration template
package, open the files folder. See Downloading the batch configuration template
package on page 4.
2. Inside the folder, extract the contents of the bootanimation.zip file to your computer.
You will see a part0 folder and desc.txt file.
3. Copy your animation sequence images into the part0 folder.
§You need to use 3D pre-distortion images in PNG format.
§The recommended image dimensions is 2880x1600 pixels.
§Name the images sequentially. For example, boot_0001.png, boot_0002.png, and so on.
§You can also place an audio file, in WAV format, to go with your animation in this folder.
8 Batch configuration

4. Open the desc.txt file using a text editor app. The desc.txt file defines how the
images inside the part0 folder are displayed.
5. Update the code according to your preferences.
2880 1600 24
p 1 0 part0
§2880 The width, in pixels, of the images used in the animation.
§1600 The height, in pixels, of the images used in the animation.
§24 Playback frame rate of the animation. The recommended frame rate is 24.
§pCommand for stopping or finish playing the animation. Enter pto stop the
animation when the headset has fully booted up even if the animation has not
finished playing. Enter cto finish playing the animation at least once even if the
headset has fully booted up.
§1Animation loop frequency. Enter the number of times the animation loops. Enter 0
to continuously loop the animation until the headset has fully booted up.
§0Wait time before replay. Enter how long to wait, in number of frames, before
replaying the animation if it is set to loop.
§part0 Name of the folder where the images for the animation are located.
Add another row if you have more than one boot-up animation.
2880 1600 24
p 1 0 part0
c 0 0 part1
6. Package the part0 folder and desc.txt into a ZIP file and name it
bootanimation.zip.
7. Place bootanimation.zip inside the files folder of the batch configuration template
file.
Choosing the apps to show on the headset
Choose the apps your users will see when using the headset.
Copy the app's apk to the apk folder of the batch configuration template package.
§The apk filename must only use letters in the English alphabet.
§Do not delete Kiosk_Enabler.apk inside the apk folder.
The app will be automatically installed on the headset after running the batch configuration ZIP
file. See Installing the batch configuration file on the headset on page 10.
9 Batch configuration

Packaging the files for installation
Once you're done setting up the batch configuration template and other files, package the files in
order to run your custom batch configuration on the headset.
1. Make sure the cota_config.xml, mns.xml, cc_config.xml, and
wifi_config.xml files are inside the xml folder.
2. Make sure the apk files of the apps you want on the headset are inside the apk folder.
3. If you have a custom animation file, make sure bootanimation.zip is inside the files
folder. See Preparing the custom boot-up animation on page 8.
4. Package the apk, xml, and files folders into a ZIP file.
Make sure to only have batch configuration files inside the xml, apk, and files folders. For
Mac users, make sure to exclude Mac resource files like the _MACOSX folder. Having non-
batch configuration files in the ZIP file may cause installation problems.
5. Name the ZIP file in this format, FocusImage_[year][month][day].zip. For
example, FocusImage_20190519.zip.
The file size of the packaged ZIP file cannot exceed 500MB.
Installing the batch configuration file on the headset
Run the batch configuration ZIP file on the headset to use your custom settings.
Before you install the batch configuration ZIP file:
§Make sure the headset has at least 35% battery power.
§If you've done the headset setup process before, do a hard reset first. To learn how to reset
the headset, see Resetting the headset (Factory reset) on page 11.
§If you've installed a custom batch configuration file on the headset before, do a hard reset
first. To learn how to reset the headset, see Resetting the headset (Factory reset) on page
11.
1. Copy the batch configuration ZIP file to a microSD™card. To learn what to package in the
ZIP file, see Packaging the files for installation on page 10.
2. Make sure the headset is turned off.
10 Batch configuration

3. Open the headset's storage card slot door.
4. Insert the microSD card into the slot.
5. Close the storage card door.
6. Turn on the headset.
7. Follow the instructions in the headset to install the batch configuration file. Wait a few
minutes for the installation to finish.
Whenever a batch configuration file is installed on the headset, a cotalog.log file is created for
you to reference if needed. You can find the log file in the storage card's root folder. Or, if there is
no storage card installed on the headset, the log file can be found in /storage/emulated/0/.
Resetting the headset (Factory reset)
If the headset has a persistent problem that cannot be solved, you can perform a factory reset
(also called a hard reset or master reset). A factory reset reverts the headset back to its initial
state—the state before you turned on the headset for the first time.
Factory reset will remove all data on the headset, including apps you've downloaded and
installed, your accounts, your files, as well as system and app data and settings. Be sure to
back up any data and files you want to keep before you do a factory reset.
1. Press the VIVE button to open the Quick Menu.
2. Select Settings More Settings.
11 Batch configuration

3. Under Personal, select Reset.
4. Select Factory data reset Reset Headset Erase Everything.
A factory reset may not permanently erase all data from the headset, including personal
information.
12 Batch configuration

Appendix
Country codes
Here is a list of countries and their country codes to use for the Wi-Fi setting in the mns.xml file.
Region Country Country code
North America
Canada CA
United States of America US
Europe
Austria AT
Belgium BE
Czech Republic CZ
Denmark DK
Finland FI
France FR
Germany DE
Ireland IE
Italy IT
Netherlands NL
Norway NO
Poland PL
Portugal PT
Slovakia SK
Spain ES
Sweden SE
Switzerland CH
United Kingdom GB
Asia Pacific
Australia AU
Japan JP
Korea KO
Russia RU
13 Appendix

Region Country Country code
Taiwan TW
Feature version requirements
On your headset, check the system version by selecting Settings More Settings About
device Build number.
Feature name VIVE Focus™VIVE Focus Plus
USB Debug 1.69.623.6 or later 1.10.623.1 or later
Virtual Wall 1.69.623.6 or later 1.10.623.1 or later
Wi-Fi settings 1.69.623.6 or later 1.10.623.1 or later
Pairing user interface 1.69.623.6 or later Not supported
Controller update (For 3 DoF controller) 1.69.623.6 or later Not supported
Chirp controller update (For 6 DoF controller) Not supported 1.63.623.1 or later
System update 1.69.623.6 or later 1.63.623.1 or later
VIVE home (Launcher) update 1.69.623.6 or later 1.63.623.1 or later
COTA Persistence Not supported 1.63.623.1 or later
Boot up animation Not supported 1.63.623.1 or later
Don't show lost tracking warnings 2.06.623.1 or later 3.03.623.5 or later
Wi-Fi and cast options on power menu 2.06.623.1 or later 3.03.623.5 or later
Show developer options 2.06.623.1 or later 3.03.623.5 or later
Play area size 2.08.623.1 or later 3.04.623.1 or later
14 Appendix

Trademarks and copyrights
©2020 HTC Corporation. All Rights Reserved.
VIVE, the VIVE logo, VIVE Focus, the VIVE Focus logo, HTC, the HTC logo, VIVEPORT, and all
other HTC product and service names are trademarks and/or registered trademarks of HTC
Corporation and its affiliates in the U.S. and other countries.
All other trademarks and service marks mentioned herein, including company names, product
names, service names and logos, are the property of their respective owners and their use herein
does not indicate an affiliation with, association with, or endorsement of or by HTC Corporation.
Not all marks listed necessarily appear in this User Guide.
Screen images contained herein are simulated. HTC shall not be liable for technical or editorial
errors or omissions contained herein, nor for incidental or consequential damages resulting from
furnishing this material. The information is provided “as is” without warranty of any kind and is
subject to change without notice. HTC also reserves the right to revise the content of this
document at any time without prior notice.
No part of this document may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying, recording or storing in a retrieval system, or
translated into any language in any form without prior written permission of HTC.
15 Trademarks and copyrights