UD Mobile

From Universal Devices, Inc. Wiki
Jump to: navigation, search

Installation

Download on the App Store Get it on Google Play

Notes

UD Mobile works with firmware 5.0.16 and greater. Firmware lower than 5.0.16 may work but are not officially supported. The latest 5.x firmware now requires a 500 series Z-Wave board. If upgrading from 4.x to 5.x be sure to select firmware which is compatible with your system. Some information contained on this page may be specific to iOS or Android.

Quick Start Guides

Existing Portal Users

Upon Installation the app will prompt to setup using ISY Portal. Select Yes.

The app will prompt for ISY Portal login. Select Yes. If app prompts for Portal credentials enter your credentials and save. App may also show a dialog with existing Portal accounts. If this is initial installation select Add New Portal Account.

App will then show a list of ISYs on your portal account or a list of ISY Portal accounts. If a list of Portal Accounts is presented select the Portal account which contains the desired ISY. Select the desired ISY.

Select SAVE at the top right. Then select YES when prompted to synchronize. Wait for synchronization to complete. After synchronization the app will be ready to use on remote connections.


Adding Another ISY (Existing Portal Users)

These instructions assume the ISY is already linked to ISY Portal.

Select Settings-Tab > Systems > Add (top right).

The app will prompt for ISY Portal login. Select Yes. If the ISY is using the same Portal Account as your previously linked ISY(s) select the existing Portal Account from the list. If the ISY is using a different Portal account select Add New Portal Account.

After Portal Account has been selected the app will show a list of available ISYs. Select the desired ISY to add to the app.

Select SAVE at the top right. Then select YES when prompted to synchronize. Wait for synchronization to complete. After synchronization the app will be ready to use on remote connections.

Remote Connections

Remote connection on UD Mobile can be achieved in 3 scenarios.

First is our managed method using ISY Portal. ISY Portal has competitive prices of $23 for the first 2 years and renewals cost of $20 for two years (prices current as of 06/2021). If your ISY has not been associated with the ISY Portal in the past we offer a 30 day free trial. ISY Portal Installation instructions can be found here https://wiki.universal-devices.com/index.php?title=ISY_Portal_Installation_Instructions

Second is an unmanaged direct connection. The unmanaged method requires a Trusted CA Signed SSL Certificate. The Trusted SSL CERT is required for reasons stated below in App Transport Security. Instructions on adding a CERT to your ISY can be found here: https://www.universal-devices.com/docs/production/ISY994%20Series%20Network%20Security%20Guide.pdf . There are methods to add a Self Signed CERT to the Trusted Key Store on Android, however it is beyond the scope of our support and may require root on some devices.

Finally a local connection can be established on a remote network if running a VPN Server on the same local network as the ISY. To use this method select "Only use Local Connection" in the local connection settings. Setting this option will instruct the App to ignore remote connection settings and only use the local network.

App Transport Security (ATS) iOS

App Transport Security (ATS) is disabled by iOS for local loads (1), for this reason Local Connections do not need a Trusted CERT, ATS requires a Trusted CERT for Remote Connections. While it is possible for the apps to disable ATS it would make all connections less secure and we would have to meet the exception requirements (2) during app review which we likely do not meet.

(1) https://developer.apple.com/documentation/bundleresources/information_property_list/nsapptransportsecurity/nsallowslocalnetworking " ATS doesn’t block local loads by default in newer versions of the OS"

(2) https://developer.apple.com/documentation/security/preventing_insecure_network_connections#3138036

"The app must connect to a server managed by another entity that doesn’t support secure connections." Portals provided by UDI and Third parties support secure connections, and UDI controls the firmware. So, this does not apply. Apple has also mentioned this will be removed in the future.

"The app must support connecting to devices that cannot be upgraded to use secure connections, and that must be accessed using public host names.". ISY firmware does support secure connections, so this exception does not apply.


Local Connections and Local VPN

Local connection on UD Mobile can be achieved in 2 scenarios. Credentials for local connections are under Advanced-Settings in the Systems Screen.

First is using a local connection along with a remote connection. This will require that "Only use Local Connection" setting is switched off, then add your local WiFi network(s) in System Network Relations. Linking a WiFi Network will instruct UD Mobile to use the Local Connection Settings when your device is connected to a linked network.

Second is only using the app on the local network (or VPN). This will require that "Only use Local Connection" setting is switched on. The app will now only connect using the Local Connection Settings, this is intended for users who have a local VPN or users who do not setup a remote connection.


Favorites

Add New Favorite

Add

Go to the Favorites Tab. Select add ("+") at the top of the screen. This will open the Favorites Editor Screen.

Custom Name (optional)

Adding a Custom Name will override the Display Node name if available.

Type

Favorites Type allows the user to choose click actions for a favorite item.

  • Node Type will display an ISY Node and requires the user to select a Display Node (below). Favorites of Type Node have 2 Interaction Types; Toggle and Open-Dashboard. Interaction Types can not be defined by the user. See Toggle Indicators below. For custom toggle please use Command Type along with an ISY Program which has your toggle preferences in the IF section, then select IF as the command (program may need to be disabled in ISY to prevent IF trigger).
  • Folder Type will act as a folder allowing the user to add additional favorites inside. Favorites of Type folder also allow for an optional display node which inherits toggle ability from Node Type (above).
  • Command. This Type will allows users to specify any number of Node Commands. Pressing a Favorite of Type Command will execute the defined commands. Favorites of Type Command also allow from an optional Display Node, the display node does not inherit toggle ability. The Display Node does not have to match Command Nodes. See Commands below.
  • Status (Currently Android Only). Favorites of Type Status to not have clickable actions.
  • Empty (Currently Android Only). Favorites of Type Empty will create an invisible tile. Empty tiles will be shown in Edit Mode for editability.


Display Node

The node which will be displayed. During Display Node selection an expand (downward chevron) icon next to a node indicates that the node has grouped children (grouped nodes), to see the children press the expand Icon. The Display Node can be cleared by pressing the delete (trash icon) during Display Node selection.

Display Status

After a node has been selected the Display Status will be shown (i.e. Status, On-Level, Ramp-Rate, ect.). This will allow users to change the default display status.

Node Toggle Indicator

The Node toggle indicator will only show for Favorites which have (#1) "Status" selected as the Display Status, and (#2) the selected node must accept on/off commands. Also (#3) if the App has NOT received a status for the node from the ISY the toggle indicator will not be show until the node's status has been received. Node status is needed to determine if an on or off command should be sent to the node. If the App has NOT received a status for the node, clicking the Favorite item will open the Node's Dashboard which shows all status values and controls for the selected node.

Program Toggle Indicator

The Program toggle indicator will only show for Favorites which have (#1) "Status" selected as the Display Status. Also (#2) if the App has NOT received a status for the program from the ISY the toggle indicator will not be show until the program's status has been received. Program status is needed to determine if the Run or Stop command should be sent to the program. If the App has NOT received a status for the program, clicking the Favorite item will open the Program's (Node's) Dashboard which shows all status values and controls for the selected program. To receive program status values on App startup go to Settings-Tab > Systems > Your-System-Name > Advanced-Settings > Program-and-Variable-Settings then toggle Request-Status-of-all-Programs.

Commands

This will be shown if Command is selected as the Favorit Type. To add a command select the add (plus) icon next the the Commands header. Note that to preserve database integrity, the app will prompt to save for new favorites, if the app does not automatically open the Command Selection dialog press the add icon again. Select a node (similar to Display Node above). After a node has been selected the command dialog will show a list of available commands. Note that a menu (three dots) next to a command indicate that the command supports no-parameter and parameter execution (i.e. ON or ON-to-50%). If a command requires parameters or if the parameter option (menu) was selected the Parameters dialog will be show. After entering any parameter adjustments select save. Currently commands support deletion not editing.


Save Favorite

Select Save at the top of the screen.

Delete Favorite

Go to the Favorites Tab. Select edit (pencil icon) at the top of the screen. Click the Favorite item. Select "Delete".

Move Favorite

Go to the Favorites Tab. Select edit (pencil icon) at the top of the screen. Click Move or Move-to-Folder. For Move-To-Folder select Paste when in the desired directory, the first screen is the home directory. To move position in the current directory long press the favorite item then drag to position.


Favorite Examples

Favorite Custom Toggle

The following is an example of adding a custom toggle for a door lock, but the process is similar for all nodes/programs/variables. A door lock is used in this example as it does not support On or Off commands, so the app will not show a toggle indicator and will only open to the Node's Dashboard when clicked on the Favorites Screen.

First we must create a Program in the Admin Console (Program creation not yet available from UD Mobile). See Program Notes in program image. The program must be disabled to prevent unintended behavior.

CustomToggleProgram.png

In UD Mobile create a new favorite. Change the Type to Command, and set the Door Lock as the Display Node. Add The program created above as a Command Node and select "Run If" as the Command. Note this Favorite was given the Custom Name "Back Door" which will override the original Node Name.

FavCommand.png

We now have a Favorite item which can toggle the "Back Door" lock. Also because we have a Display Node there is a menu (three dots) which will open the Node's Dashboard, which can be great if the lock is jammed and we must use the unlock control as the toggle will always try to lock in the program created above.


FavTabCommand.png

Node Dashboard

Show/Hide Status and Commands

From the Node's Dashboard click the edit icon (pencil on top). Now press the add/hide (+/-) buttons to the left of the status or button.

NodeDashboardEdit.png


Move Status and Commands

From the Node's Dashboard click the edit icon (pencil on top). Now long press the move icon (three lines) on the left side of the status or button. Note that status and buttons are grouped and can only be moved within the same group.