Simple Sync for OS X User Guide

Transcription

Simple Sync for OS X User Guide
SIMPLE SYNC FOR OS X
User Guide
Version 3.2
Released January 2016
Version Information
Simple Sync for OS X User Guide, Version 3.2, released January 2016.
Copyright Information
Copyright © 2016 by Roomie Remote, Inc. All rights reserved. No part of this document can be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express
written permission of Roomie Remote, Inc.
Trademark Information
“Simple Sync”, “Simple Control”, and the Simple Control logo are trademarks of Roomie Remote, Inc. All
other company, product, and service names are for identification only. All trademarks and registered
trademarks are the property of their respective owners.
Limitations
The information is this document may change at any time. It may include technical inaccuracies or
typographical errors.
Table of Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Technical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Chapter 1: Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Purchasing a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing Simple Sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2: Pairing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Pairing and Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Pairing the First Simple Control Client with Simple Sync. . . . . . . . . . . . 14
Pairing Additional Simple Control Clients. . . . . . . . . . . . . . . . . . . . . . . . . 15
Troubleshooting Pairing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Chapter 3: Client Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About Client Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Accessing Client Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Configuring Client Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Synchronization Peers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Remote Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Chapter 4: The Simple Sync Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Show Sync Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Backup Configuration to Simple Sync . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Configuration Restore from Simple Sync . . . . . . . . . . . . . . . . . . . . . . . . .23
Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Check for Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Copyright © 2016 by Roomie Remote, Inc.
3
Released January 2016
Table of Contents
Simple Sync for OS X User Guide
About Simple Sync. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Quit Simple Sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 5: The Simple Sync Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
The Simple Sync Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Configuration Lockdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Chapter 6: Mac OS X System Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Adding Simple Sync as a Device and Creating an Activity . . . . . . . . . . . 31
Using the Virtual Remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Chapter 7: Simple Sync Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
About Simple Sync Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Using Simple Sync Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Appendix A: About Trigger Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
About Trigger Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Viewing the Current Trigger Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Released January 2016
4
Copyright © 2016 by Roomie Remote, Inc.
Quick Start
This Quick Start describes how to get up and running with Simple Sync for OS X.
This Quick Start includes:
•
“Installing” on page 5
•
“Pairing” on page 6
•
“The Simple Sync Screen” on page 6
•
“Using” on page 7
INSTALLING
To install Simple Sync for OS X:
1.
Purchase a Simple Sync Software License from the Simple Store (store.simplecontrol.com), download the dmg file to your Mac OS X system from the link in the
email, then double click the dmg file to begin the installation.
2. Drag the Simple Sync app to the Applications folder on your OS X system.
3. In your Applications folder, locate the Simple Sync app and double click it.
4. If prompted to open an application downloaded from the Internet, click Open.
The Simple Sync icon appears on the menu bar of your OS X system.
Refer to Chapter 1, Setup, for more information about purchasing and installing
Simple Sync for OS X.
Copyright © 2016 by Roomie Remote, Inc.
5
Released January 2016
Quick Start
Simple Sync for OS X User Guide
Pairing
Pairing your first Simple Control or Simple System client with Simple Sync associates
your Simple Sync license with your client. If you do not pair, Simple Sync stays in pairing mode, where most features are disabled.
If you purchased the legacy product Roomie Agent, it will be upgraded to Simple Sync.
If your Roomie Agent license cannot be found, you will be prompted to open your
Roomie Agent license file.
To pair a Simple Control or Simple System client with Simple Sync for OS X:
1.
After installing Simple Sync, open a Simple Control or Simple System client.
2. Make sure you are logged in to the same Simple Control account you used to purchase Simple Sync.
The Detected Home screen appears on the Simple Control client.
It could take a moment or two for the
Detected Home screen to appear.
No approval is required for the first client to
pair with Simple Sync.
3. Tap Yes.
Refer to Chapter 2, Pairing, for more information about pairing.
THE SIMPLE SYNC SCREEN
To view the Simple Sync screen:
1.
Click the Simple Sync icon on the menu bar. The Simple Sync menu appears.
2. Click Show Sync Status. The Simple Sync screen appears.
Released January 2016
6
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
Quick Start
USING
To lock a client configuration:
1.
On the Simple Sync screen, tap the configuration you want to lock, then tap Lock.
2. Enter a numeric PIN up to five digits, then tap Lock.
3. To unlock a locked client, tap it, then tap Unlock.
To make a backup of the current configuration of your clients:
1.
Pull down the Simple Sync menu, then select Backup Configuration.
2. On the Open screen, find a location, then click Open. The backup is created.
To restore a configuration:
1.
Pull down the Simple Sync menu, then select Restore Configuration.
2. On the Open screen, select the folder with the desired configuration, then click
Open. The configuration is restored.
To view Preferences:
1.
Pull down the Simple Sync menu, then select Preferences.
To control your Mac OS X system:
1.
Add Simple Sync as a device in Simple Control or Simple System, then create an
activity for it.
2. Use a single-finger tap for left mouse and a two-finger tap for right mouse.
3. Commands that apply to the Mac OS X system on which Simple Sync is running
can be added to any Simple Control activity or button, once Simple Sync is added
as a device.
While most commands are self explanatory, some require more information:
–
the .MOUSE SET command is proportional to the destination screen. The
upper left corner is 0,0 and the lower right is 1.0,1.0. So for example if you
were to set .MOUSE SET to 0.5,0.5, the mouse would be placed in the middle
of the screen.
–
application names used with .APPLICATION LAUNCH are only the application
names exactly as stored in the Applications folder on the OS X system. For
example, XBMC. Do not use path names with .APPLICATION LAUNCH.
–
the .APPLICATION QUIT command uses the process name, not the application name. These are usually the same, with a few exceptions such as Plex,
which is “Plex” instead of “Plex Home Theater.”
–
Script names for the .SCRIPT RUN command are full path names. For
instance, “/Users/jon/Documents/myscript.scpt” would be a potential
AppleScript. Do not use path abbreviations such as “~” in the path names.
Copyright © 2016 by Roomie Remote, Inc.
7
Released January 2016
Quick Start
Released January 2016
Simple Sync for OS X User Guide
8
Copyright © 2016 by Roomie Remote, Inc.
Introduction
This User Guide describes Simple Sync for OS X.
Simple Sync for OS X supports secure synchronization, remote access, triggers, configuration lockdown and backups, OS X screen control, and agent commands.
IMPORTANT:
Simple Sync provides no functionality without a Simple Control environment and the purchase of a Simple Sync Software License.
This Introduction includes:
•
“Features” on page 9
•
“Audience” on page 10
•
“Technical Specifications” on page 10
•
“Additional Resources” on page 10
FEATURES
Simple Sync features include:
•
Remote Access: Commands, activities, and feedback to and from your devices
work remotely from outside your local network when Simple Control is securely
paired with Simple Sync. You can raise or lower blinds from the office, for example, or lower the thermostat if you are away on vacation.
Remote Access requires Simple Sync and a Simple Service subscription. Remote
Access is not available with a Roomie Service subscription.
Refer to the Simple Control User Guide for information about Remote Access.
•
Amazon Echo Integration: Integrates Simple Sync and Amazon Echo, allowing
you to control your Simple Control or Simple Server environment by speaking
commands. Refer to the Amazon Echo Integration Guide for more information.
•
Configuration Lockdown: Lets you lock the configuration of a Simple Control
client; while locked, you cannot change the client’s configuration. You can set a
PIN so that you can unlock the configuration when desired.
Configuration lockdown requires a Simple Service or Roomie Service subscription.
•
Configuration Backups: Lets you back up and restore Simple Control configurations. You can store as many configurations as desired.
•
OS X Screen Control: Lets you control the OS X system, including live mouse
movement and keyboard commands.
OS X screen control requires a Simple Service or Roomie Service subscription.
•
Simple Sync Commands: Lets you control your OS X system by sending it commands using Simple Control. Commands include launching applications, mouse
position, Wake on LAN, and restart or shutdown.
Copyright © 2016 by Roomie Remote, Inc.
9
Released January 2016
Introduction
Simple Sync for OS X User Guide
•
Secure Synchronization: Simple Sync keeps your configurations securely synchronized on all of your clients. Changes on one client are automatically reflected
on all other clients. And even if no Simple Control clients are active, Simple Sync
tracks configurations, status for all activities, and power states of all devices.
•
Triggers: Lets you run a Simple Control activity based on specified criteria (for
example, my Lutron keypad button was pressed, it’s 10 p.m., 30 minutes have
passed, and so on). Simple Sync automatically monitors all triggers and initiates
them when it is set as the trigger agent.
•
SmartThings Triggers: Simple Sync accepts commands from a SmartThings hub.
Download the Simple Control/SmartThings Integration Pack from the Simple
Control website and refer to the included PDF file for more information.
AUDIENCE
This User Guide is for users of Simple Sync for OS X.
We expect you are familiar with:
•
using your OS X and iOS devices
•
basic networking concepts
•
setting up and configuring Simple Control
TECHNICAL SPECIFICATIONS
Technical specifications for Simple Sync for OS X:
•
Mac OS X system running Mac OS X 10.9 (Mavericks) or greater.
•
TCP/IP network, with Wi-Fi enabled and Internet access. Simple Sync and the iOS
devices running the Simple Control app must all be on the same network.
•
Simple Control environment set up and running.
IMPORTANT:
Simple Sync requires a Simple Control environment. Simple Sync provides no functionality without a Simple Control environment. Your
Simple Control account is not related to your Apple App Store
account or to older Roomie Remote accounts.
ADDITIONAL RESOURCES
Additional resources for Simple Sync include:
Released January 2016
•
Simple Control User Guide: Describes the features of Simple Control for iOS.
Available on the Simple Control website.
•
Knowledge Base: Answers many common questions. Available on the Simple
Control website.
•
Support: Lets you submit a support request via the Simple Control website.
10
Copyright © 2016 by Roomie Remote, Inc.
1
Setup
This chapter describes how to set up Simple Sync for OS X by purchasing a license and
then installing Simple Sync for OS X.
This chapter includes:
•
“Overview” on page 11
•
“Purchasing a License” on page 12
•
“Installing Simple Sync” on page 12
OVERVIEW
Simple Sync for OS X requires a license, which you can provide in either of two ways:
•
Purchase a Simple Sync Software License. From the Simple Store (store.simplecontrol.com).
•
Use an existing Roomie Agent license. If you purchased the legacy Roomie
Agent product, your Roomie Agent license will be accepted by Simple Sync; you
will be prompted for it the first time you open Simple Sync.
The following information is important to understand about Simple Sync for OS X:
•
When you purchase your Simple Sync Software License, you must be logged in to
your Simple Control account.
Refer to the Simple Control User Guide for more information about Simple Control accounts.
•
Your Simple Control account is not related to your Apple App Store account or to
older Roomie Remote accounts.
•
No physical license is needed. Your Simple Sync license gets associated with your
Simple Control clients automatically when you pair the clients with Simple Sync.
•
To associate your Simple Sync license with your Simple Control clients, pair those
clients with Simple Sync. You must be signed in on your Simple Control clients to
the same Simple Control account you used to purchase the license.
•
When you first open Simple Sync after installation, Simple Sync will prompt you
to either pair a Simple Control client or to present your legacy Roomie Agent
license. If you do not do either, Simple Sync stays in pairing mode, where most
features are disabled.
Simple Sync stays in pairing mode until you pair a Simple Control client that has a
Simple Sync license associated with it or you present a legacy Roomie Agent
license.
Copyright © 2016 by Roomie Remote, Inc.
11
Released January 2016
Setup
Simple Sync for OS X User Guide
PURCHASING A LICENSE
Purchase your Simple Sync Software License from the Simple Store.
NOTE:
Sign in to your Simple Control account before you purchase your Simple
Sync Software License.
To purchase a Simple Sync Software License:
1.
Navigate to the Simple Store (https://store.simplecontrol.com/index.php/customer/account/login/), log in to your account, click Store in the My Account section, click Simple Sync Software License, then click Add to Cart.
Follow the on-screen instructions to make your purchase.
2. On the Mac OS X system on which you want to run Simple Sync, open the email
you receive from Simple Control Sales.
3. Click the link for the appropriate product.
The My Downloadable Products screen appears.
4. Click the download link for Simple Sync for OS X.
The Simple Sync installer is downloaded to your Mac OS X system.
INSTALLING SIMPLE SYNC
To install Simple Sync for OS X:
1.
On your Mac OS X system, find the Simple Sync installer and double click it.
The Simple Sync screen appears.
2. Drag Simple Sync.app into the Applications folder on your OS X system.
3. In your Applications folder, locate Simple Sync.app and double click it.
4. If you are prompted to open an application from the Internet, click Open.
Simple Sync is installed.
Released January 2016
12
Copyright © 2016 by Roomie Remote, Inc.
2
Pairing
This chapter tells you how to pair Simple Control clients with Simple Sync for OS X.
This chapter includes:
•
“Overview” on page 13
•
“Pairing and Licensing” on page 13
•
“Pairing the First Simple Control Client with Simple Sync” on page 14
•
“Pairing Additional Simple Control Clients” on page 15
•
“Troubleshooting Pairing” on page 16
OVERVIEW
Simple Control configurations are secured by pairing Simple Control clients with Simple Sync.
IMPORTANT:
The Secure Pairing feature requires Simple Sync and Simple Service or
Roomie Service.
Simple Sync pairs with the first Simple Control client on the local network without
asking for approval.
All additional Simple Control clients must be approved: the second client must be
approved by the first client, the third client can be approved by either the second or
third client, and so on.
The Simple Sync screen shows an icon for each Simple Control client:
The world globe icon means the Simple Control client is
not paired with Simple Sync.
The connected home icon means the Simple Control client is paired with Simple Sync.
PAIRING AND LICENSING
Pairing your Simple Control client with Simple Sync for OS X for the first time also
associates your Simple Sync Software License with the Simple Control client.
When you first open Simple Sync after installation, Simple Sync will prompt you to
either pair a Simple Control client or present a legacy Roomie Agent license. If you do
not do either, Simple Sync stays in pairing mode, where most features are disabled.
Simple Sync stays in pairing mode until you pair a Simple Control client that has a
Simple Sync license associated with it or you present a legacy Roomie Agent license.
Copyright © 2016 by Roomie Remote, Inc.
13
Released January 2016
Pairing
Simple Sync for OS X User Guide
PAIRING THE FIRST SIMPLE CONTROL CLIENT WITH SIMPLE SYNC
The first Simple Control client you pair with Simple Sync does not require approval.
To pair the first Simple Control client with Simple Sync:
1.
Open Simple Sync on a Mac OS X system on the local network.
The Simple Sync icon appears on the taskbar.
2. Simple Sync finds the Simple Control client on the local network and offers to
pair it to Simple Sync.
The Detected Home screen appears on the
Simple Control client.
It could take a moment or two for the
Detected Home screen to appear.
Because this is the first Simple Control client
to pair with Simple Sync on this network, no
approval is required to pair.
3. Tap Yes.
The Simple Control client is paired with Simple Sync.
4. To verify that the Simple Control client is paired with Simple Sync, open the Simple Control client, then tap the Settings icon.
The Settings screen appears.
The Settings screen shows that this client is
paired.
5. Tap Simple Sync.
The Simple Sync screen appears.
The Paired With field shows that the client is
now paired with the device hosting Simple
Sync, which in this example is Scott’s MacBook Pro.
Released January 2016
14
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
Pairing
PAIRING ADDITIONAL SIMPLE CONTROL CLIENTS
All Simple Control clients after the first client that you want to pair to Simple Sync
must be approved by an already-paired client.
To pair additional Simple Control clients with Simple Sync:
1.
Simple Sync finds the Simple Control client on the local network and offers to
pair it to Simple Sync.
Because this is not the first Simple Control
client to pair with Simple Sync on this network, approval by an already-approved client
will be required to pair.
2. Tap Yes.
3. On a Simple Control client that has already been paired with Simple Sync, the
Pairing Request screen appears.
4. Tap Approve.
The Simple Control client is now paired with Simple Sync.
Copyright © 2016 by Roomie Remote, Inc.
15
Released January 2016
Pairing
Simple Sync for OS X User Guide
TROUBLESHOOTING PAIRING
In some cases, an older or misconfigured router may prevent Simple Sync from offering to pair with Simple Control clients. In this situation, you can manually pair a Simple Control client with Simple Sync.
To manually pair a Simple Control client with Simple Sync:
1.
Open the Simple Control client, then tap the Settings icon.
The Settings screen appears.
2. Tap Simple Sync.
The Simple Sync screen appears.
3. In the Simple Sync Devices section, tap the name of the device you want to pair
with.
4. On the screen that appears, tap Pair with [device name].
A confirmation dialog appears.
5. Tap Pair.
If this is the first Simple Control client you are pairing with Simple Sync, no
approval is required.
If this is an additional Simple Control client that you are pairing, the pairing
request must be approved by an already-approved client.
If you are still experiencing issues, try one of these methods:
•
Reset Simple Sync: On the Mac OS X device hosting Simple Sync, pull down the
Simple Sync menu, select Preferences, tap Reset Simple Sync on the bottom of
the Preferences screen, then try pairing again.
When you pair by resetting Simple Sync, the configuration from the Simple Control client will be pushed onto Simple Sync as the active configuration.
•
Reset the Simple Control client: Open the Simple Control client, tap Settings,
tap Reset Configuration (near the bottom of the Settings screen), tap Reset
when the confirmation dialog appears, then try pairing again.
If you reset your Simple Control client, its configuration will be lost and your client will be prompted to inherit the active configuration from Simple Sync.
Released January 2016
16
Copyright © 2016 by Roomie Remote, Inc.
3
Client Settings
This chapter describes the Simple Sync related settings that are available on Simple
Control and Simple System clients.
This chapter includes:
•
“About Client Settings” on page 17
•
“Accessing Client Settings” on page 17
•
“Configuring Client Settings” on page 18
•
“Synchronization Peers” on page 19
•
“Remote Access” on page 20
ABOUT CLIENT SETTINGS
There are multiple Simple Sync related settings you can control on a client:
•
Settings related to a specific Simple Sync device: These settings apply to the
Simple Sync device to which the client is paired.
•
Synchronization Peers: Shows what Simple Control or Simple System clients are
paired with Simple Sync. Lets you lock the configuration of other paired clients.
•
Remote Access: Lets you enable or disable the Remote Access feature.
ACCESSING CLIENT SETTINGS
The following procedure assumes your client is paired with Simple Sync.
To access Simple Sync related settings on a client:
1.
On the client, open Settings, tap Simple Sync, then tap the name of the device
hosting Simple Sync in the Simple Sync Devices section.
In this example, Scott’s MacBook Pro is the
name of the device hosting Simple Sync, so
you would tap Scott’s MacBook Pro.
The screen appears is named for the device hosting Simple Sync.
NOTE:
Some settings are not configurable unless you are paired with Simple Sync.
Copyright © 2016 by Roomie Remote, Inc.
17
Released January 2016
Client Settings
Simple Sync for OS X User Guide
CONFIGURING CLIENT SETTINGS
Simple Sync related settings on clients are:
•
Pairing/Unpairing: If the client is paired
with Simple Sync, tap Unpair from Simple Sync to unpair.
If the client is not paired with Simple
Sync, tap Pair with Simple Sync to pair.
•
•
Licensed To: Displays the email address
of the Simple Sync license holder. Displays Unlicensed if the client is not
paired.
•
OS Version: Shows the version of OS X
running on the Macintosh hosting Simple
Sync.
•
IP Address: Shows the IP address of the
Simple Sync for OS X on the local network.
External URL: Shows the URL needed to make a connection to Simple Sync from
outside your network.
If a URL appears (for example, https://198.51.100.100:47148), you do not need
to do anything. Note that the IP address in your URL will be different than what is
shown in this example.
If a URL does not appear, refer to Simple Sync DNS Name for more information.
•
Automatically Approve Pairing
Requests: When enabled, Simple Sync
automatically approves all pairing
requests; approval from an
already-approved client is no longer
required.
•
Allow Commands from External Systems: When enabled, Simple Sync allows
commands from external systems, such
as SmartThings or other systems that use
Simple Control’s REST API.
•
Collect Diagnostics: Tells Simple Sync to
collect diagnostic information for analysis by Simple Control Support.
When enabled, Collect Diagnostics generates a significant amount of data. Be
sure to disable it when you are done gathering the necessary information.
Released January 2016
18
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
Client Settings
•
Send Diagnostics: Tap to send collected diagnostic information to Simple Control Support.
•
Simple Sync DNS Name: Used to set up a port forwarding rule on your router to
support access from outside your network, if needed. Most routers will not
require a port forwarding rule to be created. A port forwarding rule is generally
only needed with older routers that do not support standard protocols and thus
remote access does not work initially.
If a URL appears in the External URL field, you do not need to create a port forwarding rule. If a URL does not appear in the External URL field, put your external IP address in the Hostname field, then configure a port forwarding rule on
your router. Refer to your router’s documentation for information about creating
a port forwarding rule.
NOTE:
•
Amazon Echo support does not require port forwarding. Only the Remote
Access feature and External Commands may require port forwarding.
Reset [device name]: Tap to reset Simple Sync on the specified device.
SYNCHRONIZATION PEERS
Simple Sync keeps your Simple Control or Simple System configurations securely synchronized on all of your clients. Changes on one client are automatically reflected on
all other clients.
Even if no Simple Control or Simple System clients are active, Simple Sync tracks configurations, status for all activities, and power states of all devices.
Viewing Synchronization Peers
You can view all current synchronization peers on the Simple Sync screen of the Settings on a paired Simple Control or Simple System client.
To view synchronization peers:
1.
On a Simple Control or Simple System client paired with Simple Sync, open Settings, then tap Simple Sync.
The Simple Sync screen appears.
2. Tap Synchronization Peers.
The current synchronization peers display.
This screenshot shows two synchronization
peers: Scott’s iPod touch and Scott’s iPad.
The unlocked padlock icon next to Scott’s
iPad indicates that its configuration can be
locked using the Configuration Lockdown
feature.
Copyright © 2016 by Roomie Remote, Inc.
19
Released January 2016
Client Settings
Simple Sync for OS X User Guide
REMOTE ACCESS
Commands, activities, and feedback to and from your clients work remotely from
outside your local network when the Simple Control or Simple System client is
securely paired with Simple Sync and the Remote Access feature is enabled.
You can raise or lower blinds from the office, for example, or lower the thermostat if
you are away on vacation.
Remote Access requires Simple Sync and a Simple Service subscription. Remote
Access is not available with a Roomie Service subscription.
You must enable the Remote Access feature to integrate Simple Control or Simple
System with Amazon Echo. Refer to the Simple Control/Amazon Echo Integration
Guide for more information.
To enable or disable the Remote Access feature:
1.
Make sure your Simple Control or Simple System client is paired with Simple
Sync, then open Settings, then tap Simple Sync.
The Simple Sync screen appears.
2. Locate the Allow Remote Access setting at the bottom of the screen.
3. If Allow Remote Access is currently disabled (the white circle is on the left and
the slider has a black background) and you want to enable it, move the white circle to the right, then tap Enable on the popup that appears; the slider background turns green. Remote Access is enabled.
4. If Allow Remote Access is currently enabled (the white circle is on the right and
the slider has a green background) and you want to disable it, move the white circle to the left, then tap Disable on the popup that appears; the slider background
turns black. Remote Access is disabled.
Refer to the Simple Control User Guide for more information about the Remote
Access feature.
Released January 2016
20
Copyright © 2016 by Roomie Remote, Inc.
4
The Simple Sync Menu
This chapter describes the commands available on the Simple Sync menu.
This chapter includes:
•
“Overview” on page 21
•
“Show Sync Status” on page 22
•
“Backup Configuration to Simple Sync” on page 22
•
“Configuration Restore from Simple Sync” on page 23
•
“Preferences” on page 24
•
“Check for Updates” on page 25
•
“About Simple Sync” on page 25
•
“Quit Simple Sync” on page 25
OVERVIEW
The Simple Sync icon sits on the menu bar of your Mac OS X system.
The Simple Sync menu gives you quick access to many of the features of Simple Sync.
Copyright © 2016 by Roomie Remote, Inc.
21
Released January 2016
The Simple Sync Menu
Simple Sync for OS X User Guide
SHOW SYNC STATUS
Select Show Sync Status from the Simple Sync menu to see the Simple Sync screen.
Refer to Chapter 5, The Simple Sync Screen, for more information.
BACKUP CONFIGURATION TO SIMPLE SYNC
You can back up multiple Simple Control configurations to Simple Sync.
To back up a Simple Control configuration to Simple Sync:
1.
On your Mac OS X system, pull down the Simple Sync menu, then select Backup
Configuration.
The Documents screen opens.
Released January 2016
22
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
The Simple Sync Menu
2. Navigate to the location on your Mac OS X system where you want to save the
folder that will store the Simple Control configuration backup files.
You can save the folder anywhere on your Mac OS X system.
The folder will be named using the format Roomie-[Date]-[Time]. For example,
Roomie-2015-9-14-145921, which means the folder was created on Sept. 14, 2015
at 2:59:21 p.m. Your folder will be named differently.
Using the time of creation as the folder name allows you to differentiate between
backups.
3. Click Open.
The Roomie-2015-9-14-145921 folder is saved to the location you selected.
CONFIGURATION RESTORE FROM SIMPLE SYNC
If you have backed up Simple Control configurations using Simple Sync, you can
restore any of those configurations.
To restore a Simple Control configuration from Simple Sync:
1.
Pull down the Simple Sync menu, then select Restore Configuration.
The Documents screen opens.
2. Highlight the folder that contains the configuration you want to restore.
3. Tap Open.
The configuration is restored.
Copyright © 2016 by Roomie Remote, Inc.
23
Released January 2016
The Simple Sync Menu
Simple Sync for OS X User Guide
PREFERENCES
Select Preferences from the Simple Sync menu to display the Preferences screen.
Simple Sync preferences are:
•
Start Simple Sync at Login: Automatically starts Simple Sync when you start up
the Mac OS X system.
•
Remember Offline Devices: Tells Simple Sync to remember devices running Simple Control if they go offline.
•
Collect Diagnostics: Tells Simple Sync to collect diagnostic information to email
to Simple Control Support.
When enabled, Collect Diagnostics generates a significant amount of data. Be
sure to disable it after you click Send Diagnostics to send the gathered data.
•
Simple Sync Master: When enabled, Simple Sync acts as the master control for
Simple Control clients on the local network, including support for the Remote
Access feature and interaction with a SmartThings environment.
When disabled (slave mode), Simple Sync does not act as the master control for
the clients on the network, nor does it support Remote Access or interaction with
SmartThings. It does support other Simple Sync features, including triggers, configuration lockdown and backups, OS X screen control, and agent commands.
If you have more than one Simple Sync on a network, only one can have Simple
Sync Master enabled; all others must have Simple Sync Master disabled.
Released January 2016
•
Automatically Approve Pairing Requests: When enabled, Simple Sync automatically approves pairing requests where approval would normally be required.
•
Allow Commands from External Systems: When enabled, Simple Sync allows
commands from external systems, such as SmartThings.
•
Reset Simple Sync: Click to reset Simple Sync.
24
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
The Simple Sync Menu
CHECK FOR UPDATES
Select Check for Updates from the Simple Sync menu to have Simple Sync check for
a more recent version.
If there is a more recent version, you are prompted to download and install it.
If you are currently using the most recent version, no action is required.
ABOUT SIMPLE SYNC
Select About Simple Sync from the Simple Sync menu to display the About screen.
The About screen displays version number and license information for the version of
Simple Sync that you are running.
QUIT SIMPLE SYNC
Select Quit Simple Sync from the Simple Sync menu to exit from Simple Sync.
The Simple Sync menu disappears from the menu bar; it is no longer active.
NOTE:
Closing the Simple Sync status screen using the red dot in the upper left
corner of the screen does not quit you out of Simple Sync, it just closes the
screen; Simple Sync remains active.
Copyright © 2016 by Roomie Remote, Inc.
25
Released January 2016
The Simple Sync Menu
Released January 2016
Simple Sync for OS X User Guide
26
Copyright © 2016 by Roomie Remote, Inc.
5
The Simple Sync Screen
This chapter describes the Simple Agent screen, which shows Simple Control clients
that are in the same synchronization mesh and lets you lockdown their configurations.
This chapter includes:
•
“The Simple Sync Screen” on page 27
•
“Configuration Lockdown” on page 28
THE SIMPLE SYNC SCREEN
The Simple Sync screen shows Simple Control clients that are on the local network.
This image shows information about two Simple Control clients:
•
The icon on the far left: Connected home, for both clients. Indicates these clients
are paired with Simple Sync. The icon for an unpaired client is a world globe.
•
The name of the Simple Control clients: Scott’s iPad and Scott’s iPod Touch
•
The active room: Home, for both clients
•
The active activity: Watch Motorola, for both clients
•
The Simple Control version: 4.1.0
•
The iOS device type: iPad and iPod Touch
•
The iOS version: 9.2 and 9.2.1
NOTE:
The information on the Simple Sync screen grays out when the Simple Control app is no longer the active app on the device.
Copyright © 2016 by Roomie Remote, Inc.
27
Released January 2016
The Simple Sync Screen
Simple Sync for OS X User Guide
CONFIGURATION LOCKDOWN
The configuration lockdown feature lets you lock the configuration of a Simple Control client using Simple Sync. While locked, you cannot enter Edit mode on the client.
NOTE:
The configuration lockdown feature requires a Simple Service subscription.
When you lockdown a configuration, you set a PIN that allows you unlock the configuration of the Simple Control client (via a command in Settings). You can also unlock
the configuration from the Simple Sync screen.
You can also use the configuration lockdown feature in conjunction with Guided
Access mode on your iOS device to set up a virtual remote dedicated to a single room.
Locking a Configuration
To lock down the configuration of a Simple Control client:
1.
On your Mac OS X system, pull down the Simple Sync menu and select Show
Sync Status.
The Simple Sync screen appears.
2. Select the Simple Control client whose configuration you want to lock.
When you select the client, the background turns bright blue.
3. Click Lock.
The PIN dropdown appears.
4. Enter the desired PIN, up to five digits.
You must use numbers; letters and special characters are not allowed.
5. Click Lock.
The configuration of the Simple Control client is locked; the padlock symbol
appears to the left of the name of the client.
Released January 2016
28
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
The Simple Sync Screen
Unlocking a Configuration in Simple Sync
To unlock a configuration from the Simple Sync screen:
1.
On your Mac OS X system, pull down the Simple Sync menu and select Show
Sync Status.
The Simple Sync screen appears.
2. Select the Simple Control client whose configuration you want to unlock.
3. Click Unlock.
The padlock symbol changes to the Simple Control icon; the configuration is
unlocked.
To unlock a configuration on the Simple Control client:
1.
On the Simple Control client, tap the Settings icon to access Settings.
You will be prompted to enter the unlock PIN.
2. Using the number pad, enter the PIN you set using Simple Sync.
When you enter the correct PIN, the Settings screen appears.
Copyright © 2016 by Roomie Remote, Inc.
29
Released January 2016
The Simple Sync Screen
Simple Sync for OS X User Guide
3. Navigate to Prevent Editing, then disable it (tap or slide the white circle until the
green background disappears).
The configuration is unlocked.
4. Click Done to exit from Settings.
Dedicating a Virtual Remote to a Single Room
You can configure your iOS device to run only the Simple Control app and Simple
Control to work only in one room, thereby giving you a virtual remote dedicated to a
single room. Be sure to set up the room the way you want it first.
To do this, you use Guided Access mode on the iOS device, which restricts the iOS
device to running a single app, and Single Room Mode in Simple Control.
This could be used in a guest room, for example, where you want the iOS device to
work as a virtual remote in that room only and you do not want the remote’s configuration to be edited.
To configure a virtual remote dedicated to a single room:
1.
On your iOS device (not in Simple Control), navigate to Settings > General >
Accessibility > Guided Access.
The Guided Access screen appears.
2. Enable Guided Access (tap the slider so that the green background appears).
3. Exit from Settings on your iOS device.
4. Open Simple Control, open Settings, enable Prevent Editing, tap Single Room
Mode, then tap the name of the room to which you want Simple Control dedicated.
Click Done to exit from the Simple Control Settings.
5. Triple click the Home button on the iOS device.
The Guided Access screen appears.
6. Tap Start.
The Set Passcode screen appears.
7. Enter a four-digit passcode, then re-enter it.
Guided Access begins.
You cannot use the iOS device except to run Simple Control and you can only use
Simple Control to control the room you specified.
8. To exit from Guided Access, triple click the Home button, enter the four-digit
passcode, then click End.
Released January 2016
30
Copyright © 2016 by Roomie Remote, Inc.
6
Mac OS X System Control
This chapter describes how to use Simple Sync to control the mouse and keyboard on
the OS X system hosting Simple Sync.
Screen control requires a Simple Service subscription.
This chapter includes:
•
“Overview” on page 31
•
“Adding Simple Sync as a Device and Creating an Activity” on page 31
•
“Using the Virtual Remote” on page 33
OVERVIEW
To control the mouse and keyboard on the Mac OS X system hosting Simple Sync:
1.
Add Simple Sync as a device in Simple Control or Simple System.
2. Create an activity.
3. Open the activity and use the virtual remote.
These steps are described below.
ADDING SIMPLE SYNC AS A DEVICE AND CREATING AN ACTIVITY
To add Simple Sync as a device in Simple Control and create an activity:
1.
Open Simple Control to the desired room, then make sure it is in Edit mode.
2. Tap Add Device.
The Add Device screen appears.
3. Tap Simple Sync.
Copyright © 2016 by Roomie Remote, Inc.
31
Released January 2016
Mac OS X System Control
Simple Sync for OS X User Guide
The Add Device screen appears.
4. Tap Save.
The Create Activity popup appears.
5. Tap Create Activity.
The list of activities for the room appears.
Control OS X is the default name for the
activity you use to control the mouse and
keyboard on your OS X system.
Released January 2016
32
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
Mac OS X System Control
USING THE VIRTUAL REMOTE
You control your OS X system using the virtual remote.
To control your OS X system using the virtual remote:
1.
In Simple Control, tap the Control OS X activity.
The virtual remote appears.
2. Tap the mouse icon to control the screen.
This image is an iPad Mini in landscape mode; your screen will look different.
Copyright © 2016 by Roomie Remote, Inc.
33
Released January 2016
Mac OS X System Control
Simple Sync for OS X User Guide
While using the screen:
–
tap and drag to move the mouse
–
left mouse: single-finger tap
–
right mouse: two-finger tap
Tap the X in the upper right corner to close the screen.
3. Tap the keyboard icon to enter text.
The cursor must be in a position to accept text.
Tap Done to hide the keyboard.
4. Tap the finger icon to display a gesture panel.
Gesture panels are described in detail in the Simple Control User Guide.
5. Tap the numbers to enter them in a text field.
6. Tap System to access system commands.
Restart restarts the OS X system, Shutdown shuts it down, and Sleep puts it to
sleep. Be sure to save your data before restarting or shutting down.
Released January 2016
34
Copyright © 2016 by Roomie Remote, Inc.
7
Simple Sync Commands
This chapter describes using Simple Sync commands, which let you control your OS X
system by sending it commands via Simple Control or Simple System.
Commands include launching applications, mouse position, Wake on LAN, restart or
shutdown, and so on.
Simple Sync commands require a Simple Service subscription.
This chapter includes:
•
“About Simple Sync Commands” on page 35
•
“Using Simple Sync Commands” on page 36
ABOUT SIMPLE SYNC COMMANDS
Once Simple Sync is installed and licensed, you can add it as a device in Simple Control or Simple System, which makes available additional commands that can be run
from Simple Control or Simple System.
These additional commands must specify Simple Sync Auxiliary as the target and the
commands themselves affect only the Mac OS X system on which Simple Sync is running.
These commands can be part of an activity or a button on a virtual remote. Refer to
Simple Control User Guide for detailed information about commands.
NOTE:
Simple Sync must be running on the OS X system for these additional commands to work.
While most of the additional commands are self explanatory, some require additional information:
•
the .MOUSE SET command is proportional to the destination screen. The upper
left corner is 0,0 and the lower right is 1.0,1.0. So for example if you were to set
.MOUSE SET to 0.5,0.5, the mouse would be placed in the middle of the screen.
•
application names used with .APPLICATION LAUNCH are only the application
names exactly as stored in the Applications folder on the OS X system. For example, XBMC. Do not use path names with .APPLICATION LAUNCH.
•
the .APPLICATION QUIT command uses the process name, not the application
name. These are usually the same, with a few exceptions such as Plex, which is
“Plex” instead of “Plex Home Theater.”
•
Script names for the .SCRIPT RUN command are full path names. For instance, “/
Users/jon/Documents/myscript.scpt” would be a potential AppleScript. Do not
use path abbreviations such as “~” in the path names.
Copyright © 2016 by Roomie Remote, Inc.
35
Released January 2016
Simple Sync Commands
Simple Sync for OS X User Guide
USING SIMPLE SYNC COMMANDS
To demonstrate how to use a Simple Sync command, the following procedure: adds
Simple Sync as a device, creates a new activity called Open Maps, and adds the Simple
Sync command .APPLICATION LAUNCH .
If you have already added Simple Sync as a device in Simple Control, you do not need
to do it again; just jump ahead to Step 6.
Note:
The procedure assumes Simple Sync is installed, licensed, and running on
the OS X system.
To create an activity that includes a Simple Sync command:
1.
Open Simple Control to the desired room, then make sure it is in Edit mode.
2. Tap Add Device.
The Add Device screen appears.
3. Tap Simple Sync.
The Add Device screen appears.
4. Tap Save.
Released January 2016
36
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
Simple Sync Commands
The Create Activity popup appears.
5. Tap Create Activity.
The main screen for the room appears.
6. Tap Add Activity.
The Add Activity screen appears.
Copyright © 2016 by Roomie Remote, Inc.
37
Released January 2016
Simple Sync Commands
Simple Sync for OS X User Guide
7. Enter Open Maps in the Title field using the keyboard, then tap Done on the bottom of the keyboard to dismiss it.
8. Tap Add Command.
The Choose Target screen appears.
9. Tap Simple Auxiliary.
Released January 2016
38
Copyright © 2016 by Roomie Remote, Inc.
Simple Sync for OS X User Guide
Simple Sync Commands
The Choose Command screen appears.
10. Scroll down until you can see .APPLICATION LAUNCH or tap the blue # on the
right side of the screen to jump down.
11. Tap .APPLICATION LAUNCH.
The Add Command screen appears.
The .APPLICATION LAUNCH command is
selected.
Do not forget to specify what application
you want to launch.
12. At the bottom of the Add Command screen, tap Application.
13. Type Maps in the Application field, then tap Save.
IMPORTANT:
Copyright © 2016 by Roomie Remote, Inc.
Remember that with the .APPLICATION LAUNCH command, the
name of the application you want to open has to exactly match the
name in the Applications folder on the Mac OS X system.
39
Released January 2016
Simple Sync Commands
Simple Sync for OS X User Guide
The Add Activity screen appears, now showing the .APPLICATION LAUNCH
command.
14. Tap Save.
The main screen for the room appears, now showing the new Open Maps activity
that we just created.
15. Tap Edit to switch to User mode.
16. Tap Open Maps to open the Maps application on the Mac OS X system.
Released January 2016
40
Copyright © 2016 by Roomie Remote, Inc.
A
About Trigger Agents
This appendix describes trigger agents and tells you how to view the current trigger
agent.
This chapter includes:
•
“About Trigger Agents” on page 41
•
“Viewing the Current Trigger Agent” on page 42
ABOUT TRIGGER AGENTS
Simple Control and Simple System support device-based, timer-based, and
time-based triggers. Refer to the Simple Control User Guide for more information
about triggers.
NOTE:
All triggers require a Simple Service or Roomie Service subscription.
Triggers require a trigger agent, a device that continually monitors the network for
trigger commands and executes them.
There are two types of trigger agents:
•
iOS device running Simple Control or Simple System: Because the trigger agent
must continually monitor the network for trigger commands, if you use a device
running Simple Control or Simple System as a trigger agent it must always be
turned on with Simple Control or Simple System as the foreground app.
NOTE:
•
We recommend against using an iOS device running Simple Control or Simple System as trigger agent.
Simple Sync: Simple Sync does not have the same issue as a device running Simple Control or Simple System. Simple Sync can execute triggers even when it is
running in the background on the host Mac OS X system.
IMPORTANT:
When you pair a Simple Control or Simple System client with Simple
Sync, Simple Sync is automatically locked in as the trigger agent.
If you want to set a different trigger agent, you need to unpair. This unlocks the
trigger agent and you can select any available trigger agent.
Copyright © 2016 by Roomie Remote, Inc.
41
Released January 2016
About Trigger Agents
Simple Sync for OS X User Guide
VIEWING THE CURRENT TRIGGER AGENT
You can view the current trigger agent setting on a Simple Control or Simple System
client at any time.
To view the current trigger agent on a client:
1.
Open the Simple Control or Simple System client, then tap Settings.
The Settings screen appears.
2. Tap Triggers (you may have to scroll
down.)
The Triggers screen appears.
In this example, the trigger agent is Simple
Sync.
If the client is paired with Simple Sync, then the trigger agent assignment is
locked, and tapping Trigger Agent has no effect.
If the client is not paired with Simple Sync, then you can tap Trigger Agent and
select a trigger agent from the list of possible trigger agents that appears.
Refer to the Simple Control User Guide for more information about creating and using
triggers.
Released January 2016
42
Copyright © 2016 by Roomie Remote, Inc.