Modero - MVP 5200i.operationReferenceGuide
Modero - MVP 5200i.operationReferenceGuide
MVP-5200i
Modero ViewPoint Touch Panel with Intercom, 5.2" and 5
Touch Panels
Last Revised:8/17/2012
All products returned to AMX require a Return Material Authorization (RMA) number. The RMA number is obtained from the AMX RMA Department. The RMA number must be clearly marked on the outside of each box. The RMA is valid for a 30-day period. After the 30-day period the RMA will be cancelled. Any shipments received not consistent with the RMA, or after the RMA is cancelled, will be refused. AMX is not responsible for products returned without a valid RMA number. AMX is not liable for any damages caused by its products or for the failure of its products to perform. This includes any lost profits, lost savings, incidental damages, or consequential damages. AMX is not liable for any claim made by a third party or by an AMX Authorized Partner for a third party. This Limited Warranty does not apply to (a) any AMX product that has been modified, altered or repaired by an unauthorized agent or improperly transported, stored, installed, used, or maintained; (b) damage caused by acts of nature, including flood, erosion, or earthquake; (c) damage caused by a sustained low or high voltage situation or by a low or high voltage disturbance, including brownouts, sags, spikes, or power outages; or (d) damage caused by war, vandalism, theft, depletion, or obsolescence. This limitation of liability applies whether damages are sought, or a claim is made, under this warranty or as a tort claim (including negligence and strict product liability), a contract claim, or any other claim. This limitation of liability cannot be waived or amended by any person. This limitation of liability will be effective even if AMX or an authorized representative of AMX has been advised of the possibility of any such damages. This limitation of liability, however, will not apply to claims for personal injury. Some states do not allow a limitation of how long an implied warranty last. Some states do not allow the limitation or exclusion of incidental or consequential damages for consumer products. In such states, the limitation or exclusion of the Limited Warranty may not apply. This Limited Warranty gives the owner specific legal rights. The owner may also have other rights that vary from state to state. The owner is advised to consult applicable state laws for full determination of rights. EXCEPT AS EXPRESSLY SET FORTH IN THIS WARRANTY, AMX MAKES NO OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. AMX EXPRESSLY DISCLAIMS ALL WARRANTIES NOT STATED IN THIS LIMITED WARRANTY. ANY IMPLIED WARRANTIES THAT MAY BE IMPOSED BY LAW ARE LIMITED TO THE TERMS OF THIS LIMITED WARRANTY. EXCEPT AS OTHERWISE LIMITED BY APPLICABLE LAW, AMX RESERVES THE RIGHT TO MODIFY OR DISCONTINUE DESIGNS, SPECIFICATIONS, WARRANTIES, PRICES, AND POLICIES WITHOUT NOTICE.
This Agreement replaces and supersedes all previous AMX Software License Agreements and is governed by the laws of the State of Texas, and all disputes will be resolved in the courts in Collin County, Texas, USA. For any questions concerning this Agreement, or to contact AMX for any reason, please write: AMX License and Warranty Department, 3000 Research Drive, Richardson, TX 75082.
FCC Information
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received; including interference that may cause undesired operation.
Table of Contents
Table of Contents
Introduction ........................................................................................................1
Overview .................................................................................................................. 1
Common Application....................................................................................................... 1 Features .......................................................................................................................... 1
Memory .................................................................................................................... 5 Table Charging Station Connector Locations............................................................ 5 Basic Operation ........................................................................................................ 5 Navigation Wheel ..................................................................................................... 6
Navigation Wheel Behavior in Each Power Mode ........................................................... 7
Turning on the MVP-5200i ........................................................................................ 8 Intercom Microphone ............................................................................................... 8 Stylus ........................................................................................................................ 8 Kick Stand................................................................................................................. 8 Audio/Video Capabilities .......................................................................................... 8 Power Management.................................................................................................. 8 Cleaning the Touch Overlay, Case, and Navigation Wheel ....................................... 8
Accessories .........................................................................................................9
Table Charging Station ............................................................................................. 9
Powering the MVP-TCS-52 .............................................................................................. 9 Connections and Wiring ................................................................................................ 10 Recharging .................................................................................................................... 10 Cleaning the MVP-TCS-52 ............................................................................................. 10
Wall Charging Station ............................................................................................. 11 Unlocking the Touch Panel ..................................................................................... 12 Recharging.............................................................................................................. 13 Installing the MVP-WCS-52 ..................................................................................... 13
Installing the Plastic Back Box ....................................................................................... 13 Installing the Optional Metal Rough-In Box .................................................................. 17 Other MVP-WCS-52 installations................................................................................... 18
Table of Contents
DHCP............................................................................................................................. 21
Configuring Wireless Network Access .................................................................... 22 Step 1: Configure the Devices Wireless IP Settings ............................................... 22
Wireless communication using a DHCP Address ........................................................... 22 Wireless Communication Using a Static IP Address....................................................... 23 Using the Site Survey Tool ............................................................................................ 23
Using G4 Web Control to Interact with a G4 Panel ................................................ 36 Using the NetLinx Master To Control the G4 Panel................................................ 38
Panel Information Page........................................................................................... 45 Time & Date Settings Page ..................................................................................... 47 Audio Settings Page ............................................................................................... 48
WAV files - Supported Sample Rates ............................................................................ 49
Table of Contents
Client Certificate Configuration .............................................................................. 73 Calibrate Page ........................................................................................................ 75 G4 Web Control Settings Page............................................................................... 76 Other Settings ........................................................................................................ 78
Cache Settings Page ..................................................................................................... 78 Password Settings Page ................................................................................................ 79 SIP Settings Page .......................................................................................................... 81
Tools ....................................................................................................................... 83
Panel Connection Logs Page ......................................................................................... 83 Panel Statistics Page ..................................................................................................... 84 Connection Utility Page ................................................................................................ 85
Programming ....................................................................................................95
Overview ................................................................................................................ 95 Navigation Wheel Programming............................................................................. 95
Navigation Wheel-Specific Commands.......................................................................... 95
^WLD ........................................................................................................................................ 95
Table of Contents
@DPG...................................................................................................................................... @PDR ...................................................................................................................................... @PHE ...................................................................................................................................... @PHP ...................................................................................................................................... @PHT ...................................................................................................................................... @PPA ...................................................................................................................................... @PPF....................................................................................................................................... @PPG ...................................................................................................................................... @PPK ...................................................................................................................................... @PPM...................................................................................................................................... @PPN ...................................................................................................................................... @PPT....................................................................................................................................... @PPX ...................................................................................................................................... @PSE ....................................................................................................................................... @PSP ....................................................................................................................................... @PST ....................................................................................................................................... PAGE ...................................................................................................................................... PPOF....................................................................................................................................... PPOG ...................................................................................................................................... PPON ......................................................................................................................................
100 100 100 101 101 101 101 102 102 102 102 103 103 103 103 103 103 104 104 104
Table of Contents
^BRD ....................................................................................................................................... ^BSF........................................................................................................................................ ^BSP........................................................................................................................................ ^BSM....................................................................................................................................... ^BSO ....................................................................................................................................... ^BVL........................................................................................................................................ ^BVN....................................................................................................................................... ^BVP ....................................................................................................................................... ^BVT ....................................................................................................................................... ^BWW ..................................................................................................................................... ^CPF........................................................................................................................................ ^DLD ....................................................................................................................................... ^DPF ....................................................................................................................................... ^ENA....................................................................................................................................... ^FON ...................................................................................................................................... ^GDI........................................................................................................................................ ^GIV ........................................................................................................................................ ^GLH ....................................................................................................................................... ^GLL........................................................................................................................................ ^GRD....................................................................................................................................... ^GRU....................................................................................................................................... ^GSC ....................................................................................................................................... ^GSN....................................................................................................................................... ^ICO........................................................................................................................................ ^IRM........................................................................................................................................ ^JSB ........................................................................................................................................ ^JSI ......................................................................................................................................... ^JST ........................................................................................................................................ ^MBT....................................................................................................................................... ^MDC...................................................................................................................................... ^SHO....................................................................................................................................... ^TEC........................................................................................................................................ ^TEF ........................................................................................................................................ ^TOP ....................................................................................................................................... ^TXT........................................................................................................................................ ^UNI........................................................................................................................................
118 119 119 119 119 119 120 120 120 120 120 120 121 121 121 122 122 122 122 122 123 123 123 123 124 124 124 125 125 125 125 125 126 126 126 126
Table of Contents
?BOP....................................................................................................................................... ?BRD ....................................................................................................................................... ?BWW ..................................................................................................................................... ?FON ...................................................................................................................................... ?ICO........................................................................................................................................ ?JSB ........................................................................................................................................ ?JSI ......................................................................................................................................... ?JST ........................................................................................................................................ ?TEC........................................................................................................................................ ?TEF ........................................................................................................................................ ?TXT........................................................................................................................................ ABEEP..................................................................................................................................... ADBEEP .................................................................................................................................. @AKB ...................................................................................................................................... AKEYB .................................................................................................................................... AKEYP..................................................................................................................................... AKEYR..................................................................................................................................... @AKP ...................................................................................................................................... @AKR ...................................................................................................................................... BEEP ....................................................................................................................................... BRIT ........................................................................................................................................ @BRT....................................................................................................................................... DBEEP..................................................................................................................................... @EKP ...................................................................................................................................... PKEYP ..................................................................................................................................... @PKP ...................................................................................................................................... SETUP ..................................................................................................................................... SHUTDOWN ........................................................................................................................... SLEEP...................................................................................................................................... @SOU...................................................................................................................................... @TKP....................................................................................................................................... TPAGEON ............................................................................................................................... TPAGEOFF.............................................................................................................................. @VKB ...................................................................................................................................... WAKE .....................................................................................................................................
131 132 132 133 133 134 134 135 135 136 136 137 137 137 137 137 137 138 138 138 138 138 138 138 139 139 139 139 139 139 140 140 140 140 140
Table of Contents
Table of Contents
^PHN-PRIVACY....................................................................................................................... ?PHN-PRIVACY ....................................................................................................................... ^PHN-REDIAL ......................................................................................................................... ^PHN-SETUP-DTMFDURATION .............................................................................................. ^PHN-SETUP-DOMAIN ........................................................................................................... ^PHN-SETUP-ENABLE ............................................................................................................ ^PHN-SETUP-PASSWORD ...................................................................................................... ^PHN-SETUP-PORT................................................................................................................. ^PHN-SETUP-PROXYADDR .................................................................................................... ^PHN-SETUP-STUNADDR....................................................................................................... ^PHN-TRANSFER.................................................................................................................... ^PHN-SETUP-USERNAME.......................................................................................................
151 151 151 152 152 152 152 152 152 152 152 153
Table of Contents
MIC.............................................................................................................................. 170 WEP ............................................................................................................................ 170 WPA ............................................................................................................................ 170 WPA2 .......................................................................................................................... 171
AMX Certificate Upload Utility ............................................................................. 175 Uploading a Certificate File .................................................................................. 175
Table of Contents
10
Introduction
Introduction
Overview
The MVP-5200i is a wireless-only ergonomic device capable of VoIP intercom telephone communications, quick wakeup and connection time, extended battery life for longer operation between charges and includes a 5.2" Color Active LCD to display a 800 x 480 pixel image with 262,144 colors. Models includes a 5.2" Color Active LCD to display a 800 x 480 pixel image with 262,144 colors, available in black (FG5966-01) and white (FG5966-02), or a 5.0" TFT Active Matrix LCD to display a 800 x 480 pixel image with 16.7M colors, available in black (FG5966-03) and white (FG5966-04).
Microphone Touch screen Navigation wheel
Common Application
Ideal in residences for wireless control in home theaters and whole home systems as well as in-wall placement for digital intercom and entry communications. Perfect in boardrooms/conference rooms for controlling A/V equipment for presentations or training.
Features
Ultra-light, compact and thin form factor Available in your choice of high-gloss black or high-gloss white Navigation wheel provides simple (up/down) or sophisticated control (up/down, right/left, select) VoIP Intercom and SIP Telephone (requires AMX Gateway) Ready 802.11g WiFi for two-way network communications Wireless communications remain secure using WEP, WPA, WPA2, EAP-TLS, EAP-TTLS and
station
Introduction
The MVP-5200i comes with an integrated rear "kickstand", allowing it to be used and displayed away from a Charging Station if necessary (FIG. 2). It also comes with a pre-installed 802.11g WPA/WPA2 SDIO wireless card.
MVP-5200i Specifications
Models Available: MVP-5200i-GB, 5.2" (Gloss Black - FG5966-01) MVP-5200i-GB, 5" (Gloss Black - FG5966-03) MVP-5200i-GW (Gloss White - FG5966-02) MVP-5200i-GW, 5" (Gloss White - FG5966-04) Dimensions: Weight: Enclosure: Power Requirements (Without Charging): 4 3/4" x 7 9/16" x 13/16" (120.7 mm x 191.8 mm x 20.3 mm) Panel: 1.4 lbs (0.64 kg) MVP-5200i-GB: High-gloss black plastic with brushed metal retaining ring. MVP-5200i-GW: High-gloss white plastic with brushed metal retaining ring. FG5966-01 & FG5966-02: Panel with battery fully charged or with no battery: Constant current draw: 0.3 A @ 12 VDC Startup current draw: 0.4 A @ 12 VDC FG5966-03 & FG5966-04: Panel with battery fully charged or with no battery: Constant current draw: 0.32 A @ 12 VDC Startup current draw: 0.35 A @ 12 VDC Power Requirements (While Charging): FG5966-01 & FG5966-02: Panel while charging battery: Constant current draw: 1.1 A @ 12 VDC Startup current draw: 1.3 A @ 12 VDC FG5966-03 & FG5966-04: Panel while charging battery: Constant current draw: 1.06 A @ 12 VDC Startup current draw: 1.08 A @ 12 VDC Minimum Power Supply Required: PS3.0 Power Supply (FG423-30) - All MVP-5200i models are shipped with this power supply.
Introduction
Introduction
This device complies with FCC Part 15 and Industry Canada RSS 210 subject to the following conditions: 1. This device must not cause harmful interference and 2. This device must accept all interference, including interference that interferes with the operation of this device.
Introduction
Memory
The MVP-5200i comes with 128MB of Mobile DDRAM memory and 256 MB NAND Flash memory. Neither may be upgraded.
Although firmware upgrades can be conducted over a wireless Ethernet connection, transferring firmware KIT files over a direct USB connection is recommended, and only when the panel is connected to a power supply. If battery power or wireless connection fails during a firmware upgrade, the panel flash file system may become corrupted. In addition to its speaker, the MVP-5200i also utilizes its mini-USB port as a connector for standard headphones or headsets. These headphones must use a mini-USB plug or adaptor in order to utilize this feature. While standard input/output headsets may be used in lieu of headphones, the headset may only be used for output. While you may receive sound from the headset, its microphone will not function. Always use the MVP-5200is microphone for receiving sound.
Basic Operation
The MVP-5200i is operated using both its integral touchscreen and the navigation wheel on the right side of the device. If the device has gone into its Standby Mode, a touch of the touchscreen or of the button wheel will reactivate it. The MVP-5200i devices power use allows up to 96 hours of use between rechargings of its internal battery, but its battery charge lasts up to 120 hours if the device goes into Shutdown Mode during that time. The device may be placed in its charging cradle at any time and operated within its cradle. The device will automatically go into Sleep Mode after fifteen minutes of inactivity, and this limit may be changed at any time. Any wireless Internet connection intended for the device will be reconnected within approximately twenty seconds after the device is placed in its charging cradle. Depending upon preselected settings, the device may be set to go into Active Mode as soon as it is placed in the cradle.
Introduction
Navigation Wheel
The MVP-5200i device uses a unique button wheel for all commands not directly involving the touchscreen. This wheel, known as a navigation wheel, is located in the upper right corner of the device (FIG. 4). Used with the touchscreen, the navigation wheel allows scrolling and adjusting by turning the wheel with a thumb or finger and then pressing down on one of the wheels compass points for up, down, left, and right. The wheel is sensitive enough to adjust levels with one-third of a rotation. The center of the navigation wheel also acts as a button in its own right: for example, pressing down directly upon the wheel center may be used for the equivalent of an "Enter" keystroke
Compass points The navigation wheel may be turned clockwise or counterclockwise Wheel center
Press and hold the wheel center for three seconds to access the Setup pages (for more information, please see the Setup Pages section on page 41). Continue to hold the wheel center for another three seconds to access the Calibration page (page 75). If the MVP-5200i needs to be shut down or reset for any reason, press and hold down the wheel center button until the popup stating panel shutting down appears or the screen goes dark. Continuously holding down the center button down will cycle the MVP-5200i through the following steps:
1. Setup Pages 2. Calibration 3. Firmware shutdown 4. Hardware shutdown (automatically invoked if the devices firmware is unable to shut down the device.
Shut down the panel by holding the wheel center button only if the Setup pages are otherwise inaccessible. Regularly shutting down the device by this method can corrupt the Flash memory. When in its Standby Power Mode, the MVP-5200i may only be returned to its Awake state by touching the screen. The light at the center of the navigation wheel brightens and dims based on its source of power. It lights at full intensity when attached to a power source, such as the Table Charging Station (see the Table Charging Station section on page 9) or the Wall Charging Station (see the Wall Charging Station section on page 11), but lights at only half intensity when running on its internal battery. This allows the user to ascertain whether the device was properly installed in a charging station, as the brightness will visibly increase with a correct docking and will flash while charging. The flashing during recharging may be disabled via the devices on-board Setup page, as explained in the Setup Page section on page 41.
Introduction
Notes
External Power
OFF
OFF
Charging
BLINK
OFF
Battery Power
1. Panel Shutdown setting reached 2. Panel Shutdown button pressed 3. Navigation Wheel button held N/A N/A
OFF
OFF
OFF OFF
OFF OFF
The navigation wheel may also be programmed to initiate specific commands. For more information, please see the Programming section on page 95.
Introduction
1.
Press any of the navigation wheels compass points and hold until the AMX splash screen appears on the touchscreen. appears on the touchscreen.
2. If the navigation wheel does not respond, press the touchscreen and hold until the AMX splash screen
Intercom Microphone
The MVP-5200i contains a built-in microphone above the upper lefthand corner of the touch screen for video and audio conferencing capabilities. This microphone is concealed by the casing.
Stylus
The MVP-5200i comes with a unique touchscreen stylus that slides into a storage groove on the right side of the device when not in use. Replacement styluses may be ordered in a 3-pack (FG5966-30-xx) from www.amx.com.
Kick Stand
Since the MVP-5200i device is designed to be a unit used away from its charging station, it has an extendable "kickstand" on the back of the unit (FIG. 2). This may be opened by physically lifting the free end of the kick stand away from the device. The device may then be propped up on a flat surface and accessed in a normal fashion.
Audio/Video Capabilities
The MVP-5200i has the capability of displaying multiple JPEG and PNG files at one time. The device also supports streaming motion JPEG video (of the sort used by many IP and Web cameras), as well as MP3 and WAV audio files.
Power Management
The MVP-5200i utilizes a dual voltage external power supply. It may be recharged through the supplied PS3.0 Power Supply (FG423-30), as well as through the MVP-TCS-52 Table Charging Station (FG5966-1X) or the MVP-WCS-52 Wall Charging Station (FG5966-1X). For more information, see the Accessories section on page 9 for details. Although the MVP-5200i unit is equipped with a mini-USB port, the device cannot be powered through the USB port. The port is only used for uploading firmware. When not in active use, the MVP-5200i conserves battery life between chargings. In its Sleep Mode, the devices display is shut down, but its systems are still active. In Standby Mode, the device is completely shut down, with only wakeup systems powered to detect incoming commands or touch panel contact. Pressing any of the compass points on the navigation wheel will return the device to its Awake Mode, For more information on the battery, see the Battery Life and Replacement section on page 155.
Accessories
Accessories
Table Charging Station
The MVP-5200i comes with the MVP-TCS-52 Table Charging Station (FG5966-1X) (FIG. 5), which acts both as a charging station and a direct power connection. The charging station is available in either white (FG5966-10) or black (FG5966-11).
MVP-TCS-52 Specifications
Dimensions (HWD): Weight: Rear Connector: Operating/ Storage Environments: 8.0 x 4.75 x 3.5 (20.32cm x 12.07cm x 8.89cm) .65 lbs (.29 kg) 5-pin charging connector on bottom of charging cradle. Operating Temperature: 0 C (32 F) to 40 C (104 F) Operating Humidity: 20% - 85% RH Storage Temperature: -20 C (-4 F) to 60 C (140 F) Storage Humidity: 5% - 85% RH Included Accessories Other AMX Equipment: MVP-TCS-52 Table Charging Station Quick Start Guide (93-5966-02) PS3.0 Power Supply (FG423-44) MVP-5200i Modero Viewpoint Widescreen Touch Panel -Gloss Black (FG5966-01) MVP-5200i Modero Viewpoint Widescreen Touch Panel - Gloss White (FG5966-02) MVP-WCS-52: Wall Charging Station (FG5966-1X)
1. Connect the terminal end of the PS3.0 power supply to the PWR connector on the bottom of the MVPTCS-52.
2. To prevent wear on the power supply cord and assure that the devices base is in full contact with the table
surface, press the cord into the locking groove running across the bottom of the device.
3. Provide power to the MVP-TCS by connecting the PS3.0 cord to an external power source. 4. Place the touch panel in the Charging Station cradle (FIG. 6), guiding it into place with the locking
grooves on each side of the cradle (FIG. 7). When fully seated, the touch panels charging station connector should be in contact with the Charging Stations charger pins.
Accessories
MVP-5200i
Recharging
To recharge the MVP-5200i, slide the device into the Table Charging Station cradle bottom-first and make sure the device is fully seated in the Charging Station. The charger pins in the bottom of the cradle (FIG. 7) must be in contact with the connector on the bottom of the MVP-5200i for it to start recharging. The MVP panel will stop recharging automatically once the battery has achieved its maximum charge.
Charger pins
10
Accessories
MVP-5200i
The features of the MVP-WCS-52 include: Full charging of a docked MVP-5200i in approximately 4.5 hours Touch panel code lock for security Integrated docking alignment guides for easy docking Panel eject design with mechanical or electronically controlled capabilities. MVP-WCS-52 Specifications
Dimensions (HWD): 8.375" x 6.09" x 2.19" (21.27 cm x 15.46 cm x 5.56 cm) Note: Always use the cutout/installation dimensions for the MVP-WCS-52 when installing this unit into various surfaces. This SP engineering drawing is available online at www.amx.com. Power Requirements: 3 A @ 12 VDC (Class II listed power supplemented) Startup Power Requirements Total: 1.7A Charging: 1.1A Ejection: 0.6A Weight: Available Colors: Front Panel Components: Without box: 0.85 lbs (0.39 kg) With box: 1.30 lbs (0.59 kg) MVP-WCS-52-GW (White) - FG5966-13 MVP-WCS-52-GB (Black) - FG5966-12 Securing Magnets: Prevent MVP touch panel from falling free during ejection. Security Latch: Adds the primary layer of security when mounting an MVP touch panel. When the device is inserted, this latch grabs onto the rear of the touch panel and secures it to prevent it from being removed. Interface Connector Pins: A set of retractable pins (male) that connect to the underside MVP connector strip. This connection provides both communication and power between the touch panel and the MVP-WCS-52. Support Cradle: This retractable mechanism supports a resting MVP panel and allows a user to either insert or remove a connected MVP panel. Security Release pushbutton: Located on the front of the unit, this pushbutton toggles an on-screen security keypad (if security is enabled). - Entering the correct release code allows the MVP-WCS-52 to release the touch panel from the security latch.
11
Accessories
The MVP-5200i touch panel remains locked in the MVP-WCS-52 until unlocked by the user. This may be done by entering an appropriate password (please refer to the Password Settings Page section on page 79 for more information), or by pressing the Security Release button on the front of the device in emergencies. The station ejects the device top first (FIG. 9). The device uses two neodymium rare-earth magnets to keep the MVP-5200i from falling out of its cradle when the touch panel is angled forward.
Wall Charging Station
MVP-5200i
1. Press the Security Release button (see FIG. 9). 2. A password keypad will pop up on the MVP-5200i screen. Enter a password in the password keypad and
press Enter.
3. Wait for the Wall Charging Station to pivot the touch panel away from the wall. 4. The device will remain in the ejected position until the MVP-5200i is removed. Wait until the devices
ejection door has completely withdrawn before re-installing the MVP-5200i.
12
Accessories
Unique passwords may be entered for up to four unique users as well as the administrator. For more information on setting passwords, please refer to the Password Settings Page section on page 79.
Recharging
To recharge the MVP-5200i:
1. Slide the device into the Wall Charging Station cradle bottom-first and make sure the device is fully
seated in the Charging Station.
2. Press the top of the MVP-5200i back until it clicks. The touch panel is now locked into the Charging
Station, and the station will automatically charge the devices battery. (Please refer to the Power Management Page section on page 50 to check on the battery charge status.)
3. To release the touch panel, unlock the touch panel and wait for the Wall Charging Station to pivot the
touch panel away from the wall.
1. Cut a hole into the wall or surface intended to hold the box. The outer lip of the box is sized 8.69 inches
(220.66mm) long and 6.0 inches (152.4mm) high, so the hole should be at least 1/4" (6.4mm) smaller in each dimension (FIG. 10). Use the included MVP-WCS-52 Wall Charging Station Template (68-596601) as an aid for hole placement and measurement.
8.25" 8.25" (209.55mm) (212.7mm
8.25" 8.25" (209.55mm) (212 7mm) FIG. 10 Recommended cutout for plastic back box
13
Accessories
Make sure to measure the size of the intended hole before starting to cut it.
2. Select the knockout to be removed from the top of the box. The box has two knockouts, at the top left and
the top right. To assist with wiring, and to avoid mechanical stresses on the wire and the mechanism of the Wall-Mounted Charging Station, the top right knockout is preferred for use.
3. Run the power cable through the knockout into the box. Pull out about six inches (15.25cm) of cable into
the box to facilitate installation of the MVP-WCS-52.
4. Slide the plastic back box into the hole, being careful not to twist or pinch the cable, and set it flush with
the wall (FIG. 11). Make sure that all of the lockdown wings are folded into their slots before attempting to insert the box. For ease of installation, the inside of the box has the direction "UP" labeled for reference.
All lockdown wings folded flat during installation
5. Extend the wings on the sides of the box by tightening the screws inside the box.
Not all of the wings must be extended to lock the box in place, but extending a minimum of the top
wing will tighten up against the inside of the wall. Make absolutely certain that the box is in its intended position. Once the box lockdown wings are extended within the boxs hole within the wall, removing the box will be extremely difficult without damaging the wall in the process. The maximum recommended torque to screw in the wings on the plastic back box is 105 IN-OZ [74 N-CM]. Applying excessive torque while tightening the wing screws, such as with powered screwdrivers, can strip out the wings or damage the plastic back box.
14
Accessories
6. Prepare the captive wires for the 2-pin 3.55 mm mini-captive wire connector used for the MVP-WCS52s power supply: Preparing and connecting the captive wires requires the use of a wire stripper and flat-blade screwdriver.
Strip 0.25 inch (6.35 mm) of wire insulation off all wires. Insert each wire into the appropriate opening on the connector. Turn the screws clockwise to secure the wires in the connector. Do not over-torque the screws;
doing so can bend the seating pins and damage the connector.
7. Secure the power cable to the device, using either of the two tie-wrap anchors included in the Installation
Kit at the top rear of the device (FIG. 12). Point the head of each tie wrap toward the center of the device.
Tie-Wrap Anchors
8. Firmly seat the mini-captive wire connector to the power connector on the device. 9. Firmly seat the device against the box. Make sure that the tab connector at the top of the device is locked
into the box.
10. Insert the two installation screws from the MVP-WCS-52 Installation Kit into the screw holes in the
interior compartment of the device and tighten them to anchor the device to the box (FIG. 13).
15
Accessories
Screw holes
Neodymium magnets
For ease of installation, put each screw on a neodymium magnet in the devices interior compartment to keep them on hand until they are needed.
11. After fully seating the screws, wipe down the area around the screw holes with the alcohol prep pad from
the Installation Kit. Take a rubber foot and remove its adhesive backing. Put the foot, adhesive-side down, in the slot surrounding the screw hole in the Wall Charging Station. Press down firmly to remove any air bubbles from underneath the foot.
12. Install an MVP-5200i device by placing it into the interior compartment bottom-first. Press the top of the
touch panel until it is flush with the Wall Charging Station. The neodymium magnets will hold it in place.
13. To remove the MVP-5200i, unlock the touch panel (see the Unlocking the Touch Panel section on page 12
for more information) and wait for the touch panel to pull away from the Wall Charging Station. Once it has been released, grip it by the top of the device, and pull it free from the Charging Station.
16
Accessories
The Metal Rough-in Box bears a wing on each corner which is intended to bridge gaps between studs and/or spacers. These wings may be bent carefully in order to fit a particular gap, but may not be so bent as to allow the box to hang in a vertical position. Once placed in the desired position, put at least one screw through each wing into the adjoining stud or spacer to secure it. The interior of the box contains a set of holes on either side, as well as top and bottom, for standard 1/4-inch screws. Use these holes to anchor the box to its adjoining studs or spacers. Ensure that the metal rough-in box is flush with the 2x4 studs. Any overhang will affect the installation of the covering sheetrock, as well as affect the placement of the Plastic Back Box. The box has two sets of knockouts in the top and bottom, one of the set for US wiring and one for international wiring. Make sure that the power cable has been pulled through the metal rough-in box by the resident electrician before continuing the installation. After completing the installation of the metal rough-in box, install sheet rock or other wall material over the box, cut a hole matching the size of the inside diameter in the sheet rock, and clean out all dust before proceeding with the installation of the plastic back box.
17
Accessories
Instead of using the lockdown wings to secure the Plastic Back Box, standard concrete screws may be inserted through the screw holes after removing the lockdown wings. However, drill the concrete screw holes into the wall before setting the screws into the box, as excessive torque applied to the screws will damage the box. To avoid this, the box may be installed with adhesive. Test an unobtrusive spot on the back of the box with a sample of the adhesive to check for any adverse reactions before installing the device.
18
Configuring Communication
Configuring Communication
Overview
All control for a MVP-5200i touch panel is established through a NetLinx Master. Communication between the MVP and the Master consists of using either Wireless Ethernet (DHCP, Static IP) or USB. References to Ethernet in this manual focus on the use of Wireless Ethernet via the MVPs WiFi Card. Before commencing, verify you are using the latest NetLinx Master and Modero panel-specific firmware. Verify you are using the latest versions of AMXs NetLinx Studio and TPDesign4 programs. In the example below (FIG. 15), three MVP-5200i devices are shown at varying distances from the two AP gateways. As with any other AP network, the gateways are spaced so as to allow a maximum wireless coverage for the three devices.
802.11g AP
Panel 1
Network Master
IP Network
Panel 2
Panel 3
802.11g AP
When initially installing the MVP-5200i, some basic configuration items, including network settings and NetLinx settings, will need to be set. For more information, refer to the Protected Setup Pages section on page 53.
19
Configuring Communication
IR Communication
In certain situations, the MVP-5200i may be used as an infrared remote device for other AMX controllers. The device can transmit IR over 20 feet (6.10 m) from the panel at frequencies of 38KHz, 455KHz, and 1.2MHz. IR receivers and transmitters on G4 panels share the device address number of the panel. The MVP-5200i includes an IR transmitter for communication between the device and the NetLinx Master and between separate devices. The transmitter is located behind the IR Emitter Panel on the rear of the device (FIG. 16).
IR Emitter Panel
Accessing the Setup and Protected Setup Pages 1. At any time, press down and hold the center button of the navigation wheel for 3-5 seconds. This opens a
release notice to release the button immediately to open the Setup page (FIG. 17).
2. Press the Protected Setup button. This opens a keypad for entry of the password to allow access to the
Protected Setup page (FIG. 18). Enter the devices password and press Done to proceed.
20
Configuring Communication
The default password for the Protected Setup page is 1988, but this may be changed at any time. For more information on the Setup and Protected Setup pages, refer to the Setup Pages section on page 41 and the Protected Setup Pages section on page 53.
1. Press the Device Number field in the Device ID section to open the Device Number keypad. 2. The Master will assign the panel a new Device ID once connected. The default Device number is 0. 3. Press Done to return to the Protected Setup page. 4. Press Reboot to reboot the device and apply the new Device Number.
21
Configuring Communication
1. Select Wireless Settings. Wireless communication is set within the IP Settings section of this page
(FIG. 19).
Access Point Site Survey Button FIG. 19 Wireless Settings page (IP Settings section)
2. Toggle the DHCP/Static field from the IP Settings section until the choice cycles to DHCP. This action
causes all fields in the IP Settings section, other than Host Name, to be greyed-out. DHCP will register the unique factory-assigned MAC Address on the panel, and once the communication setup process is complete, assign IP Address, Subnet Mask, and Gateway values from the DHCP Server.
3. Press the optional Host Name field to open the Host Name keyboard and enter the host name information. 4. Press Done after assigning the alpha-numeric string of the host name. 5. The remaining greyed-out fields in the IP Settings section cannot be altered. Once the panel is rebooted,
these values are obtained by the unit and displayed in the DNS fields after power-up. This information can be found in either the Workspace - System name > Define Device section of the code that defines the properties for the panel, or in the Device Addressing/Network Addresses section of the Tools > NetLinx Diagnostics dialog.
6. Set up the security and communication parameters between the wireless card and the target AP by
configuring the Wireless Settings section on this page. Refer to Step 2: Configure the Cards Wireless Security Settings section on page 25 for detailed procedures to setup either a secure or insecure connection.
22
Configuring Communication
Wireless Communication Using a Static IP Address 1. From the Protected Setup page, press the Wireless Settings button to open the Wireless Settings page.
Wireless communication is set within the IP Settings section of this page (FIG. 19). Check with your System Administrator for a pre-reserved Static IP Address to be assigned to the panel. This address must be obtained before continuing with the Static assignment of the panel.
2. Toggle the DHCP/Static field from the IP Settings section until the choice cycles to Static.
The IP Address, Subnet Mask, and Gateway fields then turn red, noting that they are now user-editable.
3. Press the IP Address field to open a keyboard and enter the Static IP Address provided by the System
Administrator. Press Done after entering the IP address information and repeat the same process for the Subnet Mask and Gateway fields.
4. Press the optional Host Name field to open the keyboard and enter the Host Name information. Press
Done after assigning the alpha-numeric string of the host name.
5. Press the Primary DNS field to open a Keyboard, enter the Primary DNS Address (provided by the
System Administrator) and press Done when compete. Repeat this process for the Secondary DNS field.
6. Press the Domain field to open a Keyboard, enter the resolvable domain Address (this is provided by the
System Administrator and equates to a unique Internet name for the panel), and press Done when complete.
7. Set up the security and communication parameters between the wireless card and the target AP by
configuring the Wireless Settings section on this page. Refer to the following section for detailed procedures to set up either a secure or unsecure connection.
23
Configuring Communication
1. From the Protected Setup page, press the Wireless Settings button to open the Wireless Settings page. 2. Press the Site Survey button. This action launches the Wireless Site Survey page, which displays a listing
of all detected APs in the communication range of the internal card. The card scans its environment every four seconds and adds any new APs found to the list. Every scan cycle updates the signal strength fields. Access points are tracked by MAC Address. If the APs SSID is set as a blank, then N/A is displayed within the SSID field. If the APs SSID is not broadcast, it will not show up on the Wireless Networks screen. If a AP is displayed in the list is not detected for 10 scans in a row, it is then removed from the screen. In this way, a user can walk around a building and track access points as they move in and out of range.
3. Sort the information provided on this page by pressing on a column name. This moves the sorting arrow
to that column, where it may be toggled up or down. Up arrow - indicates that the information is being sorted in an ascending order. Down arrow - indicates that the information is being sorted in a descending order. If the panel detects more than 10 APs, the Up/Down arrows at the far right side of the page become active (blue) and allow the user to scroll through the list of entries.
4. Select a desired Access Point by touching the corresponding row. The up arrow and down arrow will be
grayed out if ten or fewer access points are detected. If more are detected, then they will be enabled as appropriate so that the user can scroll through the list. Access points using channel 8 should never be used, as the MVP-5200i may receive too much interference from other devices in the area.
If active roaming between channels is necessary, make sure to enable the Active Roaming on Channels 1,6,11 field in the Wireless Settings page (page 59).
5. With the desired AP selected and highlighted, click the Connect button to be directed to the selected
security modes Settings page with the SSID field filled in. From there, either Cancel the operation or fill in any necessary information fields and then click Save. Selecting an Open, WEP, and WPA-PSK Access Point and then clicking Connect will open the corresponding Settings page. For any other security mode, clicking Connect will only return to the previous page without any information being entered. In an Open security mode, after selection and connection to a target AP, the SSID name of the selected AP is saved for the open security mode. In a Static WEP security mode, after selection and connection to a WEP Access Point, the user is then redirected back to the Static WEP security screen, where the SSID field is already filled out. The user is only required to enter in the remaining WEP key settings. A similar process occurs for WPA-PSK access points. For any other situation, the security mode switches back to the previous page and security and connection parameters must be entered in as usual.
24
Configuring Communication
1. Press the Wireless Settings button (located on the lower-left) to open the Wireless Settings page
(FIG. 21).
Open AP from within the Site Survey page and then pressing the Connect button at the bottom of the page (FIG. 22).
Connecting to the AP begins the communication. FIG. 22 Site Survey of available APs
The Wireless Site Survey page will note the available security of each AP. If your AP is not configured for Open security, you will not be able to connect in this security mode.
25
Configuring Communication
Manually entering the SSID information into the appropriate fields by following steps 7 through 9.
3. From within the Wireless Settings page, click the Simple button. 4. In the Security Type field, select Open (FIG. 23). An Open security method does not utilize any
encryption methodology, but does require that an alpha-numeric SSID be entered. This method sends out network packets as unencrypted text.
5. Press the red SSID field to display an on-screen Network Name (SSID) keyboard. 6. In this keyboard, enter the SSID name used on the target Access Point (case sensitive).
The card should be given the SSID used by the target AP. If this field is left blank, the unit will attempt to connect to the first available AP. One of the most common problems associated with connection to a AP involves an incorrect SSID. Make sure to maintain the same case when entering the SSID information. ABC is not the same as Abc.
7.Click Done when complete. 8. From the Wireless Security: Simple Mode popup window (FIG. 23), press the Save button to incorporate the new information into the device and begin the communication process. 9. Verify the proper configuration in the fields in the IP Settings section. Refer to Step 1: Configure the
Devices Wireless IP Settings section on page 22 for detailed information.
10. Press the Back button to return to the Protected Setup page. Remember that the connection must be
configured to a target Master from the System Settings page.
11. After the panel restarts, return to the Wireless Settings pages Information/Configuration section and
verify the signal level and signal level value. The Signal Level bar should provide some information regarding the strength of the connection to a Access Point. If no signal is displayed, configuration of the network could be required.
26
Configuring Communication
1. Select Wireless Settings. 2. Press the Site Survey button at the bottom of the page to open the Wireless Site Survey page (FIG. 24). 3. Select a WEP secured AP from within the Site Survey page, and press the Connect button. .
Connecting to the AP begins the communication FIG. 24 Site Survey of available APs (Secured AP shown selected)
4. If the security is not handled automatically, the information must be entered manually from the Wireless
Security popup page.
1. Select Wireless Settings. 2. Click on the Simple button to open the Wireless Security: Simple Mode popup window (FIG. 25).
Encryption Button
3. Press the Security Type field to select WEP. 4. Press the SSID field. From the Network Name (SSID) keyboard, enter the SSID name used by the target
Access Point (case sensitive), and press Done when finished. The card should be given the SSID used by the target AP. If this field is left blank, the device will attempt to connect to the first available AP. One of the most common problems associated with connection to a AP arises because of an improperly entered SSID. The same case must be maintained when entering this information. ABC is not the same as Abc. The alpha-numeric string is AMX by default, but can later be changed to any 32-character entry. This string must be duplicated within the Network Name (SSID) field on the AP. As an example, if the SSID is TECHPUBS, this word and the case within must match both the Network Name
27
Configuring Communication
(SSID) field on the touch panels Network Name SSID field and on the APs Basic Wireless Configuration page.
5. Toggle the Encryption button (FIG. 25) until it reads either 64 Bit Key Size or 128 Bit Key Size.
The 64/128 selection reflects the bit-level of encryption security. This WEP encryption level must match the encryption level being used on the AP. WEP will not work unless the same Default Key is set on both the panel and the Access Point. For example, if the Access Point has been set to default key 4 (which was 01:02:03:04:05), the panels key 4 must be set to 01:02:03:04:05.
6. Toggle the Default Key field to choose a WEP Key value (from 1- 4) that matches what will be used on
the target.
The WEP Key identifier values must match for both devices.
7. Click Save to return to the Wireless Settings page. 8. Verify that the fields within the IP Settings section have been properly configured. Refer to Step 1:
Configure the Devices Wireless IP Settings section on page 22 for detailed information.
9. Press the Back button to navigate to the Protected Setup page. Remember that you will need to navigate
to the System Settings page and configure the connection to a target Master.
10. Return to the Wireless Settings page to verify the Signal Level and Signal Level Value.
The Signal Level bar provides some descriptive text regarding the strength of the connection to a Access Point. Configuration of the network could be required if there is no signal or no IP Address is displayed.
Configuring Multiple Wireless Touch Panels To Communicate To a Target AP 1. For each communicating touch panel, complete all of the steps outlined within the previous Automatically
Setting SSID section on page 27.
2. Navigate back to the Wireless Settings page on each panel. 3. Verify that all communicating Modero panels are using the same SSID, encryption level, Default Key #,
and an identical Current Key value. As an example, all panels should be set to Default Key #1 and be using aa:bb:cc.as the Current Key string value. This same Key value and Current Key string should be used on the target AP.
28
Configuring Communication
Because of its Ethernet over USB capabilities, the MVP-5200i also follows a different procedure for downloading firmware than with other G4 devices. Firmware downloads require use of the USB Programming Cable (FG10-5965) and a computer running Windows XP.
1. Turn on the MVP-5200i and wait for the device to finish booting up. 2. Insert the mini-USB end of the USB Programming Cable into the mini-USB port on the device. Insert the
other end into the appropriate USB port on the computer containing the files to be downloaded.
3. If the connection goes well, the Windows XP machine will detect the device as an unsupported USB
device. It then presents a dialog that prompts the user for a suitable driver (FIG. 27):
4. Select Yes, this time only and click on Next. 5. In the new window:
- Select Use the following IP Address. Under IP address, provide an IP address. Ensure that it is in the same subnet as the IP address given
to the usb0 interface on the MVP-5200i, but make sure that it has a different node number. The IP address cannot be the same as the panel`s USB IP address. Under Subnet mask, set the suitable subnet mask. Click OK.
29
Configuring Communication
Click on Browse Select the folder that contains the 'linux.inf' file
7. Click on Next. 8. The Windows XP machine now searches for the suitable driver (FIG. 29).
FIG. 29 Found New Hardware Wizard while searching for the driver
9. Once the system finds the driver, it displays its choice (FIG. 30). Click Finish to complete the driver
installation.
30
Configuring Communication
When an IP address is assigned to the usb0 interface on the device, Windows XP will make an attempt to assign an IP address to the corresponding interface on the Windows side. Usually, this IP address is a random value and in a totally different subnet. The user may set the Windows network properties for the Ethernet over USB interface to have a specific address whenever the Windows XP system detects an MVP-5200i with an assigned IP address. In Windows XP:
1. From the Windows XP desktop, click on Start > Settings > Network Connections. This opens a window
listing the currently active network connections.
2. Select the connection that is specific to AMX USB Device Link. 3. Right click and select Properties. 4. In the Local Area Connection 3 Properties window (FIG. 31) under the General tab, select Internet
Protocol (TCP/IP) and click on Properties.
31
Configuring Communication
1. If using the mini-USB connection, verify the panel has been configured to communicate via USB within
the System Settings page and that the USB driver has been properly configured. Changing the Master Connection type requires a reboot before the change takes effect.
2. In NetLinx Studio, select Settings > Master Communication Settings from the Main menu to open the
Master Communication Settings dialog (FIG. 32).
3. Click the Communications Settings button to open the Communications Settings dialog (FIG. 33).
4. Click the NetLinx Master radio button in the Platform Selection section. 5. Click the Virtual NetLinx Master radio button in the Transport Connection Option section.
32
Configuring Communication
6. Click the Edit Settings button to open the Virtual NetLinx Master Settings dialog (FIG. 34).
7. Enter the System number; the default is 1. 8. Click OK on all open dialogs to save your settings. 9. Click the OnLine Tree tab in the Workspace window to view the devices on the Virtual System. 10. Right-click on Empty Device Tree/System and select Refresh System to re-populate the list.
The panel will not appear as a device below the virtual system number (in the Online Tree tab) until both the system number (default = 1) is entered into the Master Connection section of the System Settings page and the panel is restarted. The System Connection status button turns green after a few seconds to indicate an active USB connection to the PC via the Virtual Master. If the System Connection icon does not turn green, check the USB connection and communication settings and refresh the system.
Wireless 1. When using Wireless Ethernet, press the listed Mode to toggle through the available connection modes:
Connection Modes
Mode Description None Auto No connection The device connects to the first master that responds. This setting requires setting the System Number. The device connects to the specific IP of a Master via a TCP connection. This setting requires setting the Masters IP. The device "listens" for the Master to initiate contact. This setting requires providing the Master with the devices IP. Procedures None Setting the System Number: 1. Select the System Number to open the keypad. 2. Set your System Number and select Done. Setting the Master IP: 1. Select the Master IP number to the keyboard. 2. Set the Master IP and select Done. Confirm that the device IP is on the Master URL list. Set the Host Name on the device and use it to locate the device on the Master. Host Name is particularly useful in the DHCP scenario, where the IP address can change.
URL
Listen
2. Select the Master Port Number to open the keypad and change this value.
The default setting for the port is 1319.
3. Set the Master Port and select Done. 4. If you enabled password security on your Master, set the username and password within the device. 5. Select the blank field Username to open the keyboard. 6. Set the Username and select Done. 7. Select the blank field Password to open the keyboard. 8. Set the Password and select Done. 9. Press the Back button to return to the Protected Setup page.
33
Configuring Communication
10. Press the Reboot button to reboot the device and confirm changes. Master Connection to a Virtual Master
If configuring the panel to communicate with a Virtual Master on your PC via wireless Ethernet, the Master IP/URL field must be configured to match the IP Address of the PC. Make sure to use the Virtual System value assigned to the Virtual Master within NetLinx Studio. Before beginning:
1. If making a Master connection via Ethernet, verify that the panel has been configured to communicate
with the Access Point.
2. In NetLinx Studio, select Settings > Master Communication Settings from the Main menu to open the
Master Communication Settings dialog (FIG. 35).
3. Click the Communications Settings button to open the Communications Settings dialog (FIG. 36).
4. Click on the Virtual NetLinx Master radio button (from the Platform Selection section) to indicate that
you are working as a NetLinx Master.
5. Click on the Virtual NetLinx Master radio box from the Transport Connection Option section to
indicate wanting to configure the PC to communicate with a panel. Everything else, such as the Authentication, is greyed out because the procedure is not being made through the Masters UI.
34
Configuring Communication
6. Click the Edit Settings button in the Communications Settings dialog to open the Virtual NetLinx Master
Settings dialog (FIG. 37).
7. From within this dialog, enter the System number (default is 1) and note the IP Address of the target PC
being used as the Virtual Master. This IP Address can also be obtained by following these procedures: On the PC, click Start > Run to open the Run dialog. Enter cmd into the Open field and click OK to open the command DOS prompt. From the C:\> command line, enter ipconfig to display the IP Address of the PC. This information is entered into the Master IP/URL field on the panel.
8. Click OK to close the open dialogs, save the settings, and return to the main NetLinx Studio application. 9. Click the OnLine Tree tab in the Workspace window to view the devices on the Virtual System. The
default System value is one.
10. Right-click on the Empty Device Tree/System entry and select Refresh System to re-populate the list. 11. Place the panel in the Table Charging Station or in the Wall Charging Station and turn the panel On. 12. After the panel powers up, press and hold down the navigation wheel center button for 3 seconds to
continue with the setup process and proceed to the Setup page.
13. Select Protected Setup > System Settings (located on the lower-left) to open the System Settings page
(FIG. 38).
The System Number is assigned to the Master within the AMX software application (these must match) Enter the IP Address information of the PC used as a Virtual Master When using a Virtual Master, there is no need to enter a username and/or password
FIG. 38 Sample System Settings page (for Virtual Master communication)
14. Press the Mode field until the choice cycles to the word URL.
By selecting URL, the System Number field becomes read-only (grey) because the panel pulls this value directly from the communicating target Master, virtual or not. A Virtual Master system value can be set within the active AMX software applications such as NetLinx Studio, TPD4, or IREdit.
15. Press the Master IP/URL field to open a Keyboard and enter the IP Address of the PC used as the Virtual
Master.
16. Click Done to accept the new value and return to the System Settings page. 17. Do not alter the Master Port Number value, as this is the default value used by NetLinx.
35
Configuring Communication
18. Press the Back button to return to the Protected Setup page, and Exit to return to the Setup page. 19. The USB connection will be signified by the WiFi/Wired/USB icon changing into a USB icon (FIG. 39).
1. Press and hold the two lower buttons on both sides of the display for 3 seconds to open the Setup page. 2. Press the Protected Setup button (located on the lower-left of the panel page) to open the Protected Setup
page and display an on-screen keypad.
3. Enter the appropriate password into the Keypads password field (1988 is the default password with a new
unit) and press Done.
4. Press the G4 WebControl button to open the G4 Web Control Settings page (FIG. 40).
36
Configuring Communication
5. Press the Enable/Enabled button until it toggles to Enabled and turns light blue. 6. The Network Interface Select field is read-only and displays the method of communication to the web.
Wireless is used when a wireless card is detected within the internal card slot. This method
provides an indirect communication to the web via a pre-configured Access Point. The Network Interface Select field is read-only and defaulted to Wireless, since the device has no Ethernet cable connection.
7. Press the Web Control Name field to open the Web Name keyboard. 8. From the Web Name keyboard, enter a unique alpha-numeric string to identify this panel.
This information is used by the NetLinx Security Web Server to display on-screen links to the
panel.
The on-screen links use the IP Address of the panel and not the name for communication (FIG. 41).
FIG. 41 Sample relationship between G4 Web Control and Mange WebControl Connections window
9. Assign the alpha-numeric string for the Web Control name and then press Done. 10. Press the Web Control Password field to open the Web Password keyboard. 11. From the Web Password keyboard, enter a unique alpha-numeric string to be assigned as the G4
Authentication session password associated with VNC web access of this panel.
12. Press Done after assigning the alpha-numeric string for the Web Control password. 13. Press the Web Control Port field to open the Web Port Number keypad. 14. Within the keypad, enter a unique numeric value to be assigned to the port on which the VNC Web Server
is running. The default value is 5900. Press Done after entering the value. The remaining fields within the G4 Web Control Settings section of this page are read-only and cannot be altered.
15. Press the Up/Down arrows on either sides of the G4 Web Control Timeout field to increase or decrease the
amount of time the device can remain idle with no cursor movements before the session is closed and the user is disconnected.
16. Press the Back button to open the Protected Setup page. 17. Press the on-screen Reboot button to save any changes and restart the device.
Verify that the NetLinx Masters IP Address and System Number have been properly entered into the Master Connection section of the System Settings page.
37
Configuring Communication
1. Launch your web browser. 2. Enter the IP Address of the target Master (example: http://198.198.99.99) into the web browsers Address
field.
3. Press the Enter key on your keyboard to begin the communication process between the target Master and
your computer. Initially, the Master Security option is disabled from within the System Security page, and no username and password is required for access or configuration. Both HTTP and HTTPS Ports are enabled by default via the Manage System > Server page. If the Master has been previously configured for secured communication, click OK to accept the AMX SSL certificate, if SSL is enabled, and then enter a valid username and password into the fields within the Login dialog.
4. Click OK to enter the information and proceed to the Masters Manage WebControl Connections window.
This page (FIG. 42) is accessed by clicking on the Manage connections link (within the Web Control section within the Navigation frame). Once activated, this page displays links to G4 panels running the latest G4 Web Control feature that were previously set up and activated on the device.
G4 panels
5. Click on the G4 panel name link associated with the target panel. A secondary web browser window
appears on the screen (FIG. 43).
38
Configuring Communication
6. Click Yes from the Security Alert popup window to agree to the installation of the G4 WebControl
application on your computer. This application contains the necessary Active X and VNC client applications necessary to properly view and control the panel pages from your computer. The G4 Web Control application is sent by the panel to the computer that is used for communication. Once the application is installed, this popup will no longer appear. This popup will only appear if you are connecting to the target panel using a different computer.
7. Some situations might display a Connection Details dialog (FIG. 44) requesting a VNC Server IP
Address. This is the IP Address not of the Master but of the target touch panel. Depending on which method of communication is being used, it can be found in either: Wired Ethernet - System Settings > IP Settings section within the IP Address field. Wireless - Wireless Settings > IP Settings section within the IP Address field. If this field does not appear, continue to step 9.
IP Address of touch panel - obtained from IP Settings section of the Wireless Settings page (MVP)
8. If a WebControl password was set up on the G4 WebControl page, a G4 Authentication Session password
dialog box appears on the screen within the secondary browser window.
9. Enter the Web Control session password into the Session Password field (FIG. 44).
This password was previously entered into the Web Control Password field within the G4 Web Control page on the panel.
39
Configuring Communication
10. Click OK to send the password to the panel and begin the session.
A confirmation message appears stating "Please wait, Initial screen loading.". The secondary window is then populated with the same G4 page being displayed on the target G4
panel.
A small circle appears within the on-screen G4 panel page and corresponds to the location of the
mouse cursor.
A left-mouse click on the computer-displayed panel page equates to an actual touch on the target
G4 panel page.
40
Setup Pages
Setup Pages
Overview
The MVP-5200i features on-board Setup pages. Use the options in the Setup pages to access panel information and make various configuration changes. To access the Setup pages, press the center button of the navigation wheel and hold for 3 to 5 seconds (FIG. 45).
Setup Page Access button: Press and hold for 3 to 5 seconds to access the Setup pages.
Setup Page
The Setup page (FIG. 46) allows quick access to several essential panel properties:
41
Setup Pages
Connection Status:
Displays whether the panel is has external communication, as well as the encryption status of the Master, the connection type (Ethernet or USB), and to which System the panel is connected. Until a connection is established, the message displayed is: Attempting via Ethernet or "Attempting via USB". When a connection is established, the message displayed is either: Connected via Ethernet or Connected via USB . The word Encrypted appears when an encrypted connection is established with a NetLinx Master.
Note: The panel must be rebooted before incorporating any panel communication changes and to detect Ethernet connections.
Indicates the length of time that the panel can remain idle before automatically flipping to a pre-selected page. Press the Up/Down buttons to increase/decrease the Inactivity Page Flip Timeout setting. Range = 0 - 240 (minutes). Set the timeout value to 0 to disable Inactivity Page Flip mode.
Note: The touch panel page used for the Inactivity page flip is named within a small Inactivity Page field below the buttons.
Panel Brightness:
Sets the display brightness and contrast levels of the panel. Press the Brightness Up/Down buttons to adjust the brightness level. Range = 0 - 100.
Note: Be careful not to turn down the brightness too low to be able to see the Setup page.
Enables and disables the blinking of the navigation wheel LED when the device is in Sleep mode. When enabled, the LED blinks while the device is charging. The Sleep Blink LED button is enabled by default.
Note: This feature will only apply when the device is in Sleep mode. When the device is active, the state of the LED will match that of the display.
Navigation Buttons
The following Navigation buttons (FIG. 47) appear on the left side of the Setup page:
Press to access the Protected Setup pages. Press to access the Project Information page in order to view information on the TPDesign file being used, and the Panel Information page in order to view panel specific information such as resolution and memory. Press to access the Time & Date page in order to alter the time and date settings on the Master. Press to access the Audio Settings page in order to adjust audio parameters on the panel.
Press to access the Power Management page in order to monitor battery status in the panel.
42
Setup Pages
Information Button
The Information button allows access of both the Project Information page, which contains data on the TPDesign4 file being used with the MVP-5200i, and the Panel Information page, which contains detailed information on the panel itself. To access these pages:
1. Press and hold the Information button until the Project Information button and the Panel Information
button slide from the left. The Project Information and the Panel Information buttons will be displayed for three seconds before they slide back behind the Information button, whether or not the Information button is still being pressed.
2. Press the appropriate button for the information required. 3. To return to the Setup page, press the Back button. Project Information Page
The Project Information page displays the project properties of the TPDesign4 project file currently loaded on the panel (FIG. 48).
Connection Status icon: The icon in the upper-right corner of each Setup page provides a constant visual indication of current connection status.
Note: a Lock appears on the icon if the panel is connected to a secured NetLinx Master.
File Name: Designer ID: File Revision: Dealer ID: Job Name:
Displays the name of the TPDesign4 project file downloaded to the panel. Displays the designer information. Displays the revision number of the file. Displays the dealer ID number (unique to every dealer and entered in TPD4). Displays the job name.
43
Setup Pages
Cradle Sensor Channel: Displays the channel used to broadcast the charging cradle sensor status.
IR receivers and transmitters on G4 panels share the device address number of the panel.
44
Setup Pages
Panel Type: Firmware Version: Setup Port: High Port: High Address: High Channel: High Level: Serial Number: Setup Pages Version: Panel Start Time: Bulb Hours: Screen Width: Screen Height: Screen Refresh Rate: Screen Rotation: Power Up Page: Start Up String: Wake Up String: Sleep String: Stand By String:
Displays the model of the panel being used. Displays the version number of the G4 firmware loaded on the panel. Displays the setup port information (value) being used by the panel. Displays the high port (port count) value for the panel. Displays the high address (address count) value for the panel. Displays the high channel (channel count) value for the panel. Displays the high level (level count) value being used by the panel. Displays the specific serial number value assigned to the panel. Displays the type and version of the Setup pages being used by the panel. Displays the time taken by the panel to wake up from sleep mode. Displays the number of hours elapsed with the display on full power. Displays the screen width (in pixels). MVP-5200i = 640 pixels. Displays the screen height (in pixels). MVP-5200i = 480 pixels. Displays the video refresh rate applied to the incoming video signal. Displays the degree of rotation applied to the on-screen image. Displays the page assigned to display after the panel is powered-up. Displays the start-up string. Displays the wake up string used after an activation from a timeout. Displays the sleep string used during a panels sleep mode. Displays the stand by string used during a panels Stand By mode.
45
Setup Pages
46
Setup Pages
The MVP-5200i does not have an on-board clock, so the only way to modify a panels time without altering the Master is via NetLinx Code. Features on this page include: Time & Date Setup Page
Back: WiFi/Wired/USB Icon: Saves all changes and returns to the previous page. The icon to the left of the Connection Status Icon displays whether the current connection to the Master is Wireless (image of a radio antenna), Wired (image of three networked computers), or USB (USB connection symbol).
Connection Status icon: The icon in the upper-right corner of each Setup page provides a constant visual indication of current connection status.
Note: a Lock appears on the icon if the panel is connected to a secured NetLinx Master.
The Get Time button retrieves Time and Date information from the Master. The Set Time button retains and saves any time/date modifications made on the panel.
These fields display the time in three formats: STANDARD, STANDARD AM/PM, and 24 HOUR. These fields display the calendar date information in several different formats. Use the Up/Down arrow buttons to adjust the Masters calendar date and time. The blue icon indicates which field is currently selected. Year range = 2000 - 2199 Month range = 1 - 12 Day range = 1 - 31 Hour = 24-hour military Minute range = 0 - 59 Second range = 0 - 59
47
Setup Pages
Activating the Button Hit button plays a default sound when you touch an active button. The Play Test Sound button plays a test WAV/MP3 file over the panels internal speakers. Activating the Button Miss button plays a default sound when you touch a non-active button or any area outside of the active button The singleBeep01 and singleBeep02 buttons play preselected examples of single beeps over the panels internal speakers
Adjusts the volume level on the panels internal speaker: Use the Up/Down buttons to adjust the volume (range = 0 - 100) The Internal Sound Level bargraph indicates the current sound level. Press the bargraph to the left or right of the graph marker to adjust the volume level in one-percent increments (range = 0 - 100), or press the bargraph and hold to move the graph marker to the desired level. The Mute button mutes the internal speaker volume
Enables USB headphone output. Adjusts the volume level on the intercoms microphone: Use the Up/Down buttons to adjust the microphone level (range = 0 - 100). Press the bargraph to the left or right of the graph marker to adjust the volume level in one-percent increments (range 0 - 100), or press the bargraph and hold to move the graph marker to the desired level.
48
Setup Pages
49
Setup Pages
Power Settings:
The three settings in the Power Settings section may be selected by touching either the arrow to the left of each setting or by touching the entry itself. Each is highlighted with a green arrow to the left when selected. This value determines the number of seconds or minutes that need to pass before the panel automatically goes into Sleep Mode. Once asleep, the device may be awakened by touching the buttons on either side of the screen or the screen itself. Use the Up/Down arrows to change the settings; the setting bar will change from blue to green to display the percentage of minimum versus maximum. Range = 10, 15, 20, 25, 30 seconds; 5, 15, 30 minutes; 1, 2 hours Default = 2 hours
Sleep:
Stand By:
This value determines the number of seconds or minutes that need to pass before the panel automatically goes into Standby Mode. Once in standby, the device may be awakened by touching the screen. Use the Up/Down arrows to change the settings; the setting bar will change from blue to yellow to display the percentage of minimum versus maximum. A value of Off disables this feature. Range = 15, 30 minutes; 1, 2, 3, 4 hours Default = Off
50
Setup Pages
Range = 3, 5, 10, 15, 30 minutes; 1, 2, 3, 4 hours Default = Off. Disable on External Power: This button acts as a power save feature with two options: On - Clicking on this button causes the Sleep mode to become disabled when external power is applied.. Off - Clicking on this button deactivates this power save feature. Auto Dim: Battery Charge Status: Battery Level Port: Battery Level: Battery Type: Battery Power Brightness Limit: When enabled, Auto Dim will engage at half the time set under the Sleep setting or after five minutes, whichever is sooner. The Battery Charge Status field indicates the power charge currently available on the battery. The Battery Level Port field indicates the port being used to report charge status levels back to the NetLinx Master (set in TPDesign4). The Battery Level field indicates the level being used to report status levels back to the NetLinx Master (set in TPDesign4). The Battery Type field indicates the type of battery currently installed in the MVP-5200i. The value listed is XPX5000B, 2, or 3. The Disable/Disabled button acts as a power save feature with two options: Disable - Clicking on this button deactivates this power save feature. The panel will use the Panel Brightness level. Disabled - Clicking on this button activates the brightness limit set on the panel, conserving battery power. Activating this feature causes the panel to function at 80% of full brightness and overrides the Panel Brightness value set on the Setup page.
51
Setup Pages
52
1. Press the center button of the navigation wheel and hold for 3 to 5 seconds to access the Setup pages. 2. Select the Protected Setup button on the left side of the screen. 3. Enter the factory default password (1988) into the password keypad to access the page.
53
BUTTON
0,8 Level Port Channel Code FIG. 54 Function Show example 0,50 Address Port Address Code
When the Function Show feature is displayed, the Channel Port and Code will appear in yellow, the Address Port and Code in green, and the Level Port and Channel Code in purple. To reboot the panel:
1. Access the Protected Setup page. 2. Press the Reboot button. 3. Wait until the panel completes its reboot. 4. Log back into the Protected Setup page, if necessary.
To shut down the panel:
54
2. Press the Shutdown button. 3. Disconnect any power source plugs or USB connections, if necessary. Security Settings
The Security button on the Protected Setup page has three settings: Standard, Secure, and DoD. Pressing the button opens the Panel Security Setting popup window (FIG. 55)
Each of the settings has different features for touch panel security: Security Profile Features
Standard: Factory default, shipped in this configuration. Default Protected Setup Password is 1988. Remote login uses Telnet. Secure: Default Protected Setup Password is Amx1234!. Minimum password requirement is 8 characters with at least one numeric character. Remote login uses SSH. Remote login user name is amx. Login failure attempt pauses 4 seconds before another login attempt is allowed. After 3 consecutive unsuccessful SSH login attempts, login lockout is enabled for 15 minutes. Login and logout audit logging is enabled. DoD: Default Protected Setup Password is Amx1234!. Minimum password requirement is 8 characters with at least one numeric character, one uppercase character, one lower case character, and one special character, with no duplicate adjacent characters. Remote login uses SSH. Remote login user name is amx. Login failure attempt pauses 4 seconds before another login attempt is allowed. After 3 consecutive unsuccessful SSH login attempts, login lockout is enabled for 15 minutes. Login and logout audit logging is enabled. DoD login banner is enabled.
55
A transition from one security mode to another will reset the Protected/Web Control/ remote login password to the default value for the current security mode (please refer to the default passwords above). A transition to Secure or DoD mode will disable G4 Web Control. Although the security password features are immediate, a reboot must occur for all the new security mode features to fully take effect. For more information on configuring AMX devices for a secure environment, please refer to the guide Security Profiles: Configuring AMX Devices For Installation Into a Secure Environment, available at www.amx.com.
56
57
Mode:
Password:
USB IP Settings:
Refer to the Ethernet Over USB section on page 29 for more detailed information on using the System Settings page.
58
FIG. 58 Wireless Settings page (reads from and assigns values to the AP)
59
Security Type: SSID: Channel: Signal Level Value: Signal Level: Security Mode buttons:
Some encryption and security features may or may not be supported: Wireless Security Support
802.11g Wi-Fi CF card: Open (Clear Text) Static WEP (64-bit and 128-bit key lengths) WPA-PSK EAP security (with and without certificates) AP SIte Survey
Refer to the Configuring Wireless Network Access section on page 22 for more information on configuring the panel for wireless network access using the various security options.
60
Security Modes
The Wireless Settings page has two buttons: Simple and Enterprise. Pressing the Simple button opens the Wireless Security: Simple Mode popup window (FIG. 59), which offers wireless security options suitable for most home and office environments such as Open (page 62), WEP (page 62), and WPA-PSK (page 64). For more secure options, such as for corporate environments, the Wireless Security: Enterprise Mode popup window (FIG. 60) offers EAP-LEAP (page 66), EAP-FAST (page 68), EAP-PEAP (page 69), EAP-TTLS (page 71), and EAP-TLS (page 72).
61
Open
In the Wireless Security: Simple Mode popup window (FIG. 59), press the Security Type field to select Open. Open security does not utilize any encryption methodology, but requires an SSID (alpha-numeric) entry. This entry must match the Network Name (SSID) entry of the target AP so the panel knows what device it is using to communicate with the network. Open Settings
SSID (Service Set Identifier): Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in your wireless network. If this field is left blank, the panel will attempt to connect to the first available AP. Save/Cancel: Save - store the new security information, apply changes, and return to the previous page. Cancel - discard changes and return to the previous page.
Refer to the Configuring Wireless Network Access section on page 22 and the Using the Site Survey Tool section on page 23 for further details on these security options.
WEP
In the Wireless Security: Simple Mode popup window (FIG. 59), press the Security Type field to select WEP. WEP security requires that both a target AP be identified and an encryption method be implemented prior to establishing communication. In addition to providing both Open and Shared Authentication capabilities, this page also supports Hexadecimal and ASCII keys. WEP Settings
WEP 64 / WEP 128: Cycles through the available encryption options: 64 or 128 Bit Key Size. WEP (Wired Equivalent Privacy) is an 802.11 security protocol designed to provide wireless security equivalent to wired networks. WEP64 enables WEP encryption using a 64 Bit Key Size. All packets are transmitted with their contents encrypted using the Default WEP Key. WEP128 enables WEP encryption using a 128 Bit Key Size. All packets are transmitted with their contents encrypted using the Default WEP Key. If the key is not the correct size, the system will resize it to match the number of bits required for the WEP encryption mode selected. SSID: Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in your wireless network. If this field is left blank, the panel will attempt to connect to the first available AP. WEP Keys: This feature provides another level of security by selecting up to four WEP Keys. Push any of the four buttons to open an on-screen keyboard. Both ASCII and HEX keys are supported. Up to four keys can be configured for both. An ASCII key utilizes either 5 or 13 ASCII characters A HEX key utilizes either 10 or 26 Hexidecimal characters Press Done to accept any changes and save the new value.
Note: A 64-bit key will be 10 characters in length while a 128-bit key will be 26 characters in length. The length of the key entered determines the level of WEP encryption employed (64 or 128-bit). 128-bit keys may be used if supported by the internal wireless card.
62
Authentication:
Toggles between the two authentication modes: Open (broadcast publicly) or Shared (encrypted). An Open network allows connections from any client without authentication. A Shared network requires the client to submit a key which is shared by the network AP before it is given permission to associate with the network. In this case the key is the same as the WEP encryption key. In either case, if WEP encryption has been enabled, the client will still require the WEP key to encrypt and decrypt packets in order to communicate with the network.
Cancel/Save:
Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the Configuring Wireless Network Access section on page 22 and the Using the Site Survey Tool section on page 23 for further details on these security options.
63
WPA-PSK Settings
In the Wireless Security: Simple Mode popup window (FIG. 59), press the Security Type field to select WPAPSK. WPA-PSK security is designed for environments where using WPA or WPA2 is desirable, but an 802.1x authentication server is not available. PSK connections are more secure than WEP and are simpler to configure, since they implement dynamic keys but share a key between the AP and the panel (client). Using WPA-PSK, the encryption on the AP could either be WPA or WPA2. The firmware in the panel will automatically connect to the AP using the correct encryption. The WPA encryption type is configured on the AP, not in the firmware. APs do not display WPA or WPA2 on their configuration screens: WPA is normally displayed as TKIP. WPA2 is normally displayed as AES CCMP. The following fields are required: SSID and Password/Pass Phrase. Enter the SSID of the AP. Enter a pass phrase with a minimum of 8 characters and a maximum of 63. The exact same pass phrase (including capitalization) must be entered in the access point. WPA-PSK Settings
SSID: Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in your wireless network. If this field is left blank, the panel will attempt to connect to the first available AP. Password: Opens an on-screen keyboard to enter a passphrase (password). This alpha-numeric string must use a minimum of 8 characters and a maximum of 63. The exact pass phrase string (including capitalization) must be entered on the target AP. Cancel/Save: Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the Configuring Wireless Network Access section on page 22 for details on these security
options.
Refer to the Using the Site Survey Tool section on page 23 for more information on using this tool.
64
A server certificate file uses a certificate installed in a panel so that the RADIUS server can be validated before the panel tries to connect to it. The field name associated with this file is Certificate Authority. If a server certificate is used, it should first be downloaded into the panel and the Certificate Authority field should then be set to the name of that certificate file. No file path should be used for this setting, as all certificates are stored in a specific directory that the user cannot control or change. The most secure connection method uses a server certificate. If no server certificate will be used, this field should be left blank. If the field contains a file name, then a valid certificate file with the same file name must be previously installed on the panel. Otherwise the authentication process will fail.
65
EAP-LEAP
In the Wireless Security: Enterprise Mode popup window (FIG. 60), press the Security Type field to select EAP-LEAP. EAP (Extensible Authentication Protocol) is an Enterprise authentication protocol that can be used in both wired and wireless network environments. EAP requires the use of an 802.1x Authentication Server, also known as a Radius server. The configuration fields described below take variable length strings as inputs. An on-screen keyboard is opened when these fields are selected. LEAP (Lightweight Extensible Authentication Protocol) was developed to transmit authentication information securely in a wireless network environment. LEAP does not use client (panel) or server (RADIUS) certificates, and is therefore one of the least secure EAP security methods. However, it can be utilized successfully by implementing sufficiently complex passwords. EAP-LEAP security is designed for wireless environments where having a client or server certificate validation scheme in place is not required, yet necessary to transmit data securely over a wireless network. EAP-LEAP
SSID: Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in the wireless network. With EAP security, the SSID of the AP must be entered. If it is left blank, the panel will try to connect to the first access point detected that supports EAP. However, a successful connection is not guaranteed because the detected AP may be connected to a RADIUS server, which may not support this EAP type and/or have the proper user identities configured. Identity: Opens an on-screen keyboard. Enter an EAP Identity string (used by the panel to identify itself to an Authentication (RADIUS) Server).
Note: This information is similar to a username used to login to a secured server or workstation. This works in tandem with the Password string which is similar to the password entered to gain access to a secured workstation. Typically, this is in the form of a username such as [email protected].
Password:
Opens an on-screen keyboard. Enter the network password string specified for the user entered within the Identity field (used by the panel to identify itself to an Authentication (RADIUS) Server)
Note: This information is similar to the password entered to gain access to a secured workstation.
Cancel/Save:
Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the EAP Authentication section on page 184 for further details on these security options. Refer to FIG. 62 for an example of how a typical EAP-LEAP system configuration page should
appear.
66
67
EAP-FAST
In the Wireless Security: Enterprise Mode popup window (FIG. 60), press the Security Type field to select EAP-FAST. EAP-FAST (Flexible Authentication via Secure Tunneling) security was designed for wireless environments where security and ease of setup are equally desirable. EAP-FAST uses a certificate file, however it can be configured to download the certificate automatically the first time the panel attempts to authenticate itself. Automatic certificate downloading is convenient but slightly less secure, since its the certificate is transferred wirelessly and could theoretically be sniffed-out. EAP-FAST
SSID: Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in the wireless network. With EAP security, the SSID of the AP must be entered. If it is left blank, the panel will try to connect to the first access point detected that supports EAP. However, a successful connection is not guaranteed because the detected AP may be connected to a RADIUS server, which may not support this EAP type and/or have the proper user identities configured. Identity: Opens an on-screen keyboard to enter an EAP Identity string (used by the panel to identify itself to an Authentication (RADIUS) Server).
Note: This information is similar to a username used to login to a secured server or workstation. This works in tandem with the Password string which is similar to the password entered to gain access to a secured workstation. Typically, this is in the form of a username such as: [email protected].
Anonymous Identity:
Opens an on-screen keyboard to enter an IT provided alphanumeric string which (similar to the username) is used as the identity, but that does not represent a real user. This information is used as a fictitious name which might be seen by sniffer programs during the initial connection and setup process between the panel and the Radius server. In this way the real identity (username) is protected. Typically, this is in the form of a fictitious username, such as [email protected]
Password:
Opens an on-screen keyboard. Enter the network password string specified for the user entered within the Identity field (used by the panel to identify itself to an Authentication (RADIUS) Server)
Note: This information is similar to the password entered to gain access to a secured workstation.
This selection toggles PAC (Protected Access Credential) Provisioning Enabled (automatic) or Disabled (manual). If Enabled is selected, the following PAC File Location field is disabled, because the search for the PAC file is done automatically. If Disabled is selected, the user is required to manually locate a file containing the PAC shared secret credentials for use in authentication. In this case, the IT department must create a PAC file and then transfer it into the panel using the AMX Certificate Upload application.
Note: Even when automatic provisioning is enabled, the PAC certificate is only downloaded the first time that the panel connects to the RADIUS server. This file is then saved into the panel's file system and is then reused from then on. It is possible for the user to change a setting, such as a new Identity, that would invalidate this certificate. In that case, the panel must be forced to download a new PAC file. To do this, set Automatic PAC Provisioning to Disabled and then back to Enabled. This forces the firmware to delete the old file and request a new one.
68
EAP-FAST (Cont.)
PAC File Location: This field is used when the previous Automatic PAC Provisioning option has been Disabled. When pressed, the panel displays an on-screen PAC File Location keyboard which allows you to enter the name of the file containing the PAC shared secret credentials for use in authentication. This field is only valid when the automatic PAC provisioning feature has been enabled via the previous field. Auto Key Renewal: Cancel/Save: Select between NEVER, 1 Day, 3 Days, 7 Days, 14 Days, and 30 Days. Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the EAP Authentication section on page 184 and the Using the Site Survey Tool section on page 23 for further details on these security options.
EAP-PEAP
In the Wireless Security: Enterprise Mode popup window (FIG. 60), press the Security Type field to select EAP-PEAP. PEAP (Protected Extensible Authentication Protocol) was developed as a way to securely transmit authentication information, such as passwords, over a wireless network environment. PEAP uses only serverside public key certificates and therefore does not need a client (panel) certificate which makes the configuration and setup easier. There are two main versions of the PEAP protocol supported by panels DeviceScape Wireless Client: PEAPv0 PEAPv1 PEAP uses inner authentication mechanisms supported by the DeviceScape Wireless Client, the most common of which are: MSCHAPv2 with PEAPv0 GTC with PEAPv1 EAP-PEAP security is designed for wireless environments where it is necessary to transmit data securely over a wireless network. EAP-PEAP
SSID: Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in the wireless network. With EAP security, the SSID of the AP must be entered. If it is left blank, the panel will try to connect to the first access point detected that supports EAP. However, a successful connection is not guaranteed because the detected AP may be connected to a RADIUS server, which may not support this EAP type and/or have the proper user identities configured. Identity: Opens an on-screen keyboard to enter an EAP Identity string (used by the panel to identify itself to an Authentication (RADIUS) Server).
Note: This information is similar to a username used to login to a secured server or workstation. This works in tandem with the Password string, which is similar to the password entered to gain access to a secured workstation. Typically, this is in the form of a username such as [email protected].
Password:
Opens an on-screen keyboard to enter the network password string specified for the user entered within the Identity field (used by the panel to identify itself to an Authentication (RADIUS) Server)
Note: This information is similar to the password entered to gain access to a secured workstation.
69
EAP-PEAP (Cont.)
Certificate Authority: When pressed, the panel displays an on-screen Certificate Authority (CA) File Location keyboard, which allows you to enter the name of the certificate authority file which is used to validate the server certificate.This field is optional. If a server certificate is used, it should first be downloaded into the panel and the Certificate Authority field should then be set to the name of that certificate file. No file path should be used for this setting as all certificates are stored in a specific directory that the user cannot control or change. Use the on-screen keyboards Clear button to erase completely any previously stored network path information. PEAP Version: Inner Authentication Type: When pressed, this field cycles through the choices of available PEAP: PEAPv0, PEAPv1, or PEAPv1 w/peaplabel=1. When pressed, this field cycles through the choices of available Inner Authentication mechanisms supported by the Devicescape Secure Wireless Client. The most commonly used are: MSCHAPv2 and GTC. MSCHAPv2 (used with PEAPv0) GTC (used with PEAPv1) OTP MD5 Cancel/Save: Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the EAP Authentication section on page 184 and the Using the Site Survey Tool section on page 23 for further details on these security options.
70
EAP-TTLS
In the Wireless Security: Enterprise Mode popup window (FIG. 60), press the Security Type field to select EAP-TTLS. TTLS (EAP Tunneled Transport Layer Security) is an authentication method that does not use a client certificate to authenticate the panel. However. this method is more secure than PEAP because it does not broadcast the identity of the user. Setup is similar to PEAP, but differs in the following areas: An anonymous identity must be specified until the secure tunnel between the panel and the Radius server is setup to transfer the real identity of the user. There is no end-user ability to select from the different types of PEAP. Additional Inner Authentication choices are available to the end-user. EAP-TTLS security is designed for wireless environments where the Radius server needs to validate directly the identity of the client (panel) before allowing it access to the network. This validation is done by tunneling a connection through the AP and directly between the panel and the Radius server. Once the client is identified and then validated, the Radius server disconnects the tunnel and allows the panel to access the network directly via the target AP. EAP-TTLS
SSID: Opens an on-screen keyboard to enter the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in the wireless network. With EAP security, the SSID of the AP must be entered. If it is left blank, the panel will try to connect to the first access point detected that supports EAP. However, a successful connection is not guaranteed because the detected AP may be connected to a RADIUS server, which may not support this EAP type and/or have the proper user identities configured. Identity: Opens an on-screen keyboard. Enter an EAP Identity string (used by the panel to identify itself to an Authentication (RADIUS) Server).
Note: This information is similar to a username used to login to a secured server or workstation. This works in tandem with the Password string which is similar to the password entered to gain access to a secured workstation. Typically, this is in the form of a username such as: [email protected].
Anonymous Identity:
Opens an on-screen keyboard. Enter an IT provided alpha-numeric string which (similar to the username) used as the identity, but that does not represent a real user. This information is used as a fictitious name which might be seen by sniffer programs during the initial connection and setup process between the panel and the Radius server. In this way the real identity (username) is protected. Typically, this is in the form of a fictitious username such as: [email protected]
Password:
Opens an on-screen keyboard. Enter the network password string specified for the user entered within the Identity field (used by the panel to identify itself to an Authentication (RADIUS) Server)
Note: This information is similar to the password entered to gain access to a secured workstation.
Certificate Authority:
When pressed, the panel displays an on-screen Certificate Authority (CA) File Location keyboard which allows you to enter the name of the certificate authority file which is used to validate the server certificate. This field is optional. If a server certificate is used, it should first be downloaded into the panel and the Certificate Authority field should then be set to the name of that certificate file. No file path should be used for this setting as all certificates are stored in a specific directory that the user cannot control or change. Use the on-screen keyboards Clear button to completely erase any previously stored network path information.
71
EAP-TTLS (Cont.)
Inner Authentication Type: When pressed, this field cycles through the choices of available Inner Authentication mechanism supported by the Devicescape Secure Wireless Client: EAP-MSCHAPv2 EAP-GTC EAP-OTP EAP-MD5 MSCHAPv2 MSCHAP PAP CHAP Cancel/Save: Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the EAP Authentication section on page 184 and the Using the Site Survey Tool section on page 23 for further details on these security options.
EAP-TLS
In the Wireless Security: Enterprise Mode popup window (FIG. 60), press the Security Type field to select EAP-TLS. TLS (Transport Layer Security) was the original standard wireless LAN EAP authentication protocol. TLS requires additional work during the deployment phase, but provides additional security since even a compromised password is not enough to break into an EAP-TLS protected wireless network environment. EAP-TLS security is designed for wireless environments where it is necessary to securely transmit data over a wireless network by adding an additional level of security protocol via the use of a private key. EAP-TLS
SSID: Opens an on-screen keyboard for entering the SSID name used on the target AP. The SSID is a unique name used by the AP, and is assigned to all panels on that network. An SSID is required by the AP before the panel is permitted to join the network. The SSID is case sensitive and must not exceed 32 characters. Make sure this setting is the same for all points in the wireless network. With EAP security, the SSID of the AP must be entered. If it is left blank, the panel will try to connect to the first access point detected that supports EAP. However, a successful connection is not guaranteed because the detected AP may be connected to a RADIUS server, which may not support this EAP type and/or have the proper user identities configured. Identity: Opens an on-screen keyboard for entering an EAP Identity string (used by the panel to identify itself to an Authentication (RADIUS) Server).
Note: This information is similar to a username used to login to a secured server or workstation. This works in tandem with the Password string, which is similar to the password entered to gain access to a secured workstation. Typically, this is in the form of a username such as: [email protected].
Certificate Authority:
When pressed, the panel displays an on-screen Certificate Authority (CA) File Location keyboard, for entering the name of the certificate authority file which is used to validate the server certificate. This field is optional. If a server certificate is used, it should first be downloaded into the panel and the Certificate Authority field should then be set to the name of that certificate file. No file path should be used for this setting, as all certificates are stored in a specific directory that the user cannot control or change. Use the on-screen keyboards Clear button to completely erase any previously stored network path information.
72
EAP-TLS (Cont.)
Client Certificate: Opens an on-screen keyboard for entering the name of the file containing the client (panel) certificate for use in certifying the identity of the client (panel). Refer to the Client Certificate Configuration section on page 73 for information regarding Client Certificates and their parameters. Private Key: When pressed, the panel displays an on-screen Client Private Key File Location keyboard for entering the name of the file containing the private key. Use the on-screen keyboards Clear button to completely erase any previously stored network path information. Private Key password: This field should only be used if the Private Key is protected with a password. If no password protection is associated with the Private Key, then this field should be left blank. When pressed, the panel displays an on-screen Private Key Password keyboard which allows you to enter an alpha-numeric password string. Use the on-screen keyboards Clear button to completely erase any previously stored network path information. Cancel/Save: Cancel - discard changes and return to the previous page. Save - store the new security information, apply changes, and return to the previous page.
Refer to the EAP Authentication section on page 184 for further details on these security options. Refer to the Using the Site Survey Tool section on page 23 for more information on using this
feature.
Single file contains both the client certificate and the private key. Format is: PEM or DER. First file contains the client certificate, second file contains the private key. Format is: PEM or DER. Single file contains both the client certificate and the private key. Format is: PKCS12 First file contains the client certificate, second file contains the private key. Format is: PKCS12
Enter the file name Enter the first file name Leave this field blank Not supported
Enter the same file name Enter the second file name Enter the file name Not supported
AMX supports the following security certificates PEM (Privacy Enhanced Mail) DER (Distinguished Encoding Rules) PKCS12 (Public Key Cryptography Standard #12) PKCS12 files are frequently generated by Microsoft certificate applications. Otherwise, PEM is more common.
73
Certificate files frequently use 5 file extensions. It can be confusing because there is not a one to one correspondence. The following table shows the possible file extension used for each certificate type: Certificates and their Extensions
Certificate Type Possible File Extensions
PEM
DER PKCS12
Please note which certificate types are supported by the different certificate fields used on the configuration screens (PEAP, TTLS, and TLS). The following table outlines the firmware fields and their supported certificate types. Certificate Types Supported by the Modero Firmware
Configuration Field Name Certificate File Type Supported Certificate Authority field Client Certificate field Private Key field
PEM and DER PEM and DER .PEM, DER, and PKCS12
74
Calibrate Page
The Calibrate page (FIG. 63) allows you to calibrate the touch panel for accurate button selection.
1. Press and hold the center button on the navigation wheel for 6 seconds to access the Calibrate page (see
FIG. 53).
2. Press the crosshairs in turn. If the crosshairs are not touched within ten seconds, the MVP-5200i will
return to the Protected Setup page.
3. The page will read "Calibration Successful. Touch to continue." Touch anywhere on the screen to return
to the Protected Setup page. If the screen is not touched at that point, the device will automatically return to the Protected Setup page within 10 seconds. Always calibrate the panel before its initial use, and after downloading new firmware.
75
Sets the IP communication values for the touch panel: The Enable/Enabled button toggles between the two G4 activation settings: Enable - deactivates G4 Web Control on the panel. Enabled - activates G4 Web Control on the panel.
Network Interface Select: Toggles between the two network interface options: Wireless - the panel is communicating via an Access Point (AP). Wired - the panel is communicating via its mini-USB port. Web Control Name: Use this field to enter a unique alpha-numeric string to be used as the panels display name within the Manage WebControl Connections window of the NetLinx Security browser window. Use this field to enter the G4 Authentication session password required for VNC access to the panel. Use this field to enter the number of the port used by the VNC Web Server. Default = 5900. Displays the maximum number of users that can be simultaneously connected to this panel via VNC. Default = 1. Displays the number of users currently connected to this panel via VNC.
Web Control Password: Web Control Port: Maximum Number of Connections: Current Connection Count:
76
Refer to the Using G4 Web Control to Interact with a G4 Panel section on page 36 for instructions on using the G4 Web Control page with the web-based NetLinx Security application.
77
Other Settings
Press the Other Settings button to display the three settings options for Cache, Passwords, and SIP. Press one of the options within three seconds, or the three options buttons will slide back behind the Other Settings button.
Image Cache Settings Flash Cache Size: Cache Expires: Use the Up/Down buttons to increase or decrease the total size of the flash memory cache, up to a maximum of 171MB. Use the Up/Down buttons to control the amount of time elapsed before the panel automatically deletes its cache, with increments of 2 hours, 8 hours, 1 day, 2 days, 5 days, and "NEVER". Saves any changes made to the Flash Cache Size or Cache Expires fields. Clears all files previously stored in the flash memory cache.
Enable: Clear Cache: Image Cache Status RAM Max Size: RAM Current Size:
The maximum size allocated to the RAM cache. The size of the current RAM cache contents.
78
Accesses the alphanumeric values associated to particular password sets. The PASSWORD 1, 2, 3, 4 and 5 (protected) buttons open a keyboard to enter alphanumeric values associated to the selected password group.
Note: Clearing Password #5 removes the need to enter a password before accessing the Protected Setup page.
User Access:
Use these buttons to access and modify the user name/password combinations required for removing the panel from a docking station. The number of user access passwords on the panel is limited only by the amount of storage memory available. Use the UP/DN buttons to scroll through the list of saved User Access user names and passwords.
79
1. In the Password Settings page, press the button in the In Panel Password Change section for the particular
password to be changed.
2. In the Password keyboard, enter the new alphanumeric password. 3. Press Done when complete.
Only one of the main passwords may be used to access the Protected Settings page. An individual user password may not be used to access the Protected Settings page unless it matches one of the main passwords. To list a new user within the User Access section:
1. Press a blank button in the User Access section. 2. In the Name keyboard, enter the users name or nickname and press Done when finished. 3. In the Password keyboard, enter the selected alphanumeric password and press Done when finished. 4. The new users name will appear in the left column of User Access section. The password will also appear
in the right column, but its characters will be replaced with asterisks. No matter how many characters are in an actual password, the Password column in the User Access section will always show five asterisks. To change a User Access password:
1. Press the button corresponding to the users name in the User Access section. 2. In the Password keyboard, enter the users password and press Done. 3. Press the password button in the right column of the User Access section. 4. Enter the new password into the Password keyboard and press Done.
To view all previous instances of users accessing the device:
1. From the Password Settings page, press the Enable button to highlight it. The MVP-5200i will record all
successful and unsuccessful attempts to access the touch panel.
2. Press the Record button to send a record to the network Master of all recorded attempts to access the
device. This record may be retrieved from the Master at any time. For more information on removing an MVP-5200i from a MVP-WCS-52 Charging Station, please refer to the Unlocking the Touch Panel section on page 12.
80
You may need to load a Duet module to enable the touch panel to receive SIP calls. The Duet module translates between the standard interface and the device protocol. It parses the buffer for responses from the device, sends strings to control the device, and receives commands from the UI module or telnet sessions. Refer to the documentation supplied with the Duet Module for more details. A sample UI module is provided in the module package. It is not intended to cover every possible application, but can be expanded as needed by a dealer to meet the requirements of a particular installation. Features on this page include: SIP Settings Page
Back: WiFi/Wired/USB Icon: Saves all changes and returns to the previous page. The icon to the left of the Connection Status Icon displays whether the current connection to the Master is Wireless (image of a radio antenna), Wired (image of three networked computers), or USB (USB connection symbol). The icon in the upper-right corner of each Protected Setup page provides a constant visual indication of current connection status.
Note: a Lock appears on the icon if the panel is connected to a secured NetLinx Master.
Status:
This option enables the SIP Stack on startup. If you disable this option, the panel will not attempt to read the rest of the configuration and will not register with a proxy server. However, point-to-point SIP will still be enabled allowing for existing intercom functionality. This option displays whether you are connected to the proxy server. This option enables you to enter the IP address or DNS name of the proxy server that you want to use to register. The option displays the port you use to connect to the proxy server. The standard SIP port is 5060, but some providers use different ports.
81
This option enables you to enter the IP address or DNS name of the Simple Traversal of UDP through NATs (STUN) server. This field is optional. This is the realm used for authentication. This field is optional. This option enables you to enter the user name used for authentication to the proxy server. Normally, the user name is the same as the phone number assigned to the extension you are using. This field is optional. This option enables you to enter the password for the user at the proxy server. This field is optional. Save - store the new security information, apply changes, and return to the previous page. Cancel - discard changes and return to the previous page.
Password: Save/Cancel:
82
Tools
Press and hold the Tools button to access the MVP-5200is Panel Logs, Panel Statistics, and Connection Utility buttons. Each of these buttons opens a separate page, covered in detail below. The Tools button menu will remain visible for three seconds, regardless of whether or not the button continues to be held.
83
ICSP Messages: Blink Messages: Ethernet Statistics: Wireless Statistics: Clear: Refresh:
Lists the number of ICSP messages received, processed, and dropped, both in total and within the last 15 minutes. Lists the number of blink messages received and missed, both in total and within the last 15 minutes. Displays the percentage of connection time via Ethernet. Displays the percentage of connection time via wireless connections. Clears all fields on the Panel Statistics page. Refreshes all data on the Panel Statistics page.
84
85
86
Upgrading Firmware
Upgrading Firmware
Overview
For the purpose of panel downloads, the MVP-5200is download procedure is not compatible with other AMX panel devices. This is due to the unique configuration of the device. The first major change from other AMX devices is that the MVP-5200i uses dynamic Setup Pages for its displays. Instead of requiring a separate Setup Page project built within TPDesign 4, the MVP-5200i uses only a single set of Setup Pages for all of its supported resolutions. To enable a single Setup Page project to support all resolutions, this requires including images for the largest supported resolution with the Setup Page project and scaling the images to fit for lower resolutions. This modification would apply to state-level bitmaps and chameleon images; previously, image scaling has only applied to dynamic images. These features require a separate G4SupportFiles installation to be posted for download independently of the TPDesign4, NetLinx Studio, and Visual Architect applications.
1. Launch NetLinx Studio and select Settings > Master Communication Settings from the Main menu to
open the Master Communication Settings dialog (FIG. 71). If this is the first time the device needs to be configured, refer to the Configuring Modero Firmware via the USB Port section on page 186.
87
Upgrading Firmware
2. Click the Communications Settings... button to open the Communications Settings dialog box (FIG. 72).
3. Click on the NetLinx Master radio button from the Platform Selection section. 4. Click on the Virtual Master radio box from the Transport Connection Option section to configure the PC
to communicate directly with a panel. Everything else, such as the Authentication, is greyed-out because this connection is not going through the Masters UI.
5. Click the Edit Settings button on the Communications Settings dialog to open the Virtual NetLinx Master
Settings dialog (FIG. 73).
6. Within this dialog, enter the Master System number. The default is 1.
88
Upgrading Firmware
7. In the Available Connections section, click on the IP address for the touch panel to select it. 8. In the Virtual NetLinx Master Settings dialog box, click OK to close the box. 9. In the Communications Settings dialog box, click OK to close the box. 10. In the Master Communications Settings dialog box, click OK to save your settings and return to the main
NetLinx Studio application.
11. Click the OnLine Tree tab in the Workspace window to view the devices on the Virtual System. The
default System value is 1.
12. Right-click on the Empty Device Tree/System entry and select Refresh System to re-populate the list.
The panel will not appear as a device below the virtual system number, in the Online Tree tab, until both the system number used in step 14 for the Virtual NetLinx Master is entered into the Master Connection section of the System Settings page and the panel is restarted.
13. The OnLine Tree should now display the connection to the device. The Connection Status Icon on the
device may take up to five seconds to register the connection.
Step 3: Confirm and Upgrade the firmware via the USB port
Use the CC-USB Type-A to Mini-B 5-wire programming cable to provide communication between the miniUSB Program port on the touch panel and the PC. This method of communication is used to transfer firmware Kit files and TPD4 touch panel files.
1. Verify that the direct USB connection (Type-A on the panel to mini-USB on the panel) is configured
properly, using the steps outlined in the previous two sections.
2. With the panel already configured for USB communication and the Virtual Master setup within NetLinx
Studio, refresh the Online Tree pane.
3. After the Communication Verification dialog window verifies active communication between the Virtual
Master and the panel, click the OnLine Tree tab in the Workspace window (FIG. 74) to view the devices on the Virtual System. The default System value is 1.
4. Right-click on the System entry (FIG. 74) and select Refresh System to re-populate the list. Verify the
panel appears in the OnLine Tree tab of the Workspace window.
89
Upgrading Firmware
FIG. 74 NetLinx Workspace window (showing panel connection via a Virtual NetLinx Master)
The panel-specific firmware is shown on the right of the listed panel. Download the latest firmware file from www.amx.com and then save the Kit file to your computer. Note that each Kit file is intended for download to its corresponding panel. In some cases, several Kit files may be included in a .zip file; extract the .zip file to access the required Kit file.
5. If the panel firmware version is not the latest available; locate the latest firmware file from the
www.amx.com > Tech Center > Firmware Files > Modero Panels section of the website.
6. Click on the desired Kit file link and after accepting the Licensing Agreement, verify download of the
Modero Kit file to a known location.
7. Select Tools > Firmware Transfers > Send to NetLinx Device from the main menu to open the Send to
NetLinx Device dialog (FIG. 75). Verify that the panels System and Device number values match those values listed within the System folder in the OnLine Tree tab of the Workspace window.
90
Upgrading Firmware
8. Select the appropriate Kit file from within the Browse for Folder window (FIG. 76).
9. Select the panels Kit file from the Files section. 10. Enter the Device value associated with the panel and the System number associated with the Master
(listed in the OnLine Tree tab of the Workspace window). The Port field is greyed-out.
11. Click the Reboot Device checkbox if it is not already checked. This causes the touch panel to reboot after
the firmware update process is complete.
12. Click Send to begin the transfer. The file transfer progress is indicated on the bottom-right of the dialog. 13. After the file transfer is complete, the panel will automatically reboot. As the panel is rebooting,
temporarily unplug the USB connector on the panel until the panel has completely restarted.
14. Once the first panel page has been displayed, reconnect the USB connector to the panel. 15. Right-click the associated System number and select Refresh System. This causes a refresh of all project
systems, establishes a new connection to the Master, and populates the System list with devices on your particular system.
16. Confirm that the panel has been properly updated to the correct firmware version.
Verify you have downloaded the latest firmware file from www.amx.com and then save the Kit file to your computer.
91
Upgrading Firmware
1. From the Windows Start menu, select Settings > Control Panel to open the Control Panel window. 2. In the Control Panel window, click on the Network Connections icon to open the Network Connections
window (FIG. 77)
92
Upgrading Firmware
3. From the Advanced menu, select Advanced Settings... to open the Advanced Settings window (FIG. 78).
4. Under the Adapters And Bindings tab, the user needs to make sure the Local Area Connection is not at the
top of the Connections list. If it is at the top of the list (FIG. 78), select it and use the down arrow to the right of the list to move it to the bottom of the list (FIG. 79).
5. In the lower Bindings for Local Area Connection field, unselect ALL bindings by clicking on the
checkboxes by each binding to remove the checks from each box (FIG. 80).
93
Upgrading Firmware
6. When finished, click OK to close the Advanced Settings window and save all changes.
94
Programming
Programming
Overview
You can program the MVP-5200i, using the commands in this section, to perform a wide variety of operations using Send_Commands and variable text commands. A device must first be defined in the NetLinx programming language with values for the Device: Port: System (in all programming examples - Panel is used in place of these values and represents all Modero panels). Verify you are using the latest NetLinx Master and Modero firmware, as well as the latest version of NetLinx Studio and TPD4.
<LED NUM> indicates the channel code or ID number associated with an external LED to be controlled. In Systems with one external LED, this field should be ignored. <ACTION> indicates the expected behavior of the LED. For more information, please refer to the Navigation Wheel behavior in each Power Mode table on page 7. 0 LED OFF 1 LED ON 2 LED Resume Turns LED Off Turns LED On Restores operation of LED.
3 LOW BRIGHTNESS Sets the low brightness value for LED when operating on battery. 4 HIGH BRIGHTNESS Sets the high brightness value for LED when operating on external power or docked. <Brightness> Value ranges from 0 to 100. This field is ignored when action is 0,1,or2. Examples:
^WLD-0,1,0
95
Programming
Animated Transitions
Animated transitions are used to add motion and effects to the transition from one page to another on a panel. With existing panel firmware, page flip transitions occur with the new page immediately drawing over the existing page on the screen. With animated transitions, the old page is moved, faded, or overdrawn from the screen while the new page is drawn. These operations use the OpenGL hardware accelerator to ensure smooth transitions. Current panel firmware also supports animated buttons and popup page effects. This functionality is unchanged. In all cases, once the transition is triggered, the old page is frozen. For example, if the old page had an animated button, the motion on that button would stop as soon as the transition is triggered. If there is motion on the new page such as an animated button or even a popup effect, this motion will operate even while the overall page itself is in motion as part of the transition. Seven different classes of transitions are supported. Each transition class is described below. All of the transition classes, with the exception of Page Curl, are commanded transitions. Once the transition is triggered, it proceeds to completion. Page Curl can be interrupted and directed by the person touching the LCD as described below. Transition Classes
Slide The current page slides off of the screen and the new page slides in until it completely covers the screen and stops. There is no gap between pages, so if the page backgrounds match, this effect can give the appearance of moving around on a canvas that is larger than the physical screen size. This is the same as a slide transition, but with a bounce effect added when the new page reaches the edge of the screen across from where it originated. The existing page appears to move away from the viewer and off to the side. As soon as it is completely off the screen, the new page moves in and toward the viewer from the opposite edge of the screen. Both the old and new pages have a reflection on the bottom that makes it appear that the page is sliding along black reflective glass. The current page fades out while the new page fades in. The existing page appears to be peeled away like a sheet of paper, revealing the new page underneath. The new page has a shadow effect, and a faint reversed impression of the old page can be seen through the back of the paper being flipped. This transition can be interrupted by the user by holding a finger on the LCD and moving it around. The corner of the paper will follow the user's finger until released, causing the transition to proceed to completion. For the best effect, the button that triggers the page curl effect should be placed near the corner of the screen from which the page curl will originate. The new page moves over the existing page like a door with a hinge at the edge of the LCD. In addition, the new page is semi-transparent, allowing the old page to be seen through until the transition is finished, at which point the old page has faded away. This transition operates as above, except that the hinge point is at the center of the LCD rather than the edge.
The origin of the transition is the point on the LCD where the motion originates. In most cases, these locations are the top, bottom, left and right of the screen. For example, a slide transition with a left origin will appear to slide in from the left towards the right of the screen. Slide, slide with bounce, door with fade and center door with fade can originate from the top, bottom, left and right sides of the screen. Black glass can originate from the left or right. Fade does not need an origin since the entire screen fades together. Page curl originates from the four corners of the screen: upper left, lower left, upper right and lower right. The transition time is the amount of time required for the transition to operate from start to finish. This value can be specified from 0.3 seconds to 3.0 seconds in tenths of a second. If not specified, the default is 1.5 seconds. Transition times are based on real world clock time and do not vary based on the speed of the processor or the frame rate at which the display system is running.
96
Programming
Since the transitions require OpenGL hardware acceleration, they are not seen by the user on a VNC connection. When a transition is triggered, the user will see a normal page flip to the new page on the VNC connection, while the animated transition occurs as expected on the panel. Transition Commands
^AFP Flips to a page with the specified page name using an animated transition. Flips to a page with the specified page name using an animated transition. If the page is active, do not redraw the current page. If the page name is blank, flips to the previous page.
Syntax: "'^AFP-<page name>,<animation>,<origin>,<time>'"
Animation is one of the following strings: slide, sldBounce, blkGlass, fade, pgCurl, doorFade, cntrDrFade If animation is blank or invalid, the page flip will occur without any animated transition occurring. Origin is a number representing one of the following values for where the animated transition originates on the screen: 1 - center (currently unused) 2 - top 3 - bottom 4 - left 5 - right 6 - lower left 7 - lower right 8 - upper left 9 - upper right If the origin is blank or invalid, the default is 5 (right). Time is the transition time in tenths of a second which can vary from 3 (0.3 seconds) to 30 (3.0 seconds). Values above or below these values will be clamped. If the time is blank, then the default is 1.5 seconds. Example:
"'^AFP-MAIN,slide,5,10'"
Will transition to a page named MAIN using a slide effect from the right to the left and taking 1 second to complete.
97
Programming
1. Swipe up 2. Swipe down 3. Swipe right 4. Swipe left 5. Clockwise circle 6. Counter-clockwise circle 7. Double-Tap Gesture Velocity
A gesture velocity is calculated to represent the speed of the gesture. This is done by measuring the time from when the user first presses the screen until the user releases. The following simplified velocities are supported and transferred to the master in the custom event message:
Gesture Prioritization
It is important to prioritize the operation of the presses, moves and releases of the user to avoid confusion over what the user intended. The following process is used to determine what the user meant whenever a gesture operation is defined globally or for this page. Gesture Prioritization
The user presses outside of a button or slider and moves before releasing. The user presses inside of a slider and moves before releasing. The user presses inside of a joystick button and moves before releasing. The firmware will always try to recognize a gesture as long as the user moves at least 20 pixels before the release occurs. This will always be processed as a slider operation and no attempt will be made to recognize a gesture. This will always be processed as a joystick operation and no attempt will be made to recognize a gesture.
The user moves a movable popup page. This will always be processed as a popup page move and not a gesture. The user presses on a button and then moves. In this case, the press will not be sent for the first 0.15 second. If the user has moved at least 60 pixels by this time, then a button press/release will not be processed, but this will be processed as a gesture. At 0.15 second, the button press is processed and once the user releases, the release is processed and no gesture recognition is attempted. To be clear, it is not necessary for the user to move off of a button to be considered a gesture, but to move at least 60 pixels in that first 0.15 of a second. This will not be recognized as a gesture. This would be considered two quick press/release operations on the button or slider.
98
Programming
1. Swipe up 2. Swipe down 3. Swipe right 4. Swipe left 5. Clockwise circle 6. Counter-clockwise circle 7. Double-Tap
Simplified gesture velocity values are:
1. For slides and circles this represents pixels per second. 2. For double taps, this is the time in milliseconds from the first press to the second release. Enabling or Disabling the Gesture Custom Event
By default, a gesture custom event is sent to the master each time that a gesture is recognized. A send command has been added to allow disabling and re-enabling of this capability. The value sent is not retained and gesture custom events will be enabled each time the panel restarts.
NOTE: This setting is not retained and the default is to always send the events. To enable sending the event, the value after the dash can be "on", "ON", or 1. Anything else will disable sending custom events.
99
Programming
Page Commands
These Page Commands are used in NetLinx Programming Language and are case insensitive. Page Commands
@APG Add a specific popup page to a specified popup group. Add the popup page to a group if it does not already exist. If the new popup is added to a group which has a popup displayed on the current page along with the new pop-up, the displayed popup will be hidden and the new popup will be displayed. Syntax:
"'@APG-<popup page name>;<popup group name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. popup group name = 1 - 50 ASCII characters. Name of the popup group. Example:
SEND_COMMAND Panel,"'@APG-Popup1;Group1'"
Adds the popup page Popup1 to the popup group Group1. @CPG Clear all popup pages from specified popup group. Syntax:
"'@CPG-<popup group name>'"
Variable: popup group name = 1 - 50 ASCII characters. Name of the popup group. Example:
SEND_COMMAND Panel,"'@CPG-Group1'"
Clears all popup pages from the popup group Group1. @DPG Delete a specific popup page from specified popup group if it exists. Syntax:
"'@DPG-<popup page name>;<popup group name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. popup group name = 1 - 50 ASCII characters. Name of the popup group. Example:
SEND_COMMAND Panel,"'@DPG-Popup1;Group1'"
Deletes the popup page Popup1 from the popup group Group1. @PDR If the flag is set, the popup will return to its default location on show instead of its last drag location. Set the popup location reset flag. Syntax:
"'@PDR-<popup page name>;<reset flag>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. reset flag = 1 = Enable reset flag 0 = Disable reset flag Example:
SEND_COMMAND Panel,"'@PDR-Popup1;1'"
Popup1 will return to its default location when turned On. @PHE Syntax:
"'@PHE-<popup page name>;<hide effect name>'" Set the hide effect for the specified Variable: popup page to the popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed named hide effect. On.
hide effect name = Refers to the popup effect names being used. Example:
SEND_COMMAND Panel,"'@PHE-Popup1;Slide to Left'"
100
Programming
Variable: popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'@PHP-Popup1;75,0'"
Sets the Popup1 hide effect x-coordinate value to 75 and the y-coordinate value to 0. @PHT Syntax:
"'@PHT-<popup page name>;<hide effect time>'" Set the hide effect time for the Variable: specified popup popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed page. On.
Sets the Popup1 hide effect time to 5 seconds. @PPA Close all popups on a specified page.
If the page name is empty, the current page is used. Same as the Clear Page command in TPDesign4.
Syntax:
"'@PPA-<page name>'"
Variable: page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'@PPA-Page1'"
Close all pop-ups on Page1. @PPF Deactivate a specific popup page on either a specified page or the current page.
If the page name is empty, the current page is used (see example 2). If the popup page is part of a group, the whole group is deactivated. This command works in the same way as the Hide Popup command in TPDesign4.
Syntax:
"'@PPF-<popup page name>;<page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'@PPF-Popup1;Main'"
Example 2:
SEND_COMMAND Panel,"'@PPF-Popup1'"
101
Programming
Syntax:
"'@PPG-<popup page name>;<page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'@PPG-Popup1;Main'"
Toggles the popup page Popup1 on the Main page from one state to another (On/Off). Example 2:
SEND_COMMAND Panel,"'@PPG-Popup1'"
Toggles the popup page Popup1 on the current page from one state to another (On/Off). @PPK Kill a specific popup page from all pages. Kill refers to the deactivating (Off) of a popup window from all pages. If the pop-up page is part of a group, the whole group is deactivated. This command works in the same way as the 'Clear Group' command in TPDesign 4. Syntax:
"'@PPK-<popup page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. Example:
SEND_COMMAND Panel,"'@PPK-Popup1'"
Kills the popup page Popup1 on all pages. @PPM Set the modality of a specific popup page to Modal or NonModal. A Modal popup page, when active, only allows you to use the buttons and features on that popup page. All other buttons on the panel page are inactivated. Syntax:
"'@PPM-<popup page name>;<mode>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. mode = NONMODAL converts a previously Modal popup page to a NonModal. MODAL converts a previously NonModal popup page to Modal. modal = 1 and non-modal = 0 Example:
SEND_COMMAND Panel,"'@PPM-Popup1;Modal'"
Sets the popup page Popup1 to Modal. @PPN Activate a specific popup page to launch on either a specified page or the current page.
If the page name is empty, the current page is used (see example 2). If the popup page is already on, do not re-draw it. This command works in the same way as the Show Popup command in TPDesign4.
Syntax:
"'@PPN-<popup page name>;<page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'@PPN-Popup1;Main'"
102
Programming
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. timeout = Timeout duration in 1/10ths of a second. Example:
SEND_COMMAND Panel,"'@PPT-Popup1;30'"
Sets the popup page Popup1 to timeout within 3 seconds. @PPX Close all popups on all pages. This command works in the same way as the 'Clear All' command in TPDesign 4. Syntax:
"'@PPX'"
Example:
SEND_COMMAND Panel,"'@PPX'"
Close all popups on all pages. @PSE Set the show effect for the specified popup page to the named show effect. Syntax:
"'@PSE-<popup page name>;<show effect name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. show effect name = Refers to the popup effect name being used. Example:
SEND_COMMAND Panel,"'@PSE-Popup1;Slide from Left'"
Sets the Popup1 show effect name to Slide from Left. @PSP Set the show effect position. Only 1 coordinate is ever needed for an effect; however, the command will specify both. This command sets the location at which the effect will begin. Syntax:
"'@PSP-<popup page name>;<x coordinate>,<y coordinate>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'@PSP-Popup1;100,0'"
Sets the Popup1 show effect x-coordinate value to 100 and the y-coordinate value to 0. @PST Set the show effect time for the specified popup page. Syntax:
"'@PST-<popup page name>;<show effect time>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. show effect time = Given in 1/10ths of a second. Example:
SEND_COMMAND Panel,"'@PST-Popup1;50'"
Sets the Popup1 show effect time to 5 seconds. PAGE Flip to a specified page. Flips to a page with a specified page name. If the page is currently active, it will not redraw the page. Syntax:
"'PAGE-<page name>'"
Variable: page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'PAGE-Page1'"
Flips to page1.
103
Programming
Syntax:
"'PPOF-<popup page name>;<page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'PPOF-Popup1;Main'"
Deactivates the popup page Popup1 on the current page. PPOG Toggle a specific popup page on either a specified page or the current page.
If the page name is empty, the current page is used (see example 2). Toggling refers to the activating/deactivating (On/Off) of a popup page. This command works in the same way as the Toggle Popup command in TPDesign4.
Syntax:
"'PPOG-<popup page name>;<page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'PPOG-Popup1;Main'"
Toggles the popup page Popup1 on the Main page from one state to another (On/Off). Example 2:
SEND_COMMAND Panel,"'PPOG-Popup1'"
Toggles the popup page Popup1 on the current page from one state to another (On/Off). PPON Activate a specific popup page to launch on either a specified page or the current page.
If the page name is empty, the current page is used (see example 2). If the popup page is already On, do not re-draw it. This command works in the same way as the Show Popup command in TPDesign4.
Syntax:
"'PPON-<popup page name>;<page name>'"
Variable: popup page name = 1 - 50 ASCII characters. Name of the popup page. page name = 1 - 50 ASCII characters. Name of the page the popup is displayed On. Example:
SEND_COMMAND Panel,"'PPON-Popup1; Main'"
104
Programming
Programming Numbers
The following information provides the programming numbers for colors, fonts, and borders. Colors can be used to set the colors on buttons, sliders, and pages. The lowest color number represents the lightest color-specific display; the highest number represents the darkest display. For example, 0 represents light red, and 5 is dark red.
Name
Very Light Red Light Red Red Medium Red Dark Red Very Dark Red Very Light Orange Light Orange Orange Medium Orange Dark Orange Very Dark Orange Very Light Yellow Light Yellow Yellow Medium Yellow Dark Yellow Very Dark Yellow Very Light Lime Light Lime Lime Medium Lime Dark Lime Very Dark Lime Very Light Green
Red
255 223 191 159 127 95 255 223 191 159 127 95 255 223 191 159 127 95 128 112 96 80 64 48 0
Green
0 0 0 0 0 0 128 112 96 80 64 48 255 223 191 159 127 95 255 223 191 159 127 95 255
Blue
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
Light Green Green Medium Green Dark Green Very Dark Green Very Light Mint Light Mint Mint Medium Mint Dark Mint Very Dark Mint Very Light Cyan Light Cyan Cyan Medium Cyan Dark Cyan Very Dark Cyan Very Light Aqua Light Aqua Aqua Medium Aqua
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
223 191 159 127 95 255 223 191 159 127 95 255 223 191 159 127 95 128 112 96 80
0 0 0 0 0 128 112 96 80 64 48 255 223 191 159 127 95 255 223 191 159
105
Programming
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 255
Dark Aqua Very Dark Aqua Very Light Blue Light Blue Blue Medium Blue Dark Blue Very Dark Blue Very Light Purple Light Purple Purple Medium Purple Dark Purple Very Dark Purple Very Light Magenta Light Magenta Magenta Medium Magenta Dark Magenta Very Dark Magenta Very Light Pink Light Pink Pink Medium Pink Dark Pink Very Dark Pink White Grey1 Grey3 Grey5 Grey7 Grey9 Grey4 Grey6 Grey8 Grey10 Grey12 Grey13 Grey2 Grey11 Grey14 Black TRANSPARENT
0 0 0 0 0 0 0 0 128 112 96 80 64 48 255 223 191 159 127 95 255 223 191 159 127 95 255 238 204 170 136 102 187 153 119 85 51 34 221 68 17 0 99
64 48 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 255 238 204 170 136 102 187 153 119 85 51 34 221 68 17 0 53
127 95 255 223 191 159 127 95 255 223 191 159 127 95 255 223 191 159 127 95 128 112 96 80 64 48 255 238 204 170 136 102 187 153 119 85 51 34 221 68 17 0 99
106
Programming
Font type
Courier New Courier New Courier New Courier New Courier New Courier New Courier New Courier New AMX Bold AMX Bold AMX Bold
Size
9 12 18 26 32 18 26 34 14 20 36
Font ID #
19 20 21 22 23 24 25 26 27 28 29
Font type
Arial Arial Arial Arial Arial Arial Arial Arial Arial Arial Bold Arial Bold
Size
9 10 12 14 16 18 20 24 36 10 8
Fonts must be imported into a TPDesign4 project file. The font ID numbers are assigned by TPDesign4. These values are also listed in the Generate Programmers Report.
Border styles
No border Single line Double line Quad line Circle 15 Single line Double line Quad line
No.
10-11 12 20 21 22-23 24-27 40-41
Border styles
Picture frame Double line Bevel-S Bevel-M Circle 15 Neon inactive-S Diamond 55
The TPDesign4 Touch Panel Design program has pre-set border styles that are user-selectable. The following number values cannot be used for programming purposes when changing border styles. TPD4 border styles may ONLY be changed by using the name. TPD4 Border Styles by Name
No.
1 2 3 4 5 6 7 8 9 10 11 12
Border styles
None AMX Elite -L AMX Elite -M AMX Elite -S Bevel -L Bevel -M Bevel -S Circle 15 Circle 25 Circle 35 Circle 45 Circle 55
No.
27 28 29 30 31 32 33 34 35 36 37 38
Border styles
Cursor Bottom Cursor Bottom with Hole Cursor Top Cursor Top with Hole Cursor Left Cursor Left with Hole Cursor Right Cursor Right with Hole Custom Frame Diamond 15 Diamond 25 Diamond 35
107
Programming
Border styles
Circle 65 Circle 75 Circle 85 Circle 95 Circle 105 Circle 115 Circle 125 Circle 135 Circle 145 Circle 155 Circle 165 Circle 175 Circle 185 Circle 195 Diamond 185 Diamond 195 Double Bevel -L Double Bevel -M Double Bevel -S Double Line Fuzzy Glow-L Glow-S Help Down Neon Active -L Neon Active -S Neon Inactive -L Neon Inactive -S Oval H 60x30 Oval H 100x50 Oval H 150x75 Oval H 200x100 Oval V 30x60 Oval V 50x100 Oval V 75x150 Oval V 100x200 Picture Frame Quad Line Single Line Windows Style Popup Windows Style Popup (Status Bar) Menu Bottom Rounded 15 Menu Bottom Rounded 25 Menu Bottom Rounded 35 Menu Bottom Rounded 45 Menu Bottom Rounded 55 Menu Bottom Rounded 65 Menu Bottom Rounded 75 Menu Bottom Rounded 85 Menu Bottom Rounded 95 Menu Bottom Rounded 105 Menu Bottom Rounded 115 Menu Bottom Rounded 125 Menu Bottom Rounded 135 Menu Bottom Rounded 145 Menu Bottom Rounded 155
No.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
Border styles
Diamond 45 Diamond 55 Diamond 65 Diamond 75 Diamond 85 Diamond 95 Diamond 105 Diamond 115 Diamond 125 Diamond 135 Diamond 145 Diamond 155 Diamond 165 Diamond 175 Menu Bottom Rounded 185 Menu Bottom Rounded 195 Menu Top Rounded 15 Menu Top Rounded 25 Menu Top Rounded 35 Menu Top Rounded 45 Menu Top Rounded 55 Menu Top Rounded 65 Menu Top Rounded 75 Menu Top Rounded 85 Menu Top Rounded 95 Menu Top Rounded 105 Menu Top Rounded 115 Menu Top Rounded 125 Menu Top Rounded 135 Menu Top Rounded 145 Menu Top Rounded 155 Menu Top Rounded 165 Menu Top Rounded 175 Menu Top Rounded 185 Menu Top Rounded 195 Menu Right Rounded 15 Menu Right Rounded 25 Menu Right Rounded 35 Menu Right Rounded 45 Menu Right Rounded 55 Menu Right Rounded 65 Menu Right Rounded 75 Menu Right Rounded 85 Menu Right Rounded 95 Menu Right Rounded 105 Menu Right Rounded 115 Menu Right Rounded 125 Menu Right Rounded 135 Menu Right Rounded 145 Menu Right Rounded 155 Menu Right Rounded 165 Menu Right Rounded 175 Menu Right Rounded 185 Menu Right Rounded 195 Menu Left Rounded 15 Menu Left Rounded 25
108
Programming
Border styles
Menu Bottom Rounded 165 Menu Bottom Rounded 175 Menu Left Rounded 55 Menu Left Rounded 65 Menu Left Rounded 75 Menu Left Rounded 85 Menu Left Rounded 95 Menu Left Rounded 105 Menu Left Rounded 115 Menu Left Rounded 125
No.
139 140 149 150 151 152 153 154 155
Border styles
Menu Left Rounded 35 Menu Left Rounded 45 Menu Left Rounded 135 Menu Left Rounded 145 Menu Left Rounded 155 Menu Left Rounded 165 Menu Left Rounded 175 Menu Left Rounded 185 Menu Left Rounded 195
Variable: variable text address range = 1 - 4000. start state = Beginning of button state (0= current state). end state = End of button state. time = In 1/10 second intervals. Example:
SEND_COMMAND Panel,"'^ANI-500,1,25,100'"
Runs a button animation at text range 500 from state 1 to state 25 for 10 second. ^APF Add page flip action to a button if it does not already exist. Syntax:
"'^APF-<vt addr range>,<page flip action>,<page name>'"
Example:
SEND COMMAND Panel,"'^APF-400,Stan,Main Page'"
Assigns a button to a standard page flip with page name 'Main Page'.
109
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). new text = 1 - 50 ASCII characters. Example:
SEND_COMMAND Panel,"'^BAT-520,1,Enter City'"
Appends the text 'Enter City' to the buttons OFF state. ^BAU Append unicode text. Same format as ^UNI. Syntax:
"'^BAU-<vt addr range>,<button states range>,<unicode text>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). unicode text = 1 - 50 ASCII characters. Unicode characters must be entered in Hex format. Example:
SEND_COMMAND Panel,"'^BAU-520,1,00770062'"
Appends Unicode text '00770062' to the buttons OFF state. ^BCB Set the border color to the specified color.
Only if the specified border color is not the same as the current color. Note: Color can be assigned by color name (without spaces), number or R,G,B value (RRGGBB or RRGGBBAA).
Syntax:
"'^BCB-<vt addr range>,<button states range>,<color value>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). color value = Refer to the RGB Values for all 88 Basic Colors table on page 105 for more information. Example:
SEND_COMMAND Panel,"'^BCB-500.504&510,1,12'"
Sets the Off state border color to 12 (Yellow). Colors can be set by Color Numbers, Color name, R,G,B,alpha colors (RRGGBBAA) and R, G & B colors values (RRGGBB). Refer to the RGB Values for all 88 Basic Colors table on page 105.
110
Programming
Syntax:
"'^BCF-<vt addr range>,<button states range>,<color value>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). color value = Refer to the RGB Values for all 88 Basic Colors table on page 105 for more information. Example:
SEND_COMMAND SEND_COMMAND SEND_COMMAND SEND_COMMAND Panel,"'^BCF-500.504&510.515,1,12'" Panel,"'^BCF-500.504&510.515,1,Yellow'" Panel,"'^BCF-500.504&510.515,1,#F4EC0A63''" Panel,"'^BCF-500.504&510.515,1,#F4EC0A'"
Sets the Off state fill color by color number. Colors can be set by Color Numbers, Color name, R,G,B,alpha colors (RRGGBBAA) and R, G & B colors values (RRGGBB). ^BCT Set the text color to the specified color.
Only if the specified text color is not the same as the current color. Note: Color can be assigned by color name (without spaces), number or R,G,B value (RRGGBB or RRGGBBAA).
Syntax:
"'^BCT-<vt addr range>,<button states range>,<color value>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). color value = Refer to the RGB Values for all 88 Basic Colors table on page 105 for more information. Example:
SEND_COMMAND Panel,"'^BCT-500.504&510,1,12'"
Sets the Off state border color to 12 (Yellow). Colors can be set by Color Numbers, Color name, R,G,B,alpha colors (RRGGBBAA) and R, G & B colors values (RRGGBB). ^BDO Set the button draw order. Determines what order each layer of the button is drawn. Syntax:
"'^BDO-<vt addr range>,<button states range>,<1-5><1-5><1-5><1-5><15>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). layer assignments =
Fill Layer =1 Image Layer = 2 Icon Layer = 3 Text Layer = 4 Border Layer = 5
Note: The layer assignments are from bottom to top. The default draw order is 12345.
Example:
SEND_COMMAND Panel,"'^BDO-530,1&2,51432'"
Sets the buttons variable text 530 ON/OFF state draw order (from bottom to top) to Border, Fill, Text, Icon, and Image. Example 2:
SEND_COMMAND Panel,"'^BDO-1,0,12345'"
111
Programming
Set the feedback Syntax: type of the button. "'^BFB-<vt addr range>,<feedback type>'" Variable: variable text address range = 1 - 4000. feedback type = (None, Channel, Invert, On (Always on), Momentary, and Blink). Example:
SEND_COMMAND Panel,"'^BFB-500,Momentary'"
input mask = Refer to the Text Area Input Masking table on page 176 for character types. Example:
SEND_COMMAND Panel,"'^BIM-500,AAAAAAAAAA'"
Sets the input mask to ten A characters, that are required, to either a letter or digit (entry is required). ^BLN Set the number of lines removed equally from the top and bottom of a composite video signal. The maximum number of lines to remove is 240. A value of 0 will display the incoming video signal unaffected. This command is used to scale non 4x3 video images into non 4x3 video buttons. Syntax:
"'^BLN-<vt addr range>,<button states range>,<number of lines>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). number of lines = 0 - 240. Example:
SEND_COMMAND Panel,"'^BLN-500,55'"
Equally removes 55 lines from the top and 55 lines from the bottom of the video button.
112
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). source port = 1 - 100. source address = 1 - 4000. source state = 1 - 256. codes:
BM - Picture/Bitmap BR - Border CB - Border Color CF - Fill Color CT - Text Color EC - Text effect color EF - Text effect FT - Font IC - Icon JB - Bitmap alignment JI - Icon alignment JT - Text alignment LN - Lines of video removed OP - Opacity SO - Button Sound TX - Text VI - Video slot ID WW - Word wrap on/off
Example:
SEND_COMMAND Panel,"'^BMC-425,1,1,500,1,BR'" or SEND_COMMAND Panel,"'^BMC-425,1,1,500,1,%BR'"
Copies the OFF state border of button with a variable text address of 500 onto the OFF state border of button with a variable text address of 425. Example 2:
SEND_COMMAND Panel,"'^BMC-150,1,1,315,1,%BR%FT%TX%BM%IC%CF%CT'"
Copies the OFF state border, font, Text, bitmap, icon, fill color and text color of the button with a variable text address of 315 onto the OFF state border, font, Text, bitmap, icon, fill color and text color of the button with a variable text address of 150.
113
Programming
Variables: variable text address char array = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). level range = 1 - 600 (level value is 1 - 65535). data: %R<left>, <top>, <right>, <bottom> = Set rectangle. %B<border style> = Set the border style name. See the Border Styles and Programming Numbers table on page 107. %B,<border 0-27,40,41> = Set the borer style number. See the Border Styles and Programming Numbers table on page 107. %DO<1-5><1-5><1-5><1-5><1-5> = Set the draw order. Listed from bottom to top. Refer to the ^BDO command on page 111 for more information. %F,<font 1-8,10,11,20-29,32-xx> = Set the font. See the Default Font Styles and ID Numbers table on page 107. %F<font 01-08,10,11,20-29,32-xx> = Set the font. See the Default Font Styles and ID Numbers table on page 107. %MI<mask image> = Set the mask image. Refer to the ^BMI command on page 116 for more information. %R = Sets button location and also resizes the button. Takes four parameters: left, top, right, bottom. %T<text > = Set the text using ASCII characters (empty is clear). %P<bitmap> = Set the picture/bitmap filename (empty is clear). %I,<icon 01-9900, 0-clear> = Set the icon using values of 01 - 9900 (icon numbers are assigned in the TPDesign4 Resource Manager tab - Slots section). %I<icon 01-9900, 0-clear> = Set the icon using values of 01 - 9900 (icon numbers are assigned in the TPDesign4 Resource Manager tab - Slots section). %J,<alignment of text 1-9> = As shown the following telephone keypad alignment chart:
0 1 4 7 2 5 8 3 6 9 Zero can be used for an absolute position
%JT<alignment of text 0-9> = As shown the above telephone keypad alignment chart, BUT the 0 (zero) is absolute and followed by ,<left>,<top> %JB<alignment of bitmap/picture 0-9> = As shown the above telephone keypad alignment chart BUT the 0 (zero) is absolute and followed by ,<left>,<top> %JI<alignment of icon 0-9> = As shown the above telephone keypad alignment chart, BUT the 0 (zero) is absolute and followed by ,<left>,<top>
For some of these commands and values, refer to the RGB Values for all 88 Basic Colors table on page 105.
%CF<on fill color> = Set Fill Color. %CB<on border color> = Set Border Color. %CT<on text color> = Set Text Color. %SW<1 or 0> = Show/hide a button. %SO<sound> = Set the button sound. %EN<1 or 0> = Enable/disable a button. %WW<1 or 0> = Word wrap ON/OFF. %GH<bargraph hi> = Set the bargraph upper limit. %GL<bargraph low> = Set the bargraph lower limit. %GN<bargraph slider name> = Set the bargraph slider name/Joystick cursor name. %GC<bargraph slider color> = Set the bargraph slider color/Joystick cursor color.
114
Programming
Sets the button OFF state as well as the Border, Fill Color, Border Color, Text Color, and Bitmap.
115
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). mask image = Graphic file used. Example:
SEND_COMMAND Panel,"'^BMI-530,1&2,newMac.png'"
Sets the button with variable text 530 ON/OFF state mask image to 'newmac.png'. "'^BMI-<variable text address range>,<button states range>,<mask image>'" Set the Chameleon Image button property. See Working With Chameleon Images in TPD4 Help. Note: If the Border Style properties is set to something other than 'None', no visible change will occur. Setting the Border Style to 'None' via ^BOR or ^BMF..%B will reveal the Chameleon image. Syntax:
SEND_COMMAND <DEV>,"'^BMI-<vt addr range>,<button states range>,<mask image>'"
Variables: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). mask image = Chameleon used. Example:
SEND_COMMAND Panel,"'^BMI-530,1&2,newMac.png'"
Sets the button with variable text 530 ON/OFF state mask image to 'newmac.png'. ^BML Set the maximum length of the text area button. If this value is set to zero (0), the text area has no max length. The maximum length available is 2000. This is only for a Text area input button and not for a Text area input masking button. Syntax:
"'^BML-<vt addr range>,<max length>'"
Variable: variable text address range = 1 - 4000. max length = 2000 (0=no max length). Example:
SEND_COMMAND Panel,"'^BML-500,20'"
Sets the maximum length of the text area input button to 20 characters. ^BMP Syntax:
"'^BMP-<vt addr range>,<button states range>,<name of bitmap/ Assign a picture to picture>'" those buttons with a defined address Variable: range. variable text address range = 1 - 4000.
button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). name of bitmap/picture = 1 - 50 ASCII characters. Example:
SEND_COMMAND Panel,"'^BMP-500.504&510.515,1,bitmap.png'"
Sets the OFF state picture for the buttons with variable text ranges of 500-504 & 510-515.
116
Programming
Variable: variable text address range = 1 - 4000. command value = (0= clear, 1= clear all). Example:
SEND_COMMAND Panel,"'^BNC-973,0'"
Clears the annotation of the TakeNote button with variable text 973. ^BNN Set the TakeNote network name for the specified Addresses. Syntax:
"'^BNN-<vt addr range>,<network name>'"
Variable: variable text address range = 1 - 4000. network name = Use a valid IP Address. Example:
SEND_COMMAND Panel,"'^BNN-973,192.168.169.99'"
Sets the TakeNote button network name to 192.168.169.99. ^BNT Set the TakeNote network port for the specified Addresses. Syntax:
"'^BNT-<vt addr range>,<network port>'"
Variable: variable text address range = 1 - 4000. network port = 1 - 65535. Example:
SEND_COMMAND Panel,"'^BNT-973,5000'"
Sets the TakeNote button network port to 5000. ^BOP Set the button opacity. The button opacity can be specified as a decimal between 0 - 255, where zero (0) is invisible and 255 is opaque, or as a HEX code, as used in the color commands by preceding the HEX code with the # sign. In this case, #00 becomes invisible and #FF becomes opaque. If the opacity is set to zero (0), this does not make the button inactive, only invisible. Syntax:
"'^BOP-<vt addr range>,<button states range>,<button opacity>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). button opacity = 0 (invisible) - 255 (opaque). Example:
SEND_COMMAND Panel,"'^BOP-500.504&510.515,1,200'"
Example 2:
SEND_COMMAND Panel,"'^BOP-500.504&510.515,1,#C8'"
Both examples set the opacity of the buttons with the variable text range of 500-504 and 510-515 to 200.
117
Programming
Variable: variable text address range = 1 - 4000. border style name = Refer to the Border Styles and Programming Numbers table on page 107. border value = 0 - 41. Examples:
SEND_COMMAND Panel,"'^BOR-500.504&510.515,10'"
Sets the border by number (#10) to those buttons with the variable text range of 500-504 & 510-515.
SEND_COMMAND Panel,"'^BOR-500.504&510,AMX Elite -M'"
Sets the border by name (AMX Elite) to those buttons with the variable text range of 500-504 & 510-515. The border style is available through the TPDesign4 border-style drop-down list. Refer to theTPD4 Border Styles by Name table on page 107 for more information. ^BOS Set the button to display either a Video or Non-Video window. Syntax:
"'^BOS-<vt addr range>,<button states range>,<video state>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). video state = Video Off = 0 and Video On = 1. Example:
SEND_COMMAND Panel,"'^BOS-500,1,1'"
Sets the button to display video. ^BPP Zero clears the flag. Syntax: Set or clear the protected page flip "'^BPP-<vt addr range>,<protected page flip flag value>'" flag of a Variable: button. variable text address range = 1 - 4000. protected page flip flag value range = 0 - 4 (0 clears the flag). Example:
SEND_COMMAND Panel,"'^BPP-500,1'"
Sets the button to protected page flip flag 1 (sets it to password 1). ^BRD Set the border of a button state/ states. Only if the specified border is not the same as the current border. The border names are available through the TPDesign4 border-name drop-down list. Syntax:
"'^BRD-<vt addr range>,<button states range>,<border name>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). border name = Refer to the Border Styles and Programming Numbers table on page 107. Example:
SEND_COMMAND Panel,"'^BRD-500.504&510.515,1&2,Quad Line'"
Sets the border by name (Quad Line) to those buttons with the variable text range of 500-504 & 510-515. Refer to theTPD4 Border Styles by Name table on page 107.
118
Programming
Syntax:
"'^BSF-<vt addr range>,<selection value>'"
Variable: variable text address range = 1 - 4000. selection value = Unselect = 0 and select = 1. Example:
SEND_COMMAND Panel,"'^BSF-500,1'"
Sets the focus to the text area of the button. ^BSP Set the button size and position. Set the button size and its position on the page. Syntax:
"'^BSP-<vt addr range>,<left>,<top>,<right>,<bottom>'"
Variable: variable text address range = 1 - 4000. left = left side of page. top = top of page. right = right side of page. bottom = bottom of page. Example:
SEND_COMMAND Panel,"'^BSP-530,left,top'"
Sets the button with variable text 530 in the left side top of page. ^BSM Submit text for text area buttons. This command causes the text areas to send their text as strings to the NetLinx Master. Syntax:
"'^BSM-<vt addr range>'"
Submits the text of the text area button. ^BSO Set the sound played when a button is pressed. If the sound name is blank the sound is then cleared. If the sound name is not matched, the button sound is not changed. Syntax:
"'^BSO-<vt addr range>,<button states range>,<sound name>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). sound name = (blank - sound cleared, not matched - button sound not changed). Example:
SEND_COMMAND Panel,"'^BSO-500,1&2,music.wav'"
Assigns the sound 'music.wav' to the button Off/On states. ^BVL Log-On/Log-Off the computer control connection. Syntax:
"'^BVL-<vt addr range>,<connection>'"
Variable: variable text address range = 1 - 4000. connection = 0 (Log-Off connection) and 1 (Log-On connection). Example:
SEND_COMMAND Panel,"'^BVL-500,0'"
119
Programming
Example:
SEND_COMMAND Panel,"'^BVN-500,191.191.191.191'"
Sets the remote host to '191.191.191.191' for the specific computer control button. ^BVP Syntax: "'^BVP-<vt addr range>,<network password>'" Set the network password for the Variable: specified address. variable text address range = 1 - 4000. network password = 1 - 50 ASCII characters. Example:
SEND_COMMAND Panel,"'^BVP-500,PCLOCK'"
Sets the password to PCLOCK for the specific PC control button. ^BVT Syntax: "'^BVT-<vt addr range>,<network port>'" Set the computer control network Variable: port for the variable text address range = 1 - 4000. specified address. network port = 1 - 65535. Example:
SEND_COMMAND Panel,"'^BVT-500,5000'"
Sets the network port to 5000. ^BWW Set the button word wrap feature to those buttons with a defined address range. By default, word-wrap is Off. Syntax:
"'^BWW-<vt addr range>,<button states range>,<word wrap>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). word wrap = (0=Off and 1=On). Default is Off. Example:
SEND_COMMAND Panel,"'^BWW-500,1,1'"
Sets the word wrap on for the buttons Off state. ^CPF Syntax: "'^CPF-<vt addr range>'" Clear all page flips from a button. Variable: variable text address range = 1 - 4000. Example:
SEND_COMMAND Panel,"'^CPF-500'"
Clears all page flips from the button. ^DLD Set the disable cradle LED flag. Syntax:
"'^DLD-<status>'"
Variable: status = (0= cradle operates normally, 1= forces the cradle LEDs to always be dim). Example:
SEND_COMMAND Panel,"'^DLD-1'"
120
Programming
Example:
SEND COMMAND Panel,"'^DPF-409,Prev'"
Deletes the assignment of a button from flipping to a previous page. ^ENA Enable or disable buttons with a set variable text range. Syntax:
"'^ENA-<vt addr range>,<command value>'"
Variable: variable text address range = 1 - 4000. command value = (0= disable, 1= enable) Example:
SEND_COMMAND Panel,"'^ENA-500.504&510.515,0'"
Disables button pushes on buttons with variable text range 500-504 & 510-515. ^FON Set a font to a specific Font ID value for those buttons with a defined address range. Font ID numbers are generated by the TPDesign4 programmers report. Syntax:
"'^FON-<vt addr range>,<button states range>,<font value>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). font value = range = 1 - XXX. Refer to the Default Font Styles and ID Numbers section on page 107. Example:
SEND_COMMAND Panel,"'^FON-500.504&510.515,1&2,4'"
Sets the font size to font ID #4 for the On and Off states of buttons with the variable text range of 500-504 & 510-515.
The Font ID is generated by TPD4 and is located in TPD4 through the Main menu. Panel > Generate Programmer's Report >Text Only Format >Readme.txt.
121
Programming
Variable: variable text address range = 1 - 4000. bargraph drag increment = The default drag increment is 256. Example:
SEND_COMMAND Panel,"'^GDI-7,128'"
Sets the bargraph with variable text 7 to a drag increment of 128. ^GIV Invert the joystick axis to move the origin to another corner. Parameters 1,2, and 3 will cause a bargraph or slider to be inverted regardless of orientation. Their effect will be as described for joysticks. Syntax:
"'^GIV-<vt addr range>,<joystick axis to invert>'"
Inverts the joystick axis origin to the bottom right corner. ^GLH Change the bargraph upper limit. Syntax:
"'^GLH-<vt addr range>,<bargraph hi>'"
Variable: variable text address range = 1 - 4000. bargraph limit range = 1 - 65535 (bargraph upper limit range). Example:
SEND_COMMAND Panel,"'^GLH-500,1000'"
Changes the bargraph upper limit to 1000. ^GLL Change the bargraph lower limit. Syntax:
"'^GLL-<vt addr range>,<bargraph low>'"
Variable: variable text address range = 1 - 4000. bargraph limit range = 1 - 65535 (bargraph lower limit range). Example:
SEND_COMMAND Panel,"'^GLL-500,150'"
Changes the bargraph lower limit to 150. ^GRD Change the bargraph ramp-down time in 1/10th of a second. Syntax:
"'^GRD-<vt addr range>,<bargraph ramp down time>'"
Variable: variable text address range = 1 - 4000. bargraph ramp down time = In 1/10th of a second intervals. Example:
SEND_COMMAND Panel,"'^GRD-500,200'"
122
Programming
Variable: variable text address range = 1 - 4000. bargraph ramp up time = In 1/10th of a second intervals. Example:
SEND_COMMAND Panel,"'^GRU-500,100'"
^GSC
Change the bargraph slider color or joystick cursor color.
A user can also assign the color by Name and R,G,B value (RRGGBB or RRGGBBAA). Syntax:
"'^GSC-<vt addr range>,<color value>'"
Variable: variable text address range = 1 - 4000. color value = Refer to the RGB Values for all 88 Basic Colors table on page 105. Example:
SEND_COMMAND Panel,"'^GSC-500,12'"
^GSN
Change the bargraph slider name or joystick cursor name.
Slider names and cursor names can be found in the TPDesign4 slider name and cursor drop-down list. Syntax:
"'^GSN-<vt addr range>,<bargraph slider name>'"
Variable: variable text address range = 1 - 4000. bargraph slider name = See table below.
Bargraph Slider Names: None Circle -M Rectangle -L Windows Ball Circle -S Rectangle -M Windows Active Circle -L Precision Rectangle -S
Joystick Cursor Names: None Circle Hand Target Arrow Crosshairs Metal View Finder Ball Gunsight Spiral
Example:
SEND_COMMAND Panel,"'^GSN-500,Ball'"
Changes the bargraph slider name or the Joystick cursor name to Ball.
^ICO
Set the icon to a button.
Syntax:
"'^ICO-<vt addr range>,<button states range>,<icon index>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). icon index range = 0 - 9900 (a value of 0 is clear). Example:
SEND_COMMAND Panel,"'^ICO-500.504&510.515,1&2,1'"
Sets the icon for On and Off states for buttons with variable text ranges of 500-504 & 510-515.
123
Programming
Syntax:
"'^IRM-<port>,<channel>,<onTime>,<offTime>'"
Variable: port = User-defined port on the device (panel). channel = 1 - 255 (channel to pulse). onTime = 1/10th of a second. offTime = 1/10th of a second. Example:
SEND_COMMAND Panel,"'^IRM-10,5, 20, 10'"
Sets the port 10 IR channel 5 on time to 1 second and off time to 2 seconds.
^JSB
The alignment of 0 is followed by ',<left>,<top>'. The left and top coordinates are relative to the upper left corner of the button. Set bitmap/ picture alignment Syntax: using a numeric "'^JSB-<vt addr range>,<button states range>,<new text alignment>'" keypad layout for Variable: those buttons with variable text address range = 1 - 4000. a defined address button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons range. 1 = Off state and 2 = On state). new text alignment = Value of 1- 9 corresponds to the following locations:
0 1 4 7 2 5 8 3 6 9 Zero can be used for an absolute position
Example:
SEND_COMMAND Panel,"'^JSB-500.504&510.515,1&2,1'"
Sets the off/on state picture alignment to upper left corner for those buttons with variable text ranges of 500-504 & 510-515.
^JSI
Set icon alignment using a numeric keypad layout for those buttons with a defined address range.
The alignment of 0 is followed by ',<left>,<top>'. The left and top coordinates are relative to the upper left corner of the button. Syntax:
"'^JSI-<vt addr range>,<button states range>,<new icon alignment>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). new icon alignment = Value of 1 - 9 corresponds to the following locations:
0 1 4 7 2 5 8 3 6 9 Zero can be used for an absolute position
Example:
SEND_COMMAND Panel,"'^JSI-500.504&510.515,1&2,1'"
Sets the Off/On state icon alignment to upper left corner for those buttons with variable text range of 500-504 & 510-515.
124
Programming
The alignment of 0 is followed by ',<left>,<top>'. The left and top coordinates are relative to the upper left corner of the button.
Example:
SEND_COMMAND Panel,"'^JST-500.504&510.515,1&2,1'"
Sets the text alignment to the upper left corner for those buttons with variable text ranges of 500-504 & 510-515.
^MBT
Set the Mouse Button mode On for the virtual PC.
Syntax:
"'^MBT-<pass data>'"
Variable:
pass data:
0 = None 1 = Left 2 = Right 3 = Middle
Example:
SEND COMMAND Panel,"'^MBT-1'"
^MDC
Turn On the Mouse double-click feature for the virtual PC.
Syntax:
"'^MDC'"
Example:
SEND COMMAND Panel,"'^MDC'"
Sets the mouse double-click for use with the virtual PC. Syntax:
"'^SHO-<vt addr range>,<command value>'"
^SHO
Show or hide a button with a set variable text range.
Variable: variable text address range = 1 - 4000. command value = (0= hide, 1= show). Example:
SEND_COMMAND Panel,"'^SHO-500.504&510.515,0'"
Hides buttons with variable text address range 500-504 & 510-515.
^TEC
Set the text effect color for the specified addresses/states to the specified color.
The Text Effect is specified by name and can be found in TPD4. You can also assign the color by name or RGB value (RRGGBB or RRGGBBAA). Syntax:
"'^TEC-<vt addr range>,<button states range>,<color value>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). color value = Refer to the RGB Values for all 88 Basic Colors table on page 105. Example:
SEND_COMMAND Panel,"'^TEC-500.504&510.515,1&2,12'"
Sets the text effect color to Very Light Yellow on buttons with variable text 500-504 and 510-515.
125
Programming
Set the text effect. Syntax: Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). text effect name = Refer to the Text Effects table on page 128 for a listing of text effect names. Example:
SEND_COMMAND Panel,"'^TEF-500.504&510.515,1&2,Soft Drop Shadow 3'"
Sets the text effect to Soft Drop Shadow 3 for the button with variable text range 500-504 and 510-515.
^TOP
Send events to the Master as string events.
If enabled, Press/Move/Release events are sent to the Master as string events. Syntax:
"'^TOP-<state>'"
Example command: "'^TOP-1'" Example Response: "String Event: Text: Press,320,480" Example Response: "String Event: Text: Release,320,480"
^TXT
Assign a text string to those buttons with a defined address range.
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). new text = 1 - 50 ASCII characters. Example:
SEND_COMMAND Panel,"'^TXT-500.504&510.515,1&2,Test Only'"
Sets the On and Off state text for buttons with the variable text ranges of 500-504 & 510-515.
^UNI
Set Unicode text.
For the ^UNI command (%UN and ^BMF command), the Unicode text is sent as ASCII-HEX nibbles. Syntax:
"'^UNI-<vt addr range>,<button states range>,<unicode text>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). unicode text = Unicode HEX value. Example:
SEND_COMMAND Panel,"'^UNI-500,1,0041'"
Note: Unicode is always represented in a HEX value. TPD4 generates (through the Text Enter Box dialog) unicode HEX values. Refer to the TPDesign4 Instruction Manual for more information.
126
Programming
dock
This is sent to the target Master when the MVP is docked. This string can be disabled from within the firmware setup pages.
Example:
SEND_COMMAND Panel,"'^LPC'"
Clear all users from the User Access Password list on the Password Setup page. Refer to the Other Settings section on page 78 for more information. Syntax:
"'^LPR-<user>'"
^LPR
Remove a given user from the User Access Passwords list on the Password Setup page.
Remove user named Robert from the User Access Password list on the Password Setup page. Refer to the Other Settings section on page 78 for more information.
^LPS
Set the user name and password.
This command allows you to: 1. Add a new user name and password OR 2. Set the password for a given user. The user name and password combo is added to the User Access and/or Password list in the Password Setup page. The user name must be alphanumeric. Syntax:
"'^LPS-<user>,<passcode>'"
Sets a new user name as "Manager" and the password to "undock". Example 2:
SEND_COMMAND Panel,"'^LPS-Manager,test'"
Changes the given user name password to "test". Refer to the Other Settings section on page 78 for more information.
127
Programming
Medium Drop Shadow 1 with outline Hard Drop Shadow 1 with outline Medium Drop Shadow 2 with outline Hard Drop Shadow 2 with outline Medium Drop Shadow 3 with outline Hard Drop Shadow 3 with outline Medium Drop Shadow 4 with outline Hard Drop Shadow 4 with outline Medium Drop Shadow 5 with outline Hard Drop Shadow 5 with outline Medium Drop Shadow 6 with outline Hard Drop Shadow 6 with outline Medium Drop Shadow 7 with outline Hard Drop Shadow 7 with outline Medium Drop Shadow 8 with outline Hard Drop Shadow 8 with outline
128
Programming
{ Send_String Send_String Send_String Send_String Send_String Send_String Send_String } 0,"'ButtonGet Id=',ITOA(CUSTOM.ID),' Type=',ITOA(CUSTOM.TYPE)" 0,"'Flag =',ITOA(CUSTOM.FLAG)" 0,"'VALUE1 =',ITOA(CUSTOM.VALUE1)" 0,"'VALUE2 =',ITOA(CUSTOM.VALUE2)" 0,"'VALUE3 =',ITOA(CUSTOM.VALUE3)" 0,"'TEXT =',CUSTOM.TEXT" 0,"'TEXT LENGTH =',ITOA(LENGTH_STRING(CUSTOM.TEXT))"
All custom events have the following 7 fields: Custom Event Fields
Field Description
Uint Flag slong value1 slong value2 slong value3 string text text length (string encode)
0 means text is a standard string, 1 means Unicode encoded string button state number actual length of string (this is not encoded size) index of first character (usually 1 or same as optional index the text from the button button text length
These fields are populated differently for each query command. The text length (String Encode) field is not used in any command. Button Query Commands
?BCB
Get the current border color. Syntax:
"'?BCB-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1011:
Flag - zero Value1 - Button state number Value2 - Actual length of string (should be 9) Value3 - Zero Text - Hex encoded color value (ex: #000000FF) Text length - Color name length (should be 9)
Example:
SEND COMMAND Panel,"'?BCB-529,1'"
Gets the button 'OFF state' border color. information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1011 Flag = 0 VALUE1 = 1 VALUE2 = 9 VALUE3 = 0 TEXT = #222222FF TEXT LENGTH = 9
129
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1012:
Flag - Zero Value1 - Button state number Value2 - Actual length of string (should be 9) Value3 - Zero Text - Hex encoded color value (ex: #000000FF) Text length - Color name length (should be 9)
Example:
SEND COMMAND Panel,"'?BCF-529,1'"
Gets the button 'OFF state' fill color information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1012 Flag = 0 VALUE1 = 1 VALUE2 = 9 VALUE3 = 0 TEXT = #FF8000FF TEXT LENGTH = 9
?BCT
Get the current text color.
Syntax:
"'?BCT-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1013:
Flag - Zero Value1 - Button state number Value2 - Actual length of string (should be 9) Value3 - Zero Text - Hex encoded color value (ex: #000000FF) Text length - Color name length (should be 9)
Example:
SEND COMMAND Panel,"'?BCT-529,1'"
Gets the button 'OFF state' text color information. The result sent to Master would be:
ButtonGet Id = 529 Type = 1013 Flag = 0 VALUE1 = 1 VALUE2 = 9 VALUE3 = 0 TEXT = #FFFFFEFF TEXT LENGTH = 9
130
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1002:
Flag - Zero Value1 - Button state number Value2 - Actual length of string Value3 - Zero Text - String that represents the bitmap name Text length - Bitmap name text length (should be 9)
Example:
SEND COMMAND Panel,"'?BMP-529,1'"
Gets the button 'OFF state' bitmap information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1002 Flag = 0 VALUE1 = 1 VALUE2 = 9 VALUE3 = 0 TEXT = Buggs.png TEXT LENGTH = 9
?BOP
Get the overall button opacity.
Syntax:
"'?BOP-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1015:
Flag - Zero Value1 - Button state number Value2 - Opacity Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?BOP-529,1'"
Gets the button 'OFF state' opacity information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1015 Flag = 0 VALUE1 = 1 VALUE2 = 200 VALUE3 = 0 TEXT = TEXT LENGTH = 0
131
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1014:
Flag - Zero Value1 - Button state number Value2 - Actual length of string Value3 - Zero Text - String that represents border name Text length - Border name length
Example:
SEND COMMAND Panel,"'?BRD-529,1'"
Gets the button 'OFF state' border information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1014 Flag = 0 VALUE1 = 1 VALUE2 = 22 VALUE3 = 0 TEXT = Double Bevel Raised -L TEXT LENGTH = 22
?BWW
Get the current word wrap flag status.
Syntax:
"'?BWW-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1010:
Flag - Zero Value1 - Button state number Value2 - 0 = no word wrap, 1 = word wrap Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?BWW-529,1'"
Gets the button 'OFF state' word wrap flag status information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1010 Flag = 0 VALUE1 = 1 VALUE2 = 1 VALUE3 = 0 TEXT = TEXT LENGTH = 0
132
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1007:
Flag - Zero Value1 - Button state number Value2 - Font index Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?FON-529,1'"
Gets the button 'OFF state' font type index information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1007 Flag = 0 VALUE1 = 1 VALUE2 = 72 VALUE3 = 0 TEXT = TEXT LENGTH = 0
?ICO
Get the current icon index.
Syntax:
"'?ICO-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1003:
Flag - Zero Value1 - Button state number Value2 - Icon Index Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?ICO-529,1&2'"
Gets the button 'OFF state' icon index information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1003 Flag = 0 VALUE1 = 2 VALUE2 = 12 VALUE3 = 0 TEXT = TEXT LENGTH = 0
133
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1005:
Flag - Zero Value1 - Button state number Value2 - 1 - 9 justify Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?JSB-529,1'"
Gets the button 'OFF state' bitmap justification information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1005 Flag = 0 VALUE1 = 1 VALUE2 = 5 VALUE3 = 0 TEXT = TEXT LENGTH = 0
?JSI
Get the current icon justification.
Syntax:
"'?JSI-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1006:
Flag - Zero Value1 - Button state number Value2 - 1 - 9 justify Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?JSI-529,1'"
Gets the button 'OFF state' icon justification information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1006 Flag = 0 VALUE1 = 1 VALUE2 = 6 VALUE3 = 0 TEXT = TEXT LENGTH = 0
134
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1004:
Flag - Zero Value1 - Button state number Value2 - 1 - 9 justify Value3 - Zero Text - Blank Text length - Zero
Example:
SEND COMMAND Panel,"'?JST-529,1'"
Gets the button 'OFF state' text justification information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1004 Flag = 0 VALUE1 = 1 VALUE2 = 1 VALUE3 = 0 TEXT = TEXT LENGTH = 0
?TEC
Get the current text effect color.
Syntax:
"'?TEC-<vt addr range>,<button states range>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1009:
Flag - Zero Value1 - Button state number Value2 - Actual length of string (should be 9) Value3 - Zero Text - Hex encoded color value (ex: #000000FF) Text length - Color name length (should be 9)
Example:
SEND COMMAND Panel,"'?TEC-529,1'"
Gets the button 'OFF state' text effect color information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1009 Flag = 0 VALUE1 = 1 VALUE2 = 9 VALUE3 = 0 TEXT = #5088F2AE TEXT LENGTH = 9
135
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). custom event type 1008:
Flag - Zero Value1 - Button state number Value2 - Actual length of string Value3 - Zero Text - String that represents the text effect name Text length - Text effect name length
Example:
SEND COMMAND Panel,"'?TEF-529,1'"
Gets the button 'OFF state' text effect name information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1008 Flag = 0 VALUE1 = 1 VALUE2 = 18 VALUE3 = 0 TEXT = Hard Drop Shadow 3 TEXT LENGTH = 18
?TXT
Get the current text information.
Syntax:
"'?TXT-<vt addr range>,<button states range>,<optional index>'"
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). optional index = This is used if a string was too long to get back in one command. The reply will start at this index. custom event type 1001:
Flag - Zero Value1 - Button state number Value2 - Actual length of string Value3 - Index Text - Text from the button Text length - Button text length
Example:
SEND COMMAND Panel,"'?TXT-529,1'"
Gets the button 'OFF state' text information. The result sent to the Master would be:
ButtonGet Id = 529 Type = 1001 Flag = 0 VALUE1 = 1 VALUE2 = 14 VALUE3 = 1 TEXT = This is a test TEXT LENGTH = 14
136
Programming
Example:
SEND COMMAND Panel,"'ABEEP'"
ADBEEP
Output a double beep even if beep is Off.
Syntax:
"'ADBEEP'"
Example:
SEND COMMAND Panel,"'ADBEEP'"
@AKB
Pop up the keyboard icon and Syntax: initialize the text "'@AKB-<initial text>;<prompt text>'" string to that Variables: specified. Example:
Keyboard string is set to null on power up and is stored until power is lost. The Prompt Text is optional.
initial text = 1 - 50 ASCII characters. prompt text = 1 - 50 ASCII characters. SEND COMMAND Panel,"'@AKB-Texas;Enter State'"
Pops up the Keyboard and initializes the text string 'Texas' with prompt text 'Enter State'.
AKEYB
Keyboard string is set to null on power up and is stored until power is lost.
Syntax: Pop up the keyboard icon and "'AKEYB-<initial text>'" initialize the text Variables: string to that initial text = 1 - 50 ASCII characters. specified. Example:
SEND COMMAND Panel,"'AKEYB-This is a Test'"
Pops up the Keyboard and initializes the text string 'This is a Test'.
AKEYP
Pop up the keypad icon and initialize the text string to that specified.
The keypad string is set to null on power up and is stored until power is lost. Syntax:
"'AKEYP-<number string>'"
Variables:
number string = 0 - 9999.
Example:
SEND COMMAND Panel,"'AKEP-12345'"
AKEYR
Remove the Keyboard/ Keypad.
Remove keyboard or keypad that was displayed using 'AKEYB', 'AKEYP', 'PKEYP', @AKB, @AKP, @PKP, @EKP, or @TKP commands. Syntax:
"'AKEYR'"
Example:
SEND COMMAND Panel,"'AKEYR'"
137
Programming
Variables:
initial text = 1 - 50 ASCII characters. prompt text = 1 - 50 ASCII characters.
Example:
SEND COMMAND Panel,"'@AKP-12345678;ENTER PASSWORD'"
Pops up the Keypad and initializes the text string '12345678' with prompt text ENTER PASSWORD.
@AKR
Remove the Keyboard/ Keypad.
Remove keyboard or keypad that was displayed using 'AKEYB', 'AKEYP', 'PKEYP', @AKB, @AKP, @PKP, @EKP, or @TKP commands. Syntax:
"'@AKR'"
Example:
SEND COMMAND Panel,"'@AKR'"
BEEP
Output a beep.
Syntax:
"'BEEP'"
Example:
SEND COMMAND Panel,"'BEEP'"
Outputs a beep.
BRIT
Set the panel brightness.
Syntax:
"'BRIT-<brightness level>'"
@BRT
Set the panel brightness.
Syntax:
"'@BRT-<brightness level>'"
DBEEP
Output a double beep.
Syntax:
"'DBEEP'"
Example:
SEND COMMAND Panel,"'DBEEP'"
@EKP
Extend the Keypad.
Pops up the keypad icon and initializes the text string to that specified. The Prompt Text is optional. Syntax:
"'@EKP-<initial text>;<prompt text>'"
Variables:
initial text = 1 - 50 ASCII characters. prompt text = 1 - 50 ASCII characters.
Example:
SEND COMMAND Panel,"'@EKP-33333333;Enter Password'"
Pops up the Keypad and initializes the text string '33333333' with prompt text 'Enter Password'.
138
Programming
Variables:
initial text = 1 - 50 ASCII characters.
Example:
SEND COMMAND Panel,"'PKEYP-123456789'"
Pops up the Keypad and initializes the text string '123456789' in '*'.
@PKP
Present a private keypad.
Pops up the keypad icon and initializes the text string to that specified. Keypad displays a '*' instead of the numbers typed. The Prompt Text is optional. Syntax:
"'@PKP-<initial text>;<prompt text>'"
Variables:
initial text = 1 - 50 ASCII characters. prompt text = 1 - 50 ASCII characters.
Example:
SEND COMMAND Panel,"'@PKP-1234567;ENTER PASSWORD'"
Pops up the Keypad and initializes the text string 'ENTER PASSWORD' in '*'.
SETUP
Send panel to SETUP page.
Syntax:
"'SETUP'"
Example:
SEND COMMAND Panel,"'SETUP'"
SHUTDOWN
Syntax:
"'SHUTDOWN'" Shut down the batteries providing Example: power to the SEND COMMAND Panel,"'SHUTDOWN'" panel. Shuts-down the batteries feeding power to the panel. This function saves the battery from discharging.
SLEEP
Force the panel into screen saver mode.
Syntax:
"'SLEEP'"
Example:
SEND COMMAND Panel,"'SLEEP'"
@SOU
Play a sound file.
Syntax:
"'@SOU-<sound name>'"
Variables:
sound name = Name of the sound file. Supported sound file formats are: WAV & MP3.
Example:
SEND COMMAND Panel,"'@SOU-Music.wav'"
139
Programming
Variables:
initial text = 1 - 50 ASCII characters. prompt text = 1 - 50 ASCII characters.
Example:
SEND COMMAND Panel,"'@TKP-999.222.1211;Enter Phone Number'"
Pops-up the Keypad and initializes the text string '999.222.1211' with prompt text 'Enter Phone Number'.
TPAGEON
Turn On page tracking.
This command turns On page tracking, whereby when the page or popups change, a string is sent to the Master. This string may be captured with a CREATE_BUFFER command for one panel and sent directly to another panel. Syntax:
"'TPAGEON'"
Example:
SEND COMMAND Panel,"'TPAGEON'"
TPAGEOFF
Turn Off page tracking.
Syntax:
"'TPAGEOFF'"
Example:
SEND COMMAND Panel,"'TPAGEOFF'"
@VKB
Popup the virtual keyboard.
Syntax:
"'@VKB'"
Example:
SEND COMMAND Panel,"'@VKB'"
WAKE
Force the panel out of screen saver mode.
Syntax:
"'WAKE'"
Example:
SEND COMMAND Panel,"'WAKE'"
140
Programming
Input Commands
These Send Commands are case insensitive. Input Commands
^CAL
Put panel in calibration mode. Syntax:
"'^CAL'"
Example:
SEND COMMAND Panel,"'^CAL'"
^KPS
Set the keyboard passthru.
Syntax:
"'^KPS-<pass data>'"
Variable:
pass data:
<blank/empty> = Disables the keyboard. 0 = Pass data to G4 application (default). This can be used with VPC or text areas. 1 - 4 = Not used. 5 = Sends out data to the Master. Example:
SEND COMMAND Panel,"'^KPS-5'"
Sets the keyboard passthru to the Master. Option 5 sends keystrokes directly to the Master via the Send Output String mechanism. This process sends a virtual keystroke command (^VKS) to the Master. Example 2:
SEND COMMAND Panel,"'^KPS-0'"
Disables the keyboard passthru to the Master. The following point defines how the parameters within this command work: Accepts keystrokes from any of these sources: attached USB keyboard or Virtual keyboard.
^VKS
Send one or more virtual key strokes to the G4 application.
Key presses and key releases are not distinguished except in the case of CTRL, ALT, and SHIFT.
Refer to theEmbedded Codes table on page 142 that define special characters which can be included with the string but may not be represented by the ASCII character set.
Syntax:
"'^VKS-<string>'"
Variable: string = Only 1 string per command/only one stroke per command. Example:
SEND COMMAND Panel,"'^VKS-'8"
141
Programming
Embedded codes
The following is a list of G4 compatible embedded codes: Embedded Codes
Decimal numbers Hexidecimal values
8 13 27 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 192 193 194 ($08) ($0D) ($1B) ($80) ($81) ($82) ($83) ($84) ($85) ($86) ($87) ($88) ($89) ($8A) ($8B) ($8C) ($8D) ($8E) ($8F) ($90) ($91) ($92) ($93) ($94) ($95) ($96) ($97) ($98) ($99) ($9A) ($9B) ($9C) ($9D) ($9E) ($9F) ($A0) ($A1) ($A2) ($C0) ($C1) ($C2)
Virtual keystroke
Backspace Enter ESC CTRL key down ALT key down Shift key down F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 Num Lock Caps Lock Insert Delete Home End Page Up Page Down Scroll Lock Pause Break Print Screen SYSRQ Tab Windows Menu Up Arrow Down Arrow Left Arrow Right Arrow CTRL key up ALT key up Shift key up
142
Programming
Variables:
page flip password = 1 - 50 ASCII characters.
Example:
SEND COMMAND Panel,"'@PWD-Main'"
^PWD
Set the page flip password.
Variables:
password level = 1 - 4.
143
Programming
Variable: variable text address range = 1 - 4000. button states range = 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). resource name = 1 - 50 ASCII characters. Example:
SEND_COMMAND Panel,"'^BBR-700,1,Sports_Image'"
^RAF
Add new resources.
Adds any and all resource parameters by sending embedded codes and data. Since the embedded codes are preceded by a '%' character, any '%' character contained in the URL must be escaped with a second '%' character (see example). The file name field (indicated by a %F embedded code) may contain special escape sequences as shown in the ^RAF, ^RMF - Embedded Codes table below. Syntax:
"'^RAF-<resource name>,<data>'"
Variables: resource name = 1 - 50 ASCII characters. data = Refers to the embedded codes, see the ^RAF, ^RMF - Embedded Codes section on page 145. Example:
SEND_COMMAND Panel,"'^RAF-New Image,%P0%HAMX.COM%ALab/ Test%%5Ffile%Ftest.jpg'"
Adds a new resource. The resource name is New Image %P (protocol) is an HTTP %H (host name) is AMX.COM %A (file path) is Lab/Test_file %F (file name) is test.jpg. Note that the %%5F in the file path is actually encoded as %5F.
^RFR
Syntax: "'^RFR-<resource name>'" Force a refresh for a given resource. Variable: resource name = 1 - 50 ASCII characters. Example:
SEND_COMMAND Panel,"'^RFR-Sports_Image'"
144
Programming
Variables: resource name = 1 - 50 ASCII characters data = Refers to the embedded codes, see the ^RAF, ^RMF - Embedded Codes section on page 145. Example:
SEND_COMMAND Panel,"'^RMF-Sports_Image,%ALab%%5FTest/ Images%Ftest.jpg'"
Changes the resource Sports_Image file name to test.jpg and the path to Lab_Test/ Images. Note that the %%5F in the file path is actually encoded as %5F.
^RSR
Change the refresh rate for a given resource.
Syntax:
"'^RSR-<resource name>,<refresh rate>'"
Variable: resource name = 1 - 50 ASCII characters. refresh rate = Measured in seconds. Example:
SEND_COMMAND Panel,"'^RSR-Sports_Image,5'"
Sets the refresh rate to 5 seconds for the given resource (Sports_Image).
The <data> variable uses the embedded codes described in the following table: ^RAF, ^RMF - Embedded Codes
Parameter Embedded Code Description
Set protocol. HTTP (0) or FTP (1). Set Username for authentication. Set Password for authentication. Set Host Name (fully qualified DNS or IP Address). Full path to the location of the file or program that will return the resource. The path must be a valid HTTP URL minus the protocol and host. The only exception to this is the inclusion of special escape sequences and in the case of FTP protocol, regular expressions.
path
%A <path>
Set Directory path. The path must be a valid HTTP URL minus the protocol, host and filename. The only exception to this is the inclusion of special escape sequences and in the case of FTP protocol, regular expressions.
145
Programming
refresh
%R <refresh 1-65535>
The number of seconds between refreshes in which the resource is downloaded again. Refreshing a resource causes the button displaying that resource to refresh also. The default value is 0 (only download the resource once). Set the newest file. A value of 1 means that only the most recent file matching the pattern is downloaded.
Note: The 'newest file' option only applies to FTP Dynamic Images, and only those that have pattern matching as part of their filename. Neither 'newest file' nor pattern matching apply to HTTP Dynamic Images. When set, the panel will first pull a list of files matching the given pattern from the specified FTP server and path. The timestamps of the items in the list will be compared, with the newest one being displayed on the panel. This is useful for source devices that place a uniquely named still image in a folder at constant intervals, allowing the panel always to display the most recent one.
newest
%N <0-1>
preserve
%V <0-1>
Set the value of the preserve flag. Default is 0. Currently preserve has no function.
Escape Sequences
The ^RAF and ^RMF commands support the replacement of any special escape sequences in the filename (specified by the %F embedded code) with the corresponding data obtained from the system as outlined in the table below: Escape Sequences
Sequence Panel Information
$DV $SY $IP $HN $MC $ID $PX $PY $ST $AC $AP $CC $CP $LC $LP $BX $BY $BN
Device Number System Number IP Address Host Name Mac Address Neuron ID (Only supported on panels that use ICSNet; ignored on all other panels) X resolution of current panel mode/file Y resolution of current panel mode/file Current state Address code Address port Channel code Channel port Level code Level port X Resolution of Current button Y Resolution of Current button Name of Button
146
Programming
Intercom Commands
The following is a list of Intercom Commands: Intercom Commands
^MODEL?
Panel model name. If the panel supports intercom hardware it will respond with its model Sets model name. name as shown in the response below. Older hardware or newer hardware that has intercom support disabled with not respond to this command. Syntax:
SEND_COMMAND <DEV>,"'^MODEL?'"
^ICSIntercom start.
^ICS-<IP>,<TX UDP port>,<RX UDP port>,<initial mode>'" Intercom start. Starts a call to the specified IP address and ports, where initial mode is either 1 (talk) or 0 (listen) or 2 (both). If no mode is specified 0 (listen) is assumed. Please note, however, that no data packets will actually flow until the intercom modify command is sent to the panel. Syntax:
SEND_COMMAND <DEV>,"'^ICS-<IP>,<TX UDP port>,<RX UDP port>,<initial mode>'"
Variables: IP = IP Address of panel to connect with on an Intercom call. TX UDP port = UDP port to transmit to. RX UDP port = UDP port to receive from. initial mode = 0 (listen) or 1 (talk) or 2 (handsfree). 0 is the default. Examples: Example of setting up a handsfree unicast call between two panels:
SEND_COMMAND TP1, "^ICS-192.168.0.3,9000,9002,2" SEND_COMMAND TP2, "^ICS-192.168.0.4,9002,9000,2"
Example of setting up a multicast call where the first panel is paging two other panels:
SEND_COMMAND TP1, "^ICS-239.252.1.1,9002,9000,1" SEND_COMMAND TP2, "^ICS-239.252.1.1,9002,9000,0" SEND_COMMAND TP3, "^ICS-239.252.1.1,9002,9000,0"
Example of setting up a baby monitor call where the first panel is listening to the microphone audio coming from the second panel:
SEND_COMMAND TP1, "^ICS-192.168.0.3,9000,9002,0" SEND_COMMAND TP2, "^ICS-192.168.0.4,9002,9000,1"
^ICE
Intercom end.
147
Programming
^ICM-MICLEVEL
Intercom modify command.
Used to set the microphone level during an intercom call. Syntax: SEND_COMMAND <DEV>, "^ICM-MICLEVEL" Variables: Valid levels are from 0 to 100. Example: SEND_COMMAND TP1, "^ICM-MICLEVEL,40"
^ICM-MUTEMIC
Intercom modify command.
Set the state of the microphone on a panel to muted (1) or unmuted (0). At the start of each call the microphone starts out unmuted. Syntax: SEND_COMMAND <DEV>, "^ICM-MUTEMIC" Variables: None. Example: SEND_COMMAND TP1, "^ICM-MUTEMIC,1"
Used to set the speaker level during an intercom call. ^ICMSPEAKERLEVEL Syntax: Intercom modify SEND_COMMAND <DEV>, "^ICM-SPEAKERLEVEL,55" command. Variables: Valid levels are from 0 to 100. Example: SEND_COMMAND TP1, "^ICM-SPEAKERLEVEL,55"
148
Programming
SIP Commands
The following table lists and describes SIP commands that are generated from the touch panel. SIP Commands
^PHNAUTOANSWER
Syntax:
"'^PHN-AUTOANSWER, <state>'"
Provides the state Variable: of the state = 0 or 1 (off or on) auto-answer Example: feature.
^PHN-CALL
Provides call progress notification for a call.
Syntax:
"'^PHN-CALL, <status>, <connection id>'"
Variable: status = CONNECTED, DISCONNECTED, TRYING, RINGING, or HOLD. connection id = The identifying number of the connection. Example:
SEND_COMMAND Panel"'^PHN-CALL, CONNECTED, 1'"
^PHN-DECLINE
Declines the incoming call.
Decline (send to voice mail if configured) the incoming call on <CallID> as indicated from the previous PHN-INCOMING message. CallID should be 0 or 1. Syntax:
"'^PHN-DECLINE, <CallID>'"
^PHN-INCOMING Provides incoming call notification and the connection id used for all future commands Provides incoming related to this call. The connection id will be 0 or 1.
call notification. Syntax:
"'^PHN-INCOMING, <caller number>, <caller name>, <connection id>, <timestamp>, '"
Variable: caller number = The phone number of the incoming call. caller name = The name associated with the caller number. connection id = The identifying number of the connection. timestamp = The current time in MM/DD/YY HH:MM:SS format. Example:
SEND_COMMAND Panel,"'^PHN-INCOMING, 2125551000, AMX, 07/22/08 12:00:00, 1'"
^PHNLINESTATE
Indicates the current state of each of the available connections used to manage calls.
Syntax:
"'^PHN-LINESTATE, <connection id>, <state>, <connection id>, <state>,...'"
Variable: connection id = The identifying number of the connection. state = IDLE, HOLD, or CONNECTED extn = The local extension of this panel (see Example) Example:
SEND_COMMAND Panel,"'^PHN-LINESTATE, 1, IDLE, 2, CONNECTED, SIP, <extn>'"
149
Programming
Variable: messages = 0 or 1 (1 indicates new messages) new message count = The number of new messages. old message count = The number of old messages. new urgent message count = The number of new messages marked urgent. old urgent message count = The number of old messages marked urgent. Example:
SEND_COMMAND Panel,"'^PHN-MSGWAITING, 1, 1, 2, 1, 0"
^PHN-PRIVACY
Syntax:
"'^PHN-PRIVACY, <state>'" Indicates the state of the privacy Variable: feature. state = 0 (Disable) or 1 (Enable)
new message count = The number of new messages. old message count = The number of old messages. new urgent message count = The number of new messages marked urgent. old urgent message count = The number of old messages marked urgent. Example:
SEND_COMMAND Panel,"'^PHN-PRIVACY, 0"
^PHN-REDIAL
Indicates the panel is redialing the number.
Syntax:
"'^PHN-REDIAL, <number>'"
^PHNTRANSFERRED
Indicates a call has been transferred.
Syntax:
"'^PHN-TRANSFERRED'"
Example:
SEND_COMMAND Panel,"'^PHN-TRANSFERRED"
The following table lists and describes SIP commands that are sent to the touch panel to manage calls. SIP Commands
^PHN-ANSWER
Answers the call. Syntax:
"'^PHN-ANSWER, <connection id>'"
^PHNAUTOANSWER
Enables or disables the autoanswer feature of the phone.
Enables (1) or disables (0) the auto-answer feature on the phone. Syntax:
"^PHN-AUTOANSWER, <state>"
150
Programming
Example:
SEND_COMMAND Panel,"'?PHN-AUTOANSWER'"
^PHN-CALL
Calls the provided number.
Syntax:
"^PHN-CALL, <number>"
^PHN-DTMF
Sends DTMF codes.
Syntax:
"^PHN-DTMF, <DTMF code>"
^PHN-HANGUP
Hangs up the call.
Syntax:
"^PHN-HANGUP, <connection id>"
^PHN-HOLD
Places the call on hold.
Syntax:
"^PHN-HOLD, <connection id>"
?PHNLINESTATE
Syntax: Queries the state "?PHN-LINESTATE" of each of the Example: connections used SEND_COMMAND Panel,"'?PHN-LINESTATE'" by the SIP device.
^PHN-PRIVACY
Enables or disables the privacy feature of the phone.
Enables or disables the privacy feature on the phone (do not disturb). Syntax:
"^PHN-PRIVACY, <state>"
?PHN-PRIVACY
Queries the state of the privacy feature.
Example:
SEND_COMMAND Panel,"'?PHN-PRIVACY'"
^PHN-REDIAL
Redials the last number.
Syntax:
"^PHN-REDIAL"
Example:
SEND_COMMAND Panel,"'^PHN-REDIAL'"
151
Programming
Variable: connection id = The identifying number of the connection number = The number to which you want to transfer the call. Example:
SEND_COMMAND Panel,"'^PHN-TRANSFER, 1, 2125551000'"
The following table lists and describes SIP setup commands. Using any of these commands causes the current user to go offline. SIP Setup Commands
Syntax: ^PHN-SETUPDTMFDURATION '^PHN-SETUP-DTMFDURATION, <duration in ms>'" Changes the Variable: DTMF duration in duration = range from 100ms to 3000ms milliseconds Example:
'^PHN-SETUP-DTMFDURATION, 250'"
^PHN-SETUPDOMAIN
Sets the realm for authentication.
Syntax:
"^PHN-SETUP-DOMAIN,<domain>"
^PHN-SETUPENABLE
Registers a new user
Once the configuration has been updated, the ENABLE command should be run to reregister the new user. Syntax:
"^PHN-SETUP-ENABLE"
^PHN-SETUPPASSWORD
Sets the user password for the proxy server.
Syntax:
"^PHN-SETUP-PASSWORD,<password>"
^PHN-SETUPPORT
Sets the port number for the proxy server.
Syntax:
"^PHN-SETUP-PORT,<port>"
^PHN-SETUPPROXYADDR
Sets the IP address for the proxy server.
Syntax:
"^PHN-SETUP-PROXYADDR,<IP>"
^PHN-SETUPSTUNADDR
Sets the IP address for the STUN server.
Syntax:
"^PHN-SETUP-STUNADDR,<IP>"
152
Programming
Variable: username = The user name (usually the phone extension) Example:
SEND_COMMAND Panel,"^PHN-SETUP-USERNAME,6003"
153
Programming
154
Always:
Use only with AMX approved battery charger Store in dry place with temperature between 0 C (32 F) and 40 C (104 F)
Care must be taken to install the battery without damaging the battery.
IMPORTANT NOTES!
Lithium-Polymer battery technology degrades in capacity over time, unless the battery is periodically charged and discharged. AMX recommends installing all Lithium-Polymer batteries in functional AMX products within 6 months of receipt.
Please dispose of all used batteries in a proper fashion as required by municipal or federal regulations.
Prior to battery removal, run the device until the battery is completely discharged.
155
Operating/Storage Environment
Operating Temperature: 0 C (32 F) to 45 C (113 F) Operating Humidity: 20% - 85% RH Storage Temperature: -20 C (-4 F) to 60 C (140 F) for periods of less than one month, -20 C (-4 F) to 45 C (113 F) for less than three months but greater than one month, and -20 C (-4 F) to 20 C (68 F) for less than one year but greater than three months Storage Humidity: 5% - 85% RH
Included Parts
Replacement MVP-5200i battery (57-0016-SA) Upper rubber feet (screw covers, black, 60-5966-13BL; and white, 605966-13GR) Replacement label to cover lower screws: black (91-5966-01BL) and white (91-5966-01WH) Upper screws (5), (80-0125-01) Lower screws (3), (80-0125-02) Replacement hinge cover (2), (66-5966-14) Replacement battery cover screws (2), (60-5966-44)
Power Management
Since the MVP-5200i is a battery-powered handheld device, power management is a necessary concern. Under active use, the charge on the integral Lithium-Polymer battery can last for as long as five days. However, to maximize usability and minimize the chances of the device becoming completely discharged at a critical moment, the MVP-5200i should be kept in its charging cradle or wall station when not in use. The MVP-5200i operates on three distinct power modes: Awake - This is the normal power mode of the panel during operation. In this mode, all necessary modules are powered up and their respective clocks are being driven appropriately. The device remains online with the Netlinx Master and continues to appear in the online tree of Netlinx Studio. Sleep - This mode of operation can be selected through the Setup Pages and only controls the backlight. In this case, the unit remains on all the time, and only the backlight will be turned off after the user-selectable time of inactivity has elapsed. The device remains online with the Netlinx Master and continues to be shown in the online tree of Netlinx Studio. The unit shall transfer to the Awake mode after it detects a touch on the touchscreen or navigation wheel. This mode uses 80 percent of the power required for the Awake mode. Stand By - In this mode, the device is completely shut down, with only wakeup systems powered to detect incoming commands or touch panel contact. Shutdown - The system enters this mode after a user selectable amount of inactivity time has elapsed or if the battery level falls below10 percent of its full charge. This is the absolute lowest mode of operation, during which power to all peripherals and components is turned off. It is not online with the NetLinx Master and will not appear in NetLinx Studio. The system remains in this mode until it is rebooted. In the latter case, the panel has to be placed in a Table Charging Station in order for it to be operational.
156
Battery Replacement
The touch panel's battery is intended to last the life of the device, but in cases where the battery has reached its effective end of life, it may be replaced with the MVP-BP-5X Battery Pack Kit (FG5966-27).
1. Remove the battery from its packaging, remove the protective film from the battery, and inspect it for any
damage or distortion. If the battery shows evidence of damage, contact AMX for replacement and proper disposal information.
2. Place the device face-down on a surface that will not scratch the unit and remove the five screws from the
back of the device (FIG. 81). Two of the screws are at the upper corners of the device, underneath rubber feet that also act as screw covers. Remove the rubber feet to access the screws. Lift up the kickstand and remove the label to reach the remaining three screws.
IR emitter panel
Lower screws
Kickstand
The three bottom screws are shorter than the top two screws. The screws must be re-assembled in their original location or the device can be damaged during reassembly.
3. Discharge all static electricity that may have built up on your body, either by using a static discharge strap
or by touching a nearby piece of metal.
4. Carefully remove the back of the device and detach the battery lead at the battery connector (FIG. 82).
This will allow the back cover to be detached from the device.
157
Battery Connector
If the battery is attached to the interior of the device with adhesive tape, carefully pry the battery free. DO NOT use sharp or edged objects to pry the battery free, as these may damage the battery or the device. Please dispose of the battery in a proper fashion as required by municipal or federal regulations. If the battery comes in a protective metal case, remove the two screws holding the battery case to the back cover. Carefully remove the battery from the back cover. Please dispose of the battery in a proper fashion as required by municipal or federal regulations.
the battery itself. Attach the new battery to the back cover, either using the two screws used to hold the previous battery to the cover or with the two replacement screws included with the MVP-BP-5X kit.
Reconnecting the Battery To The Device 1. On the back cover, make sure that the battery connector wiring runs to the right and that the protective
film on the battery case has been removed. Make sure that the excess battery wiring fits in the space to the bottom left of the battery placement (FIG. 83). The battery wiring may be looped around the support if necessary; make sure that the battery is not crimped or damaged upon closure of the case.
Excess battery wiring path
2. Make sure to seat fully the battery plug to the connector in the device (FIG. 82). If fingers cannot be used,
use a clean, nonconductive stick or probe to seat the connectors.
3. Reattach the back of the device, engaging the hook on the lower left of the case (near the speaker) and
using it to swing the back down into place.
158
When reassembling the device, take especial care not to pinch, puncture, or damage the battery. Do not force the rear plate onto the device, as this can damage the device.
4. Insert the five screws and replace the rubber feet atop the two upper screws, using the replacement rubber
feet and bottom label included in the Battery Pack Kit (FIG. 5).
Rubber feet
Upper screws
Back plate
Speaker
Front of MVP-5200i
The three bottom screws are shorter than the top two screws. The screws must be re-assembled in their original location or the device can be damaged during reassembly.
5. Restart the device to confirm that the new battery is functioning correctly.
159
160
$P
Display the current percentage of the bargraph (derived from the Adjusted Level Value as it falls between the Range Values) Raw Level Value Range Low Value Range High Value N/A
Display the current percentage of the bargraph (derived from the Adjusted Level Value as it falls between the Range Values) Raw Level Value Range Low Value Range High Value Current State
$V $L $H $S $A $R $$
Adjusted Level Value (Range Low Value Adjusted Level Value (Range Low Value subtracted from the Raw Level Value) subtracted from the Raw Level Value) Low Range subtracted from the High Range Dollar sign Low Range subtracted from the High Range Dollar sign
By changing the text on a button (via a VT command), you can modify the codes on a button. When one of the Text Formatting Codes is encountered by the firmware, it is replaced with the correct value. These values are derived from the following operations: Formatting Code Operations
Code Operation
$P $V $L $H $S $A $R
(Current Value - Range Low Value / Range High Value - Range Low Value) x 100 Current Level Value Range Low Value Range High Value Current State (if regular bargraph then resolves to nothing) Current Value - Range Low Value Range High Value - Range Low Value
Given a current raw level value of 532, a range low value of 500, and a high range value of 600, the following text formatting codes would yield the following strings as shown in the table below: Example
Format Display
$P% $A out of $R $A of 0 - $R $V of $L - $H
161
0 9 # L ? A a & C
Digit (0 to 9, entry required, plus [+] and minus [-] signs not allowed) Digit or space (entry not required, plus and minus signs not allowed) Digit or space (entry not required; plus and minus signs allowed) Letter (A to Z, entry required) Letter (A to Z, entry optional) Letter or digit (entry required) Letter or digit (entry optional) Any character or a space (entry required) Any character or a space (entry optional)
The number of the above characters used determines the length of the input masking box. Example: 0000 requires an entry, requires digits to be used, and allows only 4 characters to be entered/used. Refer to the following SEND_COMMANDs for more detailed information:
^BIM - Sets the input mask for the specified addresses. (see the ^BIM section on page 112). ^BMF subcommand %MK - sets the input mask of a text area (see the ^BMF section on page 114).
162
[ ] |
[0|255] This allows a user to enter a value from 0 to 255. Input mask next field characters
These characters allow you to specify a list of characters that cause the keyboard to move the focus to the next field when pressed, instead of inserting the text into the text area. Input Mask Next Field Char
Character Meaning
{ }
{.} or {:} or {.:} Proceed to the next text area input box after a user hits any of these keys. Input mask operations
Input Mask Operators change the behavior of the field in the following way: Input Mask Operators
Character Meaning
< > ^
Forces all characters to be converted to lowercase Forces all characters to be converted to uppercase Sets the overflow flag for this field
163
When data overflows from a numerical field, the overflow value is added to the previous field on the chain if the overflow character was specified. In the above example, if the overflow flag was set, the first example will place the "1" into the previous logical field and the second example will place "12" in the previous logical field. If the overflow field already contains a value, the new value will be inserted to the right of the current characters and the overflow field will be evaluated. Overflow continues to work until a field with no overflow value is set or no more fields remain (i.e. reached first field). If a character is typed and that character appears in the Next Field list, the keyboard should move the focus to the next field. For example, when entering time, a ":" is used as a next field character. If you enter "1:2", the 1 is entered in the current field (hours) and then the focus is moved to the next field and 2 is entered in that field. When entering time in a 12-hour format, entry of AM and PM is required. Instead of adding AM/PM to the input mask specification, the AM/PM should be handled within the NetLinx code. This allows a programmer to show/hide and provide discrete feedback for AM and PM.
Any value from 0 to 255 Any value from 1 to 12 Any value from 0 to 59 Any value from 0 to 29 (555) 555-5555 75082-4567
URL Resources
A URL can be broken into several parts. For example, with the URL http://www.amx.com/company-infohome.asp, this URL indicates that the protocol in use is http (HyperText Transport Protocol) and that the information resides on a host machine named www.amx.com. The image on that host machine is given an assignment (by the program) name of company-info-home.asp (Active Server Page). The exact meaning of this name on the host machine is both protocol dependent and host dependent. The information normally resides in a file, but it could be generated dynamically. This component of the URL is called the file component, even though the information is not necessarily in a file. A URL can optionally specify a port, which is the port number to which the TCP/IP connection is made on the remote host machine. If the port is not specified, the default port for the protocol is used instead. For example, the default port for http is 80. An alternative port could be specified as: http://www.amx.com:8080/companyinfo-home.asp.
164
$DV $SY $IP $HN $MC $ID $PX $PY $BX $BY $BN $ST $AC $AP $CC $CP $LC $LP
Device Number System Number IP Address Host Name Mac Address Neuron ID X Resolution of current panel mode/file Y Resolution of current panel mode/file X Resolution of current button Y Resolution of current button Name of button Current state Address Code Address Port Channel Code Channel Port Level Code Level Port
165
Most languages can be entered into the state property field in TPDesign4 via the Windows language bar. In some cases, the user may need correct rendering of mixed left-to-right and right-to-left text, and may display both of these together in the same page (FIG. 86). Text edit boxes only operate left-to-right.
Some languages, notably Hindi and Tamil, are not supported by coded pages. These languages will display ??? for characters entered via the language bar, even if the selected font supports the language. Text in these languages can still be pasted via the clipboard or via the Alt-<Scan Code> method.
166
For more information on TPDesign4 and its complex script support, please refer to the TPDesign4 (v3.0 or higher) Operation Reference Guide, available at www.amx.com.
167
168
radio frequency (RF) technology. Together the two standards are together called Wi-Fi and operate in frequency bands of 2.4 GHz and 5 GHz respectively. The 802.11b specification was the first to be finalized and reach the marketplace. The actual throughput obtained from an 802.11b network will typically be between 4 and 5 Mbps. Because of the higher frequency (and thus shorter wavelength) that they use, 802.11a signals have a much tougher time penetrating solid objects like walls, floors, and ceilings. As a result, the price for 802.11a's higher speed is not only a shorter range but also a weaker and less consistent signal. 802.11g provides increased bandwidth at 54 Mbps. As part of the IEEE 802.11g specification, when throughput cannot be maintained, this card will automatically switch algorithms in order to maintain the highest spread possible at a given distance. In addition, 802.11g can also step down to utilize 802.11b algorithms and also maintain a connection at longer distances. IP Routing is a behavior of the wireless routing is largely dependent on the wired network interface. Although the panel can be connected to two networks simultaneously, it may only have one gateway. If the wired network was successfully set up and a gateway was obtained; then the default route for all network traffic will be via the wired network. In the event that the wired network was not configured, then the default route for all network traffic will be via the wireless network. The wired network connection always takes priority. Example: Imagine a panel connected to the two networks A & B. A is the wired network and B is the wireless network. If the Master controller is on either of these networks, then it will be reached. However if the Master controller is on a different network, C, then the gateway determines which network interface (wired or wireless) will be used. Access Points (APs) are the cornerstone of any wireless network. A AP acts as a bridge between a wired and wireless network. It aggregates the traffic from all wireless clients and forwards it down the network to the switch or router. One AP may be all that is necessary for a standard installation. However, more APs may be needed, depending on the size of the installation, its layout, and its construction. Wireless Equivalent Privacy (WEP) Security is a method by which WLANs protect wireless data streams. A data stream encrypted with WEP can still be intercepted or eavesdropped upon, but the encryption makes the data unintelligible to the interloper. The strength of WEP is measured by the length of the key used to encrypt the data. The longer the key, the harder it is to crack. 802.11b implementations provided 64-bit and 128-bit WEP keys. This is known respectively as 64bit and 128-bit WEP encryption. 64-bit is generally not regarded as adequate security protection. Both key lengths are supported by the Modero product line. Whichever level of WEP used, using identical settings is crucial (CASE SENSITIVE)--the key length, and the key itself-- on all devices. Only devices with common WEP settings will be able to communicate. Similarly, if one device has WEP enabled and another does no, they will not be able to talk to each other. Although the calculations required to encrypt data with WEP can impact the performance of your wireless network, this impact is generally only seen when running benchmarks, and is not large enough to be noticeable in the course of normal network usage.
169
Terminology
802.1x
IEEE 802.1x is an IEEE standard that is built on the Internet standard EAP (Extensible Authentication Protocol). 802.1x is a standard for passing EAP messages over either a wired or wireless LAN. Additionally, 802.1x is also responsible for communicating the method with which APs and wireless users can share and change encryption keys. This continuous key change helps resolve any major security vulnerabilities native to WEP.
AES
Short for Advanced Encryption Standard, is a cipher currently approved by the NSA to protect US Government documents classified as Top Secret. The AES cipher is the first cipher protecting Top Secret information available to the general public.
CERTIFICATES (CA)
A certificate can have many forms, but at the most basic level, a certificate is an identity combined with a public key, and then signed by a certification authority. The certificate authority (CA) is a trusted external third party which "signs" or validates the certificate. When a certificate has been signed, it gains some cryptographic properties. AMX supports the following security certificates within three different formats: PEM (Privacy Enhanced Mail) DER (Distinguished Encoding Rules) PKCS12 (Public Key Cryptography Standard #12) Typical certificate information can include the following items: Certificate Issue Date Extensions Issuer Public Key Serial Number Signature Algorithm User Version
MIC
Short for Message Integrity Check, this prevents forged packets from being sent. Through WEP, it was possible to alter a packet whose content was known even if it had not been decrypted. TKIP Short for Temporal Key Integration, this is part of the IEEE 802.11i encryption standard for wireless LANs. TKIP provides a per-packet key mixing, message integrity check and re-keying mechanism, thus ensuring that every data packet is sent with its own unique encryption key. Key mixing increases the complexity of decoding the keys by giving the hacker much less data that has been encrypted using any one key.
WEP
Short for Wired Equivalent Privacy, WEP is a scheme used to secure wireless networks (Wi-Fi). A wireless network broadcasts messages using radio which are particularly susceptible to hacker attacks. WEP was intended to provide the confidentiality and security comparable to that of a traditional wired network. As a result of identified weaknesses in this scheme, WEP was superseded by Wi-Fi Protected Access (WPA), and then by the full IEEE 802.11i standard (also known as WPA2).
WPA
Wi-Fi Protected Access (WPA and WPA2) is a class of system used to secure wireless (Wi-Fi) computer networks. It was created in response to several serious weaknesses researchers had found in the previous WEP system. WPA implements the majority of the IEEE 802.11i standard, and was intended as an intermediate measure to take the place of WEP while 802.11i was prepared (WPA2). WPA is designed to work with all wireless network interface cards, but not necessarily with first generation Access Points.
170
To resolve problems with WEP, the Wi-Fi Alliance released WPA (FIG. 87), which integrated 802.1x, TKIP and MIC. Within the WPA specifications, the RC4 cipher engine was maintained from WEP. RC4 is widely used in SSL (Secure Socket Layer) to protect internet traffic.
WPA2
Also know as IEEE 802.11i, this is an amendment to the 802.11 standard specifying security mechanisms for wireless networks. The 802.11i scheme makes use of the Advanced Encryption Standard (AES) block cipher; WEP and WPA use the RC4 stream cipher. The 802.11i architecture contains the following components: 802.1X for authentication (entailing the use of EAP and an authentication server), RSN for keeping track of associations, and AES-based CCMP to provide confidentiality, integrity and origin authentication. WPA2 implements the full standard, but will not work with some older network cards. Both provide good security, with two significant issues: either WPA or WPA2 must be enabled and chosen in preference to WEP. WEP is usually presented as the first security choice in most installation instructions. in the "Personal" mode, the most likely choice for homes and small offices, a passphrase is required that, for full security, must be longer than the typical 6 to 8 character passwords users are taught to employ. With the RC4 released to the general public, the IEEE implemented the Advanced Encryption Standard (AES) as the cipher engine for 802.11i, which the Wi-Fi Alliance has branded as WPA2 (FIG. 88).
171
EAP Authentication
EAP (Extensible Authentication Protocol) is an Enterprise authentication protocol that can be used in both a wired and wireless network environment. EAP requires the use of an 802.1x Authentication Server, also known as a RADIUS server. Although over 40 different EAP methods are currently defined, the current internal Modero 802.11g wireless card and accompanying firmware only support the following EAP methods (listed from simplest to most complex): EAP-LEAP (Cisco Light EAP) EAP-FAST (Cisco Flexible Authentication via Secure Tunneling, a.k.a. LEAPv2) The following use certificates: EAP-PEAP (Protected EAP) EAP-TTLS (Tunneled Transport Layer Security) EAP-TLS (Transport Layer Security) EAP requires the use of an 802.1x authentication server (also known as a RADIUS server). Sophisticated Access Points (such as Cisco) can use a built-in RADIUS server. The most common RADIUS servers used in wireless networks today are: Microsoft Sever 2003 Juniper Odyssey (once called Funk Odyssey) Meetinghouse AEGIS Server DeviceScape RADIUS Server Cisco Secure ACS
EAP Characteristics
The following table outlines the differences among the various EAP Methods from most secure (at the top of the list) to the least secure (at the bottom of the list): EAP Method Characteristics
Method: Credential Type: Authentication: Pros: Cons:
EAP-TLS EAP-TTLS
Certificate is based on a two-way authentication Client authentication is done via password and certificates Server authentication is done via certificates Client authentication is done via password and certificates Server authentication is done via certificates
EAP-PEAP
High Security
EAP-LEAP
Authentication is based on Easy MS-CHAP and deployment MS-CHAPv2 authentication protocols N/A N/A
EAP-FAST
N/A
172
1. The client (panel) establishes a wireless connection with the AP specified by the SSID. 2. The AP opens up a tunnel between itself and the RADIUS server configured via the access point. This
tunnel means that packets can flow between the panel and the RADIUS server but nowhere else. The network is protected until authentication of the client (panel) is complete and the ID of the client is verified.
3. The AP (Authenticator) sends an "EAP-Request/Identity" message to the panel as soon as the wireless
connection becomes active.
4. The panel then sends a "EAP-Response/Identity" message through the AP to the RADIUS server
providing its identity and specifying which EAP type it wants to use. If the server does not support the EAP type, then it sends a failure message back to the AP which will then disconnect the panel. As an example, EAP-FAST is only supported by the Cisco server.
5. If the EAP type is supported, the server then sends a message back to the client (panel) indicating what
information it needs. This can be as simple as a username (Identity) and password or as complex as multiple CA certificates.
6. The panel then responds with the requested information. If everything matches, and the panel provides
the proper credentials, the RADIUS server then sends a success message to the access point instructing it to allow the panel to communicate with other devices on the network. At this point, the AP completes the process for allowing LAN Access to the panel (possibly a restricted access based on attributes that came back from the RADIUS server). As an example, the AP might switch the panel to a particular VLAN or install a set of farewell rules.
173
Prepare NetLinx Studio For Communication Via the USB Port 1. From the Start menu in Windows XP, open the Network Connections dialog (Start > Settings >
Network Connections > Local Area Connection).
2. Look for the Local Area Connection reading Local Area Connection, AMX USB Device Link and doubleclick on it to open the Local Status.
3. Press the Properties tab to open the Local Area Connection Properties section. 4. Press the Properties button to open the TCP/IP Properties dialog box. 5. Set the IP address to an address within the same subnet as the panel IP address specified within the USB
IP settings of the panel. For instance, if the default IP address on the device is 12.0.0.2, set the IP address to 172.16.0.2.
6. Set the Subnet Mask to 255.255.255.0. 7. In the TCP/IP Properties dialog box, click OK. 8. In the Local Area Connection Properties, section, click Close.
174
2.
Access the target panel's Protected Setup firmware page and configure the USB communication parameters. Utility. Familiarize yourself with the Certificate Utility User Interface options.
3. With the panel successfully communicating with the target computer, launch the Certificate Upload
4. Locate your certificate file by using the Browse button and navigating to the desired file type. 5. Use the drop-down arrow in the Local Address field to select direct communication through the USB port. 6. Select the 10.XX.XX.1 IP Address that corresponds to the virtual IP Address assigned to the USB
connection port on the computer.
7. Navigate to the Add IP Address field at the bottom-right of the interface and enter a value of 1 greater than
the virtual USB IP Address. For example: If the virtual USB IP Address is 10.0.0.1, then add an address for the directly connected panel of 10.0.0.2. This is one greater than the USB address value detected by the utility. A certificate may be sent to ONLY ONE directly connected panel via USB. Use the Ethernet ports IP Address to send a server certificate to multiple panel targets.
8. Select the IP Address which corresponds to the local computer's Ethernet address. 9. Navigate to the Add IP Address field (bottom-right of the interface) and enter the IP Addresses of the
various target touch panels.
10. Click the Add button to complete the entry and add the new IP Address to the listing of available device
IP Addresses. Repeat this process for all subsequent device IP Addresses.
175
11. Once the list is complete, click on the File drop-down menu and select the Save option. This launches a
Save dialog to assign a name to the current list of addresses and then save the information as a TXT (text) file to a known location. This application must be run from a local machine and should not be used from a remote network location.
12. Select the target devices to be uploaded with the selected certificate. These may be:
individually selected by toggling the box next to the Send entry (with the Type column). selected as a group by clicking on the Check All radio box located at the top of the device IP
Address listing.
13. When ready to send the certificate file to the selected panels, click the Send button to initiate the upload. Once the Status field for each entry reads Done, the upload was successfully completed.
176
Appendix C: Troubleshooting
Appendix C: Troubleshooting
Overview
This section describes the solutions to possible hardware/firmware issues that could arise during the common operation of a Modero touch panel.
1. Load the firmware into the panel, using NetLinx Studio. 2. After loading the firmware, power cycle the MVP (this is a complete power cycle, not a Reboot). The
panel will now show the current firmware version within the Setup > Panel Information page.
3. Connect the power supply to the panel. You will see 2 warning messages on the display.
The first one warns that the battery is low and must be charged. The second warning tells you that the battery is in a protected mode.
4. Wait a few minutes and then check the Battery Settings page on the device to see any charging activity on
the bar graphs. (For more information, refer to the Power Management Page section on page 50.) The "Sensor" device in the Online Tree tab below the MVP panel should show v1.24 or higher after the upgrade, as shown in FIG. 90:
177
Appendix C: Troubleshooting
MVP-5200i Isnt Appearing In The Online Tree Tab 1. Verify that the System number is the same on both the NetLinx Project Navigator window and the System
Settings page on the device.
2. Verify the proper NetLinx Master IP and connection methods entered into the Master Connection section
of the System Settings page.
1. Verify that the AP is configured to match the MVP panel Network Name (SSID) field, Encryption,
Default Key, and Current Key string.
2. In NetLinx Studio, select Diagnostics > Network Address and verify the System number. 3. If the IP Address field is still empty, give the device a few minutes to negotiate a DHCP Address and try
again.
1. Press and hold the two lower buttons on both sides of the display for 3 seconds to open the Setup page. 2. Press the Protected Setup button (located on the lower-left of the panel page), enter 1988 into the onscreen Keypads password field, and press Done when finished.
3. Enter a Device Number value for the panel into the Device Number Keypad. The default is 10001 and the
range is from 1 - 32000.
178
Appendix C: Troubleshooting
1. DO NOT download TPD4 files (of large size) over the demo pages, or any other large TPD4 file. 2. First download a small blank one page file to the G4 panel using the Normal Transfer option to send/
download the page.
179
Appendix C: Troubleshooting
180
Appendix C - Troubleshooting
181
8/2012
2012
AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time.