24
RWExplorer for the HMT-1 and HMT-1Z1 devices Version 1.0

RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

Embed Size (px)

Citation preview

Page 1: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

RWExplorer for the

HMT-1 and HMT-1Z1 devices

Version 1.0

Page 2: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

1 | P a g e RWExplorer

RWExplorer for the

HMT-1 and HMT-1Z1 devices

Legal Information ....................................................................................... Error! Bookmark not defined.

Revision Information .................................................................................................................................... 2

Introduction ................................................................................................................................................... 3

Getting Started .............................................................................................................................................. 4

Step 1a: Launching RWExplorer for Windows ....................................................................................... 4

Step 1b: Launching RWExplorer for Mac ................................................................................................ 5

Step 1c: Application Launched ................................................................................................................. 5

Step 2: Connect HMT Device to Computer .............................................................................................. 6

Step 3: Troubleshooting - USB Options on HMT Device ........................................................................ 7

RWExplorer – Application Overview ........................................................................................................... 8

RWExplorer – Developer Tools ................................................................................................................. 10

RWExplorer – Drag-and-Drop to Install APKs .......................................................................................... 11

RWExplorer – Configuration Options ........................................................................................................ 12

WearML Window ....................................................................................................................................... 13

Appendix A – Downloading and Installing RWExplorer for Windows PC ............................................... 14

Step 1: Download RWExplorer for Windows PCs ................................................................................. 14

Step 2: Install RWExplorer for Windows PC ......................................................................................... 15

Step 3: Running RWExplorer for Windows PC ..................................................................................... 19

Appendix B – Downloading and Installing RWExplorer for Apple Mac ................................................... 20

Step 1: Download RWExplorer for Apple Mac ...................................................................................... 20

Step 2: Install RWExplorer for Apple Mac ............................................................................................ 20

Step 3: Running RWExplorer for Apple Mac ......................................................................................... 21

Appendix C – Enabling USB Options on the HMT .................................................................................... 22

Page 3: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

2 | P a g e RWExplorer

Revision Information

V1.0 10-20-2016 Abbas Camp Initial Version

V1.1 12-28-2016 Trinh Nguyen Updated screenshots, settings and WearML

Page 4: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

3 | P a g e RWExplorer

Introduction

RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the screen of the

HMT-1 to the desktop. That means as a developer you don’t keep needing to look at the HMT micro-

display to see what your application is doing – you can instead look at a large version of the same screen

right on your desktop. Furthermore, you can use the PC mouse and keyboard to drive the user interface on

the HMT device.

RWExplorer requires the HMT headset (or HDK emulator) is connected to the PC using a standard USB

cable as supplied with the headset.

Page 5: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

4 | P a g e RWExplorer

Getting Started

If you have not yet downloaded and installed RWExplorer, please refer to Appendix A for Windows PC

versions, or Appendix B for Apple Macintosh versions.

Step 1a: Launching RWExplorer for Windows

Step 1 a1 – To launch the RWExplorer

application, navigate to the desktop to

locate a shortcut icon (if created in the

installer wizard). The application can

also be located in the directory where

the application was installed.

Step 1 a2 – If the system does not

already have Java installed, you will be

prompted to download it from

java.com website.

Step 1 a3 – Download and install the

latest Java version from java.com

website.

Page 6: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

5 | P a g e RWExplorer

Step 1b: Launching RWExplorer for Mac

Step 1 b1 – To launch the

RWExplorer application, navigate to

the applications folder. The

RWExplorer can be located on the

desktop if one was created.

Step 1 b2 - If the RWExplorer

application doesn’t run and displays

an error message, Navigate to the

.dmg file to open up the content

folder and double click on ‘Java 8’.

Follow the instructions for the

installation of Java 8 and re-run the

application.

Step 1c: Application Launched

Once the application is launched the following window will appear.

Page 7: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

6 | P a g e RWExplorer

The message inside the window indicates the HMT is not yet connected to the computer.

Step 2: Connect HMT Device to Computer

Using the supplied USB cable, insert one end into the HMT device and the other into the computer. If the

HMT is set up correctly and powered on, the computer screen will change to reflect the contents of the

HMT screen.

Page 8: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

7 | P a g e RWExplorer

Step 3: Troubleshooting - USB Options on HMT Device

If after connecting the two devices via USB cable the computer still reports it is waiting for the device to

connect, it is likely that certain USB options have not been enabled on the HMT device. Refer to

Appendix C for further details on how to enable USB options.

Page 9: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

8 | P a g e RWExplorer

RWExplorer – Application Overview

Once launched, the RWExplorer takes the form of a single-window application:

The main part of the RWExplorer window is used to mirror the contents of the HMT screen. The screen

will continuously refresh at a rate of two times per second to show faithfully what the user would see

when wearing the headset.

Furthermore, clicking anywhere on the screen can be used to activate the HMT user interface elements –

for example clicking the ‘My Apps’ button above has the same effect as speaking ‘My Apps’ inside the

headset.

Likewise, the computer keyboard can be used to type into text fields on the HMT user interface.

In this way the developer can view and interact with the HMT application without having to continually

wear the device.

Page 10: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

9 | P a g e RWExplorer

In addition to the central screen display there are a number of additional options designed to make the

developers experience easier:

Go Home: Pressing this button with cause the HMT to return to its home screen.

Identical to speaking ‘go home’ command.

Go Back: Pressing this button will cause the HMT to go back one screen. Identical to

speaking ‘go previous’ command.

Settings: This is a shortcut to launch the standard Android settings on the HMT device

Menu: This is a shortcut to pressing the Menu button, found on some older Android

devices. This is not used for most HMT applications, but is provided for backward

compatibility with older Android applications.

Page 11: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

10 | P a g e RWExplorer

RWExplorer – Developer Tools

There are additional tools specifically for Android application developers. These tools are represented as

the following icons, bottom left of the screen

The “ADB” button opens up a new command prompt window, allowing for Android

adb commands to be entered and run.

The “Logcat” button downloads the HMT system log and opens it using the system’s

default text editor. To change the default text editor, navigate to the File menu, select

Options and then browse to the desired text editor.

The “Screenshot” button captures a screenshot of the HMT device connected to the

computer.

Macintosh: Screen capture is taken and is saved to the desktop with a

timestamp.

Windows: Screen capture taken and saved into the system clipboard which can

be pasted into an image editor.

The “WearML” button opens the WearML window to manage WearML files.

Page 12: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

11 | P a g e RWExplorer

RWExplorer – Drag-and-Drop to Install APKs

RWExplorer supports a very easy method to install APKs (android applications) onto the HMT. This is a

method known conventionally as ‘side-loading an APK’.

It is simply activated by dragging and dropping an APK file from the computer desktop onto the ‘drop

zone’ of RWExplorer.

Step 1 – Drag-and-drop APK file from desktop

onto the ‘drop zone’

Step 2 – RWExplorer will install the APK and

report progress

Step 3 – On completion a message will be

Page 13: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

12 | P a g e RWExplorer

displayed to indicate success or failure (in the

case of error)

RWExplorer – Configuration Options

RWExplorer has a limited number of configuration options that can be accessed by selecting ‘Options’

from the ‘File’ menu.

Page 14: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

13 | P a g e RWExplorer

This will display an Options Panel, allowing the following settings to be made:

ADB File Location:

By default, RWExplorer ships with its own copy of the ADB executable. However, this option

allows different versions of ADB to be specified.

Editor File Location:

The Editor is the system text editor used to open and read the ‘logcat’ files from HMT. This

option allows the user to specify a different text editor to use.

Toggle Sound:

Turn on or off the button click sound.

WearML Window

The “Capture” button records the WearML

structure of the current screen and saves it to a file

with the name chosen by you.

Page 15: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

14 | P a g e RWExplorer

The WearML file is automatically opened in your

preferred text editor.

You can also double click on the file in the list to

open it.

The file is stored temporarily in your computer.

Changes made in the file are automatically saved

back into the device.

When you navigate to a different app in the

device, the WearML window still stays in the

previous app.

The “Refresh” button refreshes the WearML

window with the current screen.

The “Refresh” button also reloads the WearML

files applicable to the current screen.

.

Appendix A – Downloading and Installing RWExplorer for Windows PC

Requirements: Windows PC, running Microsoft Windows 7, 8 or 10

Step 1: Download RWExplorer for Windows PC

Download RWExplorer for your platform using the following link:

Page 16: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

15 | P a g e RWExplorer

RWExplorer for Windows PC

http://www.realwear.com/downloads/rwexplorer_pc.exe

Step 2: Install RWExplorer for Windows PC

Step 1 – To begin, double click

on the RWExplorer installer.

This will begin the installation

wizard, displaying a welcome

message.

Click, Next.

Step 2 – Select the location of

where the RWExplorer

application will be installed.

Click, Next.

Page 17: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

16 | P a g e RWExplorer

Step 3 – Select the location of

the program’s shortcut, setup

will create shortcut in the

following Start Menu Folder

(Default: RWexplorer).

Click, Next

Step 4 – Select checkbox to

create a desktop shortcut.

Click, Next.

Page 18: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

17 | P a g e RWExplorer

Step 5 – An overview of the

setup is displayed.

Click, Install.

Step 6 – The RWExplorer

application will begin to install

Page 19: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

18 | P a g e RWExplorer

the files.

Step 7 – After the installation is

complete, a completion window

will be shown.

To launch RWExplorer

application after the completion

of the installation,

Check “Launch RWexplorer”.

Click, Finish.

Step 8 – The RWExplorer

installation window closes and

the application is launched.

If the application is closed, the

application can be located on the

desktop.

Page 20: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

19 | P a g e RWExplorer

Step 3: Running RWExplorer for Windows PC

Step 1 – Navigate to the desktop and locate the

RWExplorer shortcut icon (if created in

installation wizard).

The application can also be located in the

directory where the application was installed.

Step 2 – The RWExplorer application will launch.

Page 21: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

20 | P a g e RWExplorer

Appendix B – Downloading and Installing RWExplorer for Apple Mac

Requirements: Apple Mac, running OS X 10.8 or greater

Step 1: Download RWExplorer for Apple Mac

Download RWExplorer for your platform using the following link:

RWExplorer for Mac

http://www.realwear.com/downloads/rwexplorer_mac.dmg

Step 2: Install RWExplorer for Apple Mac

Step 1 – To begin, double click on the

.dmg file to open up the content folder

for the RWExplorer Application.

Step 2 – Drag the RWExplorer

application icon to the Applications

folder.

Page 22: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

21 | P a g e RWExplorer

Step 3: Running RWExplorer for Apple Mac

Step 1 – Navigate to the RWExplorer

labelled ‘RWExplorer’, either located on

the desktop or in the Application folder.

Step 2 – If the RWExplorer application

doesn’t run and displays an error

message, Navigate to the .dmg file to

open up the content folder and double

click on ‘Java 8’.

Page 23: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

22 | P a g e RWExplorer

Appendix C – Enabling USB Options on the HMT

If after connecting the HMT and the computer via USB cable the computer still reports it is waiting for

the device to connect, it is likely that certain USB options have not been enabled on the HMT device.

To resolve the issue of the device not connecting:-

Step 1 – Navigate to Settings and select “About

Phone”.

Step 2 – Once on the settings page, navigate to

the bottom and locate “Build number”. Begin

to tap the build number continuously until a

message pops up stating that developer tools

have been enabled.

Navigate back to the settings page.

Step 3 – The developer options will now appear

on the setting page, proceed by clicking on the

developer tools.

Page 24: RWExplorer for the HMT-1 and HMT-1Z1 devices - RealWear · RWExplorer 3 | P a g e Introduction RWExplorer is a desktop tool for both Windows PCs and Mac computers that mirrors the

23 | P a g e RWExplorer

Step 4 – Turn on the developer tools options by

turning on the developer options and also

turning on USB debugging.

Step 5 – The device will begin to connect to the

developer tools and the device screen will be

displayed on the developer tools.

.