Related Manuals for PCS PulseWorx Gateway
Summary of Contents for PCS PulseWorx Gateway
- Page 1 Gateway User Guide Version 1.5 14-March-2016 19201 Parthenia Street, Suite J Northridge, CA 91234 P: 818.701.9831 F: 818.701.1506 pcssales@pcslighting.com www.pcslighting.com...
-
Page 2: Table Of Contents
Introduction............................1 Downloads............................1 Initial Setup ............................1 Configuring your UPB home file design for use with smart phones, tablets, or the PCS Windows App ..3 Exporting the UPB network design to the Gateway................6 Remote access using the PulseWorx-App Windows Application ............8 Security considerations ........................11 Remote access using the application for iPhone and iPad ..............13... - Page 3 Connection Catalog ..........................52 Upgrading the PulseWorx Gateway Firmware .................55...
-
Page 4: Introduction
The latest version of this User Guide, the PulseWorx Windows Application, the newest version of UPStart, and any Gateway firmware updates are all available from the PCS PulseWorx web site. You will find all these downloads under Support on the Master Download list under the category Gateway. - Page 5 UPB file you may do this after you are connected to the Gateway. 9. Select in the ribbon the “PulseWorx Gateway” category. Press the “Location” button and set the location by entering your zip code and then pressing the “Zip Code Lookup” button. If you are not in a location covered by a US zip code then use the manual configuration button and enter all the necessary information in that dialog.
-
Page 6: Configuring Your Upb Home File Design For Use With Smart Phones, Tablets, Or The Pcs Windows App
Configuring your UPB home file design for use with smart phones, tablets, or the PCS Windows App When your UPB network design appears in a remote application (applications on Smart Phones or Tablets) icons represent each room and within the room icons represent each device. Unlike the icons used by UPStart these should represent the actual devices controlled. - Page 7 - you can disable the “Show Icon” option by “un-ticking” the checkbox. For a two channel device like the PCS OCM2 (Output Control Module) you can select an icon and icon label for each channel. If you are only using a single channel of the device, you can un-tick the unused channel so it doesn’t show on the application display.
- Page 8 each button. These button names are seen in the remote applications in popup keypads where you can virtually “push” keypad buttons”. For this purpose, the button size and font choices don’t matter. Once you have room icons, device icons, and keypad button text all configured then save the UPB file. P a g e...
-
Page 9: Exporting The Upb Network Design To The Gateway
Once your design is configured you must export it to the Gateway so it can be accessed by the remote applications. To do this press the “Export” button in the PulseWorx Gateway” ribbon category and press the “Start” button to begin the export. - Page 10 The second option works well with the UPStart "Network State" operation which queries each device for its state and can use that state for the export. Here is what you can do when you are ready to export your UPB network to the Gateway. First, use the "Network – Status All" operation. Second, export using the "Update Gateway state from UPStart state"...
-
Page 11: Remote Access Using The Pulseworx-App Windows Application
Start PulseWorx-App and press the “Configure Connection” button in the ribbon. The dialog is very similar to that in UPStart. Again, choose the interface type as “PulseWorx Gateway” then use the “Find Gateway” button to locate the Gateway IP address and port. It is important to enter in the username and password for the user you created during the UPStart session. - Page 12 At this point you can click on a room icon to enter that room and show the devices in the room. You can click on a device to toggle its state – ON to OFF or OFF to ON – or double-click on the device to open a control panel where you can control it ON or OFF using buttons or set a level - if dimmable - with a slider.
- Page 13 devices that have multiple icon representations, by the icon image. For example, the Bookcase Lights are on and the Bar Light isn’t. For a keypad, the popup has a representation of the keypad and you can click on the buttons to have the same action as was programmed for the keypad single-click action.
-
Page 14: Security Considerations
Gateway and then start UPStart. Once connected to the Gateway, press the “Users” button in the “PulseWorx Gateway” ribbon category. As you can see the Gateway can store information for up to four users. Usernames and password can be up to 16 characters in length. - Page 15 Tip: If your router supports it and are very concerned about security, you may want to investigate using a Virtual Private Network (VPN). Establishing one and configuring for it is beyond the scope of this User Guide or PCS Technical support. Contact people who specialize in networks. 12 |...
-
Page 16: Remote Access Using The Application For Iphone And Ipad
Remote access using the application for iPhone and iPad The PulseWorx application is available in the Apple App Store. After downloading and installing, first open the Settings application and choose “PulseWorx” to edit the connection information. As part of the settings for the application, the IP address of the Gateway is specified. The application settings have a place for a primary and a secondary IP address. - Page 17 The reason for having two IP addresses is best explained by an example. Let’s see how a user called Bob uses the primary and secondary IP addresses. When Bob is at home he accesses the Gateway from his tablet using wireless. The IP address of his Gateway is always 192.168.2.100.
- Page 18 Connection. There are three options in the connection and they control how the primary and secondary Gateway connection is used. They are: o Use primary, if fails use secondary connection (the default) o Use only Primary connection o Use only secondary connection Once you have the settings entered then you can start the PulseWorx application.
- Page 19 gray then no device in the room is on. A tap on a device toggles its state – on to off or off to on. Some icons have two representations and the icon changes to show its state – the bookcase lights in the above image. Others have only a single representation –...
-
Page 20: Remote Access Using The Application For Android
Remote access using the application for Android The PulseWorx application is available in the Google App Store (aka "Play Store"). After downloading and installing, open the application. Once the application starts you must first configure the Gateway connection. The three icons at the top of the display are –... - Page 21 But when Bob is not at home he wants to access his Gateway using BobsHome.homeDNS.org. So he makes this his secondary IP address. Now when he is out of range of his home network – he is outside his firewall - the connection is made using the mobile device 3G/4G connection or from some wireless hotspot.
- Page 22 Once you have the settings entered then you can return to the application home page and tap on the connect icon (the "arrow and dot"). The application connects to the Gateway and then displays an icon for each room. Note: All the screen images here are using a Android tablet. On an Android phone the display is different but the idea is the same.
- Page 23 A tap on a device toggles its state – on to off or off to on. Most icons have two representations and the icon changes to show its state – note how the off devices are gray and the on devices show in color. In either case the text below the icon shows yellow if the device is on and light gray if it is off.
- Page 24 Tip: The icons shown for rooms and devices, and the text shown in the virtual keypads are all configurable in your design using UPStart. This is described in the “Configuring your UPB network design for remote access” section above. When the application is moved to the background on your mobile device, it disconnects from the Gateway.
-
Page 25: Virtual Keypads
"push" the button and the scene activates. As far as the mobile application is concerned, virtual and real keypads are exactly the same. To add a virtual keypad to your design, select the "PulseWorx Gateway" ribbon category, then press the "Add Virtual Keypad" button in the "Gateway Tools" panel. This dialog opens. - Page 26 All you need do is select the room you want the keypad to appear in, give the keypad a name, and choose the type of keypad. Once added, configure it like any other keypad then export your design to the Gateway and you are ready to go. One great use of virtual keypads is to make the whole remote access experience easier for the less technical folks in your home by customizing a keypad just for them.
-
Page 27: Using Time-Based Schedules In The Gateway
Using time-based schedules in the Gateway In addition to providing a connection point to a UPB network, the Gateway also contains an autonomous time based scheduler. The scheduler sends scene commands based upon a fixed time (for example 10pm), or sun based times (for example, sunset + 10 minutes) on chosen days. If you have worked with the PulseWorx Timed Event Controller (TEC) this is very similar. -
Page 28: Choosing The Scheduling Mode
Choosing the scheduling mode To select which type of scheduling is used, press the “Schedule Mode” button in the “PulseWorx Gateway” ribbon in UPStart. This dialog appears: There are two important considerations when choosing the schedule mode. First, changing scheduling mode clears any existing schedule entries. -
Page 29: Editing Schedules
Editing schedules To edit the schedules press the “Schedule Edit” button in the “PulseWorx Gateway” ribbon Category in UPStart. This dialog appears. It is a good idea to assign better names than “Schedule A”, “Schedule B”, etc. These can be entered into the schedule name entry at the top of each schedule tab. - Page 30 Select the day or days this schedule entry applies to. Choices are: Every Day, Monday – Friday, Saturday – Sunday, These weekdays, or this date. In the “These weekdays” choice there are 7 checkboxes to choose which days of the week this schedule entry applies to. The “This Date”...
-
Page 31: Single Device Control
Suppose for this example, that the “Office Off” scene is scheduled for 10:05pm. This happens at that time each day. Also suppose that on some occasions you don’t want that to happen – you want to override the Gateway scheduler. To do that you can program a PulseWorx keypad to have a button that acts as an override. -
Page 32: Calendar Scheduling
Calendar scheduling If you have selected the Calendar mode of scheduling the procedures outlined above still apply. When editing the schedules the popup dialog also contains a calendar tab. The Gateway stores a five year calendar so you can configure the scheduler for days that “move around”... -
Page 33: Calendar Scheduling: Pairing One Or More Days With A Schedule
In the calendar months those days that are holidays show not in black text but red text. UPStart ships with a holiday definition file that contains the observed dates for the US Federal holidays for the next 5 years. This file, called holidays.csv is in the UPStart installation in the “Program” sub- folder. -
Page 34: Calendar Quick Configuration
Calendar quick configuration To quickly configure the calendar by pairing each weekday to a given schedule use the “Calendar Quick Setup” tool opened from the last button on the lower left of the calendar tab. 31 | P a g e... -
Page 35: Working With Schedules In Upstart When Not Connected To The Gateway
To use this dialog, for each weekday choose the schedule it should be paired with and then close the dialog with OK. The calendar then updates to make these weekday-schedule pairings. Using the Quick setup can make it easier to work with the calendar by performing the majority of assignments for you and then you can use the selection method to change the assignments for specific days. - Page 36 Gateway and save the changes. You can do this after you connect to the Gateway by pressing the “Schedule Program” button in the “PulseWorx Gateway” ribbon category. 3. After you connect to the Gateway and begin an edit of the schedule, UPStart reads the schedule from the Gateway and if the schedule in the Gateway doesn’t match the schedule in...
-
Page 37: Working With Schedules Using The Iphone Or Ipad
Working with schedules using the iPhone or iPad When connected to the Gateway from an iPhone or iPad you can view and modify the entries in a schedule. Note: Currently the mobile applications are limited to editing schedules only if the Gateway is working in Weekly Schedule mode (see above for a discussion of weekly and calendar schedule modes) and can't view or modify schedules if the Gateway is in calendar scheduling mode. - Page 38 Tap on a schedule name to view the entries for that schedule. 35 | P a g e...
- Page 39 To edit a schedule entry, tap on the schedule entry. To modify any of the schedule entry options, click on the blue text for that option and choices are presented as shown in the above image. In this example, the date is being changed. When done editing, tap on the display background to complete the edit.
- Page 40 To delete a schedule entry, "flick from right to left" on the schedule entry and press the Delete button shown. To show a different schedule use the Back button (blue "< Back" at the top left of the display) and then choose the schedule you want to view/modify.
-
Page 41: Working With Schedules Using The Android Application
Working with schedules using the Android application When connected to the Gateway from an Android device you can view and modify the entries in the schedules. Note: Currently the mobile applications are limited to editing schedules only if the Gateway is working in Weekly Schedule mode (see above for a discussion of weekly and calendar schedule modes) and can't view or modify schedules if the Gateway is in calendar scheduling mode. - Page 42 At the right side of each entry is a "X" icon. Tap on this to delete the entry – you will be asked to confirm the deletion. To add a new entry, tap on the green "Tap here to add a new entry" text at the bottom of the page.
- Page 43 If you have made changes to the schedule then when you return to the main scheduling page a "Save" button lets you commit the changes by saving them in the Gateway. From the main scheduling page you can also change the active schedule. Click on the "Set Current Schedule"...
-
Page 44: Resetting The Gateway
Resetting the Gateway At some point there may become a time to reset the Gateway. For example, if you forget a username or password. Where is the Gateway button? In the description that follows a sequence of button presses are used to configure the Gateway. There are two buttons on the Gateway;... -
Page 45: How To Reset The Gateway To Factory Defaults
How to reset the Gateway to factory defaults Why use this procedure? This procedure is needed in the case where the gateway is set to an IP address that is incompatible with your network. This procedure can also be used if you don’t know the state of the Gateway programming and just want it all erased. - Page 46 Press and hold the Gateway button though the hole on the side of the Gateway with a bent paperclip (see the "Where is the Gateway button" section above) for about 30 seconds until the green (right) LED on the network connector is blinking 2 times per second continuously. You may see the LEDs blink in other ways during this time but keep pressing the button until you see the 2-times per second blinking.
-
Page 47: How To Remove All Users And Passwords Without A Full Factory Reset - Upstart Method
After pressing "Password Reset" a popup requests for you to enter the reset password. The Reset password should be found on a sticker on the Gateway if it was programmed by PCS at the factory. If the reset password was added by you after a factory reset or firmware upgrade hopefully you recorded it someplace as was suggested. - Page 48 After it is entered, close the popup with OK. If the reset password is correct then a success message displays. You should then create new users and assign them privileges and passwords using the "Users" ribbon button. When starting that tool, since there is now no password table, as expected this popup displays. Close the popup and the user table editor opens.
-
Page 49: Network Considerations
What do you do if you lose your usernames and password and the reset password? The only solution is to perform a factory reset on the Gateway using the manual process described in the User Guide. Once done, the next time you create users, UPStart prompts to create a new reset password. Network Considerations As a network device, the Gateway must have what is known as an IP address. -
Page 50: How To Set The Gateway To Dhcp Mode Without A Full Factory Reset
The button press sequences listed below are given as x-y-z. Where x, y, and z are the number of times to press and release the button. The dash character represents a short pause. The button presses need to come in a regular sequence that is not too fast and not too slow. A normally paced rhythm works well: Press and hold down for ½... -
Page 51: How To Assign The Gateway A Static Address If No Dchp Server Is Available
How to assign the Gateway a static address if no DCHP server is available Why use this procedure? If you are installing the Gateway on a network with no DHCP server. Step 1. Have the Gateway powered on for at least 60 seconds before beginning. The Gateway must have the network cable plugged in and connected to the network or this procedure will not work. -
Page 52: How To Assign The Gateway A Specific Static Ip Address
Step 1. Have the Gateway powered on for at least 60 seconds before beginning. Step 2. Start UPStart and press the “Configure” button in the “Powerline Interface” panel in the “PulseWorx Gateway” category in the ribbon. Step 3. Connect to the Gateway using the “Connect” button in the dialog. You must successfully connect before proceeding to the next step. -
Page 53: Accessing The Gateway From Outside The Firewall
Accessing the Gateway from outside the firewall In order to access the Gateway from outside the network firewall there are two issues: the IP address will be different than on the local network and the router must be configured to forward port requests to the Gateway –... -
Page 54: Port Forwarding
Port Forwarding In addition to this IP address you must also configure your DSL or cable modem to understand that a connection to it from a specific port number should have those requests sent to the Gateway. This is called “port forwarding”. Configuring this is different for each network and is beyond the scope of this user guide. -
Page 55: Upstart Considerations
Before you can use the connection catalog you have to enable its use in the UPStart options on the “UPStart Operations” tab. To create a connection catalog, press the Connection Catalog button in the “PulseWorx Gateway” ribbon category. If this is a new connection catalog this dialog appears. - Page 56 If you proceed with creating a connection catalog then the connection list appears. In this example, there are already previously created connections. To edit a connection, select the connection and press the “Edit“ button or double-click on the connection. The connection editor opens. 53 | P a g e...
- Page 57 This dialog shows the configuration for the connection. Make changes and close the dialog with OK. If when editing a connection the username and/or password are left blank then when you select that connection to connect to, UPStart will prompt for the username and/or password before the connection is attempted.
- Page 58 Gateway is the most current. If it isn't then a popup displays. Step 1 In the “PulseWorx Gateway” category, “Advanced” panel, press the “Firmware Update” button. It first displays some helpful info on the process. Press "Yes" to continue and a second popup pauses the process until UPStart confirms that the firmware files are available and of the correct version.
- Page 59 Press "Yes" to continue and then the firmware update process proceeds. As each step completes the indicator for that step turns green. Each time a new firmware image is moved into the Gateway, the Gateway restarts. The process pauses for 120 seconds to allow the Gateway time to restart.
- Page 60 When the countdown reaches zero the next update phase begins. After all phases complete the firmware update is finished and UPStart reconnects to the Gateway. At this point firmware update is complete. ## end of Gateway User Guide ## 57 | P a g e...