Home Screen and My Programs Custom Configuration and Deployment

Note: This page is only for Release 11.1 and later.

  • Starting in Release 11.1, both the background image, the applications presented on the Home Screen and which applications appear in My Programs can be configured with one configuration file.
  • In releases before 11.1, the background image, applications presented on the Home Screen and which applications appear in My Programs must be configured with three separate configuration files.

Consult the below links for details on configuration with releases before 11.1:

Configure – Home Screen Apps

Configure – Home Screen Background

Configure – My Programs

Introduction

Home Screen

The Home Screen is the primary user interface view and dashboard for the HMT, and is where you start when you power on a RealWear device. Both the background image and the applications presented on the Home Screen can be configured by IT admins.

Home Screen

My Programs

My Programs enables users to access applications installed on their RealWear device. Applications available to end users on a RealWear device can be configured by IT admins.

My Programs Custom Configuration

Configuration File Creation

File Creation

In order to create and modify the configuration, it is recommended to use

  • Visual Studio Code

This tool will help with JSON validation and formatting.

Glossary

<storage> refers to the internal storage on the HMT, sometimes referred to as ‘internal_storage’, ‘sdcard’ & ’emulated/0/’.

JSON is a standard text-based format for representing structured data based on JavaScript object syntax.

Files

The home screen and application draw require a single file in order to be configured. Using Visual Studio Code, or your preferred text editing tools create a new file with the filename listed below.

  • config.json – This is the configuration file that will be used to store the configuration for the home screen and application draw.

File Format and Options

Application Item Description
Home Screen apps A list of up to five package names for applications that will appear on the home screen
Home Screen backgroundImage The background images that will appear on the Home Screen, depending on the current device theme
Home Screen config_start_time The time in milliseconds the configuration app shows a splash screen before starting
My Programs packages The list of available package names that are shown in the My Programs appThese can be specified in two modes:

  • Allow Mode: an inclusive list
  • Block Mode: an exclusive list

File Format Items to Note:

  • Each theme needs a specified image – if not specified, the system behaviour is undefined.
  • The image for each theme is specified by a name/value pair, where the value is specified by a base64 encoded string.
  • Each image should be 854 by 456 pixels.
  • RealWear devices will check for a custom file first and, if it does not exist, will check the default file
  • inclusive: a boolean variable, which is true to indicate “Allow Mode” and false to indicate “Block Mode”

Example json file:

{
  "apps": [
    {
      "packagename": "com.realwear.launcher.ApplicationActivity"
    },
    {
      "packagename": "com.realwear.camera"
    },
    {
      "packagename": "com.realwear.filebrowser"
    },
    {
      "packagename": ""
    },
    {
      "packagename": ""
    }
  ],
  "config_start_time":15000,
  "backgroundImage": {
      "default_background": "light",
      "light": "base64 encoded image",
      "dark": "base64 encoded image"
  },
  "inclusive": true,
  "packages": [
    "com.android.settings",
    "com.about.realwear.aboutdevice",
    "com.realwear.barcodereader",
    "com.realwear.camera",
    "com.realwear.configuration",
    "com.realwear.controlpanel",
    "com.realwear.filebrowser",
    "com.realwear.sitesurvey"
  ]
}

Folder Location

The Home Screen and My Programs configuration service reads the files from the folder /<storage>/realwear/com.realwear.launcher/config/ on the device.

By placing your config.json file which contains all the configurations for the home screen and app drawer, your file will now live at the file location: /<storage>/realwear/com.realwear.launcher/config/config.json 

The deployment section below will cover how to create this folder and correctly transfer the file into the correct folder location.

Configuration File Creation

File Creation

In order to create and modify the configuration, it is recommended to use

  • Visual Studio Code

This tool will help with JSON validation and formatting.

Glossary

<storage> refers to the internal storage on the HMT, sometimes referred to as ‘internal_storage’, ‘sdcard’ & ’emulated/0/’.

JSON is a standard text-based format for representing structured data based on JavaScript object syntax.

Files

The home screen and application draw require a single file in order to be configured. Using Visual Studio Code, or your preferred text editing tools create a new file with the filename listed below.

  • config.json – This is the configuration file that will be used to store the configuration for the home screen and application draw.

File Format and Options

Application Item Description
Home Screen apps A list of up to five package names for applications that will appear on the home screen
Home Screen backgroundImage The background images that will appear on the Home Screen, depending on the current device theme
Home Screen config_start_time The time in milliseconds the configuration app shows a splash screen before starting
My Programs packages The list of available package names that are shown in the My Programs appThese can be specified in two modes:

  • Allow Mode: an inclusive list
  • Block Mode: an exclusive list

File Format Items to Note:

  • Each theme needs a specified image – if not specified, the system behaviour is undefined.
  • The image for each theme is specified by a name/value pair, where the value is specified by a base64 encoded string.
  • Each image should be 854 by 456 pixels.
  • RealWear devices will check for a custom file first and, if it does not exist, will check the default file
  • inclusive: a boolean variable, which is true to indicate “Allow Mode” and false to indicate “Block Mode”

Example json file:

{
  "apps": [
    {
      "packagename": "com.realwear.launcher.ApplicationActivity"
    },
    {
      "packagename": "com.realwear.camera"
    },
    {
      "packagename": "com.realwear.filebrowser"
    },
    {
      "packagename": ""
    },
    {
      "packagename": ""
    }
  ],
  "config_start_time":15000,
  "backgroundImage": {
      "default_background": "light",
      "light": "base64 encoded image",
      "dark": "base64 encoded image"
  },
  "inclusive": true,
  "packages": [
    "com.android.settings",
    "com.about.realwear.aboutdevice",
    "com.realwear.barcodereader",
    "com.realwear.camera",
    "com.realwear.configuration",
    "com.realwear.controlpanel",
    "com.realwear.filebrowser",
    "com.realwear.sitesurvey"
  ]
}

Folder Location

The Home Screen and My Programs configuration service reads the files from the folder /<storage>/realwear/com.realwear.launcher/config/ on the device.

By placing your config.json file which contains all the configurations for the home screen and app drawer, your file will now live at the file location: /<storage>/realwear/com.realwear.launcher/config/config.json 

The deployment section below will cover how to create this folder and correctly transfer the file into the correct folder location.

Configuration File Deployment

After you’ve created your configuration file, there are three ways to deploy the file to your RealWear device(s):

RealWear Foresight

  • In order to upload Homescreen and MyPrograms via Foresight, click the Device Management tab, then select Application Catalog:
  • Select “System Applications:
  • Select “Home Screen” and scroll down to Configurations and click “Add Configuration”.
  • Add “Configuration Name” and upload “config.json” to “Configuration File” file. Click “Save”.
  • Next, create a policy within the policy controller. Create a policy name, fill in a description, and select a “Add APP”.
  • Select the application and choose the configuration from drop down and save it.
  • Add the policy to your desired device group.
  • To register for Foresight, or for more details on using the product, visit the product page on RealWear’s website.

Via your Enterprise Mobility Management Solution (EMM)

  • Please see your EMM provider on how to push files to your device. When files are pushed to the HMT, remember to push the files to the location: ‘/realwear/com.realwear.launcher/Config/’
  • For more information on managing RealWear devices via EMM, visit the dedicated RealWear Knowledge Center page

Android File Transfer

  • Open the folder ‘realwear’ and create the folder ‘com.realwear.launcher’.
  • Copy the config.json file into the Config folder: