all | frequencies |
|
|
|
|
|
|
|
exhibits | applications |
---|---|---|---|---|---|---|---|---|---|---|
manuals | photos | label |
app s | submitted / available | |||||||
---|---|---|---|---|---|---|---|---|
1 2 |
|
Users Manual-1 | Users Manual | 5.45 MiB | May 25 2023 / November 22 2023 | |||
1 2 |
|
Users Manual-2 | Users Manual | 5.42 MiB | May 25 2023 / November 22 2023 | |||
1 2 |
|
Users Manual-3 | Users Manual | 5.49 MiB | May 25 2023 / November 22 2023 | |||
1 2 |
|
Users Manual-4 | Users Manual | 1.18 MiB | May 25 2023 / November 22 2023 | |||
1 2 |
|
Internal Photos | Internal Photos | 4.40 MiB | November 10 2023 / May 09 2024 | delayed release | ||
1 2 |
|
External Photos | External Photos | 3.87 MiB | November 10 2023 / May 09 2024 | delayed release | ||
1 2 |
|
ID Label/Location Info | ID Label/Location Info | 199.16 KiB | May 25 2023 / May 28 2023 | |||
1 2 | Antenna report | Operational Description | November 10 2023 | confidential | ||||
1 2 | Attestation Statements | November 10 2023 / November 13 2023 | ||||||
1 2 |
|
C2PC FCC permissive change letter | Cover Letter(s) | 130.33 KiB | November 10 2023 / November 13 2023 | |||
1 2 | Attestation Statements | November 10 2023 / November 13 2023 | ||||||
1 2 | Attestation Statements | November 10 2023 / November 13 2023 | ||||||
1 2 |
|
MPE Report | RF Exposure Info | 1.20 MiB | November 10 2023 / November 13 2023 | |||
1 2 |
|
Request for Confidentiality | Cover Letter(s) | 129.28 KiB | November 10 2023 / November 13 2023 | |||
1 2 |
|
Test Report | Test Report | 481.44 KiB | November 10 2023 / November 13 2023 | |||
1 2 |
|
Test Setup Photos | Test Setup Photos | 1.43 MiB | November 10 2023 / May 09 2024 | delayed release | ||
1 2 |
|
Antenna Report | Test Report | 401.24 KiB | May 25 2023 / May 28 2023 | |||
1 2 |
|
Attestation Statements | Attestation Statements | 142.97 KiB | May 25 2023 / May 28 2023 | |||
1 2 | Block Diagram | Block Diagram | May 25 2023 | confidential | ||||
1 2 |
|
Confidentiality | Cover Letter(s) | 172.01 KiB | May 25 2023 / May 28 2023 | |||
1 2 |
|
Declaration of authorization | Cover Letter(s) | 59.77 KiB | May 25 2023 / May 28 2023 | |||
1 2 | Operational Description | Operational Description | May 25 2023 | confidential | ||||
1 2 |
|
RF Exposure Info. | RF Exposure Info | 1.20 MiB | May 25 2023 / May 28 2023 | |||
1 2 | Schematics | Schematics | May 25 2023 | confidential | ||||
1 2 | Attestation Statements | May 25 2023 / May 28 2023 |
1 2 | Users Manual-1 | Users Manual | 5.45 MiB | May 25 2023 / November 22 2023 |
CONFIGURATION & PROGRAMMING MANUAL VARIA TOUCH PANELS VARIA SL50 VARIA SL80 VARIA 80 VARIA 100 VARIA 100N VARIA 150 VARIA 150N 5.5 ULTRA-SLIM WALL MOUNT TOUCH PANEL 8 ULTRA-SLIM WALL MOUNT TOUCH PANEL 8 TOUCH PANEL 10.1 TOUCH PANEL 10.1 TOUCH PANEL NO-COMM 15.6 TOUCH PANEL 15.6 TOUCH PANEL NO-COMM AV FOR AN IT WORLD IMPORTANT SAFETY INSTRUCTIONS ESD Warning To avoid ESD (Electrostatic Discharge) damage to sensitive components, make sure you are properly grounded before touching any internal materials. When working with any equipment manufactured with electronic devices, proper ESD grounding procedures must be followed to make sure people, products, and tools are as free of static charges as possible. Grounding straps, conductive smocks, and conductive work mats are specifically designed for this purpose. These items should not be manufactured locally, since they are generally composed of highly resistive conductive materials to safely drain static discharges, without increasing an electrocution risk in the event of an accident. Anyone performing field maintenance should use an appropriate ESD field service kit complete with at least a dissipative work mat with a ground cord and a UL listed adjustable wrist strap with another ground cord. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. READ these instructions. KEEP these instructions. HEED all warnings. FOLLOW all instructions. DO NOT use this apparatus near water. CLEAN ONLY with dry cloth. DO NOT block any ventilation openings. Install in accordance with the manufacturer's instructions. DO NOT install near any heat sources such as radiators, heat registers, stoves, or other apparatus (including amplifiers) that produce heat. DO NOT defeat the safety purpose of the polarized or grounding type plug. A polarized plug has two blades with one wider than the other. A grounding type plug has two blades and a third grounding prong. The wider blade or the third prong are provided for your safety. If the provided plug does not fit into your outlet, consult an electrician for replacement of the obsolete outlet. PROTECT the power cord from being walked on or pinched, particularly at plugs, convenience receptacles, and the point where they exit from the apparatus. ONLY USE attachments/accessories specified by the manufacturer. USE ONLY with a cart, stand, tripod, bracket, or table specified by the manufacturer, or sold with the apparatus. When a cart is used, use caution when moving the cart/apparatus combination to avoid injury from tip-over. UNPLUG this apparatus during lightning storms or when unused for long periods of time. REFER all servicing to qualified service personnel. Servicing is required when the apparatus has been damaged in any way, such as power-supply cord or plug is damaged, liquid has been spilled or objects have fallen into the apparatus, the apparatus has been exposed to rain or moisture, does not operate normally, or has been dropped. DO NOT expose this apparatus to dripping or splashing and ensure that no objects filled with liquids, such as vases, are placed on the apparatus. To completely disconnect this apparatus from the AC Mains, disconnect the power supply cord plug from the AC receptacle. Where the mains plug or an appliance coupler is used as the disconnect device, the disconnect device shall remain readily operable. DO NOT overload wall outlets or extension cords beyond their rated capacity as this can cause electric shock or fire. The unit is to be connected only to PoE networks without routing to the outside plant. WATCH FOR THESE SYMBOLS:
The exclamation point, within an equilateral triangle, is intended to alert the user to the presence of important operating and maintenance (servicing) instructions in the literature accompanying the product. The lightning flash with arrowhead symbol within an equilateral triangle is intended to alert the user to the presence of uninsulated dangerous voltage within the products enclosure that may be of sufficient magnitude to constitute a risk of electrical shock to persons. ESD Warning: The icon to the left indicates text regarding potential danger associated with the discharge of static electricity from an outside source (such as human hands) into an integrated circuit, often resulting in damage to the circuit. WARNING: To reduce the risk of fire or electrical shock, do not expose this apparatus to rain or moisture. WARNING: No naked flame sources such as lighted candles should be placed on the product. WARNING: Equipment shall be connected to a MAINS socket outlet with a protective earthing connection. CAUTION: To be installed by instructed, or skilled, persons only. WARNING: This product is intended to be operated ONLY from the voltages listed on the back panel or the recommended, or included power supply of the product. Operation from other voltages other than those indicated may cause irreversible damage to the product and void the products warranty. The use of AC Plug Adapters is cautioned because it can allow the product to be plugged into voltages in which the product was not designed to operate. If you are unsure of the correct operational voltage, please contact your local distributor and/or retailer. If the product is equipped with a detachable power cord, use only the type provided, or specified, by the manufacturer or your local distributor. WARNING: Do Not Open! Risk of Electrical Shock. Voltages in this equipment are hazardous to life. No user-serviceable parts inside. Refer all servicing to qualified service personnel. Place the equipment near a main power supply outlet and make sure that you can easily access the power breaker switch. BATTERY INFORMATION:
This product contains batteries that are covered under the 2006/66/EC European Directive, which cannot be disposed of with normal household waste. Please follow local regulations. THIS PRODUCT CONTAINS A LITHIUM PACK OR COIN/BUTTON CELL BATTERY. IF MISUSED OR ABUSED THIS CAN RESULT IN:
Smoke or gas hazard Heat hazard Fire hazard Explosion hazard WARNING: Do not place batteries in mouth or ingest. Chemical burn hazard. Keep new and used batteries out of reach of children and pets. If swallowed, it can cause severe internal burns in just 2 hours and can lead to death. If you think batteries might have been swallowed or placed inside any part of the body, seek immediate medical attention. VARIA Touch Panels - Configuration & Programming Manual
| TOC 3 WARNING: If battery compartment does not close securely, stop using the product and keep it away from children and pets WARNING: Do not handle leaking or damaged lithium batteries. WARNING: Risk of leakage. Only use the specified type of batteries. Never mix new and used batteries. Observe correct polarity. Remove batteries from products that are not in use for extended periods of time. Store batteries in a dry place. CAUTION: Danger of explosion if battery is incorrectly replaced. Replace only with the same or equivalent type. WARNING: Batteries (battery pack or batteries installed) shall not be exposed to excessive heat such as sunshine, fire or the like. Please dispose of any used batteries properly, following any local regulations. Do not incinerate. WARNING: Do not recharge non-rechargeable batteries. WARNING: 40 C / 104 F is maximum ambient operating temperature. Avoid exposure to extreme heat or cold. LASER SAFETY:
This product complies with FDA performance standards for laser products except for conformance with IEC 60825-1 Ed. 3., as described in Laser Notice No. 56, dated May 8, 2019. Date of manufacture: the date code shown on the product label represents the manufacturing date of this laser product. CAUTION: Invisible laser radiation when open. Avoid exposure to beam. Class 1 laser product. This system must be opened only by qualified technicians to prevent accidents caused by the laser beam. CAUTION: Use of controls or adjustments or performance of procedures other than those specified herein may result in hazardous radiation exposure. FCC AND CANADA EMC COMPLIANCE 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. CAN ICES-3 (B)/NMB-3(B) FCC SDOC SUPPLIERS DECLARATION OF CONFORMITY:
HARMAN Professional, Inc. hereby declares that this equipment is in compliance with the FCC part 15 Subpart B. NOTE: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. Consult the dealer or an experienced radio/TV technician for help. Approved under the verification provision of FCC Part 15 as a Class B Digital Device. Caution: Changes or modifications not expressly approved by the manufacturer could void the users authority to operate this device. WIRELESS TRANSMITTER COMPLIANCE INFORMATION:
The term IC: before the radio certification number only signifies that Industry Canada technical specifications were met. Le terme IC: avant le numro de certification radio signifie seulement que les specifications techniques d'Industrie Canada ont t respectes. This device complies with part 15 of the FCC Rules and the applicable Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device. Le prsent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio exempts de licence. L'exploitation est autorise aux deux conditions suivantes : (1) l'appareil ne doit pas produire de brouillage, et (2) l'utilisateur de l'appareil doit accepter tout brouillage radiolectrique subi, mme si le brouillage est susceptible d'en compromettre le fonctionnement. This equipment complies with FCC and IC radiation exposure limits set forth for an uncontrolled environment. This equipment should be installed and operated with minimum distance 200 mm between the radiator and your body. This transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. Cet appareil est conforme FCC et IC l'exposition aux rayonnements limites fixes pour un environnement non contrl. Cet appareil doit tre install et utilize avec une distance minimale de 200 mm entre le radiateur et votre corps. Cet transmetteur ne doit pas tre co-situ ou operant en liaison avec toute autre antenne ou transmetteur. This logo applies to electronic information products sold in the People's Republic of China. The number in the middle of the logo is the number of years of environmental utility. WEEE NOTICE:
The WEEE Directive 2012/19/EU on Waste Electrical and Electronic Equipment (WEEE), which entered into force as European law on 14/02/2014, resulted in a major change in the treatment of electrical equipment at end-of-life. VARIA Touch Panels - Configuration & Programming Manual
| TOC 5 The purpose of this Directive is, as a first priority, the prevention of WEEE, and in addition, to promote the reuse, recycling and other forms of recovery of such wastes so as to reduce disposal. The WEEE logo on the product or on its box indicating collection for electrical and electronic equipment consists of the crossed-out wheeled bin, as shown below. This product must not be disposed of or dumped with your other household waste. You are liable of dispose of all your electronic or electrical waste equipment by relocating over to the specified collection point for recycling of such hazardous waste. Isolated collection and proper recovery of your electronic and electrical waste equipment at the time of disposal will allow us to help conserving natural resources. Moreover, proper recycling of the electronic and electrical waste equipment will ensure safety of human health and environment. For more information about electronica and electrical waste equipment disposal, recovery, and collection points, please contact your local city center, household waste disposal service, shop from where you purchased the equipment, or manufacturer of the equipment. RoHS Compliance:
This product is in compliance with Directive 2011/65/EU and (EU) 2015/863 of the European Parliament and of the Council of 31/03/2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment. REACH:
REACH (Regulation No 1907/2006) addresses the production and use of chemical substances and their potential impacts on human health and the environment. Article 33 (1) of REACH Regulation requires suppliers to inform the recipients if an article contains more than 0.1% (per weight per article) of any substance(s) on the Substances of Very High Concern (SVHC) Candidate List (REACH candidate list). This product contains the substance lead (CAS-No. 7439-92-1) in a concentration of more than 0.1% per weight. At the time of release of this product, except for the lead substance, no other substances of REACH candidate list are contained in a concentration of more than 0.1% per weight in this product. Note: on June 27, 2018, lead was added to the REACH candidate list. The inclusion of lead in the REACH candidate list does not mean that lead-
containing materials pose an immediate risk or results in a restriction of permissibility of its use. Manufacturer Information:
Manufacturer: HARMAN Professional, Inc. Address: 8500 Balboa Blvd. Northridge, CA 91329 USA EU Regulatory Contact:
HARMAN Professional, Inc. Denmark ApS Olof Palmes All 44, 8200 Aarhus N, Denmark COPYRIGHT NOTICE AMX 2017, all rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of AMX. Copyright protection claimed extends to AMX hardware and software and includes all forms and matters copyrightable material and information now allowed by statutory or judicial law or herein after granted, including without limitation, material generated from the software programs which are displayed on the screen such as Varias, screen display looks, etc. Reproduction or disassembly of embodied computer programs or algorithms is expressly prohibited. LIABILITY NOTICE No patent liability is assumed with respect to the use of information contained herein. While every precaution has been taken in the preparation of this publication, AMX assumes no responsibility for error or omissions. No liability is assumed for damages resulting from the use of the information contained herein. Further, this publication and features described herein are subject to change without notice. AMX WARRANTY AND RETURN POLICY The AMX Warranty and Return Policy and related documents can be viewed/downloaded at www.amx.com. VARIA Touch Panels - Configuration & Programming Manual
| TOC 7 Table of Contents IMPORTANT SAFETY INSTRUCTIONS ........................................................................................................ 2 VARIA Touch Panels Configuration & Programming .............................................................................. 14 Overview .................................................................................................................................... 14 Additional Documentation ......................................................................................................... 14 Out of the Box Experience ..................................................................................................................... 15 Overview .................................................................................................................................... 15 The Setup Wizard ....................................................................................................................... 15 Language ................................................................................................................................................ 15 Date & Time ........................................................................................................................................... 15 Network ................................................................................................................................................. 15 Persona (app) Selection ......................................................................................................................... 17 AMX Control........................................................................................................................................... 18 Overview .................................................................................................................................... 18 2 Simple Steps ............................................................................................................................ 18 Netlinx Setup .............................................................................................................................. 18 Load TP5 File .............................................................................................................................. 19 AMX Book .............................................................................................................................................. 20 Overview .................................................................................................................................... 20 Setup .......................................................................................................................................... 20 Zoom Rooms Controller ......................................................................................................................... 20 Overview .................................................................................................................................... 20 Setup .......................................................................................................................................... 20 Web Kiosk .............................................................................................................................................. 20 Overview .................................................................................................................................... 20 Setup .......................................................................................................................................... 20 Panel Settings Menu .............................................................................................................................. 21 Overview .................................................................................................................................... 21 Accessing the Settings Menu ...................................................................................................... 21 Via the G5:setup SSH Command (Standard Security mode only) .......... !
Using AMX System Recovery .................................................................................................................. 79 Using the Settings Menu ........................................................................................................................ 21 Settings Menu - Page Categories ................................................................................................ 23 AMX Book .............................................................................................................................................. 25 Overview .................................................................................................................................... 33 Calendar ..................................................................................................................................... 33 Microsoft Exchange .................................................................................................................... 33 Office 365 ................................................................................................................................... 34 Meeting Time ............................................................................................................................. 35 Group ......................................................................................................................................... 36 Room .......................................................................................................................................... 36 Security ...................................................................................................................................... 37 Closing the Settings menu ........................................................................ !
INFO - Device Info .................................................................................................................................. 50 INFO - Maintenance ............................................................................................................................... 51 Rebooting the Panel ................................................................................................................... 51 Shutting Down the Panel ............................................................................................................ 51 DEVICE - Storage .................................................................................................................................... 51 Internal Storage: Downloads ...................................................................................................... 52 Internal Storage: Cached Data ................................................................................................... 52 USB Storage ................................................................................................................................ 53 Unmounting a USB Storage Device ............................................................................................ 53 DEVICE - Sound ...................................................................................................................................... 53 Adjusting Volumes ..................................................................................................................... 55 Selecting Device Sounds ............................................................................................................. 55 Selecting a Default Notification Sound ....................................................................................... 56 DEVICE - Display ..................................................................................................................................... 56 Adjusting Panel Brightness ......................................................................................................... 57 Adjusting Display Timeout .......................................................................................................... 57 Selecting the Font Size ............................................................................................................... 57 DEVICE - G5 Settings .............................................................................................................................. 57 Setting a Remote Profile ............................................................................................................ 58 Setting an Inactivity Time Period and Page Flip .......................................................................... 59 Setting Password Protection ...................................................................................................... 59 Streaming Video ................................................................................................... !
Clearing the Current Streaming Video URL .............................................. !
Touch Panel Aspect Ratio ......................................................................... !
Active Video Windows - Limitations ........................................................................................... 59 DEVICE - Sensors .................................................................................................................................... 60 Calibrating the Light Sensor ....................................................................................................... 60 DEVICE - VNC .......................................................................................................................................... 61 Enabling VNC .............................................................................................................................. 61 VARIA Touch Panels - Configuration & Programming Manual
| TOC 9 Configuring VNC Access .............................................................................................................. 61 CONNECTIONS - Ethernet ...................................................................................................................... 62 Setting Static IP Information (IPv4) ............................................................................................ 63 Entering a New Hostname (IPv4/DHCP only) ............................................................................. 64 Setting IPv6 Information ............................................................................................................ 64 Working With 802.1x Security .................................................................................................... 65 CONNECTIONS - NetLinx ........................................................................................................................ 25 Scanning for Controllers ............................................................................................................. 26 Changing the Controller Connection Mode ................................................................................ 26 Changing the Controller IP/URL.................................................................................................. 27 Changing the Controller Port Number ........................................................................................ 27 Changing the Controller Username ............................................................................................ 27 Changing the Controller Password ............................................................................................. 27 Changing the Device Number and Device Name ........................................................................ 27 Enabling a Secure Controller Connection ................................................................................... 27 Enabling Hostname Verification ................................................................................................. 28 CONNECTIONS - Browser ..................................................................................... !
Adding a URL to the URLs List................................................................... !
Switching Between Desktop and Mobile Content .................................... !
Deleting a URL from the URLs List ........................................................... !
CONNECTIONS - Smart Card ................................................................................................................... 66 SYSTEM - Date & Time ........................................................................................................................... 67 Retrieving the Date and Time From NTP .................................................................................... 67 Manually Setting the Date and Time .......................................................................................... 67 Specifying a Network Time Server .............................................................................................. 68 Manually Setting the Time Zone ................................................................................................ 68 Specifying a Date Format ........................................................................................................... 68 SYSTEM - Language & Input ................................................................................................................... 69 Selecting the Panels Language ................................................................ !
Personal Dictionary .................................................................................. !
Changing Input Methods ............................................................................................................ 69 Changing the Pointer Speed ..................................................................... !
SYSTEM - Security .................................................................................................................................. 71 Placing the Panel in High Security Mode .................................................................................... 73 Switching From High Security Mode to Standard Security Mode ............................................... 74 Changing the Password .............................................................................................................. 75 Changing USB Security Settings .................................................................................................. 75 Displaying Trusted Credential Certificates ................................................................................. 76 Installing Credential From Storage ............................................................................................. 77 Clearing Credentials ................................................................................................................... 77 Restoring the Default System Security Settings ......................................................................... 77 SYSTEM - Reset and Update ................................................................................................................... 78 Factory Data Reset ..................................................................................................................... 78 Reset Settings ............................................................................................................................. 79 Storing and Loading Settings Configuration Files ....................................................................... 79 Storing the Current Settings ....................................................................................................... 80 Loading Settings ......................................................................................................................... 80 Firmware Manager ..................................................................................................................... 81 Reverting to Previous Firmware ................................................................................................. 81 Reverting to Factory-Installed Firmware .................................................................................... 81 Installing New Firmware From An External USB Stick ................................................................ 82 Install Firmware From Web ........................................................................................................ 82 App Manager ............................................................................................ !
App Manager Page - AVAILABLE tab ........................................................ !
Installing All Available Updates ................................................................ !
Updating Individual Applications .............................................................. !
Enabling Native (Disabled) Applications ................................................... !
Installing Downloaded Applications ......................................................... !
Installing Applications From an External USB Drive .................................. !
App Manager Page - INSTALLED tab .................................................................... !
Disabling Native Applications ................................................................... !
Uninstalling Downloaded Applications ..................................................... !
Scheduled Updates .............................................................................................. !
Scheduled Application Updates ............................................................... !
Scheduled Update Days ........................................................................... !
Scheduled Update Time ........................................................................... !
Update Applications on Startup ............................................................... !
Installing Panel Pages From an External Disk ......................................................................................... 84 Removing User Pages From the Panel .................................................................................................... 84 SYSTEM - Diagnostics ............................................................................................................................. 85 Gestures ................................................................................................................................................. 86 VARIA Touch Panels - Configuration & Programming Manual Overview .................................................................................................................................... 86
| TOC 11 Touch Gesture Recognition ........................................................................................................ 86 Gesture Velocity ......................................................................................................................... 86 Gesture Prioritization ................................................................................................................. 86 Gesture VNC/Mouse Support ..................................................................................................... 87 Gesture Custom Event................................................................................................................ 87 Gesture numbers and velocity values ........................................................................................ 87 Precise gesture velocity .............................................................................................................. 87 Enabling or Disabling the Gesture Custom Event ....................................................................... 87 Programming - Send Commands ............................................................................................................ 87 Overview .................................................................................................................................... 87 Using the Pipe ( | ) Character .................................................................................................. 88 Panel Commands ....................................................................................................................... 89 Page Commands ....................................................................................................................... 103 Page Commands are case in-sensitive ...................................................................................... 103 Button Commands ................................................................................................................... 107 Text Effect Name/Numbers ...................................................................................................... 132 Dynamic Image Commands .................................................................................................................. 133
^RAF and ^RMF Embedded Codes / Escape Sequences ........................................................... 135 Intercom Commands ............................................................................................ !
Listview (Data Access) Commands ....................................................................................................... 137 Terminology ............................................................................................................................. 137 VNC Commands ................................................................................................................................... 142 Programming Numbers ........................................................................................................................ 144 Color Table ............................................................................................... !
Justificaion Values .................................................................................................................... 146 Border Styles ............................................................................................................................ 146 ISO-8859-1 Character Encoding/Decoding table ...................................................................... 147 Virtual Keystroke Commands ................................................................................................... 148 SSH Commands ........................................................................................................................ 150 Overview .................................................................................................................................. 150 Appendix A: Upgrading Firmware via NetLinx Studio ........................................................................... 156 Overview .................................................................................................................................. 156 NetLinx Studio 4 ....................................................................................................................... 156 Upgrading Firmware via NetLinx Studio (v4 or Higher) ............................................................ 156 Appendix B: Using NetLinx to Define a Data Source (Listview Buttons) ............................................... 159 Example Listview Workflow - NetLinx Data Source .................................................................. 159 1) Create the Listview Button and Set Button Properties ......................................................... 159 2) Create the Data Source ........................................................................................................ 163 NetLinx Usage Example - ASCII ................................................................................................. 163 3) Configure the Response to a User Selection ........................................................................ 166 Appendix C: Text Formatting................................................................................................................ 167 Text Formatting Codes for Bargraphs ....................................................................................... 167 Text Area Input Masking .......................................................................................................... 167 Input mask character types ...................................................................................................... 168 Input Mask Ranges ................................................................................................................... 168 Input Mask Operations ............................................................................................................. 168 Input Mask Literals ................................................................................................................... 169 Input Mask Output Examples ................................................................................................... 169 Special Escape Sequences ........................................................................................................ 169 Appendix D: Bargraph Functions .......................................................................................................... 171 Overview .................................................................................................................................. 171 Setup Codes ............................................................................................................................. 171 Appendix E: Video Streaming ............................................................................................................... 172 Optimizing Motion JPEG Video Presentation and Speed .......................................................... 172 Streaming a Video File Saved on the Panel via Custom URL Scheme ....................................... 172 Transcoding Guidelines ............................................................................................................ 174 Appendix F: DragDrop.axi .................................................................................... !
Overview .................................................................................................. !
VARIA Touch Panels - Configuration & Programming Manual
| TOC 13 VARIA Touch Panels Configuration & Programming Overview The AMX Varia touch panels redefine control with personas that fit any application. Any AMX Varia touch panel can be configured as any persona:
AMX G5 Control that utilizes AMX G5 programming tools like TPDesign5 & Netlinx Studio AMX Book Scheduling that directly connects directly to popular scheduling software Zoom Rooms Controller to manage Zoom Rooms environments
- Web Kiosk that can display HTML5 & web content on a full-screen borderless browser
CloudworX Control (future availability) The VARIA touch panels covered in this document are listed below:
VARIA TOUCH PANELS AMX-UTP0501 VARIA SL50 5.5 ULTRA-SLIM WALL MOUNT TOUCH PANEL AMX-UTP0801 VARIA SL80 8 ULTRA-SLIM WALL MOUNT TOUCH PANEL AMX-UTP0811 VARIA 80 8 TOUCH PANEL AMX-UTP1011 VARIA 100 10.1 TOUCH PANEL AMX-UTP1011N VARIA 100N 10.1 TOUCH PANEL NO-COMM AMX-UTP1511 VARIA 150 15.6 TOUCH PANEL AMX-UTP1511N VARIA 150N 15.6 TOUCH PANEL NO-COMM NO-COMM Touch Panels are used in highly secure environments where device peripherals are not allowed. NO-COMM panels omit the camera, microphone, and NFC reader. NO-COMM panels include speakers, ambient light sensor, and proximity sensor. Additional Documentation For instructions on using NetLinx Studio, refer to NetLinx Studio online help, or the NetLinx Studio v4 Instruction Manual. For instructions on using TPDesign5, refer to TPDesign5 online help, or the TPDesign5 Instruction Manual. For installation instructions for Varia panels, refer to the Varia Touch Panels Installation and Hardware Reference Guide. VARIA Touch Panels - Configuration & Programming Manual
| TOC 14 Out of the Box Setup Wizard Overview AMX Varia touch panels include a step-by-step wizard to walk a user through basic setup requirements. This includes language selection, date &
time, network, and touch panel persona. The Setup Wizard When a panel is first turned on (either out of the box, or after a factory reset operation), the setup wizard appears. Follow the steps to select your preferences. After making selections on each page, press [Continue] on the bottom-right of the screen to go to the next page. To go back, press
[Back] on the bottom-left of the screen. Language Use the dropdown to select your language. NOTE: The selected language will only apply to the operating system. Additional language selections/decisions may be required based on the selected persona. Date & Time Use the dropdown to select your time zone. Then, if required, adjust your date & time by using the dropdowns. Network Select your network configuration The current configuration will be shown. Default is DHCP with 802.1x disabled and no proxy. A blue Change button is available to modify settings as needed. Make sure to press {Save] after making changes, or your newly entered network settings will not be saved. VARIA Touch Panels - Configuration & Programming Manual
| TOC 15 DHCP (preferred) Network DHCP server will automatically assign IP address, subnet mask, default gateway, and DNS server info. In this mode, IP fields are read-only. Hostname is available to change as needed. Static IP IP address, subnet mask, default gateway, and DNS server info must be entered manually. Make sure to press [Save] after entering the information. Press
[Cancel] to leave without saving any edits. NOTE: It is not good networking practice to use the pre-filled DHCP address as a permanent static IP address. AMX prefers the use of DHCP MAC reservations vs. static IP addressing. 802.1X If 802.1X is available/required, turn it [ON], select your EAP method, and enter the required info for that method (eg. certificate, domain, identity, password, etc.). For further assistance and detail on whether your network supports or requires 802.1X, please contact your or your clients IT department. Proxy If a proxy is available/required, turn it [ON] and enter the appropriate configuration information. For further assistance and detail on whether your network supports or requires 802.1X, please contact your or your clients IT department. VARIA Touch Panels - Configuration & Programming Manual
| TOC 16 Persona (app) Selection Select the panels persona, which is the primary app that will be used by the panel. Each subsequent reboot will launch only this persona. Each persona is described in detail later in this manual. Once selected, press [Continue]. NOTE: The panel persona may be changed at any time in Advanced Settings. Confirm Panel App Your selection will be confirmed in a pop-up. Press [Yes, continue] to complete the selection or [Cancel] to go back and select a different persona. NOTE: Once confirmed, the panel may take up to one (1) minute to initially configure the persona. VARIA Touch Panels - Configuration & Programming Manual
| TOC 17 Wizard - AMX Control Overview The AMX Control persona utilizes familiar G5 touch panel technology & features, used with Netlinx control systems. The touch panel GUI
(graphical user interface) is programmed with TPDesign5 and is compatible with .TP5 files. 2 Simple Steps When the AMX Control persona is selected & configured, the wizard continues to help guide through the setup of Netlinx controller and load the TPDesign5 (TP5) UI file. Select [Get Started] to continue, or [Maybe Later] to exit the wizard. Netlinx Setup Connect to your Netlinx controller. Start by pressing the blue [Change]
button on the right. Select one of the three (3) available connection methods. Each is described in detail below. By URL Enter the Controllers IP/URL, port number (if not using default 1319), and username/password (if used). The System Number field is read-only; the panel obtains this information from the controller. Assign your touch panel a Device ID and a Device Name for your panel. VARIA Touch Panels - Configuration & Programming Manual
| TOC 18 Listen Add the panel address into the URL List in NetLinx Studio and set the connection mode to Listen. This mode allows the panel to listen for the Controllers communication signals. The System Number and Controller IP/URL fields are read-only. Auto Enter the System Number and a username/password (if applicable). Use this mode when both the panel & NetLinx Controller are on the same Subnet. The Controller IP/URL field is read-only. Load TP5 File Choose one of the three (3) available options to load a .TP5 file to the panel. Demo TP5 file will load a pre-loaded & pre-built panel file Load from USB will allow a file to be loaded via a USB thumb drive. Load from URL will allow the user to enter a URL from which the .TP5 file will be downloaded. Alternatively, Cloudworx Manager Desktop software may be used to load a .TP5 file to one or more touch panels. If you dont wish to load a .TP5 file right now, the final option [Maybe Later] may be selected at the bottom of the screen VARIA Touch Panels - Configuration & Programming Manual
| TOC 19 Wizard - AMX Book Overview AMX Book offers an out-of-the box room scheduling solution, connects directly to popular scheduling platforms and supports the latest authentication protocols like Microsoft Modern Authentication. Setup Complete setup instructions can be found later in this manual. Wizard - Zoom Rooms Controller Overview The built-in Zooms Room Controller persona can be used to control & manage Zoom Rooms environments. Setup Setup for ZRC environments is completed within the ZRC app. More information on Zoom Rooms can be found here:
https://explore.zoom.us/en/products/zoom-rooms/
Wizard - Web Kiosk Overview A full-screen borderless browser for HTML5, JavaScript, & web can be selected as a persona to turn your panel into a standards-based kiosk designed around web content. Setup Use the dropdown to select https:// (preferred) or http://. Be careful not to repeat this protocol in the URL field. Enter the URL to be displayed in the field. Press [Save], and then [Continue]. Your web content will load immediately and will also load on any subsequent panel reboot. VARIA Touch Panels - Configuration & Programming Manual
| TOC 20 Panel Settings Menu Overview Panel Settings contain configuration info for the current persona & advanced settings. Persona settings are available only for the currently-
active persona. Accessing the Settings Menu To access the Panel Settings menu, briefly press & release the Settings Button. The Settings Button is the pin-hole button on the top-right of the panel bezel, next to the rectangular Function button. The default PIN to access Panel Settings is 1988. NOTE: Do not confuse the Settings button (pin-hole button) with any of the microphone or sensor holes. The Settings button is the larger hole located closest to the Function Button. Irreparable damage may occur if a foreign object is pushed down the microphone hole or into one of the sensors. Using the Settings Menu When opened, the Settings menu appears in the center of the panel display. Please note that many of the pages in the menu may be longer than they initially appear. To reach additional functions on a given page, the page itself may be scrolled up & down to reveal those functions. Selected Category Change button Help Netlinx Connection Indicator Encrypted ICSP Indicator Categories Category Settings Settings App Version VARIA Touch Panels - Configuration & Programming Manual
| TOC 21 Please note on the 5.5 panel, the Categories Menu is shown on the full screen and then flips to each Categories settings page. Press the arrow on the top-left of the page to go back to the Categories Menu. VARIA Touch Panels - Configuration & Programming Manual
| TOC 22 Settings Menu - Page Categories Settings menu (FIG. 6 & FIG. 7) provides access to all of the Settings pages for G5 panels. Settings pages are separated into five categories:
INFO, DEVICE, CONNECTIONS, ACCOUNTS, and SYSTEM. The menu options available via the Settings window are summarized below:
AMX Control Settings Menu PAGE NAME NETLINX Connection Mode Controller IP/URL DESCRIPTION PAGE #
Connection to the Netlinx controller by either URL (IP or URL), Auto (System number), or Listen (Netlinx URL List). page 24 Sets the UP/URL of the Netlinx controller. Note: Available in URL Mode only; disabled when Auto or Listen Mode is selected. Controller Port Number Enter the IP port number used with the Netlinx controller. Default: 1319 System Number Enter the Netlinx system number. Default: 0 (zero). Note: Available in Auto Mode Only; disabled when URL or Listen Mode is selected. Panels Device Number Enter the touch panel device number. Panels Device Name Enter the touch panel devices name. Secure Controller Connection Set the secure connection to the Netlinx controller Note: the IP port used for secure ICSP connections is 1320. Hostname Verification Set the hostname verification of the NetLinx controller, via the controllers device certificate. Note: This option is only available if the Secure Connection option is enabled. G5 SETTINGS TP5 File Sound Inactivity Page /
Page Tracking View TP5 UI file information or load a new one. Set a sound to play on button hit, button miss, and NFC notification Set Inactivity Page Flip behavior and Set Page Tracking info. User Password Protection Set additional user protected passwords. SYSTEMS AMX Control Settings Management Allows management of the settings in the AMX Control persona. Reset AMX Control settings Load settings config file from USB Save current settings to USB. Date & Time Sync date & time either with the system OS or with the Netlinx controller. Note: System date & time can be set in the System OS Settings. DESCRIPTION AMX Book Settings Menu PAGE NAME CALENDAR Microsoft Exchange Microsoft O365 MEETING TIME TBD GROUP PAGE #
page 24 VARIA Touch Panels - Configuration & Programming Manual
| TOC 23 TBD ROOM TBD SECURITY TBD DESCRIPTION Web Kiosk Settings Menu PAGE NAME WEB KIOSK Default URL JavaScript Force Dark Mode Licenses PAGE #
page 24 VARIA Touch Panels - Configuration & Programming Manual
| TOC 24 AMX Control Overview The Overview page presents a summary of the options available in an AMX NetLinx control system. NetLinx The NetLinx page controls the method of connecting to a NetLinx Controller. Netlinx Scan for Controllers Press to scan for NetLinx controllers on the network, via the Controller Connection window. See Scanning for Controllers on page 48 for details. Mode Cycles between the connection modes: URL, Listen, and Auto. URL - Enter the IP/URL, Controller Port Number, and username/password (if used) on the Controller. The System Number field is read-only - the panel obtains this information from the Controller. Listen - Add the panel address into the URL List in NetLinx Studio and set the connection mode to Listen. This mode allows the panel to listen for the Controllers communication signals. The System Number and Controller IP/URL fields are read-only. Auto - Enter the System Number and a username/password (if applicable). Use this mode when both the panel and the NetLinx Controller are on the same Subnet. The Controller IP/URL field is read-only. System Number Allows entry of a system number. Default value is 0 (zero). Note: Available in Auto Mode Only - disabled when URL or Listen is selected. Controller IP/URL Controller/Port Number Username Password Sets the Controller IP or URL of the NetLinx Controller. Note: Available in URL Only - disabled when Listen or Auto is selected. Allows entry of the port number used with the NetLinx Controller. Default = 1319. If the target Controller has been previously secured, enter the alpha-numeric string (into each field) assigned to a preconfigured user profile on the Controller. This profile should have the predefined level of access/configuration rights. If the target Controller has been previously secured, enter the alpha-numeric string (into each field) assigned to a preconfigured user profile on the Controller. This profile should have the predefined level of access/configuration rights. Device Number Displays the panels device number and allows entry of a new one. VARIA Touch Panels - Configuration & Programming Manual
| TOC 25 Netlinx Device Name Displays the panels device name and allows entry of a new one. Scan for Controller Connection Press to enable and configure a connection a secured NetLinx Controller, via options in the NetLinx window (see page 49). Note: The secure connection is a TLS connection to a NetLinx Controller on port 1320. Hostname Verification Press to enable hostname verification of the NetLinx Controller via the Controllers device certificate (see page 50). Note: This option is only available if the Secure Controller Connection option is enabled. Connection Status Displays the panels connection status to the Controller Scanning for Controllers Use the Scan For Controllers feature to quickly and easily identify all of the available NetLinx Controllers on the network. The site survey on this page passively listens to network traffic and presents all the compatible Controllers for easy selection. Selecting the desired Controller automatically updates the NetLinx Controller section and establishes a connection. 1. In the NetLinx page, press Scan For Controllers to begin listening for NetLinx controllers and open the Controller Connection window
(FIG. 64):Select the NetLinx Controller for this panel. 2. The NetLinx page will automatically display the connection information on the selected Controller Changing the Controller Connection Mode To select the Controller Connection mode (URL, Listen, or Auto):
1. In the NetLinx page, press Mode to open NetLinx Options window:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 26 2. Select the desired option from the Mode menu - URL (default setting), Listen or Auto. 3. When finished, press OK to return to the NetLinx page. Changing the Controller IP/URL To change the IP address or URL for the chosen Controller:
1. 2. 3. 4. 5. In the NetLinx page, press Controller IP/URL to open the NetLinx Options window and on-screen keyboard. Enter the IP address or the URL. Press the double-down arrow key at the bottom right of the on-screen keyboard to close the keyboard. The new IP address/URL is now displayed in the Controller IP/URL field. Press OK to save the changes and return to the NetLinx page.:
Changing the Controller Port Number To change the Controller Port Number from its default:
6. 7. 8. 9. 1. In the NetLinx page, press Controller Port Number to open the NetLinx Options window and on-screen keyboard. Enter the new Controller Port Number. Press the double-down arrow key at the bottom right of the on-screen keyboard to close the keyboard. The new Port Number is now displayed in the Controller Port Number field. 10. Press OK to save the changes and return to the NetLinx page. Changing the Controller Username 1. In the NetLinx page, press the Username field to open the NetLinx Options window and on-screen keyboard. 2. 3. 4. 5. Enter the new username. Press the double-down arrow key at the bottom right of the on-screen keyboard to close the keyboard. The new Username is now displayed in the Username field. Press OK to save the changes and return to the NetLinx page Changing the Controller Password 1. In the NetLinx page, press Password to open the NetLinx Options window and on-screen keyboard. 2. 3. 4. 5. Enter the new password. Press the double-down arrow key at the bottom right of the on-screen keyboard to close the keyboard. The new Password is now displayed in the Password field. Press OK to close the NetLinx window and return to the NetLinx Changing the Device Number and Device Name 1. In the NetLinx page, press the Device Number field to open the NetLinx Options window and on-screen keypad. 2. 3. 4. 5. 6. 7. Enter a new Device Number. Press Next, to select Device Name in the NetLinx page and open the n-screen keyboard. Enter a new Device Name. Press Done to close the keypad and keyboard. The new Device Number and Device Name are now displayed in the Device Number and Device Name fields. Press OK to save changes and close the NetLinx window and return to the NetLinx page. Enabling a Secure Controller Connection 1. In the NetLinx page, press the Secure Controller Connection field to open the NetLinx Options window. 2. Scroll to the bottom of the options list and toggle the Secure Controller Connection option ON:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 27 Enabling Hostname Verification 1. In the NetLinx page, press the Hostname Verification field to open the NetLinx Options window. 2. Scroll to the bottom of the options list and toggle the Hostname Verification option ON (FIG. 67):
Note that this option is available only if the Secure Controller Connection option is ON. G5 Settings The G5 Settings contains specific settings related to the G5 experience and to the TP5 project file loaded. VARIA Touch Panels - Configuration & Programming Manual
| TOC 28 G5 Settings Options This tab contains information related to your TP5 project file, and also gives the option to change the TP5 file loaded. TP5 File To change the TP5 project file, press [Change]. There are options to load from USB, URL, demo file, or remove the current TP5 project file VARIA Touch Panels - Configuration & Programming Manual
| TOC 29 G5 Settings Options This tab contains sound settings for your touch panel. Dedicated sounds for Button Hit & Button Miss can be applied here. To change either of these sounds, or to select no sound, press its respective [Change] button. Sound Scroll through and select a new sound. The options for None is at the very top. This contains options to set up an Inactivity page Flip Time, which is a page flip made inside a TP5 project file after a specified period of inactivity on the panel (ie. no touches), and to enable or disable Page Tracking. Inactivity Page /
Page Tracking To set up, press [Change]. Select On or Off. If On, select the desired amount of time. VARIA Touch Panels - Configuration & Programming Manual
| TOC 30 G5 Settings Options Inactivity Page is read-only, and dictated by the TP5 project file. See TPDesign5 for more information. Page Tracking , if enabled, will send page flip tracking messages to the Netlinx controller. This provides the option of assigning passwords to the secured Settings pages. Users have the the ability to assign alphanumeric values to particular password sets. To assign, change, or delete a password, press [Change]. User Password Protection You may enter up to four (4) passwords. Note: This function does not overwrite the default settings password (1988). VARIA Touch Panels - Configuration & Programming Manual
| TOC 31 System The System settings contains options for the panel configuration, date & time, and date & time. This allows management of the settings in the AMX G5 Control persona:
Reset will revert all AMX Control settings to their default values. Load from USB will allow a panel config file to be loaded via connected storage device. Save to USB saves the current panel configuration to USB. Allows syncing with either the touch panel system date & time or the Netlinx controller date & time. System AMX Control Settings Management Date & Time Note: this will only apply to the AMX Control persona. Licenses This displays all the open sources licenses being utilized, if applicable. VARIA Touch Panels - Configuration & Programming Manual
| TOC 32 AMX Book Overview The Overview page presents a summary of the steps that entail the Scheduling Panel Setup Wizard. Press [Next] to start. Calendar Use the options in the CALENDAR page to configure the scheduling panels connection to the scheduling system. Microsoft Exchange Microsoft Microsoft Exchange Calendar Configuration Settings VARIA Touch Panels - Configuration & Programming Manual
| TOC 33 Server URL Username Enter the full URL for the scheduling server. Example syntax:
https://<EXCHANGE_SERVER_HOSTNAME>/EWS/Exchange.asmx Enter the Username (including domain) required to login to the scheduling server (as required). Example: "JaneDoe@acme.onmicrosoft.com". Password Enter the Password required to login to the scheduling server (as required). Calendar Email ID Enter the Email ID (including domain) used by the scheduling service. Example: "ConfRoom1@acme.onmicrosoft.com"
Certificate Validation Select Strict to include hostname validation and apply certain certificate requirements - see SSL Validation Schemes (below). Select None to disable validation schemes - see SSL Validation Schemes (below). Select Manage Certificates to open the Security (Advanced Settings) page (see FIG. 100 on page 57), which provides access to Credential Storage options, as described in the Installing Certificates section on page ##. Poll Time Office 365 Microsoft Office 365 Calendar Configuration Settings Enter the required information regarding your O365 Tenant. Tenant ID Client ID Verify Please refer to your Azure Portal https://portal.azure.com for more information and see Appendix A on page ## for steps to find this ID. Enter the required information regarding your O365 Client. Please refer to your Azure Portal https://portal.azure.com for more information and see Appendix A on page ## for steps to find this ID. Once entered, the wizard will attempt a connection to your O365 server. You will be prompted to log in with your email & password as normal when accessing Microsoft services. Depending on your configurations and the calendars to which you have access, you may be prompted to select a calendar. NOTE: Only Modern Authentication is supported. Support for Basic Authentication has ended and will not be supported. Microsoft login & calendar selection:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 34 A correctly setup mailbox will look like this:
Meeting Time Use the options in the MEETING TIME page to customize default meeting & timing options. Setup Wizard - LOCALIZATION page options Date Format Default Meeting Length Default Meeting Increment Indicates the current date display setting for this panel (default =
Month-Date). To change the date display to Month-Date format, press the Month-Date button. This setting specifies how many times each hour this panel can indicate separate meetings. The default setting is 15 minutes, in which case this panel can schedule up to 4 meetings in an hour. To change the default meeting increment setting, press either the 30 mins or 60 mins button. With 30 mins selected, this panel can schedule a meeting every 30 minutes. With 60 mins selected, this panel can schedule a meeting every 60 minutes. Indicates the current default meeting length setting for this panel (default = 30 minutes). To change the default meeting length setting, press either the 15 mins or 60 mins button. VARIA Touch Panels - Configuration & Programming Manual
| TOC 35 Group AMX Book touch panels can be configured either as a Primary or Secondary, as it relates to a Scheduling Panel Group. Secondary panels communicate with the Primary panel, which enables panels to browse the schedules of panels in the same Group. This provides users with the ability to schedule a meeting in any room included in the Scheduling Panel Group, from any panel in the Group. For example, when a room is occupied, users can browse other rooms and schedule a meeting in any of the rooms in the Group. Use the options in the GROUP page to configure this panel as either the Primary or Secondary of a Scheduling Panel Group. Note that there can be only one Primary panel for a Group. If there is only one stand-alone AMX Book panel, then it must be configured as a Primary. NOTE: Up to 49 AMX Book panels can be configured as Members of a Primary panels Group (for a total of 50 panels including the Primary). However, note that when configuring Scheduling Groups, smaller Room Groups typically have quicker responsiveness for "Browse Rooms"
requests. Setup Wizard - GROUP page options Primary/Secondary Specify to use this panel either as a Primary panel or as a Secondary panel, as part of a Scheduling Panel Group (default = Primary). Primary Configuration With Primary selected, the following Primary Configuration options are presented:
IP/Hostname This read-only field displays the Primary IP/Hostname currently assigned to this panel. Username Password Enter a Username to associate with this panel (required for Primary panels). Enter a Password to associate with this panel (required for Primary panels). Clear Secondary Panels Press to clear any and all members of the Group with which this Primary panel is associated. Secondary Configuration With Secondary selected, the following Secondary Configuration options are presented:
IP/Hostname Username Password Enter the Primary IP/Hostname of the Primary panel for the Group to which this Secondary panel belongs. Enter the Username associated with the Primary panel for this panels Group. Enter the Passwords associated with the Primary panel for this panels Group. Room Use the options in the ROOM pages to set room-level options for this panel VARIA Touch Panels - Configuration & Programming Manual
| TOC 36 Setup Wizard - ROOM page options Room Name Enter the room name as it will appear on this panel. Default Meeting Subject Enter a default meeting subject to be displayed on this panel. Note that this default subject can be over-written in the Room page (see the Editing Meeting Details section on page 71). Support Contact Name Enter the name of the support personnel as it will appear on this panel. Support Contact Phone Enter the phone number of the support personnel as it will appear on this panel. Room Status LED Press to toggle the Room Status LEDs on the panel, which light green when the Room is available, or red when the Room is occupied (default = enabled). Logo Image Indicates the current logo image, if applicable. Press Add to add a custom logo image. Supported Formats: JPG, PNG The custom logo image window is 375 x 165. AMX Book Panels will take the downloaded image and scale it down to fit in the window. However, to maximize the available space, the downloaded logo should have a similar aspect ratio (~2.2). Security Use the options in the SECURITY pages to set security & privacy options for this panel. VARIA Touch Panels - Configuration & Programming Manual
| TOC 37 Setup Wizard - SECURITY page options Require Meeting PIN Code Meeting PIN Code Read Only Mode Privacy Mode Private Meeting Subject When enabled, the PIN code will be required to reserve a meeting, edit Meeting Time/Details and Delete Meeting. Press to enable this option (default = disabled). Enter the 4-digit PIN code that will be required to reserve, edit or delete a meeting on this panel, only if the Require Meeting PIN Code option (above) is enabled. Press to toggle this option (default = disabled). When enabled, all fields on the Room page are displayed, but are read-only. In this case, users will be able to see all meetings and reservation details, but will not be allowed to reserve, edit or delete meetings on this panel. Press to toggle this option (default = disabled). When in Privacy Mode, information considered to be private is hidden and immutable on this panel. See the Privacy Mode section on page 34 for details. Note: If a meeting is booked outside of an AMX Book panel (i.e directly via the scheduling system software), then the subject line of the meeting will be replaced with the Private Meeting Subject text
(default = "Private Meeting"). The default Private Meeting Subject text can be edited if desired (see page 34). Press to enter the text that will be used as the meeting subject displayed for private meetings. The text entered here provides the meeting subject for all types of private meetings:
It will be used when Privacy Mode is enabled on the AMX Book panel. Will be used when a meeting is marked as Private by the calendar server (Exchange/Office 365/Google). Finish Press to exit the Setup Wizard (see Exiting the Scheduling Panel Setup Wizard on page 35). VARIA Touch Panels - Configuration & Programming Manual
| TOC 38 Web Kiosk Overview These are settings available for the Web Kiosk persona. Web Kiosk Settings Default URL JavaScript Allow the kiosk browser to use JavaScript Force Dark Mode Automatically render all web content using a dark theme VARIA Touch Panels - Configuration & Programming Manual
| TOC 39 Advanced Settings Overview TBD About Panel About Panel Firmware Version Displays the panels FW version Device Model Displays the panels model number. Serial Number Displays the specific serial number value assigned to the panel. MAC Address Displays the panel MAC address Resolution Up Time Displays the panels screen width & height in pixels. Displays the time elapsed since the panel was last started. IPv4 Address Displays the panels IP address (v4). IPv6 Address Displays the panels IP address (v6). Memory Storage Licenses Displays the panels used & total memory (RAM). Displays the panels used and total storage (eMMC) Select this entry to open the Legal Information window, which displays information on intellectual property notices and information on copyright concerns. VARIA Touch Panels - Configuration & Programming Manual
| TOC 40 Apps Apps Panel App Displays to panels currently selected Persona, and gives the option to change to a new persona. By pressing [Change], you may choose a new panel persona. Select the desired Persona and press
[Continue]. If you wish to exit without selecting a new persona, press [Cancel] or the [x] button. Clear App Data will clear or preserve (checked or unchecked, respectively) the app data of the current persona, before switching to the new persona. This is helpful if you ever wish to return to the previous persona. VARIA Touch Panels - Configuration & Programming Manual
| TOC 41 Sound Sound Volume Control Displays the current volume level for media, alarm, & notifications. If adjustment is needed, press the
[Change] button. Press or drag your finger across the slider and let go at the desired volume level. A sound will play at that new volume level to confirm loudness. Press the Back arrow [<] to return. Changes the default notification sound on the panel. Default Notification Sound To select a notification sound, press [Change]. VARIA Touch Panels - Configuration & Programming Manual
| TOC 42 Sound Press the Back arrow [<] to return. Note: this is not the Button Hit or Button Miss sound for the AMX G5 Control persona. Button Hit &
Button Miss can be found in G5 Settings. Touch Sounds Displays the specific serial number value assigned to the panel. Display Display Brightness Contains settings for panel brightness & Auto Display Brightness If adjustment is needed, press the respective [Change] button. Press or drag your finger across the slider and let go at the desired brightness level. The panel will react to your changes when you lift your finger. VARIA Touch Panels - Configuration & Programming Manual
| TOC 43 Display Display DIm Screen Timeout When Automatically Adjust Brightness is enabled, the panel will automatically adjust its brightness relative to the light levels in the environment. Press the Back arrow [<] to return. Display dim will lower the brightness level after a period of inactivity. To adjust the time interval before dimming, press [Change]. Select a new time, or select Never to keep the screen at full brightness. Press the Back arrow [<] to return. Screen timeout will turn off the display after a period of inactivity. To adjust the time interval before timeout, press [Change]. Select a new time, or select Never to keep the screen on at all times. VARIA Touch Panels - Configuration & Programming Manual
| TOC 44 Display Font Size Press the Back arrow [<] to return. The font size can be increased or decreased to your desired level. To adjust, press [Change]. Select a new font size from the choices. Press the Back arrow [<] to return. VARIA Touch Panels - Configuration & Programming Manual
| TOC 45 Date & Time Date & Time When enabled, the touch panels date & time will be synced to either the default NTP (Network Time Protocol) server, or a custom NTP server (eg. time.google.com) To enable, turn the radio button ON. For Default NTP, there are no additional settings to enter. The panel will periodically check the NTP server for date & time. A reboot may be required if you want immediate synchronization. If your panels date & time are drastically different than actual, it may take up to 24 hours or more for the correct time to be synchronized. For Custom NTP, select this option and then press [add server]. Sync Date & Time with NTP Server Enter the custom NTP server URL and press [Sync]. VARIA Touch Panels - Configuration & Programming Manual
| TOC 46 Date & Time Date The panel will attempt to connect and list the last successful sync. If you need to change the NTP, press [Change NTP server]. To disable NTP and set the date & time manually, turn the radio button OFF. When using NTP, the Date field is read-only. With NTP disabled, adjust the date by pressing the [Change] button. Use the calendar to select the date, either by using the calendar picker or by selecting the pencil icon to enter the numeric value. To save your changes, press [OK]. To close without saving changes, press [Cancel]. When using NTP, the Time field is read-only. Time With NTP disabled, adjust the date by pressing the [Change] button. VARIA Touch Panels - Configuration & Programming Manual
| TOC 47
1 2 | Users Manual-2 | Users Manual | 5.42 MiB | May 25 2023 / November 22 2023 |
Press the Hours and Minutes fields to numerically enter the time, and appropriately select AM or PM. Or, press the clock icon on the lower-left to switch to the clock picker, and drag the clock hands to the correct hours & minutes, respectively. Then, appropriately select AM or PM. To save your changes, press [OK]. To close without saving changes, press [Cancel]. Date & Time Time Zone Date Format Time Format Network System Security VARIA Touch Panels - Configuration & Programming Manual
| TOC 48 Diagnostics VARIA Touch Panels - Configuration & Programming Manual
| TOC 49 INFO - Device Info The INFO - Device Info page (FIG. 9) displays basic panel information, such as available memory and screen resolution dimensions (read-only). FIG. 9 INFO - Device Info page Device Info page options DEVICE Device IP Displays the panels IP address. Device Number Displays the panels device number. Device Name Device Type Displays the panels device name. Displays the panel model Serial Number Displays the specific serial number value assigned to the panel. Version Displays the current version of the panels firmware. MAC Address Displays the panels MAC address. Bluetooth Address Displays the panels Bluetooth address. Resolution Displays the panels screen height and width in pixels. NETLINX CONTROLLER Controller IP Displays the IP address for the panels Controller. Controller Port Displays the port used by the panels Controller. Controller System Number Displays the Controllers system number. Connection Displays the panels connection status. MEMORY AND FILES Memory File System Displays the amount of memory available on the panel. Displays the amount of MicroSD card memory available on the panel. File Information Displays information on the current main panel page. MISC Up Time Displays the time elapsed since the panel was last started. VARIA Touch Panels - Configuration & Programming Manual
| TOC 50 Legal Information Select this entry to open the Legal Information window, which displays information on intellectual property notices and information on copyright concerns. INFO - Maintenance The INFO - Maintenance page (FIG. 10) provides control of basic panel functions, including rebooting or shutting down the panel. FIG. 10 Maintenance page INFO - Maintenance page options Reboot:
Shutdown:
Select this entry to open the Reboot window.. Select this entry to open the Shutdown window Rebooting the Panel 1. In the Maintenance page, select Reboot. This opens the Reboot window (FIG. 11). FIG. 11 Reboot window 2. Press OK to reboot. Shutting Down the Panel 1. In the Maintenance page. select Shutdown. This opens the Shutdown window (FIG. 12):
FIG. 12 Shutdown window 2. Press OK to shut down the panel. DEVICE - Storage NOTE: The DEVICE pages are all password-protected. The default password is 1988. The Storage page (FIG. 13) provides access to data stored on the panel including applications, pictures, audio files, and other files. This page also displays files accessible via connected USB storage devices, such as from hard drives or thumb drives. VARIA Touch Panels - Configuration & Programming Manual
| TOC 51 Scroll down to see all menu items Storage page options INTERNAL STORAGE Internal Storage Total Space Available This graph displays how much internal storage is being used compared to what is available, and which file categories are using that storage. Note that this graph is color-coded to indicate how much storage is being The total amount of storage space on the panel. The total amount of storage that may be used for apps and other files on the panel. Apps (app data & media content) The total amount of storage currently being used for apps and related files on the panel. Note that Apps are installed via TPDesign5, and cannot be added or removed via the panel. Pictures, Videos The total amount of storage currently being used for picture and video files on the panel Audio (music, ringtones, podcasts, etc.) The total amount of storage currently being used for audio files (such as music, ring tones, and podcasts) on the panel. Select this entry to open the Choose Music Track window. See the Internal Storage:
Audio section on page 27 for details Downloads Cached Data USB STORAGE The total amount of storage currently being used for downloaded files (such as text files or spreadsheets) on the panel. Select this entry to open the Downloads window. See the Internal Storage: Downloads section on page 27 for details. The total amount of storage currently being used for cached data on the panel. Select this entry to clear the cache. See the Internal Storage: Cached Data section on page 27 for details. Mount USB Storage This option only appears if no USB data storage is connected to the panel. USB Storage Graph This graph displays the total used storage in a connected USB storage device versus the total amount available. This graph only appears if a USB storage device is connected to the panel. Total Space Available The total amount of used storage on the connected USB storage device. The total amount of available storage on the connected USB storage device. Unmount Shared Storage Select this option to allow safe removal of any USB data storage device connected to the panel. Internal Storage: Downloads From the Storage page, select Downloads to display all files downloaded to the panel. This opens the Downloads window. Select a downloaded file in the window to open it. To close the Downloads window, touch the display screen anywhere outside of the window. Internal Storage: Cached Data Under Internal Storage, the Cached Data option indicates the amount of data currently in the panels memory cache for all applications. To clear the cache, press Cached Data. The panel will prompt you to verify this action before clearing the cache (FIG. 15):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 52 FIG. 15 Clear Cached Data prompt Select Cancel to return to the Storage page, or select OK to clear the cached data for all applications on the panel. USB Storage In addition to its internal storage capabilities, G5 panels also have the ability to access files in USB-enabled external storage options, such as thumb drives and external hard drives. The status of USB storage is indicated in the USB STORAGE section of the Storage page. If no USB storage option is connected to the panel, this section will read Insert USB storage for mounting. If a USB storage option is connected to the panel, the USB Storage section will display the panels total used space and total available space, as well as give the option to unmount the storage device (FIG. 16). FIG. 16 USB Storage Unmounting a USB Storage Device To launch Telnet Window, 1. On the Storage page, select the Unmount Shared Storage option . 2. This opens the Unmount USB storage? window (FIG. 16):
FIG. 17 Unmount USB Storage prompt 3. Select OK to unmount the storage device (or Cancel to return to the Storage page). If the storage device has been unmounted from the panel but is still physically connected, the only option in the USB Storage section will be Mount USB storage. Press this option to remount the storage device to the panel. DEVICE - Sound The Sound page (FIG. 18) allows adjustment of volume levels and panel sounds settings. Scroll down to see all menu item FIG. 18 DEVICE - Sound page Storage page options VARIA Touch Panels - Configuration & Programming Manual
| TOC 53 Volumes Press to open the Volumes window, which provides options to adjust volume for Music, video, games and other media as well as Notifications and Alarms. See the Adjusting Volumes section on page 29 for details. DEVICE SOUNDS Button Hit Sound Button Miss Sound Displays the information on the sound file associated with the Button Hit Sound function. See the Selecting Device Sounds section on page 30 for details. Displays the information on the sound file associated with the Button Miss Sound function. See the Selecting Device Sounds section on page 30 for details. Play Test Select this entry to test the audio output by playing a preselected sound. Smart Card Sound Select Select to choose a sound to associated with the smart card action from the menu provided (default = none). See Selecting a Default Notification Sound section on page 31. SYSTEM SOUNDS Touch Sounds Select this entry to enable a notification sound every time the panel display is touched. Default Notification Sound:
Select this entry to choose a default notification sound from the menu provided. See Selecting a Default Notification Sound section on page 31. Audio:
Displays the current audio options. The current and only option is Internal Audio. VARIA Touch Panels - Configuration & Programming Manual
| TOC 54 Adjusting Volumes 1. In the Sound page, select the Volume Varia (FIG. 20) to open the Music Volumes control window (FIG. 21 on page 30):
FIG. 20 DEVICE - Sound page - Volume Control Varia 2. 3. This opens the Music Volume control. Use this slider to adjust the volume for music tracks. To mute music playback, move the slider all the way to the left. In this case, the volume Varia on the Music Volume control will indicate Muted. Press the Varia on the right side of the Music Volume control to open the System Volumes control. Use these volume controls to adjust all of the available volume controls on the panel (FIG. 21):
FIG. 21Music Volume control and System Volumes control To adjust the panels media volume, slide the Music/media slide bar pointer to your preferred level. To mute the panel, move the slidebar pointer all the way to the left. The speaker Varia on the left of the slidebar will indicate that the panel is muted. To adjust the volume of notifications, slide the Notifications slide bar pointer to your preferred level. If the Music/media slide bar is set to mute, the Notifications slide bar will also be muted. To adjust the volume of alarms, slide the Alarms slide bar pointer to your preferred level. The Alarms volume will NOT be muted if the other slide bars are set to mute. Selecting Device Sounds Use the options under DEVICE SOUNDS in the Sound Settings page to select a particular sound to coincide with a button being pressed in a panel page (FIG. 22):
FIG. 22 Device Sounds - Button Hit Sound / Button Miss Sound Selection 1. In the Sound page:
Select Button Hit Sound to select a sound to coincide with a button being pressed via the Button Hit Sound window. Select Button Miss Sound to select a sound to coincide with a button being missed via the Button Miss Sound window. Press Play Test to play a sample sound file to test the volume setting. Select Smart Card Sound Select to select a sound to coincide with a Smart Card being detected by the panel via the Smart Card Sound Select window. VARIA Touch Panels - Configuration & Programming Manual
| TOC 55 FIG. 23 Device Sounds - Smart Card Sound Select 1. Choose a sound from the presented list: selecting a new sound will play it once. The sound will only be audible if the Media slide bar in Volumes is not muted. 2. Once you select the preferred sound, press OK to save it. The sounds name will now appear under the category in the Sound page. 3. To the Sound page without making any changes, press Cancel. Selecting a Default Notification Sound To select a particular sound to be the default notification sound for all panel functions:
4. 5. 6. In the Sound page, under SYSTEM SOUNDS, enable the Touch Sounds option. Select Default notification sound. This opens the Default notification sound window. Choose a sound from the presented list: selecting a new sound will play it once. The sound will only be audible if the Notifications slide bar in Volumes is not muted. 7. Once you select the preferred sound, press OK to save it. If you wish to return to the Sound page without making any changes, press Cancel. DEVICE - Display The Display page (FIG. 24) controls the basic functions of the panel display, including the panel brightness. FIG. 24 DEVICE - Display page Display page options Brightness:
Sets the display brightness and contrast levels of the panel. See Adjusting Panel Brightness on page 31 for details. Display Timeout:
Indicates the length of time that the panel can remain idle before the display automatically powers down. Select the Display Timeout setting. Range = 15, 30 seconds, 1, 5, 10, 30 minutes, 1, 2 hours. Set the timeout value to None to disable Display Timeout mode. See the Adjusting Display Timeout on page 32 for details. Font Size:
Sets the size of the font used in the Settings menu. See Selecting the Font Size on page 32 for details. Calibration Test:
Select this to open the Calibration Test page. See Calibration Test on page 32 for details. VARIA Touch Panels - Configuration & Programming Manual
| TOC 56 Adjusting Panel Brightness In the Display page, select Brightness to open the Brightness window (FIG. 25). FIG. 25 Brightness window Use the slidebar for manual adjustment of the panels display brightness. Select Automatic brightness to make automatic adjustments to brightness based on ambient light in the vicinity. Press OK to save changes and close this window (or select Cancel to return to the Display page without saving any changes). Adjusting Display Timeout In the Display page, select Display Timeout to open the Display Timeout window (FIG. 26). FIG. 26 Display Timeout menu Select the time period that will pass before the panel enters sleep mode, or select None to keep the panel from shutting down its display. The default settings is 30 Minutes. Press OK to save changes and close this window (or select Cancel to return to the Display page without saving any changes). Selecting the Font Size In the Display page, select Font size to open the Font Size window (FIG. 27). FIG. 27 Font Size menu Select the desired size for the font used in the Settings menu via this window. The default setting is Normal. Changing this setting requires re-entry of the password in order to confirm your changes. If you wish to return to the Display page without saving any changes, select Cancel at the bottom of the window. DEVICE - G5 Settings The G5 Settings page (FIG. 30) controls both the panels transmission of page flip tracking to the Controller and the panels activeduration before going into Sleep mode. VARIA Touch Panels - Configuration & Programming Manual
| TOC 57 G5 Settings page options Page Tracking Press to enable or disable the panel sending page flip tracking to the Controller. Default = disabled. Function Show Press to display the address, channel, and level information associated with each button on the panel. Default =
disabled. Verbose File Diagnostics Press to display file error dialogs any time the panel encounters a problematic file. Default = disabled. REMOTE PROFILE Remote Profile Remote URL INACTIVITY Inactivity:
Press On to enable Remote Profiles. Note that turning Remote Profiles On enables the Remote URL option (see note below). Enter the URL of the desired remote profile: press this field to access an on-screen keyboard. Refer to Setting a Remote Profile section on page 33 for details. Select this to open the Inactivity window and control the maximum time the panel will remain inactive before going into Sleep mode. Refer to Setting an Inactivity Time Period and Page Flip section on page 34 for details. Inactivity Page:
Lists the TPDesign5 page displayed when the panel goes to sleep. Refer to Setting an Inactivity Time Period and Page Flip section on page 34 for details. PASSWORD PROTECTION Password 1-4 HTTPS CLIENT These options provide the option of assigning passwords to the secured Settings pages. Refer to Setting Password Protection section on page 34 for details. Validate HTTPS Server Certificate Press to enable or disable the validation of HTTPS server certificate while negotiating the connection. Default =
disabled. Verify HTTPS Server Hostname Press to enable or disable the verification of the HTTPS Server hostname. Note that this option is available only if the Validate HTTPS Server Certificate option is selected. Default = disabled. Setting a Remote Profile NOTE: Enabling a Remote Profile will cause the panel to ignore and TP5 file that has been transferred to the panel. It will only open the TP5 file set in the Remote URL. 1. In the G5 Settings page, press Remote Profile to toggle the option ON. 1. 2. b Press Remote URL to enter the URL of the remote profile to use via the on-screen keyboard (FIG. 31) VARIA Touch Panels - Configuration & Programming Manual
| TOC 58 FIG. 31 Remote URL window 3. Press OK to save changes and close this window. Setting an Inactivity Time Period and Page Flip 1. In the G5 Settings page, press Inactivity to open the Inactivity window (FIG. 32):
FIG. 32 Inactivity window 2. Select the amount time that will be allowed to pass before the panel enters into sleep mode. Select Off to disable the inactivitytimer. The default setting is 1 hour. Setting Password Protection The options under PASSWORD PROTECTION provide the ability to assign alphanumeric values to particular password sets (FIG. 33):
FIG. 33 G5 Settings page - PASSWORD PROTECTION options (Password 1-4) 1. In the G5 Settings page, under PASSWORD PROTECTION, press Password 1 to open the Password 1 window to enter a new alphanumeric password via the on-screen keyboard (FIG. 34):
FIG. 34 Password 1 window 2. 3. Press OK to save changes (or press Cancel to close this window without saving changes). Press Password 2, Password 3 and Password 4 to set Passwords 2-4 (press OK to save each). Active Video Windows - Limitations The term Active Video Windows refers to any window on the touch panel (which could be a Page, Popup, Sub-Page or Button) that is displaying active video content. VARIA Touch Panels - Configuration & Programming Manual
| TOC 59 Maximum supported number of active video windows displayed simultaneously on the panel: 2 While this limitation is not enforced (i.e the TPDesign5 application will allow you include any number of video windows in the panel design), attempting to display more than two active video windows at one time may have a negative impact on the panels overall performance. Maximum supported resolution for video windows: 720dpi Maximum supported frame rate for video windows: 30fps DEVICE - Sensors The Sensors page (FIG. 38) allows activation and optimization of the panels motion and light sensors. Sensors page options Motion Detection sensor channel is on. The blue bar within the slide bar shows the current motion sensor reading. The slide bar sets the motion sensor threshold.The threshold controls when a motion The walk Varia shows bars on either side when the threshold is crossed (FIG.38). Wake on Motion Sense:
Press this checkbox to wake up the panel if any motion detected crosses the threshold set by the Motion Detection slide bar. Wake on Motion Test:
Light Sensor Level Value This selection only be enabled if Wake Panel On Motion Sense is enabled. Pressing the test button will initiate a test mode where the display will go to sleep and wait for motion to turn it on. It can be used to test your current Motion Detection threshold value. The blue bar within the slide bar displays the current light sensor reading. The slide bar indicates the light sensor threshold. The threshold controls when a Light Sensor Channel Code press will be generated. Light Sensor Calibration:
Press to perform a calibration on the light sensor. See the Calibrating the Light Sensor section on page 36 for details. Light Sensor Level Port:
Displays the current level port being used by the light sensor (read-only). Default = 1. Light Sensor Level Number:
Displays the current level being used by the light sensor (read-only). Default = 0. Light Sensor Channel Port:
Displays the current channel port being used by the light sensor (read-only). Default = 1. Light Sensor Channel Number:
Displays the current channel being used by the light sensor (read-only). Default = 0. Motion Sensor Channel Port:
Displays the current channel port being used by the motion sensor (read-only). Default = 1. Motion Sensor Channel Number:
Displays the current channel being used by the motion sensor (read-only). Default = 0. Sensor Version:
Displays the current sensor version (read-only). NOTE: Light and motion sensor ports, levels, and channels are configured in TPDesign 5. For more information on configuring light and motion sensors, please refer to the TPDesign 5 Operation/Reference Guide, available at www.amx.com. Calibrating the Light Sensor When the panel is installed for the first time, the light sensor should be calibrated to the rooms maximum ambient light condition. This calibration setting will be saved until the panels system settings are reset. VARIA Touch Panels - Configuration & Programming Manual
| TOC 60 To calibrate the light sensor from the Settings pages:
1. 2. From the Sensor Settings page, press Light Sensor Calibration. Allow the panel 10 seconds to calibrate the rooms ambient light level. The indicator next to the button will show a rotating circle while calibration is in progress. DEVICE - VNC An on-board VNC (Virtual Network Computing) server allows the panel to connect to any remote PC running a VNC client. Once connected, the client can view and control the panel remotely. The options on the VNC page (FIG. 39) allow you to enable or disable VNC server functionality on the panel. FIG. 39 VNC page VNC page options Enable/Disable:
The Enable/Disable button toggles between the two VNC settings:
Disable- deactivates the VNC server on the panel. Enable - activates the VNC server on the panel (default setting). Timeout:
Sets the length of time (in minutes) that the panel can remain idle, detecting no cursor movements, before the VNC session is terminated. (default = 15 minutes). Password:
Enter the VNC Authentication session password required for VNC access to the panel. Port:
Use this field to enter the number of the port used by the VNC Web Server. Note that this field is enabled only while VNC is disabled (default = 5900). Current Connections:
Displays the number of users currently connected to this panel via VNC (read-only). Maximum Connections:
Displays the maximum number of users that can be simultaneously connected to this panel via VNC. Press this field to increase the number allowed to connect to this panel. (default = 2). NOTE: The VNC server takes snapshots of the display buffer and sends them via VNC at a low frame rate Enabling VNC In the VNC page, press Enable/Disable to toggle VNC to ON (the default setting is OFF). Configuring VNC Access In the VNC page, use the options under VNC SERVER to configure various aspects of VNC access on the panel:
Press Timeout to specify a timeout period for VNC connections, in the Timeout window. Press OK to save changes Press Password to assign the password to be required to establish a VNC connection, in the Password window. By default, no VNC password is set. Press OK to save changes. Press Port to specify the port to be used by the VNC Web Server, in the Port window. This option is not available if VNC is currently enabled. Press OK to save changes. Press Maximum Connections to set the maximum number of users that can be simultaneously connected to this panel via VNC. Press OK to save changes VARIA Touch Panels - Configuration & Programming Manual
| TOC 61 CONNECTIONS - Ethernet The Ethernet page (FIG. 52) controls the configuration of settings for Ethernet communication with the panel. to see all Scroll down menu items FIG. 52 Ethernet page Ethernet page - IPV4 tab options DHCP/Static:
Sets the panel to either DHCP or Static communication modes. Connection fields are disabled (see below). Connection fields are enabled. DHCP is an IP Address assigned to the panel by a DHCP server. If DHCP is selected, the other Network Static IP is a permanent IP Address assigned to the panel. If Static IP is selected, the other Network IP Address:
Displays the IP address for this panel. If DHCP is enabled, this field will be disabled. Subnet Mask:
Displays the subnetwork for this panel. If DHCP is enabled, this field will be disabled Gateway:
Displays the gateway address for this panel. If DHCP is enabled, this field will be disabled. Hostname:
Displays the hostname for this panel. Domain:
Displays a name to the panel for DNS look-up. If DHCP is enabled, this field will be disabled. Primary DNS:
Displays the address of the primary DNS server used by this panel for host name lookups. If DHCP is enabled, this field will be disabled. Secondary DNS:
Displays the secondary DNS address for this panel. If DHCP is enabled, this field will be disabled. MAC Address:
This unique address identifies the Ethernet connection in the panel (read-only). 802.1x Security Displays the current state (disabled or enabled) of 8021.x security (default = disabled). Press to set enable and configure 802.1x security on the panel via the 802.x1 Security dialog (see page 46). Ethernet page - IPV6 tab options IPv6 Support When enabled, the panel will attempt to connect via IPv6 (default = OFF). To enable IPv6 support on this panel, press to toggle this setting to ON. Note that when IPv6 Support is On, the following fields are enabled for editing:
Static IPv6 Address Specifies the static IPv6 address for this panel. VARIA Touch Panels - Configuration & Programming Manual
| TOC 62 Static IPv6 Subnet Prefix Length Static IPv6 Gateway Link Local IP Address:
Neighbor Discovery IP Address:
Discovered IPv6 Gateway:
Specifies the Static IPv6 Subnet Prefix Length for this panel. Specifies the Static IPv6 Gateway address for this panel. Displays the Link Local IP address for this panel, if one exists (read-only). Displays the Neighbor Discovery IP address for this panel (read-only). Displays the Discovered IPv6 gateway for this panel (read-only). Hostname:
Displays the hostname for this panel. Domain:
Displays a name to the panel for DNS look-up. Primary DNS:
Displays the address of the primary DNS server used by this panel for host name lookups. Ethernet page - IPV6 tab options (Cont.) Secondary DNS:
Displays the secondary DNS address for this panel. MAC Address:
This unique address identifies the Ethernet connection in the panel (read-only). 802.1x Security Displays the current state (disabled or enabled) of 802.1x security (default = disabled). Press to set enable and configure 802.1x security on the panel via the 802.x1 Security dialog (see page 46). Setting Static IP Information (IPv4) When using DHCP settings for a panel, the DHCP server will automatically populate almost all of the Ethernet page fields, with the exception of Hostname. When setting the panel for Static, however, all IP address information must be entered manually:a calibration test on the touch panel:
1. Press DHCP/Static to access the DHCP/Static options window (FIG. 53):
FIG. 53 DHCP/Static window 2. Press Static to open the Static IP (IPv4) window (FIG. 54). FIG. 54 Static IP (IPv4) window 3. 4. Press any field in this window to open the on-screen keypad or keyboard. Enter IP address information for each field presented, via the Static IP window. 5. When complete, press OK to save changes and return to the Ethernet page - IPV4 tab (FIG. 55):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 63 FIG. 55 Ethernet page (IPV4 tab) - indicating Static IP connection information Entering a New Hostname (IPv4/DHCP only) In order to facilitate DNS lookup of the panel, you should set a new hostname for the panel. To add a new hostname, or to changean existing one:
1. From the Ethernet page (IPv4 tab), select Hostname to open the Hostname window (FIG. 56). FIG. 56 Hostname window 2. Enter the new hostname and press OK. The new hostname will now appear in the Hostname field. Setting IPv6 Information When using IPv6 network addressing for a panel, IPv6 support must be enabled on the panel, and all IP address information must be entered manually:
1. In the Ethernet page, open the IPV6 tab (FIG. 57):
FIG. 57 Ethernet page - IPV6 tab 2. Toggle the IPv6 Support option ON. Note that this enables the other fields for editing (FIG. 58): :
VARIA Touch Panels - Configuration & Programming Manual
| TOC 64 FIG. 58 Ethernet page - IPV6 tab (IPv6 support enabled) 3. Press the Static IPv6 Address field to set the static IP address for this panel, via the Static IP window (FIG. 59):
FIG. 59 Static IP (IPv6) window 4. Press Static IPv6 Address to enter this information via the on-screen keypad or keyboard. Press OK to save changes and return to the Ethernet page (IPV6 tab). 5. Repeat for the Static IPv6 Subnet Prefix Length, Static IPv6 Gateway, Hostname, Domain, Primary and Secondary DNS fields. 6. When complete, press OK to save changes and return to the Ethernet page - IPV6 tab (FIG. 60):
FIG. 60 Ethernet page (IPV6 tab) Working With 802.1x Security Use the 802.1x Security option in the Ethernet page (both tabs) to enable and configure 802.1x security settings on this panel:
1. From the Ethernet page (either tab), select 802.1x Security to open the 802.1x Security window (FIG. 61). VARIA Touch Panels - Configuration & Programming Manual
| TOC 65 FIG. 61 802.1x Security window (OFF) 2. 3. 4. 5. 6. Toggle this feature ON to enable the editable fields in this window (FIG. 62):
Press User certificate to select a user certificate to use for 802.1x access. Press User certificate to select a user certificate to use for 802.1x access Press the Identity and Password fields to enter the appropriate Identity and Password for 802.1x access via the on-screen keyboard. Press OK to save changes and return to the Ethernet page. FIG. 62 802.1x Security window (ON) CONNECTIONS - Smart Card The Smart Card page enables Smart Card functionality on the panel, and provides access to the PIV Authentication Certificate and CHUID associated with the Smart Card reader (FIG. 75). FIG. 75 Smart Card page Smart Card page options Enable/Disable:
Press to toggle the smart card service on this panel (default = OFF). Reader Name This read-only field displays the name of the attached smart card reader, if a reader is attached and enabled. VARIA Touch Panels - Configuration & Programming Manual
| TOC 66 Read PIV Authenticate Certificate Press to read and display the PIV Authentication Certificate of the smart card. Read CHUID Verify PIN Press to read and display the CHUID from the smart card. Press to require the entry of a valid PIN for the smart card. SYSTEM - Date & Time The Date & Time page (FIG. 78) allows setting and adjusting the time and date information on the panel FIG. 78 Date & Time page Date & Time page options Automatic Date & Time:
When checked, the panel retrieves time/date information from a network time server (NTP). Default = Enabled. Set network time server:
Press this option to specify the IP address/name of a custom NTP if desired. Set Date:
Set Time:
Use the Set Date window (FIG. 79) to set the current day, month, and year. Use the Set Time window (FIG. 79) to select the current time. Select Time Zone:
Use the Select Time Zone window (FIG. 82) to select the current time zone. Use 24-Hour Format:
When checked, this option always displays the time in 24-hour format. Choose Date Format:
Use the Choose Date Format window (FIG. 83) to select the desired date format. The current date and time may be retrieved from NTP or it may be updated manually. Retrieving the Date and Time From NTP 1. In the Date & Time page, press Automatic Date & Time. Note that this option is selected by default. 2. Make sure that the checkbox is selected. 3. The date and time will be updated automatically by NTP. Manually Setting the Date and Time 1. If Automatic Date & Time is enabled, de-select the field to disable it. 2. Press Set Date to open the Set Date window (FIG. 79). VARIA Touch Panels - Configuration & Programming Manual
| TOC 67 FIG. 79 Set Date and Set Time windows 3. Select the date, either by pressing and dragging on the fields on the left or by pressing the date in the calendar. 4. Press Set Time to open the Set Time window 5. Select the time by pressing and dragging on the fields in the center. 6. Press Done to save changes and close this window. Specifying a Network Time Server If Automatic Date & Time is enabled, the network time server used can be specified via the Set network time server option:
1. Press Set network time server to open the Set network time server window (FIG. 80):
FIG. 80 Set network time server window 2. Press Custom to open the NTP Server window (FIG. 81):
FIG. 81 NTP Server window 3. 4. Enter the IP address/name of the time server to use. Press OK to save changes and close this window Manually Setting the Time Zone 1. Press Select Time Zone to open the Select Time Zone window (FIG. 82). Scroll down menu items FIG. 82 Select Time Zone window 2. Select the time zone desired. The window will automatically close and return to the Date & Time page. Specifying a Date Format 1. Press Choose Date Format to open the Choose date format window (FIG. 83). VARIA Touch Panels - Configuration & Programming Manual
| TOC 68 FIG. 83 Choose Date Format window 2. Select the desired date format. The window will automatically close and return to the Date & Time page. SYSTEM - Language & Input The Language & Input page (FIG. 84) controls the language used by the Settings menu, as well as the keyboard input used for Settings menu field entries. Language & Input page options Language:
Select a language for the Settings menu. See Selecting the Panels Language on page 57 for details. Spell Checker:
Enable this option to include an automatic spell checker in all Settings menu fields. Personal Dictionary:
Lists all words saved in the panels personal dictionary file. See Personal Dictionary on page 58 for details. KEYBOARD & INPUT METHODS Default:
System Keyboard:
PHYSICAL KEYBOARD Specify the default system keyboard. Refer to Changing Input Methods on page 58 for details. Choose the keyboard matching the selected panel language, or another language-format keyboard. Refer to Changing Input Methods on page 58 for details. Generic:
Selects the format for a physical keyboard connected to the panel. Auto-Replace:
Select this for automatic correction of commonly mistyped words. Auto-Capitalization:
Select this for automatic capitalization of the first word in a sentence. Auto-Punctuate:
Select this for automatic addition of a period when the space key is pressed twice. MOUSE/TRACKPAD Pointer Speed:
Provides the ability to adjust the speed of the cursor on the panel. Refer to Changing the Pointer Speed on page 60 for details. Changing Input Methods While a standard English keyboard is the default input language, you may also change the input method, such as choosing a Dvorak keyboard. To change the keyboard layout:
4. In the Language & Input page, under KEYBOARD & INPUT METHODS, press Default to open the Choose Input Method window (FIG. 87):
FIG. 87 Choose Input Method window 5. Press Set up input methods to open the Keyboard Options window (FIG. 88). VARIA Touch Panels - Configuration & Programming Manual
| TOC 69
1 2 | Users Manual-3 | Users Manual | 5.49 MiB | May 25 2023 / November 22 2023 |
FIG. 88 Keyboard Options window 3. Press the Settings Varia next to System keyboard to access the System Keyboard Settings page (FIG. 89):
FIG. 89 System Keyboard Settings page 4. 5. Edit these settings as desired, and press the return Varia to close this page and return to the Keyboard Options window. Under PHYSICAL KEYBOARD, press Generic to open the Choose Keyboard Layout window (FIG. 90):
FIG. 90 Choose Keyboard Layout window 6. Press Set up keyboard layouts to open the Keyboard Layout window (FIG. 91):
FIG. 91 Keyboard Layout window 7. 8. Select the keyboard layouts that should be available for selection. Press the return Varia to close the Keyboard Layouts window and open the Choose Keyboard Layout window (FIG. 92):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 70 FIG. 92 Keyboard Layout window 9. Select the desired layout. SYSTEM - Security G5 Panels support two security modes: Standard and High Security:
Standard is wide open and lets the administrator decide what is enabled/disabled. High Security is targeted at max security installations. In High Security mode, everything that could be a remote threat is disabled and cannot be turned on. The Security page (FIG. 94) controls panel security, such as front button access, security mode and password settings. FIG. 94 Security page Security page options SECURITY PROFILE Enforce High Security Profile:
Click to enable the high security profile on this panel. The panel will alert you if the current password does not meet the requirements for the currently selected Password Complexity setting (see Password Complexity below). Note: If this option is switched from High Security back to standard security mode, all of the security values are set to default EXCEPT the password. The password remains unchanged from the complex password. Security page options (Cont.) PROTECTED ACCESS Configuration Protected:
Select this checkbox to protect the pages within the Settings menu from access without a password. By default, this option is selected. If the setting is selected, then a password will be required to access the Settings pages except Device Info and Maintenance. If this option is not selected, then there is no password protection on the panel, and all Settings pages are accessible to users. VARIA Touch Panels - Configuration & Programming Manual
| TOC 71 Front Button Access:
Select this checkbox to enable or disable the ability to access the pages within the Settings menu from the Sleep/Settings button (FIG. 6). Note: If Sleep/Settings button access is disabled, the Settings menu can be accessed through the splash page, as shown in the Accessing the Settings Menu section on page 20. The Settings menu may also be accessed via send command or a preconfigured setup button on panel pages. PASSWORDS Make Passwords Visible:
Password Complexity:
Select this option to allow you to see the number of characters in a password, and to see, briefly, the character just typed in clear text for verification. If this option is not selected, then characters are not displayed in the password text input field Select this option to set the level of Password Complexity to either STANDARD or HIGH (via the Password Complexity dialog:
STANDARD - There are no complexity rules for a STANDARD complexity password. In this case, the password can be any length, including empty, and there are no minimum requirements for characters in the password. HIGH - HIGH complexity passwords must contain at least 15 characters such that: The password must contain at least one uppercase alphabetic character. The password must contain at least one lowercase alphabetic character. The password must contain at least one numeric character. The password must contain at least one special character. The password must not contain more than three consecutive repeating characters. Note: If the current password does not meet the high complexity password requirements, when this option is selected the panel will prompt you to change the current password to one that does meet the high complexity requirements. Set Password:
Select this option to open the Enter Password window (FIG. 101). DEVICE ADMINISTRATION The Device Administration options are only available if the panel is in standard security mode. When the Enforce High Security Profile option is selected, Microphone, and Bluetooth functionality is forced OFF, forced disabled, and the these functions cannot be toggled on until the panel is returned to standard security mode. Enable Microphone Enable Bluetooth If this switch is on, then the internal microphone is enabled. If the switch is off, then the internal microphone is disabled. If the panel is in Standard Security mode, the Enable Microphone option can be enabled/disabled. In High Security mode, the microphone is automatically disabled If this switch is on, then the Bluetooth subsystem is enabled. If the switch is off, the Bluetooth subsystem is disabled: this switch mimics the Bluetooth switch under Connections in the Settings menu. If the panel is in Standard Security mode, the Enable Bluetooth option can be enabled/ disabled. In High Security mode, Bluetooth functionality is automatically disabled. USB Security This field displays the current level of USB security applied to this panel (default = Enable All). Press to change this setting via the USB Security Options window. See Changing USB Security Settings on page 64. Security page options (Cont.) SYSTEM SERVICES SYSTEM SERVICES The System Services options are only available if the panel is in standard security mode. When the Enforce High Security Profile option is elected, VNC, SIP, Content Sharing and Update Manager Web Services functionality is forced OFF, forced disabled, and the these functions cannot be toggled on until the panel is returned to standard security mode. Note: SSH is unchanged in High Security Mode. It is the only system service that can remain enabled in High Security Mode. VNC Server SIP Connections If this switch is on, the VNC Server is enabled. If the switch is off, the VNC Server is disabled: this switch mimics the Enable/Disable switch on the DEVICE - VNC page (see page 37). If the panel is in Standard Security mode, the VNC Server option can be enabled/disabled. In High Security mode, VNC functionality is automatically disabled. If this switch is on, the SIP client subsystem is enabled. If the switch is off, the SIP client subsystem is disabled:
this switch mimics the Enable/Disable switch on the DEVICE - SIP page (see page 41). If the panel is in Standard Security mode, the SIP Connections option can be enabled/disabled. In High Security mode,SIP functionality is automatically disabled. VARIA Touch Panels - Configuration & Programming Manual
| TOC 72 SSH Connections Content Sharing Sender Update Manager Web Services If this switch is on, the SSH Server is enabled. If the switch is off, the SSH Server is disabled: this switch mimics the SSH switch on the SYSTEM - Diagnostics page (see page 77). The SSH Connections option can be enabled/disabled in both Standard and High Security modes (not automatically disabled when the panel is placed in High Security mode) If this switch is on, the Content Sharing Sender subsystem is enabled. If the switch is off, the Content Sharing Sender is disabled: this switch mimics the Enable switch on the DEVICE - Content Sharing page
(see page 38). If the panel is in Standard Security mode, the Content Sharing Sender option can be enabled/disabled. In High Security mode, Content Sharing is automatically disabled. If this switch is on, the Update Manager will attempt to connect to the Update Manager Server
(hosted on amx.com). If the switch is off, then the Update Manager will not attempt to connect to the Update Manager Server: this switch mimics the Web Services switch on the Reset and Update page (see page 66). If the panel is in Standard Security mode, the Update Manager Web Services option can be enabled/disabled. In High Security mode, Update Manager Web Services functionality is automatically disabled. Audit Logging If this switch is on, audit logging to the NetLinx Controller syslog client is performed over ICSP (default = OFF). APPLICATIONS Allow only SECURE applications to be installed CREDENTIAL STORAGE If the panel is in Standard Security mode, select this option to allow only secure applications to be installed on this panel. In High Security mode, this option is automatically selected. Note: Applications are considered to be non-secure if they permit access to the web or to a file system. When this option is selected (or when the panel is High Security mode), non-secure applications will automatically be disabled and/or uninstalled:
All non-secure user installed applications are uninstalled All non-secure pre-installed applications are disabled Trusted Credentials Press to display a listing of the trusted certificates currently saved on this panel (see page 65). Install from storage Press to install certificates from an attached USB drive (see page 65). Clear credentials Press to remove all certificates that have been installed on th is panel (see page 66). DEFAULT SECURITY SYSTEMS Restore Default System Security Settings This option restores the default system security settings:
When this option is selected, all Security settings are returned to the default (Standard) security values and the password is changed to the default 1988. Placing the Panel in High Security Mode G5 Panels support two security modes: Standard and High Security:
Standard Security mode is the default mode - it requires a password to access the Settings pages, except Device Info and Maintenance. The default password is 1988. High Security mode is enabled via the Enforce High Security Mode option at the top of the Security Settings page - it also requires a password to access the Settings pages. However, there are specific complexity requirements that must be met for the password. To place the panel in High Security Mode:
1. On the SYSTEM > Security Settings page, toggle the Enforce High Security Profile option to ON (FIG. 95): . FIG. 95 SECURITY PROFILE - Enforce High Security Profile option 2. The panel will alert you to the fact that enabling the High Security profile will disable several system services, and that the password may need to be changed. Press Yes to proceed (FIG. 96): . VARIA Touch Panels - Configuration & Programming Manual
| TOC 73 FIG. 96 Enable High Security Profile dialog NOTE: In High Security mode, all System Services except SSH are automatically disabled, and cannot be enabled unless the security mode is changed back to Standard. Refer to the Storage page options section on page 26 (SYSTEM SERVICES section) for details. 3. The panel will prompt you to create a new password that meets the minimum complexity requirements for High Security mode (FIG. 97): . FIG. 97 Update Password dialog 4. Press OK to invoke the Enter Password window (FIG. 98): . FIG. 98 Enter Password window 5. Press the Enter Password field to invoke the on-screen keyboard, and enter a new password that meets the minimum complexity requirements for High Security mode:
The password must contain at least one uppercase alphabetic character. The password must contain at least one lowercase alphabetic character. The password must contain at least one numeric character. The password must contain at least one special character. The password must not contain more than three consecutive repeating characters. 6. Press the Enter Password Again field to invoke the on-screen keyboard, and re-enter the new password. Press OK to save the new password and close this window. At this point, the panel has been put into High Security Mode. Note that the DEVICE ADMINISTRATION and SYSTEM SERVICES options (expect for SSH Connections) are disabled. These options are only available in Standard Security Mode. Switching From High Security Mode to Standard Security Mode To return a panel that is in High Security Mode to Standard Security mode:
1. Press the Enforce High Security Mode option to toggle it from ON to OFF (FIG. 99):
FIG. 99 SECURITY PROFILE 2. The panel will alert you to the fact that disabling the High Security profile will reset several system services to their default values, and that the password will not be changed. Press Yes to proceed (FIG. 100): . VARIA Touch Panels - Configuration & Programming Manual
| TOC 74 FIG. 100 Disable High Security Profile dialog The panel is now in Standard Security Mode. NOTE: Switching from High Security mode to Standard Security mode does not automatically change the Password Complexity setting, or reset the current password. Therefore, when the panel is switched from High to Standard Security, the High Complexity password is still required, until a new password is set. To set a new password with Standard complexity, select STANDARD in the Password Complexity field. Then, you can use the Set Password option to set a new password without complex password requirements. Changing the Password 1. In the Security page, select Set Password. This opens the Enter Password window (FIG. 101). FIG. 101 Enter Password window 2. 3. Enter the new alphanumeric password. Press OK when complete Note that the Password Complexity setting determines the requirements for the new password:
If set to STANDARD, there are no particular requirements for the new password. If set to High, the complexity requirements for the new password are:
The password must contain at least one uppercase alphabetic character. The password must contain at least one lowercase alphabetic character. The password must contain at least one numeric character. The password must contain at least one special character. The password must not contain more than three consecutive repeating characters Changing USB Security Settings By default, the panel has all USB security options enabled (as indicated by the Enable All entry in the Security page (FIG. 102):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 75 FIG. 102 Security Page - USB Security setting indicating Enable All (the default setting) 1. To disable USB security options on this panel, press USB Security to access the USB Security Options window (FIG. 103):
FIG. 103 USB Security Options window 2. 3. Select the desired security feature to enable (Enable All, Disable Storage, Enable Smart Card, or Disable All). This selection automatically closes the USB Security Options window and applies the selected option. NOTE: Click Cancel to close this dialog without making a selection Displaying Trusted Credential Certificates In the Security page, press the Trusted Credentials option. 1. 2. The credentials detected on this panel are listed, organized by Certificate Type (FIG. 104):
FIG. 104 Security page - Example Trusted Credentials lis 3. Supported Certificate Types include Trusted CA and 802.x1. Note that each list has two tabs: System and User. To select which type of certificate to display, select either Trusted CA or 802.x1 from the Certificate Type drop-down menu (FIG. 105):
FIG. 105 Security page - Certificate Type menu NOTE:
The default setting is Trusted CA. 4. Press the return button to return to the main Security page. VARIA Touch Panels - Configuration & Programming Manual
| TOC 76 Installing Credential From Storage 1. In the Security page, press the Install From Storage option. 2. Select the type of certificate that will be installed: Trusted CA or 802.x1 (FIG. 106):
FIG. 106 Select a Certificate Type window 3. In the Certificate File Browser window, select the certificate file on the attached USB drive that will be installed (FIG. 107):
FIG. 107 Select a Certificate Type window (indicating no certificate files found) 4. The selected certificate is installed on the panel. Clearing Credentials 1. In the Security page, press the Clear Credentials option. This options clears all credentials installed on this panel. 2. In the confirmation window, press OK to proceed (FIG. 108):
FIG. 108 Confirm - Remove all the credentials Restoring the Default System Security Settings 1. In the Security page, press the Restore Default System Security Settings option. 2. In the confirmation window, press Yes to proceed (FIG. 109):
FIG. 109 Confirm - Restoring the Default Security Settings 3. All Security settings are returned to the default (Standard) security values and the password is changed to the default 1988. VARIA Touch Panels - Configuration & Programming Manual
| TOC 77 SYSTEM - Reset and Update The Reset and Update page (FIG. 110) allows resetting and updating of panel settings and firmware, including installation of new firmware from an external drive. Reset and Update page options DEVICE RESET Factory Data Reset Erases all data on the panel and resets the panel back to its factory default settings. See Factory Data Reset on page 67 for details. Reset Settings Select to revert the panel back to its default settings, but does not erase all data from the panel. Load Settings Select to load a saved settings configuration file (.acfg). Store Settings Select to save the current settings configuration file at the root of the connected USB drive. UPDATE MANAGER Web Services Use this switch to toggle Update Manager Web Services on the panel: If this switch is on, the Update Manager will attempt to connect to the Update Manager Server (hosted on amx.com). If the switch is off, then the Update Manager will not attempt to connect to the Update Manager Server. Note: If the panel is in Standard Security mode, the Update Manager Web Services option can be enabled/disabled. In High Security mode, Update Manager Web Services functionality is automatically disabled. See the SYSTEM -
Security section on page 60 for details. Firmware Manager Select to open the Firmware Manager page. Use the options on this page to update the firmware on the panel. See the Firmware Manager section on page 69 for details. Note: G5 Firmware can also be updated via the NetLinx Studio software application. See Appendix A:
Upgrading Firmware via NetLinx Studio on page 179 for details. App Manager Select to open the App Manager page. Use the options on this page to update the applications on the panel. See the App Manager section on page 72 for details. Scheduled Updates Select this option to access the Scheduled Update options. These options allow you to control if and when automatic scheduled application updates will be made to the panel. See the Scheduled Updates section on page 74 for details. PANEL PAGES Install Pages From External Disk Select this to open the TPDesign5 File Browser window (FIG. 138). Remove User Pages Select this to remove all previously loaded user pages from the panel. Factory Data Reset To reset the panel to its factory defaults and remove all data stored in the panel (including user pages):
1. Under DEVICE RESET, press Factory Data Reset to open the Factory Data Reset window (FIG. 111). VARIA Touch Panels - Configuration & Programming Manual
| TOC 78 FIG. 111 Factory Data Reset window To return to the Reset and Update page without making any changes, press Reset and Update. 2. To erase all data from the panel, press Reset Device. Reset Settings To reset the the Settings values to their default values:
1. Under DEVICE RESET, press Reset Settings. 2. The panel will prompt you to verify this action (FIG. 112):. FIG. 112 Reset Settings prompt window 3. Press Yes to proceed. To return to the Reset and Update page without saving any changes, press No. Using AMX System Recovery During a normal firmware upgrade, if a G5 panel is unable to boot all the way, AMX System Recovery can be used to try to reset system data or re-install firmware. To initiate system recovery:
1. 2. 3. Power up the panel while holding the Sleep/Settings button. Release the button 3 seconds after seeing the AMX boot logo, and wait a few seconds for recovery mode to begin. A text screen titled AMX System Recovery is displayed, presenting the following options:
Reboot Device Factory Data Reset Revert to Factory Firmware Install Firmware from USBs 4. Navigate the menu options by pressing the Sleep/Settings button. To select an item, press and hold the Sleep/Settings button for 2 or more seconds. Alternatively, if the panel has a USB keyboard plugged in at bootup, use the Up/Down arrows and Enter keys to navigate the menus. Select Reboot Device to reboot the panel. Select Factory Data Reset and then select Yes on the confirmation window to erase all of the user data (settings, application data, user pages) on the panel. VARIA Touch Panels - Configuration & Programming Manual
| TOC 79 Select Revert to Factory Firmware and then select Yes on the confirmation window for the system to extract the factory firmware (this can take a minute) and then automatically initiate a firmware upgrade as usual. Select Install Firmware from USB for a new menu to come up, where the user can navigate the files on the USB drive. Selecting the ../
entry will take the user back to the previous directory. Entries with a trailing / on the name are directories, and selecting a directory will bring up a new menu with the contents of that directory shown. All other entries will be .kit files. Selecting a KIT file and selecting Yes on the confirmation screen will extract the firmware (this can take minute) and then automatically initiate a firmware upgrade as usual. Storing and Loading Settings Configuration Files G5 panels have many settings. - the Store Settings and Load Settings options on the Reset and Update page provide the ability to store and load these settings to and from a Settings Configuration File (*.acfg). Use cases include:
Backing up final system settings Create settings configuration files ahead of time to help with large deployments of panels. Storing the Current Settings 1. In the Reset and Update page, press Store Settings to open the Store Settings window (FIG. 113):
FIG. 113 Store Settings window 2. 3. Enter a unique file name for this settings configuration file (default = settings.acfg). The UI will check for a valid config filename as its being entered. Invalid entries will not be saved. Press OK to save the file at the root of the USB drive. If the filename exists, the system will prompt you to verify overwriting the file. Loading Settings Configurations can be loaded from a file on the file system or from a URL:
4. In the Reset and Update page, press Load Settings to open the Setting Config File Browser window (FIG. 114):
FIG. 114 Setting Config File Browser window 5. 1. 2. 3. 4. This window lists all settings configuration (*.acfg) files present on the USB Storage media. Select the desired settings configuration file. The panel will prompt you to verify this action (FIG. 115):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 80 FIG. 115 Open File window Firmware Manager Select Firmware Manager under UPDATE MANAGER in the Reset and Update page to access the Firmware Manager page (FIG. 116):
FIG. 116 Firmware Manager window Reverting to Previous Firmware To reset the panel to its previously installed firmware:
1. 2. From the Firmware Manager window (FIG. 116), select Revert to Previous Firmware. If no previous version is available, this field is disabled. A System Message window is displayed that indicates the previous firmware version that will be installed, and prompting you to verify this action (FIG. 117):
FIG. 117 System Prompt - Revert To Previous Firmware?
3. 4. Select OK to install the previous firmware version and Cancel to return to the Firmware Manager. If you choose OK, the panel will reboot and restart with the previously installed firmware. Reverting to Factory-Installed Firmware In certain circumstances, it may be necessary to uninstall the current firmware on a panel and return it to the original factory default firmware. To reset the panel to its original factory firmware:
1. 2. From the Firmware Manager window (FIG. 116 on page 69), select Revert to Factory Firmware . A System Message window is displayed that indicates the factory firmware version that will be installed, and prompting you to verify this action (FIG. 118):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 81 FIG. 118 System Prompt - Revert To Factory Firmware?
3. 4. Select OK to install the previous firmware version and Cancel to return to the Firmware Manager. If you choose OK, the panel will reboot and restart with the factory installed firmware. NOTE: Resetting the panel to its original factory firmware will remove all updates made to the Settings menu since that version. Installing New Firmware From An External USB Stick To install new firmware to the panel from a USB stick:
NOTE: G5 Firmware can also be updated via the NetLinx Studio software application. See Appendix A: Upgrading Firmware via NetLinx Studio on page 179 for details. 1. Download the latest G5 panel firmware from www.amx.com and save it to a USB stick or other external drive with USB capability. NOTE: The firmware can be saved at the root directory, or be saved in a folder in the USB stick directory.The folder name is not case sensitive. 2. 3. Insert the USB stick into an available USB port. This may require disassembling wall-mounted panels to access the USB ports if a USB extension was not already installed. From the Firmware Manager window (FIG. 116 on page 69), select Install Firmware from USB to open the KIT File Browser window
(FIG. 119). FIG. 119 KIT File Browser window 4. 5. Select the KIT file to be installed. The panel will upload the new firmware (FIG. 120) and then reboot. FIG. 120 Update Progress display Install Firmware From Web If any firmware updates are available for the panel, the Install Firmware From Web option is presented on the Firmware Manager page (see FIG. 116 on page 69). Note that if High Security mode is set on the panel, web updates are not permitted. See the SYSTEM - Security section on page 60 for details on security modes. VARIA Touch Panels - Configuration & Programming Manual
| TOC 82 To install new firmware to the panel from the web:
1. 2. From the Firmware Manager window (FIG. 116 on page 69), select Install Firmware from Web. The panel will attempt to connect to AMX and look for any potential/available firmware updates for the platform (FIG. 121):
1. 2. FIG. 121 AMX Web Update - Checking for updates 3. The web update utility will display the available update versions (FIG. 122):
FIG. 122 AMX Web Update - Available updates 4. Press View Readme to review the firmware update Readme file prior to installation. Press Cancel to close this window without updating the panel firmware. Select the firmware version that will be used to update the panel and press Install Update to initiate the firmware update. The panel will prompt you to verify this action - Press OK to proceed with the update (FIG. 123):
FIG. 123 System Prompt - Install Firmware From Web 5. The progress of the download is indicated on the Firmware Manager page (FIG. 124). FIG. 124 Firmware Manager page - Install Firmware From Web (in progress) 6. The firmware update will begin the install process (FIG. 125):
FIG. 125 Firmware Update - Preparing Firmware 7. After copying the firmware package to the staging location, the panel will reboot and complete the firmware installation process (FIG. 126):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 83 FIG. 126 Firmware Update - reboot and complete firmware update Installing Panel Pages From an External Disk TPDesign5 page files (*.tp5) may be loaded onto a panel, both via TPDesign5 and through files saved to a USB-enabled external drive. To load TPD5 pages via USB:
1. Download the panel pages and save them to a USB stick or other external drive with USB capability. 2. 3. Insert the USB stick into an available USB port on the panel. In the Reset & Update window, press Install Pages from External Disk (under PANEL PAGES) to open the TP5 File Browser window. All TP5 files found on the USB drive are listed (FIG. 138):. FIG. 138 TPDesign5 File Browser window 4. 5. Press the TP5 file to load on the panel. The panel will prompt you to verify this action (FIG. 139):
FIG. 139 TP5 Update prompt 6. Press Yes to load the selected TP5 project on the panel. Removing User Pages From the Panel To remove user pages from the panel:
1. In the Reset and Update page, press Remove User Pages to open the Remove User Pages window (FIG. 140). FIG. 140 Remove User Pages prompt 2. Press Yes to remove the user pages from the panel. At this point, the panel will indicate that there are no device pages installed (FIG. 141):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 84 FIG. 141 No Device Pages Installed window Press one of the options presented on this page to proceed:
Launch Settings: Press to invoke the Setting menu. Use this option to navigate to the SYSTEM > Reset & Update window to use the Install Pages from External Disk option to load pages via a TP5 file (see Installing Panel Pages From an External Disk on page 75). Launch Default Profile: Press to launch the default panel profile. Launch Applications: Press to invoke the Available Apps window, which provides shortcuts to all Apps loaded on the panel (FIG. 142):. FIG. 142 Available Apps window, SYSTEM - Diagnostics The Diagnostics page (FIG. 143) displays the current processor temperature, provides access to panel logs, and toggles SSH functionality. FIG. 143 Diagnostics page Diagnostics page Temperature Displays the current temperature of the panel in Celsius. VARIA Touch Panels - Configuration & Programming Manual
| TOC 85 Logs SSH Select this option to display the panel logs. Select this option to enable or disable the SSH server on this panel. Refer to the SSH Commands section on page 170 for a listing of supported SSH commands. The Logs window chronicles all previous connections between the panel and the network. To access the Logs window, select Logs in the Diagnostics page. Gestures Overview You can program Varia touch panels 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 Varia panels). NOTE: Verify you are using the latest NetLinx Controller and Varia firmware, as well as the latest version of NetLinx Studio and TPD5. NOTE: For more information on gestures and on designing touch panel pages, please refer to the TPDesign 5 online help, available at www.amx.com. Touch Gesture Recognition Gesturing refers to the act of moving a finger or stylus across the overlay and having the panel recognize and process this motion as a gesture. In G5, gesture events are assigned as individual buttons or pages. In addition, a gesture velocity is calculated and transmitted to the controller along with the gesture type itself in a custom event message. NOTE: Nothing will be processed if the button associated with this gesture has no gesture event operations programmed, is disabled, or has no values programmed for address, channel, level, string output or command output. The custom event, however, is always transmitted. The following gesture types are supported:
1. 2. 3. 4. Swipe up Swipe down Swipe right Swipe left 5. Double-tap 6. 7. 8. 9. 2 Finger Swipe Up 2 Finger Swipe Down 2 Finger Swipe Right 2 Finger Swipe Left 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 controller in the custom event message:
1. Fast 2. Normal 3. Slow A precise velocity is sent in the custom event message which represents the velocity in terms of pixels per second for slides and circles. For a double tap, this value is the total time in milliseconds from the first press to the second release. Gesture Prioritization The following table describes the process used to determine what the user meant whenever a gesture operation is defined globally versus for the current page. Gesture Prioritization The user presses outside of a button or slider 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. VARIA Touch Panels - Configuration & Programming Manual
| TOC 86 The user presses inside of a slider and moves before releasing. The user moves a movable popup page. The user presses on a button and then moves. 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 popup page move and not a gesture. 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. The user double taps on a button or slider. This will not be recognized as a gesture. This would be considered two quick press/release operations on the button or slider. This will be registered as a gesture. The user double taps outside of a button or slider. Gesture VNC/Mouse Support Gestures are recognized when the user is using a finger or stylus on the panels screen overlay, a mouse on a VNC connection, or a mouse connected to the local USB port on the panel. Gesture Custom Event Whenever a gesture is recognized and processed a custom event is also sent to the controller. The following values describe this event:
CUSTOM_EVENT ADDRESS is 1 CUSTOM_EVENT EVENTID is 600 Custom.Value1 is the gesture number Custom.Value2 is the simplified gesture velocity Custom.Value3 is the precise gesture velocity Gesture numbers and velocity values Gesture Numbers and Velocity Values Gesture numbers Simplified gesture velocity values Swipe up Swipe down3 -
1-
2-
Swipe right 4 - Swipe left 5 - Circle (not implemented) 6 - CCW Circle (not implemented) Precise gesture velocity For double taps, this is the time in milliseconds from the first press to the second release. 7 8 9 10 Two-Finger Swipe left.
- Double-Tap
- Two-Finger Swipe up
- Two-Finger Swipe down
- Two-Finger Swipe right11 -
1 - Fast 2 - Normal 3 - Slow Enabling or Disabling the Gesture Custom Event The ^GCE Send Command sets whether or not the panel sends a custom event to the controller whenever a gesture is detected (see page 92). The value sent is not retained - gesture custom events will be enabled each time the panel restarts. The default is to always NOT send the events. Programming - Send Commands Overview You can program VARIA touch panels, using the commands in this section, to perform a wide variety of operations using Send Commands and variable text commands. A device must f irst be def ined 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 Varia panels). Verify you are using the latest NetLinx Controller and VARIA firmware, as well as the latest version of NetLinx Studio and TPDesign5. VARIA Touch Panels - Configuration & Programming Manual
| TOC 87 The Send Commands described in this document are case-insensitive. Using the Pipe ( | ) Character Previously, in G4, the pipe character ( |) was used to create a new line. G5 uses carriage return / line feed ($0d,$0a) instead. The examples below illustrate indicating a new line (between the words Hello and World) in G4 and in G5 programming:
G4: ^TXT-200,0,Hello|World G5: ^TXT-200,0,Hello,$0d,$0a,World VARIA Touch Panels - Configuration & Programming Manual
| TOC 88 Panel Commands Panel Commands
^ABP ABEEP:
^ADB ADBEE
^AKB
@AKB AKEYB
^AKP
@AKP AKEYP Single Beep Command - Output a single beep. The ABEEP command is implemented for G4 compatibility. Syntax:
^ABP or ABEEP Variables: None Example:
SEND COMMAND Panel,^ABP Double Beep Command - Output a double beep. The ADBEEP command is implemented for G4 compatibility. Syntax:
^ADB or ADBEEP Variables: None Example:
SEND COMMAND Panel,^ADP Show System Keyboard Command - Brings up system keyboard. When user presses the Done button, a string is returned to the controller with the user-entered value. The keyboard can be removed either by the Back button or the ^AKR command. The @AKB and AKEYB commands are implemented for G4 compatibility. Syntax:
^AKB-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
or
@AKB-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
or AKEYB-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
Variables:
Initial text: Pre-populated text to appear on keyboard (i.e. default) Prompt text: Descriptive header to appear above keyboard text entry box Hint Text: Hint text to appear behind the keyboard text entry box Return prefix: Prefix to the send string returned to the controller. If not specified, the entered text will be preceded by AKB-. Return port: The port number to return the response on if different than the port to which the command is sent. Example:
SEND_COMMAND Panel,^AKB-username;Enter user name;Enter the name of the user for this panel Present a keyboard with a prompt of Enter user name, the initial text of username, and hint text of Enter the name of the user for this panel. Show System Keypad Command - Brings up system keypad. When user presses the Done button, a string is returned to the controller with the user-entered value. The keypad can be removed either by the Back button or the ^AKR command. The @AKP and AKEYP commands are implemented for G4 compatibility. Syntax:
^AKP-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
or
@AKP-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
or AKEYP-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
Variables:
Initial text: Pre-populated text to appear on keyboard (i.e. default) Prompt text: Descriptive header to appear above keyboard text entry box Hint Text: Hint text to appear behind the keyboard text entry box Return prefix: Prefix to the send string returned to the controller. If not specified, the entered text will be preceded by AKP-. Return port: The port number to return the response on if different than the port to which the command is sent. VARIA Touch Panels - Configuration & Programming Manual
| TOC 89 Panel Commands Example:
SEND_COMMAND Panel,^APK-John Doe;Enter Username:;Enter the name for the user;
AKP-username-;1 Opens a keyboard with the initial text as John Doe, the keyboard prompt as Enter Username:, the Hint text as Enter the name for the user, the return prefix as AKP-username-, and the return port as port 1. Remove Keyboard/Keypad Command - This command removes any keyboard or keypad that is currently displayed. If it is a non-virtual keyboard or keypad, it is essentially an Abort, because any user-entered text is lost. The @AKR and AKEYR commands are implemented for G4 compatibility. Syntax:
^AKR or @AKR or AKEYR Variables: None:
Examples:
SEND COMMAND Panel,^AKR Remove the displayed keyboard/keypad. Automatic close application command - Setup alarm times to close all open applications. Syntax:
^APC-<enable>,[optional alarm time],[optional alarm time]
Variables:
enable: 1 to enable alarms, 0 to disable alarms. Default is 1. Alarm time: Time of day to trigger alarm in HH:mm format. Format is 24 hour values. Up to six alarm times can be set each day. Valid HH formats are 00-23. Valid mm format is 00-59. Invalid formats and parameters will be disregarded. The default is one time set at 00:00 (midnight). Examples:
SEND_COMMAND Panel, ^APC-1,00:00, 08:00, 18:00 Enable the application close alarms at midnight (00:00), 8:00 AM (08:00), and 6:00 PM (18:00). SEND_COMMAND Panel, ^APC-0 Disable application close alarms. SEND_COMMAND Panel, ^APC-1 Enable alarms to close applications at previous alarm times. Query application close alarms - Query the values of the close applications alarms. The response is a NetLinx DATA/Command event to the controller from the port the command was sent to in the format used in the ^APC command. Syntax:
?APC Variables: None Example:
SEND_COMMAND Panel, ?APC Response is a DATA/Command event to controller from the port the ?APC command was sent on in the format of:
^APC-<enable>,[optional alarm time],[optional alarm time]
If alarms are enabled and times set to midnight and noon, the response would be:
^APC-1,00:00,12:00 Launch application chooser command - Launch a dialog showing all available apps.
^AKR
@AKR AKEYR
^APC
?APC
^APP Launch application chooser Syntax:
^APP Variables: None
^APP Launch application window Launch application window command - Launch an application window at the specified location with the specified application. Syntax:
^APP-left,top,<width>,<height>,[optional window type],<AppName>[,<param list>]
Variables:
left - The left position of the application window. top - The top position of the application window. width - The optional width of the application window. If not specified, the default width of 320 is used. height - The optional height of the application window. If not specified, the default height of 240 is used. window type - The optional window type. If not specified, the default window type of floating, resizable, movable is used. Window type Description 0 1 2 Floating, resizable, movable Floating, fixed size, movable Floating, fixed size, non-movable VARIA Touch Panels - Configuration & Programming Manual
| TOC 90 Panel Commands 3 4 5 comma-separated list of parameter triplets as follows:
Docked left Docked right Docked top 6 Docked bottom app name The name of the application to launch. param list The optional
<param_1_name>,<param_1_type>,<param_1_value>,...,<param_N_name>,<param_N_ type>,<param_N_value>
where: name: parameter name
(e.g.URI) type: parameter type (e.g. String) - not case sensitive value:
parameter value (e.g. http://www.amx.com) Note: The name, type and value are separated by a single comma. If there are additional parameters, a single comma should separate the previous parameters value and the next parameters name. Since comma is used to delimit the parameter fields, any comma appearing in the value of the element must be escaped with a backslash
(\). If a backslash itself appears in any element, it too must be escaped with another backslash. To access a file on an attached USB drive, the URI must be: file:///udisk/path_to_file. (Note there are three (3) forward slashes after the file: and you must specify udisk to point to the USB disk.) Example:
SEND_COMMAND Panel,^APP-0,0,Browser Launch browser in upper left corner Close a specific application command - Close the application specified. Syntax:
^APP-<app name>
^APP - Close a specif ic application Variables:
app name - The name of the application to close. Example:
SEND_COMMAND Panel,^APP-Browser Close the browser Syntax:
Application action command - Performs a specified action on an application specified by app name.
^APP-<action>,<app name>[,<param list>]
Variables: None action: The action to perform on the application. The available actions are: show: show an app, launch if not visible centered on the screen in a floating, moveable, resizable window. close: close a running app close_all: close all running apps app name: The name of the application to act upon. param list: The optional comma-separated list of parameter triplets as follows:
<param_1_name>,<param_1_type>,<param_1_value>,...,<param_N_name>,<param_N_ type>,<param_N_value>
^APP Application action where: name: parameter name
(e.g.URI) type: parameter type (e.g. String) - not case sensitive value:
parameter value (e.g. http://www.amx.com) Note: The name, type and value are separated by a single comma. If there are additional parameters, a single comma should separate the previous parameters value and the next parameters name. Since comma is used to delimit the arameter fields, any comma appearing in the value of the element must be escaped with a backslash
(\). If a backslash itself appears in any element, it too must be escaped with another backslash. To access a file on an attached USB drive, the URI must be: file:///udisk/path_to_file. (Note there are three (3) forward slashes after the file: and you must specify udisk to point to the USB disk.) Example:
SEND_COMMAND Panel,^APP-show,Browser Show the browser centered on the screen in a floating, movable, resizable window. SEND_COMMAND Panel,^APP-close,Browser Query available application command - Query all the available apps installed.. Syntax:
?APP Variables:None l App names are sent through a custom event:
?APP Custom Event Property Value Port port command was received on ID 1 Type 4170 VARIA Touch Panels - Configuration & Programming Manual
| TOC 91 Panel Commands Flag 0 Value 1 App Number (0 - max number apps in no particular order) Value 2 Number of available apps Value 3 n/a Text App Name (suitable for launching via ^APP,0,0,AppName) Panel Brightness Command - Set the panel brightness. The @BRT and BRIT commands are implemented for G4 compatibility.
^BRT
@BRT BRIT
?BRT Syntax:
^BRT-<brightness level>
or
@BRT-<brightness level>
or BRIT-<brightness level>
Variables:
brightness level = 0 - 100. Example:
SEND COMMAND Panel,^BRT-70 Sets the brightness level to 70 Query Brightness Command - Query panel brightness. Syntax:
?BRT Variables: None Example:
SEND_COMMAND Panel,?BRT Gets the current brightness value. The response returned is a custom event with the following properties:
Custom Event Property Value Port port command was received on ID 0 Type 1303 Flag 0 Value 1 Brightness value 0-100 Value 2 0 Value 3 0 Text String that represents the brightness value Example response:
Custom Event Property Value Port port command was received on ID 0 Type 1303 Flag 0 Value 1 70 Value 2 0 Value 3 0 Text 70 Cache Purge Command - Purge the image cache. Syntax:
^CPR Variables:None l
^CPR Example:
SEND COMMAND Panel,^CPR Purge the image cache. Panel Streaming Audio Mute Command. Set the audio mute for a specified streaming URL.
^DMM Syntax:
^DMM-<audio mute>,<video mute>,<url>
video mute - mute/unmute the video for <url> (0 = unmute, 1 = mute) (not implemented at this time) url - a valid ^SDM url that is already in the playing state. Variables: l audio mute - mute/unmute the audio for <url> (0 = unmute, 1 = mute) Examples:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 92 Panel Commands SEND_COMMAND Panel, ^DMM-1,0,udp://224.1.1.1:1234 Mute audio, unmute video for UDP stream server 224.1.1.1 port 1234. SEND_COMMAND Panel, ^DMM-0,0,udp://224.1.1.1:1234 Unmute audio, unmute video for UDP stream server 224.1.1.1 port 1234. System Extended Keypad - Brings up system extended keypad. Currently, the system extended keypad and the system telephone keypad are the same, and have all the keys that the G4 extended keypad had except the : key. When the user presses the Done button, a string is returned to the controller with the user-entered value. The keypad can be removed either by the Back button or the ^AKR command (page 88). Note: The @EKP command is implemented for G4 compatibility. Syntax:
^EKP-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
or
@EKP-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
^EKP
@EKP Variables:
Initial text: Pre-populated text to appear on keypad (i.e. default) Prompt text: Descriptive header to appear above keypad text entry box Hint Text: Hint text to appear behind the keypad text entry box Return prefix: Prefix to the send string returned to the controller. If not specified, the entered text will be preceded by EKP-. Return port: The port number to return the response on if different than the port to which the command is sent. Set Text Encoding Method - Sets the text encoding method which is used for commands and strings sent from panel to controller (the default is UTF-8). Syntax:
^ENC-<Encoding>
Variables:
Encoding: 0: UTF-8 (default), 1: Latin-1 (ISO 8859-1) Example:
SEND_COMMAND Panel,^ENC-1
^ENC Sets the encoding method used for all strings to the Controller to Latin-1. Note: NetLinx Studio does not support UTF-8 at this time; therefore UTF-8-encoded characters cannot be copied from TPD5 and pasted in Studio. To use NetLinx Studio to send UTF-8 encoded text, byte values must be enumerated in the command. For example, the following command sends a UTF-8 string to the panel, consisting of ASCII, extended ASCII and Unicode (Chinese) characters:
^UTF-3,0,Hello,$C3,$A2,$C3,$A3,$E5,$9C,$B0,$E7,$9B,$A4,$E3,$83,$87 Also note that in backwards compatibility mode (i.e. when the ^TXT command is sent or when the ^ENC-1 command has been sent), ISO-8859-1 is used for character encoding/decoding, since that is what G4 panels used. ISO-8859-1 is different from the Windows-1252 character set in that characters in the range 128-159 (decimal) are non-
printable control characters. So in response to a ?TXT query, any characters in that range (assuming the ^ENC-1 was previously sent) will be returned as AMX Hex quad-encoded values with Custom Event Flag=1, whereas the remainder of the extended ASCII range (160-255) will be returned as Latin-1-encoded characters with Custom Event Flag=0 (see the ISO8859-1 Character Encoding/Decoding table on page 168). Get Text Encoding Method - Gets the current text encoding method which is used for commands and strings sent from panel to controller (the default is UTF-8). Syntax:
?ENC Variables:None l Example:
SEND_COMMAND Panel,?ENC Get the panels text encoding status. The response returned is a custom event with the following syntax:
?ENC Custom Event Property Value Port port command was received on ID 0 Type 1331 Flag 0 Value 1 encoding (0 = UTF-8, 1 = ISO-8859-1) Value 2 0 VARIA Touch Panels - Configuration & Programming Manual
| TOC 93 Panel Commands Value 3 0 Text String that represents the encoding name Example response for encoding status:
Custom Event Property Value Port port command was received on ID 0 Type 1331 Flag 0 Value 1 0 Value 2 0 Value 3 0 Text UTF-8 Set Gesture Custom Event - Sets whether or not the panel sends a custom event to the controller whenever a gesture is detected.
^GCE-<state>
Variables:None l state: ON or OFF / 1 or 0 / on or off. Syntax:
^GCE Note: This setting is not retained and the default is to always NOT 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. Examples:
SEND_COMMAND Panel, ^GCE-on Enables gesture custom event reporting to the controller. SEND_COMMAND Panel, ^GCE-0 Disables gesture custom event reporting to the controller. Level on command (generated by NetLinx controller) - Enable device to send level changes to the controller. By default, devices will not report level changes unless a LEVON command is received. The LEVON command is automatically sent by the controller to the device if:
LEVON There is a LEVEL event for the DPS of the device. There is a CREATE_LEVEL defined in the NetLinx program for the DPS of the device. Syntax:
LEVON Variables: None Level off command (generated by NetLinx controller) - Disable the device from sending level changes to the controller. By default, devices will not report level changes unless a LEVON command is received. The LEVON command is automatically sent by the controller to the device if:
LEVOF There is a LEVEL event for the DPS of the device. There is a CREATE_LEVEL defined in the NetLinx program for the DPS of the device. Syntax:
LEVOF Variables:None Query Panel MAC Address - Query the MAC Address of the panel. Syntax:
?MAC Variables:None
?MAC Example:
SEND_COMMAND Panel,?MAC Get the panels MAC Address. The response returned is a custom event with the following syntax:
Custom Event Property Value Port port command was received on ID 0 Type 1315 Flag 0 Value 1 0 Value 2 0 Value 3 0 Text String that represents the the MAC Address VARIA Touch Panels - Configuration & Programming Manual
| TOC 94 Panel Commands Example response:
Custom Event Property Value Port port command was received on ID 0 Type 1315 Flag 0 Value 1 0 Value 2 0 Value 3 0 Text 00:60:9f:90:00:01
^MSG Syntax:
Message Dialog Command - A generic message dialog that has displayed content defined from the ^MSG command.
^MSG-dialog_id[:dialog_theme],dialog_type[-input_option][:dialog_image_name], timeout,custom_event_type, custom_event_id, title_text, message_text, positive_ button_text,negative_button_text, neutral_button_text, cancel_text, timeout_text Variables: None dialog_id: Unique id to reference the dialog. Used to track IDs to displayed dialogs. dialog_theme: Optional theme of the dialog is set by appending the theme to the dialog_id number with : and the theme. Valid themes are light and dark (default) dialog_type. The type of dialog to display: std - standard dialog. By default, no image is displayed in the title area. warn - warning dialog. The built-in warning image is used in the title area. error - error dialog. The built-in error image is used in the title area. quest - question dialog. The built-in question image is used in the title area. list - list of items to choose. By default, no image is displayed in the title area. List items are put in the message_ text field and are separated by colons (:). input - input entry. By default, no image is displayed in the title area. Optional input_options follow a dash (-) and are: no option present - alphanumeric input num - numeric input (no alphabetic input) phone- phone pad presented uri - URI keyboard presented email - Email keyboard presented name -
Keyboard presented and capital words are used. date - Date pad presented time - Time pad presented datetime -
Date/Time pad presented The message_text is System is busy. The positive_button_text is OK SEND_COMMAND Panel,^MSG-1,list:question-flat-48x48.png,30000,32001,10, Select item,item 1:item 2:item 3:item 4:item 5,,Cancel Display dialog ID 1 as a list dialog. The image question-flat-48x48.png is used as the image in the title area. The timeout is 30s. The custom_event_type to use is 32001. The custom_event_id to use is 10. The title_text is Select Item. The message_text is list of 5 items (item 1, item 2, item 3, item 4, item5). The positive_button_text is empty. The negative_button_text is empty. The neutral_button_text is Cancel. pass - password entry. By default, no image is displayed in the title area. Optional input_options follow a dash (-) and are:
no option present - alphanumeric input num
- numeric input (no alphabetic input) dialog_image_name: It is optional to override any type with a custom image or dynamic image from the TP5 file to be displayed in the title area. The image used is set by appending a : and image file/resource name to the dialog_type-
input_option (e.g. std:number.png or warn:mywarningimage.jpg). timeout: Timeout is in milliseconds. If timeout is 0, message does not timeout and is considered modal. custom_event_type: The custom event type value to use for result custom events. custom_event_id: The custom event ID value to use for result custom events. title_text: Text that is displayed in the dialog title. If this field is empty, no title is displayed on the dialog. message_text: In most cases, the contents of this field is displayed in the message of the dialog. There are a few exceptions based on dialog_type:
list - In a list dialog type, the message_text contains the list items. List items are separated by a colon (:). input - In a input dialog type, the message_text contains the initial value of the text entry field of the dialog. pass In a pass dialog type, the message_text contains the initial value of the text entry field of the dialog. positive_button_text: Text to display on the positive button (e.g. Yes, OK, Enter, etc.) In most cases, if the positive button is selected, this text is sent to controller in the custom.text field. Note: If this field is empty, the positive button is not displayed in the MessageDialog. Note: Text fields can be put into quotations ( ) so that commas can be used in text. Like the CSV parser, if a is needed in the text, the can be escaped by a prepended another (e.g. ). Note: The use of text params in command instead of preset definitions for button text is so that the language of text can be set in code. Unicode quads for text are supported by using the command ^MSGU- command. Legacy ISO-8859-1 (like ^TXT) text is supported by using the ^MSGT- command. There is a LEVEL event for the DPS of the device. There is a CREATE_LEVEL defined in the NetLinx program for the DPS of the device. Response Data:
The response to the MessageDialog is sent to the controller via a Custom Event. Some of the custom event values are set in the ^MSG command, and others are generated as a result of the dialog action. VARIA Touch Panels - Configuration & Programming Manual
| TOC 95 Panel Commands Result Custom Events data: custom.type: The value set in the custom_event_type field custom.id: The value set in the custom_event_id field. custom.flag: value has the result. In most cases, it indicates which button was selected, or cancel, or timeout:
-1 = timeout 0 = cancel 1 = positive button 2 = negative button 3 = neutral button In a list dialog type, when an item is selected, the custom.flag field will be set to 1 (positive button). custom.value1 The dialog_id value set in the command custom.value2 In a list dialog type, this field has the index of the selected list item. If the first item was selected then value2==1, second item selected then value2==2, etc. If the dialog_type is not a list, then value2 is unused and is set to 0. custom.value3: Unused. Set to 0. custom.text: The text of the resulting button selected, or cancel_text if dialog was canceled, or timeout_text if timed out. In list mode, the selected list item text value is sent in this field. In input or pass, the entered value is sent in this field. Note: Custom events are returned on the port the command was sent to from the controller. Examples:
SEND_COMMAND Panel,^MSG-1,std,60000,32001,1,Please Wait,System is busy,OK;
Display dialog ID 1 as a standard dialog. The timeout is 60s. The custom_event_type to use is 32001. The custom_event_id to use is 1. The title_text is Please Wait. SEND_COMMAND Panel,^MSGT-1:light,error,30000,32001,32002,Error Title,Lorem ipsum dolor sit amet, consectetur adipiscing elit,sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex eacommodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore ND_COMMAND Panel,^MSGT-1:lig ht,error,30000,32001,32002,Error Title,Lorem ipsum dolor sit amet, consectetur adipiscing elit,sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. the end,Positive,Negative, Neutral,Cancel,Timeout
^MSGT -The dialog text is encoded in the ISO-8859-1 (Latin-1) format (like what is expected by ^TXT command). Display dialog ID 1 with a light theme as an error dialog. The default error image is used as the image in the title area. The timeout is 30s. The custom_event_type to use is 32001. The custom_event_id to use is 32001. The title_text is Error Title. The message_text is a variation of Lorem ipsum.... The positive_button_text is Positive. The negative_button_text is Negative. The neutral_button_text is Neutral. The cancel_text is Cancel. The timeout_text is Timeout. Panel Volume Mute - Mute or unmute a panel volume. Syntax:
^MUT-<mute value>
Variables:
mute value: 0 for not muted, 1 for muted. Examples:
SEND_COMMAND Panel,^MUT-1 Mute the controller volume. SEND_COMMAND Panel,^MUT-0 Unmute the controller volume. Query Panel Mute Status - Query the mute status of the panel. Syntax:
?MUT Variables: None Example:
^MUT
?MUT VARIA Touch Panels - Configuration & Programming Manual
| TOC 96 Panel Commands SEND_COMMAND Panel,?MUT Get the panels mute status. The response returned is a custom event with the following syntax:
Custom Event Property Value Port port command was received on ID 0 Type 1305 Flag 0 Value 1 mute status (0 unmuted or 1 for muted) Value 2 0 Value 3 0 Text String that represents the mute status (0 or 1) Example response for muted status:
Custom Event Property Value Port port command was received on ID 0 Type 1305 Flag 0 Value 1 1 Value 2 0 Value 3 0 Text 1
^NOT
^PKB
@PKB PKEYB
^PKP
@PKP PKEYP Syntax:
Popup Note Command - A generic popup note message that can be used to display information for a short duration on the display.
^NOT-note_text, duration, location, text_size The time in milliseconds to display the popup note location - Where to display the popup note. Options are c for CENTERED on display, t for TOP CENTER on display, and b for BOTTOM CENTER on display. Any other value will be displayed as CENTER. text_size - The size value to display the popup note text. Default is 18. Variables: None note_text - The text to displayed in the popup note. duration -
Note: The note text field can be put into quotations ( ) so that commas can be used in text. Like the CSV parser, if a is needed in the text, the can be escaped by a perpending another (e.g. ). Note text is assumed to be UTF-8 encoded. Show System Private Keyboard Command - Brings up system private keyboard (the same as the system keyboard, with typed text hidden with the * character). When user presses the Done button, a string is returned to the controller with the user-entered value. The keyboard can be removed either by the Back button or the ^AKR command (page 88). The
@PKB and PKEYB commands are implemented for G4 compatibility. Syntax:
^PKB-<initial text>;<prompt text>;<hint text>;<return prefix>;<return port> or
@PKB-<initial text>;<prompt text>;<hint text>;<return prefix>;<return port> or PKEYB-<initial text>;<prompt text>;<hint text>;<return prefix>;<return port>
Variables:
Initial text - Pre-populated text to appear on keyboard (i.e. default). Note that for the private keyboard, this text will be hidden. Prompt text - Descriptive header to appear above keyboard text entry box Hint Text - Hint text to appear behind the keyboard text entry box Return prefix - Prefix to the send string returned to the controller. If not specified, the entered text will be preceded by PKB-. Return port - The port number to return the response on if different than the port to which the command is sent. Show System Private Keypad Command - Brings up system private keypad (the same as the system keypad, with typed text hidden with the * character). When user presses the Done button, a string is returned to the controller with the userentered value. The keypad can be removed either by the Back button or the ^AKR command (page 88). The @PKP and PKEYP commands are implemented for G4 compatibility. Syntax:
PKEYP-[optional initial text];[optional prompt text];[optional hint text];
[optionalreturn prefix];[optional return port]
Variables:
Initial text: Pre-populated text to appear on keypad (1 - 50 ASCII characters). Note that for the private keypad, this text will be hidden. Prompt text: Descriptive header to appear above keypad text entry box Hint Text: Hint text to appear behind the keypad text entry box Return prefix: Prefix to the send string returned to the controller. If not specified, the entered text will be preceded by PKP-. VARIA Touch Panels - Configuration & Programming Manual
| TOC 97 Panel Commands Return port: The port number to return the response on if different than the port to which the command is sent. Examples:
SEND COMMAND Panel,PKEYP-123456789 Pops up the Keypad and initializes the text string 123456789 in *. Reset protected password command - This command is used to reset the protected setup password to the factory default value. Syntax:
^RPP Variables: None Example:
SEND_COMMAND Panel,^RPP Reset the panel protected password to the factory default. Reset System Settings Command - Reset Settings to factory default. Syntax:
^RSS Variables: None Example:
SEND_COMMAND Panel, ^RSS Reset the panel to factory default settings. Send string on command (generated by NetLinx controller) - Enable device to send STRING changes to the controller. By default, devices will not report STRING changes unless a RXON command is received. The RXON command is automatically sent by the controller to the device if:
There is a DATA/STRING event for the DPS of the device. There is a CREATE_BUFFER defined in the NetLinx program for the DPS of the device. Syntax:
RXON Variables: None Send string off command (generated by NetLinx controller) - Disable the device from sending STRING changes to the controller. By default, devices will not report STRING changes unless a RXON command is received. The RXON command is automatically sent by the controller to the device if:
There is a DATA/STRING event for the DPS of the device. There is a CREATE_BUFFER defined in the NetLinx program for the DPS of the device. Syntax:
RXOF Variables:None Content Sharing command - Send a content URI to be shared. Allows the user to specify a URI to share. Syntax:
SHAR-<mode>,<uri>
Variables: mode: The mode to use with the URI for sharing uri: The URI to share Example:
SEND_COMMAND Panel,SHAR-view,udp://255.255.22.25 Share the streaming video URI of udp://255.255.25.25 for the Content Sharing receiver to view.
^RPP
^RSS RXON RXOF SHAR SHUTDOWN Power Off the Panel Command - Receipt of this command will cause the panel to power off. Syntax:
SHUTDOWN Variables: None
^SCO
^SLP SLEEP Session clear out command - Clears session data for some applications (Browser, Firefox, Gallery, Skype, Dropbox, VNC server, PlanMaker, TextMaker, and Presentations). Syntax:
^SCO Variables: None Panel Sleep Command - Place the panel in sleep state. Sleep state turns the display off. The SLEEP command is implemented for G4 compatibility. Syntax:
^SLP or VARIA Touch Panels - Configuration & Programming Manual
| TOC 98 Panel Commands SLEEP Variables:None Example:
SEND COMMAND Panel,^SLP Sends the panel to the sleep (display off)
^SOU
@SOU
^SSL
@SSL
^STP SETUP
^SWK
@SWK
^TKP
@TKP Play Sound Command - Plays a specified sound file. The @SOU command is implemented for G4 compatibility. Syntax:
^SOU-<sound name> or SLEEP Variables:
sound name: Name of the sound file. Supported sound file formats are: WAV & MP3. Example:
SEND COMMAND Panel,^SOU-Music.wav Plays the Music.wav file. Set the Sleep String Command - Set the content of the string that is sent to the controller when the panel goes to sleep
(display off). The @SSL command is implemented for G4 compatibility.. Syntax:
^SSL-<sleep string>
or
@SSL-<sleep string>
Variables:
Sleep string: The string sent to the controller when the panel goes to sleep. Example:
SEND COMMAND Panel,^SSL-Sleeping Sets the sleep string to Sleeping. Settings application command - Open the Settings Applications. The SETUP command is implemented for G4 compatibility. Syntax:
^STP or SETUP Variables:None Example:
SEND COMMAND Panel,^STP Opens the Settings application. Set the Wake String Command - Set the content of the string that is sent to the controller when the panel wakes up from sleep (display on). The @SWK command is implemented for G4 compatibility. Syntax:
^SWK-<wake string>
or
@SWK-<wake string>
Variables:
Wake string: The string sent to the controller when the panel wakes up from sleep. Example:
SEND COMMAND Panel,^SWK-Wakeing Up Sets the sleep string to Wakeing Up. Brings up system telephone keypad - Currently, these keypads are the same, and have all the keys that the G4 extended keypad had except the : key. When user presses the Done button, a string is returned to the controller with the userentered value. The keypad can be removed either by the Back button or the ^AKR command (page 88). The @TKP command is implemented for G4 compatibility. Syntax:
^TKP-[optional initial text];[optional prompt text];[optional hint text];
[optional return prefix];[optional return port]
Variables:
Initial text: Pre-populated text to appear on keypad (i.e. default) Prompt text: Descriptive header to appear above keypad text entry box Hint Text: Hint text to appear behind the keypad text entry box Return prefix: Prefix to the send string returned to the controller. If not specified, the entered text will be preceded by TKP-. VARIA Touch Panels - Configuration & Programming Manual
| TOC 99 Panel Commands Return port: The port number to return the response on if different than the port to which the command is sent. Note:
See also - ^EKP (system telephone keypad) on page 91.
^TPF TPAGEOF
^TPN TPAGEON
^UPD UPDATE
^VKB
@VKB
^VKP
@VKP
^VKS
^VOL Turn Off Page Tracking Command. The TPAGEOF command is implemented for G4 compatibility. Syntax:
^TPF or
^TPF Variables: None Example:
SEND COMMAND Panel,^TPF Turn On Page Tracking Command - This command turns on page tracking, whereby when the page or popups change, a string is sent to the Controller. This string may be captured with a CREATE_BUFFER command for one panel and sent directly to another panel. The TPAGEON command is implemented for G4 compatibility. Syntax:
^TPN or TPAGEON Variables: None Example:
SEND COMMAND Panel,^TPN Panel Update Command - This command starts the Update Manager to perform a silent update of platform applications or firmware. The UPDATE command is implemented for G4 compatibility. Note: Allow 10-15 minutes for update to complete before sending another ^UPD command. Syntax:
^UPD-<update type>
or UPDATE-<update type>
Variables:
update type: Determines which form of update is performed. Valid values are APP and FW. Examples:
SEND_COMMAND Panel,^UPD-FW Update the panels Firmware silently in the background. SEND_COMMAND Panel,^UPD-APP Update the panels applications silently in the background. Show Virtual Keyboard Command - Brings up system virtual keyboard, which is the keyboard without a designated text entry area. A Text Input button must be in focus; if not, the keyboard will not appear. The type of keyboard is determined by the Text Area currently in focus. When user presses the Done button, a string is returned to the controller with the userentered value. The keyboard can be removed either by the Back button or the ^AKR command (page 88). The
@VKB command is implemented for G4 compatibility. Syntax:
^VKB Variables: None Show Virtual Keypad Command - Brings up system virtual keypad, which is the keypad without a designated text entry area. A Text Input button must be in focus; if not, the keypad will not appear. The type of keypad is determined by the Text Area currently in focus. When user presses the Done button, a string is returned to the controller with the user-entered value. The keypad can be removed either by the Back button or the ^AKR command (page 88). The @VKP command is implemented for G4 compatibility.. Syntax:
^VKP Variables: None Virtual Key Stroke Command - Sends a Virtual Key Stroke to the Varia touch panel. Note: this command does not function in the same way as with G4 touch panels. Syntax:
^VKS-<keycode>
or
^TPF in G4. Note: For the key code values, please refer to the Virtual Keystroke Commands table on page 169. Variables: None keycode: Android key code decimal value. Note that these are not the same as Set Volume Command - Set the [specified] volume. Syntax:
^VOL,<level>,[optional type]
Variables:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 100 Panel Commands Level: the volume level from 0-100. The level will be scaled according to the platforms abilities. Type (option): Change the volume of the given type 0 = Controller volume (change all volumes simultaneously). Used by default if no type is specified. This is not a real volume, but instead is a virtual value that changes all other volume type concurrently. 10 = Alarm Volume 11 = Call Volume 12 = Media Volume 13 = Notification Volume 44 = Display the volume dialog (level is ignored) Note: the platform dialog sliders will NOT update if they are displayed when the command is received. They are accurate, however, if displayed after receiving the command. Examples:
SEND_COMMAND Panel,^VOL,50 Sets the controller volume to 50. SEND_COMMAND Panel,^VOL,50,0 Sets the controller volume to 50. Query Volume Command - Query the volume.Note: Allow 10-15 minutes for update to complete before sending another
^UPD command. Syntax:
?VOL,[optional type]
Variables:
Type (option) Get the volume of the given type 0 = Controller volume. Used by default if no type is specified. Since Controller volume is not a real volume, the value returned will actually be the Media Volume Value. 10 = Alarm Volume 11 = Call Volume 12 = Media Volume 13 = Notification Volume The response returned is a custom event with the following syntax:
?VOL Custom Event Property Value Port port command was received on ID 0 Type 1306 Flag 0 Value 1 volume level Value 2 volume type Value 3 0 Text String containing type=level Examples:
SEND_COMMAND Panel,?VOL Query the Controller volume. Response would be similar to:
Custom Event Property Value Port port command was received on ID 0 Type 1306 Flag 0 Value 1 80 Value 2 0 Value 3 0 Text Controller=80 SEND_COMMAND Panel,?VOL,10 Query the Alarm volume. Response would be similar to:
Custom Event Property Value Port port command was received on ID 0 Type 1306 Flag 0 Value 1 20 Value 2 10 Value 3 0 Text Media=72
^WCN Web Control Name (Panel to Controller) - Report the Web Control (VNC) name to the controller. This is originated in the panel and sent to the controller if VNC is enabled. VARIA Touch Panels - Configuration & Programming Manual
| TOC 101 Panel Commands WEBU
^WKE WAKE Update Firmware from URL - This command tells the panel to retrieve a firmware kit file from the included URL and update to the firmware included in that kit file. Syntax:
WEBU-<url>
Variables:
url: URL to the kit file. Support protocols are HTTP only at this time. Example:
SEND_COMMAND PANEL,WEBU,http://file.server/VARIA-firmware.kit Download and install the VARIA-firmware.kit file from the HTTP server file.server. Panel Wakeup Command - Place the panel in wake state. Wake state turns the display on. The WAKE command is implemented for G4 compatibility. Syntax:
^WKE Variables: None Example:
SEND COMMAND Panel,^WKE Wakes the panel from sleep (turn display on) VARIA Touch Panels - Configuration & Programming Manual
| TOC 102 Page Commands Page Commands are case in-sensitive Page Commands Flip to specified page using the named animation. Syntax:
^AFP-<page name>,<animation>,<origin>,<duration>
Variables:
Page Name: If the page name is blank, flip the to the previous page Animation: If blank/invalid, the default animation is Fade. Animation Name Center Door Fade Command Snytax* (see note below) Origin(s) Default Origin cntrdrfade, centerdoorfade, or center door fade top(2), bottom(3), left(4), right(5) right(5) Door Fade doorfade, door fade, or door top(2), bottom(3), left(4), right(5) right(5)
^AFP Fade Slide Slide Bounce fade slide center(1) center(1) top(2), bottom(3), left(4), right(5) right(5) sldbouce, slidebounce, or slide bounce top(2), bottom(3), left(4), right(5) right(5) Spin In spinin or spin in Spin Out spinout or spin out Zoom In zoomin or zoom in Zoom Out zoomout or zoom out center(1) center(1) center(1) center(1) center(1) center(1) center(1) center(1) Note: Multiple aliases for the transition name command syntax are allowed to maintain backwards compatibility with G4. Duration: Transition time in 10ths of a second. Range is 3-30 with 15 (1.5 seconds) as the default Examples:
SEND_COMMAND Panel,^AFP-NextPage,slide,4,5 Flip to NextPage sliding from the left for half a second. SEND_COMMAND Panel,^AFP-,centerdoorfade,2,10 Flip to NextPage center door fade from the top for a second. Collapse Collapsible Popup Command - Moves the named closeable popup to the collapsed position. Syntax:
^PCL-<popup name>;[optional target page]
Variables:
^PCL Popup name: the name of the popup to collapse Target page: name of the page hosting the popup to affect the change upon. If target page is not specified, the command is applied to the current page. Examples:
SEND_COMMAND Panel,^PCL-Contacts Collapse the Contacts popup on the current page. SEND_COMMAND Panel,^PCL-Contacts;Teleconference Control Collapse the Contacts popup on the Teleconference Control pages Collapsible Popup Custom Toggle Command - This is an advanced toggle command for collapsible popups, working with a comma-separated list of commands. This list is parsed and a command table is created. Based on the current state of the collapsible popup, the correct command is executed. Note: The previously parsed list is saved and is only parsed again if the command string differs for this popup. Syntax:
^PCT-<popup>,<custom toggle commands>;[optional target page]
Variables:
^PCT Popup: popup name Custom toggle commands: a comma separated list of commands. This list is parsed and a command table is created. The state letters are as follows: o - open c - collapsed d - dynamic, followed by an integer indicating the offset.
* - wildcard, always last in the list Before and after states are separated by -> characters. Target page: name of the page hosting the popup to affect the change upon. If target page is not specified, the command is applied to the current page. Example:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 103 Page Commands SEND_COMMAND Panel,^PCT-RightSlider,c->o,o->d100,*->c The popup named RightSlider opens if collapsed, move to d100 if open, and collapse otherwise. Collapsed Popup Dynamic Offset Command - Moves the collapsible popup to a specific offset position relative to the collapsed direction configured for the popup. This allows other positions besides open and collapsed. Syntax:
^PDO-<popup name>,<offset>;[optional target page]
Variables:
^PDO Popup name: name of the popup to affect offset: number of pixels to offset (hide). <offset> is constrained as follows: 0 <= offset <= collapsed offset Target page:
name of the page hosting the popup to affect the change upon. If target page is not specified, the command is applied to the current page. Examples:
^PDO-RightSlider,66 Move popup named RightSlider to an offset position of 66 on the current page.
^PDO-RightSlider,66;Media Controls Move popup named RightSlider to an offset position of 66 on the Media Controls page. Page Flip Command - Flips to a page with a specified page name. If the page is currently active, it will not redraw the page. The PAGE command is implemented for G4 compatibility. Syntax:
^PGE PAGE
^PGE-<page name>
or PAGE-<page name>
Variables: page name: Name of the page to be displayed. If left blank, the page flips back to the previous page. Examples:
SEND_COMMAND Panel,^PGE-Page1 Flips to page1. SEND_COMMAND Panel,^PGE-
Flips to the previous page. Open Collapsible Popup Command - Moves the named collapsible popup to the open position. Syntax:
^POP-<popup>;[optional target page]
Variables:
^POP Popup: the name of the popup to collapse Target page: name of the page hosting the popup to affect the change upon. If target page is not specified, the command is applied to the current page. Example:
SEND_COMMAND Panel, ^POP-Contacts Open the Contacts popup on the current page. SEND_COMMAND Panel, ^POP-Contacts;Teleconference Control Open the Contacts popup on the Teleconference Control page. Close All Popups Command - Close all popups on a specified page. The @PPA command is implemented for G4 compatibility. Syntax:
^PPA
@PPA
^PPF
@PPF PPOF
^PPA-<page name>
or
@PPA-<page name>
Variables:
Page name: Name of the page to close all popups on. If no name is specified, then the current page will have all popups closed. Example:
SEND_COMMAND Panel,^PPA-Page1 Close all pop-ups on Page1. Popup Page Off Command - Detach a popup from a page. If the page name is empty, the current page is used. 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 TPDesign 5. The @PPF and PPOF commands are implemented for G4 compatibility. Syntax:
^PPF-<popup page name>;[optional page name]
or
@PPF-<popup page name>;[optional page name]
or PPOF-<popup page name>;[optional page name]
Variables:
Popup page name: name of the popup page. page name: name of the page the popup is displayed On. If not specified the popup is detached from the current page. Examples:
SEND_COMMAND Panel,^PPF-Popup1;Main Detach the popup Popup1 from page Main. VARIA Touch Panels - Configuration & Programming Manual
| TOC 104 Page Commands SEND_COMMAND Panel,^PPF-Popup1 Detach the popup page Popup1 from the current page.
^PPG
@PPG PPOG Toggle a Popup Page - Toggle a specific popup page. If the page name is empty, the current page is used. 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 TPDesign. The @PPG and PPOG commands are implemented for G4 compatibility. Syntax:
^PPG-<popup page name>;[optional page name]
or
@PPG-<popup page name>;[optional page name]
or PPOG-<popup page name>;[optional page name]
Variables:
Popup page name: the name of the popup page. Page name: name of the page the popup is toggled on. If not specified the popup is toggled on the current page. Examples:
SEND_COMMAND Panel,^PPG-Popup1;Main Toggles the popup page Popup1 on the Main page from one state to another (On/Off). SEND_COMMAND Panel,^PPG-Popup1 Toggles the popup page Popup1 on the current page from one state to another (On/Off). Kill Popup Page Command - 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. The @PPK command is implemented for G4 compatibility. Syntax:
^PPK
@PPK
^PPK-<popup page name>
or
@PPK-<popup page name>
Variables:
Popup page name: name of the popup page. Example:
SEND_COMMAND Panel,^PPK-Popup1 Kills the popup page Popup1 on all pages. Popup modal command - Set whether a popup is modal or not modal. The @PPM command is implemented for G4 compatibility. Syntax:
^PPM
@PPM
^PPM-<popup page name>;<modal 1|0>
or
@PPM-<popup page name>;<moda1 mode 1|0>
Variables:
Popup page name: Name of the popup page. Modal mode: 1 if modal, 0 if non-modal. Example:
SEND_COMMAND Panel,^PPM-Popup1;1 Set the popup page named Popup1 to modal mode. Attach a popup on a page - Attach 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. 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 TPDesign5. The @PPN and PPON commands are implemented for G4 compatibility. Syntax:
^PPN-<popup page name>;[optional page name]
or
@PPN-<popup page name>;[optional page name]
or PPON-<popup page name>;[optional page name]
Variables:
Popup page name: name of the popup page. page name: name of the page the popup is displayed On. If the page name is not specified the current page is used.
^PPN
@PPN PPON Examples:
SEND_COMMAND Panel,^PPN-Popup1;Main Activates Popup1 on the Main page. SEND_COMMAND Panel,^PPN-Popup1 Activates the popup page Popup1 on the current page. Popup Timeout Command - Set the popup to close after timeout. The @PPT command is implemented for G4 compatibility. Syntax:
^PPT
@PPT
^PPT-<popup page name>;<timeout>
or
@PPT-<popup page name>;<timeout>
Variables:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 105 Page Commands Popup page name: the name of the popup to apply the timeout to. Popup must be visible on screen in order to apply timeout. Timeout: the time in tenths of seconds (10 = 1 second) or 0 to cancel timeout. Note: Successive calls to timeout will reset the timeout. A timeout of 0 cancels the timeout and the popup stays open. Examples:
SEND_COMMAND Panel,^PPT-MyPopup;150 Close MyPopup after 15 seconds. Close All Popup Pages Command - Close all popups on all pages. This command works in the same way as the Clear All command in TPDesign5. The @PPX command is implemented for G4 compatibility. Syntax:
^PPX
@PPX
^PPX or
@PPX Variables: None Example:
SEND_COMMAND Panel,^PPX Close all popups on all pages.
^PTC
^PTO Toggle Collapsible Popup Collapsed Command - Toggles the named collapsible popup between the open and collapsed positions. More specifically, if the popup is not fully collapsed, it is collapsed. Syntax:
^PTC-<popup>;[optional target page]
Variables:
Popup: the name of the popup to toggle Target page: name of the page hosting the popup to affect the change upon. If target page is not specified, the command is applied to the current page. Examples:
SEND_COMMAND Panel,^PTC-Contacts Toggle the Contacts popup collapsed on the current page. SEND_COMMAND Panel,^PTC-Contacts;Teleconference Control Toggle the Contacts popup collapsed on the Teleconference Control page. Note: Collapsible popup send commands do not automatically show the popup on the target page. The popup must be first shown with a standard show command. This applies even when the collapsible popup is a member of a popup group. For all of these commands, if the target page is blank, the current page is used. If the named popup is not collapsible, the commands are ignored. Toggle Collapsed Popup Open Command - Toggles the named collapsible popup between the open and collapsed positions. More specifically, if the popup is not fully open, it is opened. Syntax:
^PTO-<popup>;[optional target page]
Variables:
Popup: the name of the popup to toggle Target page: name of the page hosting the popup to affect the change upon. If target page is not specified, the command is applied to the current page. Examples:
SEND_COMMAND Panel,^PTO-Contacts Toggle the Contacts popup open on the current page. SEND_COMMAND Panel,^PTO-Contacts;Teleconference Control Toggle the Contacts popup open on the Teleconference Control page. Note: Collapsible popup send commands do not automatically show the popup on the target page. The popup must be first shown with a standard show command. This applies even when the collapsible popup is a member of a popup group. For all of these commands, if the target page is blank, the current page is used. If the named popup is not collapsible, the commands are ignored. VARIA Touch Panels - Configuration & Programming Manual
| TOC 106 Button Commands Button Commands Multistate Button Animation Command - Commands a multistate button to animate from a starting state to an ending state. Syntax:
^ANI-<addr range>,<start state>,<end state>,<time>
^ANI Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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-1,1,10,50 Command button with Address 1 to animate from state 1 to state 10 over 5 seconds. Add page flip action - Add page flip action to a button. This command installs a page flip command to the Button Release event action. Syntax:
^APF-<addr range>,<page flip action>,<page name> [,<animation>,[origin],[duration]]
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. page flip action: (see the following): Stan[dardPage] - flip to standard page StanAni - flip to standard page with animation PrevAni - flip to previous page with animation Prev[iousPage] - flip to previous page Show[Popup] - Show popup page Hide[Popup] - Hide popup page Togg[lePopup] - toggle popup state ClearG[roup] - clear popup page group from all pages ClearP[age] - clear all popup pages from a page with the specified page name ClearA[ll] - Clear all popup pages from all pages Page Name: the name of the page to flip to, or name of popup to show/hide/toggle Animation: If animated flip, the animation to perform. Origin: If animated flip, the origin of the animation. Duration: Transition time in 10ths of a second. Range is 3-30 with 15 (1.5 seconds) as the default
^APF Animation Name Command Snytax* (see note below) Origin(s) Default Origin Center Door Fade cntrdrfade, centerdoorfade, or center door fade top(2), bottom(3), left(4), right(5) right(5) Door Fade doorfade, door fade, or door top(2), bottom(3), left(4), right(5) right(5) Fade Slide fade slide center(1) top(2), bottom(3), left(4), right(5) Slide Bounce sldbouce, slidebounce, or slide bounce top(2), bottom(3), left(4), right(5) Spin In Spin Out Zoom In spinin or spin in spinout or spin out zoomin or zoom in Zoom Out zoomout or zoom out center(1) center(1) center(1) center(1) center(1) right(5) right(5) center(1) center(1) center(1) center(1) Note: Multiple aliases for the transition name command syntax are allowed to maintain backwards compatibility with G4. Example:
SEND COMMAND Panel,APF-400,StanAni,Main Page,ZoomIn,30 Add animated page flip action to button 400 to flip to Main Page using zoom in for 3 seconds. Append UTF-8 Text to State Command - append non-unicode text. Syntax:
^BAF-<addr range>,<button states range>,<new text>
^BAF Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for general buttons 1 = Off state and 2 = On state). new text: UTF-8 encoded characters. Examples:
SEND_COMMAND Panel,^BAF-520,1, Appends the UTF-8 text ? to the buttons OFF state
^BAT Append Text to State Command - Append non-unicode text. Syntax:
^BAT-<addr range>,<button states range>,<new text>
VARIA Touch Panels - Configuration & Programming Manual
| TOC 107 Button Commands Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for general buttons 1 = Off state and 2 = On state). new text: ISO-8859-1 encoded characters Examples:
SEND_COMMAND Panel,^BAT-520,1,Enter City Appends the text Enter City to the buttons OFF state. Append Unicode Text to State Command - Append unicode text. Same format as ^UNI. Syntax:
^BAU-<addr range>,<button states range>,<unicode text>
^BAU Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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 characters must be entered in Hex format. Example:
SEND_COMMAND Panel,^BAU-520,1,00770062 Appends Unicode text 00770062 (wb) to the buttons OFF state. Set Border Color Command - Set the border color to the specified color. Only if the specified border color is not the same as the current color. Syntax:
^BCB-<addr range>,<button states range>,<color value>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address.
^BCB button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). color value: See color table for more information. Note: Colors can be set by Color Numbers, Color name, RGB alpha colors (RRGGBBAA) or RGB colors values (RRGGBB). RGBA and RGB color are given in HEX ASCII prepended by a #. Examples:
SEND_COMMAND Panel,^BCB-500.504&510,1,12 Sets the Off state border color to 12 (Yellow). SEND_COMMAND Panel,^BCB-520,2,#FF000080 Set the ON state border color to RED with opacity at 128 ($80 / 0x80). Get Border Color Command - Get the current border color. Syntax:
?BCB-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). Value is returned in a custom event with the following properties:
Custom Event Property Value Port port command was received on ID Address code of the button responding Type 1011 Flag 0 Value 1 Button state number Value 2 Actual length of string (should be 9) Value 3 0 Text Hex encoded color value (ex:
#000000FF) Examples:
?BCB SEND COMMAND Panel,?BCB-529,1 Gets the button OFF state border color. information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1011 Flag 0 Value 1 1 Value 2 9 Value 3 0 Text #222222FF
^BCF Background Color Fill Command - Set the background color fill to specified color in state(s). Syntax:
^BCF-<addr range>,<button state range>,<color value>
VARIA Touch Panels - Configuration & Programming Manual
| TOC 108 Button Commands Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 =
Off state and 2 = On state). color value: See the color table on page 165 for details. Note: Colors can be set by Color Numbers, Color name, RGB alpha colors (RRGGBBAA) or RGB colors values (RRGGBB). RGBA and RGB color are given in HEX ASCII prepended by a #
Examples:
SEND_COMMAND Panel,^BCF-500.504&510.515,1,Blue Sets the OFF state background color fill for the buttons with variable text ranges of 500-504 & 510-515 to Blue. Get Fill Color Command - Get the current fill color. Syntax:
?BCF-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). Value is returned in a custom event with the following properties:
Custom Event Property Value Port port command was received on ID Address code of the button responding Type 1012 Flag 0 Value 1 Button state number Value 2 Actual length of string (should be 9) Value 3 0 Text Hex encoded color value (ex: #000000FF) Examples:
?BCF SEND COMMAND Panel,?BCF-529,1 Gets the button OFF state fill color. information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1012 Flag 0 Value 1 1 Value 2 9 Value 3 0 Text #FF8000FF Set Text Color Command - Set the text color to the specified color. Syntax:
^BCT-<addr range>,<button states range>,<color value>
^BCT Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). color value: See the color table on page 165 for details. Note: Color can be assigned by color name (without spaces), number or R,G,B value (RRGGBB or RRGGBBAA). Examples:
SEND_COMMAND Panel,^BCT-500.504&510,1,12 Sets the OFF state text color to 12 (Very Light Yellow). Get Text Color Command - Get the current text color. Syntax:
?BCT-<addr range>,<button states range>
?BCT Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). Value is returned in a custom event with the following properties:
Custom Event Property Value Port port command was received on ID Address code of the button responding Type 1013 Flag 0 Value 1 Button state number Value 2 Actual length of string (should be 9) Value 3 0 Text Hex encoded color value (ex: #000000FF) Examples:
SEND COMMAND Panel,?BCT-529,1 VARIA Touch Panels - Configuration & Programming Manual
| TOC 109 Button Commands Gets the button OFF state text color. information. The result sent to the Controller would be:
Custom Event Property Value Port 529 ID Address code of the button responding Type 1013 Flag 0 Value 1 1 Value 2 9 Value 3 0 Text #FFFFEFF Button Drag and Drop Custom Event Command - This command configures Drag and Drop custom events. This command can be used to enable or disable the transmission of custom events to the controller whenever certain operations occur. For example, the system programmer may want to be notified whenever a drag button enters an acceptable target. The notification mechanism is a custom event. The ^BDC command takes the form of a comma separated list of custom event numbers. If the number is 0 or blank for a given event type then no custom event will be transmitted when that event occurs. If a number is specified, then it is used as the EVENT TYPE value for the custom event. The range of 32001 to 65535 has been reserved in the panel for user custom event numbers. A different value could be used but might collide with other AMX event numbers. Event configuration is not permanent and all event numbers revert to the default of 0 when the panel restarts. Syntax:
^BDC-<drag start event number>,<enter valid drop target event number>,
<exit valid drop target event number>,<drop event number>,<drag cancel event number>,
<enter invalid drop target event number>,<exit invalid drop target event number>
Variables:
enabled, the default values are:
drag start event number: Value of a drag start event. enter valid drop target event number: Value of an enter valid drop target event. enter valid drop target event number: Value of an enter valid drop target event. exit valid drop target event number: Value of an exit valid drop target event. drop event number: Value of a drop event drag cancel event number: Value of a drag cancel event enter invalid drop target event number: Value of an enter invalid drop target event. exit invalid drop target event number: Value of an exit invalid drop target event. By default the ^BDC command is DragStartedEvent = 1410 ValidDropEnterEvent = 1411 ValidDropExitEvent = 1412 DropEvent = 1413 DragCancelEvent = 1414 InvalidDropEnterEvent = 1415;
InvalidDropExitEvent = 1416
^BDC To disable the ^BDC command send: ^BDC-0,0,0,0,0,0,0 The events DragStarted - a draggable button has initiated a drag ValidDropEntered - a draggable button has entered a valid target ValidDropExited - a draggable button has exited a valid target Drop - a draggable button has been dropped on a valid target DragCancel - a draggable button has been dropped outside of a valid target InvalidDropEntered - a draggable button has entered an invalid target InvalidDropExited - a draggable button has exited an invalid target are:
In response to any or all of the above events, the panel will create a custom event which is then sent to the controller. The format of START custom events transmitted to the controller are as follows:
CUSTOM.TYPE = the specified drag event custom event type
(started) CUSTOM.ID = the address of the viewer button which generated the event CUSTOM.FLAG = 0 CUSTOM.VALUE1 = the button address of the draggable CUSTOM.VALUE2 = 0 CUSTOM.VALUE3 = 0 CUSTOM.TEXT =
dr{ch=<channelPort>,<channel>:ad=<addressPort>,<address>:gp=<groupName>:nm=<buttonName>}
dt{vl=<dropTargetValid 1=valid,0=invalid>:ch=<channelPort>,<channel>:ad=<addressPort>,
<address>:nm=<buttonName>}
VARIA Touch Panels - Configuration & Programming Manual
| TOC 110 Button Commands dt{vl=<dropTargetValid 1=valid,0=invalid>:ch=<channelPort>,<channel>:ad=<addressPort>,
<address>:nm=<buttonName>}
The CUSTOM.TEXT provides data sets that represent the draggables info (dr). The draggables info included is the drag channel port, the drag channel code, the drag address port, the drag address code, the drag group name, and the drag button name. Drag target info is also presented, with a data set for each drag target visible at that time. The drag targets info (dt) includes the target validity to accept the drop, the drop target channel port, the drop target channel code, the drop target address port, the drop target address code, and the drop target button name. Buttons are identified as dr (draggable) or dt (drop target) Button properties are contained between open brace ( { ) and close brace ( } ) Button properties are represented by key=value pairs (KVP). Keys are two letters followed by equal ( = ) by convention but the two letter keys are not a requirement. Property KVPs are separated by colon ( : ). Each Buttons data sets are on a separate line (i.e. the close brace is followed by a \n). Key values. dr = draggable ch = channel (port,channel) ad = address (port,address) gp = group name nm = button name dt = drop target vl = validity of drop target (valid=1, invalid=0) ch = channel (port,channel) ad = address (port,address) nm = button nameBy default the ^BDC command is enabled, the default values are:
Example texts:
dr{ch=1,31:ad=1,31:gp=:nm=Drag1}
dt{vl=1:ch=1,101:ad=1,101:nm=Tgt1}
dt{vl=1:ch=3,103:ad=3,103:nm=Tgt3}
dt{vl=1:ch=3,103:ad=3,103:nm=Tgt3}
dt{vl=0:ch=1,11:ad=1,11:nm=Grp1 Tgt1}
dt{vl=0:ch=1,12:ad=1,12:nm=Grp1 Tgt2}
dt{vl=0:ch=2,11:ad=2,11:nm=Grp2 Tgt1}
dt{vl=0:ch=1,15:ad=1,15:nm=Grp1 Tgt5}
dt{vl=0:ch=1,16:ad=1,16:nm=Grp1 Tgt6}
dt{vl=0:ch=2,13:ad=2,13:nm=Grp2 Tgt3}
dt{vl=0:ch=1,15:ad=1,15:nm=Grp1 Tgt5}
dt{vl=0:ch=1,16:ad=1,16:nm=Grp1 Tgt6}
dt{vl=0:ch=2,13:ad=2,13:nm=Grp2 Tgt3}
dr{ch=2,4:ad=2,4:gp=Group1+2:nm=Drag2_4}
dt{vl=1:ch=1,11:ad=1,11:nm=Grp1 Tgt1}
dt{vl=1:ch=1,12:ad=1,12:nm=Grp1 Tgt2}
dt{vl=1:ch=2,11:ad=2,11:nm=Grp2 Tgt1}
dt{vl=1:ch=1,15:ad=1,15:nm=Grp1 Tgt5}
dt{vl=1:ch=1,16:ad=1,16:nm=Grp1 Tgt6}
dt{vl=1:ch=2,13:ad=2,13:nm=Grp2 Tgt3}
dt{vl=1:ch=1,15:ad=1,15:nm=Grp1 Tgt5}
dt{vl=1:ch=1,16:ad=1,16:nm=Grp1 Tgt6}
dt{vl=1:ch=2,13:ad=2,13:nm=Grp2 Tgt3}
dt{vl=0:ch=1,101:ad=1,101:nm=Tgt1}
dt{vl=0:ch=3,103:ad=3,103:nm=Tgt3}
dt{vl=0:ch=3,103:ad=3,103:nm=Tgt3}
A NetLinx .AXI file that can provide routines to parse the drag and drop info strings can be found on page 198 The format of VALIDENTER/VALIDEXIT/CANCEL custom events transmitted to the controller are as follows:
CUSTOM.TYPE = the specified drag event (validEntered/validExited/drop/cancel) CUSTOM.ID = the address of the drag/drop button which generated the event CUSTOM.FLAG = 0 // 0 specifies valid CUSTOM.VALUE1 = the button address of the draggable CUSTOM.VALUE2 = 0 CUSTOM.VALUE3 = 0 CUSTOM.TEXT =
The format of INVALIDENTER/INVALIDEXIT custom events transmitted to the controller are as follows:
CUSTOM.TYPE = the specified drag event (invalidEntered/invalidExited) CUSTOM.ID = the address of the drag/drop button which generated the event CUSTOM.FLAG = 65535 (-1) // -1 specifies invalid target CUSTOM.VALUE1 = the button address of the draggable CUSTOM.VALUE2 = 0 CUSTOM.VALUE3 = 0 VARIA Touch Panels - Configuration & Programming Manual
| TOC 111 Button Commands CUSTOM.TEXT =
If the VALIDENTER and INVALIDENTER events are set to the same event number, the flag value indicates whether the targets are valid or not. 0 == valid, 65535 (-1) == invalid. If the VALIDEXIT and INVALIDEXIT events are set to the same event number, the flag value indicates whether the targets are valid or not. 0 == valid, 65535 (-1) == invalid. The format of the DROP custom event transmitted to the controller is as follows:
CUSTOM.TYPE = the specified drag event (started/entered/exited/drop/cancel) the address of the viewer button which generated the event CUSTOM.ID = the address of the viewer button which generated the event CUSTOM.FLAG = 0 CUSTOM.VALUE1 = the button address of the draggable CUSTOM.VALUE2 = the button address of the dropTarget CUSTOM.VALUE3 = 0 CUSTOM.TEXT = group name to which the dropTarget belongs Example:
SEND_COMMAND panel,^BDC-32001,32002,32003,32004,32005 After the users sends this command to the panel, if the user then drags a button addressed 9 and then proceeds to drop that draggable button on a dropTarget button addressed 10, the following event would be transmitted to the controller. CUSTOM.ID = 10 (the dropTarget receives the drop event) CUSTOM.TYPE = 32004 (this our drop event) CUSTOM.FLAG = 0 CUSTOM.VALUE1 = 9 (the button we dragged over the target & dropped) CUSTOM.VALUE2 = 10 (the dropTarget that the draggable was dropped on) CUSTOM.VALUE3 = 0 CUSTOM.TEXT = (a name we had given to the group the target was assigned,since the target was not assigned to a group well receive an empty string)
?BDC Query Button Drag and Drop Custom Event Command - Get the drag and drop custom event values. Syntax:
?BDC Variables: None The response returned is a custom event with the following syntax:
CUSTOM.TYPE = 0 CUSTOM.ID = 1332 CUSTOM.FLAG = 0 CUSTOM.VALUE1 = 0 CUSTOM.VALUE2 = 0 CUSTOM.VALUE3 = 0 CUSTOM.TEXT = String containing a comma separated list of Button Drag & Drop Custom Event values
[StartEventNum],[ValidEnterEventNum],[ValidExitEventNum],[DropEventNum],[CancelEventNum],
[InvalidEnterEventNum],[InvalidExitEventNum]
Example:
SEND_COMMAND Panel,?BDC Query the Controller Button Drag and Drop Custom Event values. Response would be similar to:
Custom.ID = 0 Custom.Type = 1332 Custom.Flag = 0 Custom.Value1 = 0 Custom.Value2 = 0 Custom.Value3 = 0 Custom.Text = 1410,1411,1412,1413,1414,1415,1416 Button set feedback command - Set the feedback type of the button. ONLY works on General-type buttons. Syntax:
^BFB-<addr range>,<feedback type>
^BFB Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. feedback type: None, Channel, Invert, On (Always on), Momentary. Example:
SEND_COMMAND Panel,^BFB-500,Momentary Sets the Feedback type of the button to Momentary.
^BIM Button set input mask command - Set the input mask for the specified address. Syntax:
^BIM-<addr range>,<input mask>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. VARIA Touch Panels - Configuration & Programming Manual
| TOC 112 Button Commands input mask: Refer to Appendix C: Text Formatting on page 189 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). Button Input Type Command - Modifies the keyboard type of the text input button(s) with given address(es). If this is sent to a button that is not a Text Input button, it has no effect. Syntax:
^BIT-<address range>,<Input Type>,<return port>
Variables:
^BIT Address Range: range of addresses that this command applies to Input Type: Input Type to Change to, as specified here: http://developer.android.com/reference/android/text/InputType.html 1: Text 2: Number (standard keypad) 3: Telephone 4: Date/Time Return port: The port number to return the response on if different than the port to which the command is sent. Button copy command - Copy attributes of the source button to all the destination buttons. Note that the source is a single button state. Each state must be copied as a separate command. The <codes> section represents what attributes will be copied. All codes are 2 char pairs that can be separated by comma, space, percent or just ran together. Syntax:
^BMC-<addr range>,<button states range>,<source port>,<source address>,
<sourcestate>,<codes>
Variables:
address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). source port: port number of button to copy from. source address: address number of button to copy from. source state: state number of button to copy from. codes:
BM - Picture/Bitmap BR - Border CB - Border Color CF - Fill Color CT - Text Color EC - Text effect color EF - Text effect FT - Font JB - Bitmap alignment JT - Text alignment OP - Opacity SO - Button Sound TX - Text WW - Word wrap on/off Examples:
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. SEND_COMMAND Panel,^BMC-150,1,1,315,1,%BR%FT%TX%BM%CF%CT Copies the OFF state border, font, Text, bitmap, fill color and text color of the button with a variable text address of 315 onto the OFF state border, font, Text, bitmap, fill color and text color of the button with a variable text address of 150. Note: Use this command if you are using the panels default color palette. For custom color palettes, use ^BMF instead. Button Modify Command - Set any/all button parameters by sending embedded codes and data. Syntax:
^BMF-<addr range>,<button states range>,<data>
Note: Many subcommands do not use button state information. Refer to the subcommand for details Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). data:
%B<border style>
^BMC
^BMF
%CB<on border color>
%CF<on fill color>
%CT<on text color>
Set the border style name. (No support for states.) Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set Border Color. Set Fill Color. Set Text Color. VARIA Touch Panels - Configuration & Programming Manual
| TOC 113 Button Commands
%EC<text effect color>
%EF<text effect name>
%EN<1 or 0>
%F<primary_font_filename:
primary_font_size>, <alternate_font_filename:
alternate_font_size
%GC<bargraph slider color>
%GD<bargraph ramp down>
%GG<bargraph drag increment>
%GH<bargraph hi>
%GI<bargraph invert>
%GL<bargraph low>
%GN<bargraph slider name>
%GR<repeat interval
%GU<bargraph ramp up>
%GV<bargraph value>
%J,<set text alignment 0-10>
%JB<alignment of bitmap 0-10>
%JT<alignment of text 0-9>
%MI<mask image>
%MK<input mask>
%ML<max length>
%MI<mask image>
%OP<0-255>
%OP#<00-FF>
%OT<feedback type>
%P<bitmap,bitmap_index, justification>
%R<l,t,r,b
%OP<0-255>
%SC<1 or 0>
%SF<1 or 0>
%SM
%SP<spacing>
%SO<sound>
%SW<1 or 0>
Set the text effect color. Set the text effect. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Enable/disable a button. Set the font filename and optional font size for the primary font and/or the alternate font. Set the bargraph slider color Set the bargraph ramp down time in 1/10 second. Set the bargraph drag increment. Refer to the ^GDI command (page 125) for more information. Set the bargraph upper limit. Set the bargraph invert/non-invert. Set the bargraph lower limit. Set the bargraph slider name/Joystick cursor name. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set bargraph repeat interval. Set the bargraph ramp up time in intervals of 1/10 second. Set the bargraph value. As shown in the Justification Values table (page 166), BUT the 0 (zero) is absolute and followed by ,<left>,<top>
As shown in the Justification Values table (page 166) BUT the 0 (zero) is absolute and followed by ,<left>,<top>
As shown in the Justification Values table (page 166) BUT the 0 (zero) is absolute and followed by ,<left>,<top>
Set the mask image. Refer to the ^BMI command for more information. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set the input mask of a text area. See the text input mask area for more information. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set the maximum length of a text area. Set the mask image. Refer to the ^BMI command for more information. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set the button opacity to either Invisible (value=0) or Opaque
(value=255). Set the button opacity to either Invisible (value=00) or Opaque
(value=FF). Set the Feedback (Output) Type to one of the following: None, Channel,Invert, ON (Always ON), Momentary, or Blink. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set the picture/bitmap filename (empty is clear). Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Sets button location and also resizes the button. For more information, please refer to the ^BSP command (see page 122). Set the button opacity to either Invisible (value=0) or Opaque
(value=255). Set the bitmap scale to fit. Set the focus for text area button. (No support for states.) Submit a text for text area button. (No support for states.) Set subpage viewer subpage spacing. (No support for states.) Set the button sound. Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Show/hide a button. (No support for states.) VARIA Touch Panels - Configuration & Programming Manual
| TOC 114 Button Commands
%T<text >
%UN<Unicode text>
%UT<UTF-8 text>
%WW<1 or 0>
Set the text using ASCII characters (empty is clear). Note: This parameter should be always used in its own BMF command, and should not be combined with other BMF subcommands. Set the Unicode text. See ^UNI on page 136 for the text format. Set the Unicode text. See ^UTF on page 137 for the text format. Word wrap ON/OFF. For some of these commands and values, refer to the RGB Values for all 88 Basic Colors table. Example:
SEND_COMMAND Panel,^BMF-500,1,%B10%CFRed%CB Blue %CTBlack%Ptest.png Sets the button OFF state as well as the Border, Fill Color, Border Color, Text Color, and Bitmap. Note: Use this command if you are using custom color palette for your panel. If you intend to use the default color palette, use
^BMC (page 113) instead. Note: To accept unspecified parameters, use either ,, or ,-1. If left or top is unspecified, then the current values for the button will be used. If right or bottom is unspecified, the current width and height is used to maintain the button size. This effectively creates a button move command (also works with ^BSP - see page 122. Set state mask image command - Assign a Chameleon mask image to those buttons with a defined address and state range. Syntax:
^BMI-<addr range>,<button states range>,<name of mask image>
^BMI Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). name of mask image: The filename of the mask image in the TPD5 file to use. Example:
SEND_COMMAND Panel,^BMI-500.504&510.515,1,mask.png Sets the OFF state mask image for the buttons with address ranges of 500-504 & 510-515 to mask.png. Set text input max length command - Set the maximum length of the text area button. If this value is set to zero (0), the text area has no max length. This is only for a Text area input button and not for a Text area input masking button. Syntax
^BML
^BML-<addr range>,<max length>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. max length: The maximum length in characters of a text input area. (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 Set State Bitmap Command - Assign a picture to those buttons with a defined address range. Syntax:
^BMP-<addr range>,<button states range>,<name of bitmap/picture>,[bitmap index],[optional justification]
Variables:
- Absolute position: If absolute justification is set, the next two parameters are the X and Y offset of the bitmap 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 : ASCII characters. Optional bitmap index: 0 - 5, the state bitmap index to assign the bitmap. If not present, will place the referenced bitmap in index 1. The indexes are defined as:
0 - Chameleon Image (if present) 1 - Bitmap 1 2 - Bitmap 2 3 - Bitmap 3 4 - Bitmap 4 5 - Bitmap 5 Optional justification: 0-10 where:
0 for the referenced index. 1
- top left 2
- top center 3
- top right 4
- middle left 5
- middle center 6
- middle right 7
- bottom left 8
- bottom center 9
- bottom right 10
- scale to fit 11
- scale-maintain-aspect-ratio If no justification is specified, the current justification is used. VARIA Touch Panels - Configuration & Programming Manual
| TOC 115 Button Commands 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. Query State Bitmap Command - Get the current bitmap name. Syntax:
?BMP-<addr range>,<button states range>,[index]
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). Optional index: 0-5, the state bitmap index to assign the bitmap. If not present, will place the referenced bitmap in index 1. The indexes are defined as:
0 1 2 3 4 The response returned is a custom event with the following properties:
Custom Event Property Value
- Chameleon Image (if present)
- Bitmap 1
- Bitmap 2
- Bitmap 3
- Bitmap 4 5 - Bitmap 5
?BMP Port port command was received on ID address code of button Type 1002 Flag 0 Value 1 state number Value 2 length of text Value 3 bitmap index Text bitmap name Example:
SEND_COMMAND Panel,?BMP-529,1 Gets the button OFF state bitmap information (index 1 since index is unspecified). Example response:
Custom Event Property Value Port port command was received on ID 529 Type 1002 Flag 0 Value 1 1 Value 2 9 Value 3 1 Text Buggs.png Set State Bitmap Extended Command - Assign a picture with justifications to those buttons with a defined address range. Syntax:
^BMX-<addr range>,<button states range>,<name of bitmap/picture/resource,index,justification>;
<name of bitmap/picture/resource,index,justification>; <name of bitmap/picture/resource,index, justification>
^BMX Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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: The filename of the bitmap in the TPD5 file to use. Optional bitmap index: 0 - 5, the state bitmap index to assign the bitmap. If not present, will place the referenced bitmap in index 1. The indexes are defined as:
0 - Chameleon Image (if present) 1 - Bitmap 1 2 - Bitmap 2 3 - Bitmap 3 4 - Bitmap 4 5 - Bitmap 5 Optional justification: 0-11 where:
0 for the referenced index. 1
- top left 2
- top center 3
- top right 4
- middle left 5
- middle center 6
- middle right 7
- bottom left
- Absolute position: If absolute justification is set, the next two parameters are the X and Y offset of the bitmap VARIA Touch Panels - Configuration & Programming Manual
| TOC 116 Button Commands
- bottom center
- bottom right
- scale to fit
- scale-maintain-aspect-ratio 8 9 10 11 If no justification is specified, the current justification is retained. Example:
SEND_COMMAND Panel,^BMX-
500.504&510.515,1,bitmap.png,1,5;bitmap2.png,2,0,100,50;bitmap3.png,3,1 Sets the OFF state pictures for the buttons with address ranges of 500-504 & 510-515 as follows: bitmap.png is assigned to index 1 and is middle center justified. bitmap2.png is assigned to index 2 and is absolute justified with an X offset of 100 and a Y offset of 50. bitmap3.png is assigned to index 3 and is top left justified. Query State Bitmap Extended Command - Get the current bitmap name and justification for one or all indexes. Syntax:
?BMX-<addr range>,<button states range>,[index]
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). bitmap index: 0 - 5, the state bitmap index to assign the bitmap. If not present, will place the referenced bitmap in index 1. The indexes are defined as:
0
- Chameleon Image (if present) 1
- Bitmap 1 2
- Bitmap 2 3
- Bitmap 3 4
- Bitmap 4 5 - Bitmap 5 The response returned is a series of custom events (one for each valid index) with the following syntax:
Custom Event Property Value Port Button Address code ID address code of button Type 1018 Flag 0 Value 1 Button state number Value 2 Length of Custom.Text Value 3 Index of bitmap (0-5) Text String that describes the bitmap name/justification. The text looks like: bitmapname,justification If absolute justification is set, then the X and Y offset are appended to the description. See page 166 for justification mapping. Example:
SEND_COMMAND Panel,?BMX-529,1 Gets the button OFF state bitmap information (all index with a bitmap since index is unspecified). Example response:
Custom Event 1:
Custom.ID = 529 Custom.Type = 1018 Custom.Flag = 0 Custom.Value1 = 1 Custom.Value2 = 34 Custom.Value3 = 1 Custom.Text = button-background.png,scale-to-fit Custom Event 2:
Custom.ID = 529 Custom.Type = 1018 Custom.Flag = 0 Custom.Value1 = 1 Custom.Value2 = 26 Custom.Value3 = 2 Custom.Text = arrow.png absolute,200,100 Custom Event 3:
Custom.ID = 529 Custom.Type = 1018 Custom.Flag = 0 Custom.Value1 = 1 Custom.Value2 = 22 Custom.Value3 = 3 Custom.Text = img_Varia,middle-center For this case, 3 bitmaps are defined and 3 custom event s are sent as a response.
?BMX VARIA Touch Panels - Configuration & Programming Manual
| TOC 117 Button Commands Button Opacity Command - Set the button opacity in the selected state(s). Syntax:
^BOP-<addr range>,<button state range>,<opacity>
^BOP Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). opacity: An integer value from 0-255 where 0 is fully transparent and 255 is fully opaque, or #XX where the value after the # is a HEX number between 0 and FF. Example:
SEND_COMMAND Panel,^BOP-500.504&510.515,1,200 Sets the OFF state opacity for the buttons with address ranges of 500-504 & 510-515 to 200. SEND_COMMAND Panel,^BOP-500.504&510.515,1,#C8 Sets the OFF state opacity for the buttons with address ranges of 500-504 & 510-515 to 200 (0xC8). Get button opacity command - Get the overall button opacity. Syntax
?BOP-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). The response returned is a series of custom events (one for each valid index) with the following syntax:
Custom Event Property Value Port port command was received on ID address code of button Type 1015 Flag 0 Value 1 state number Value 2 opacity Value 3 0 Text Examples:
?BOP SEND COMMAND Panel,?BOP-529,1 Gets the button OFF state opacity information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1015 Flag 0 Value 1 1 Value 2 200 Value 3 0 Text Button State Video Fill Command - Sets the button state to display either a Video or Non-Video window. Syntax
^BOS-<addr range>,<button states range>,<video state>
^BOS Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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, URL Video On = 1, MPL Video On = 101. Example:
SEND_COMMAND Panel,^BOS-500,1,1 Sets the button to display video. Query Button State Video Fill Command - get the current button state video fill. Syntax:
?BOS-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). The response returned is a custom event with the following syntax:
Custom Event Property Value
?BOS Port port command was received on ID address code of button Type 1017 Flag 0 Value 1 state number Value 2 video state video state values:
0 = no video fill 100 = video fill 101 = MPL video fill VARIA Touch Panels - Configuration & Programming Manual
| TOC 118 Button Commands Value 3 0 Text video URL (or empty if no video) Example:
SEND_COMMAND Panel,?BOS-560,1 Gets the button OFF state video fill. Example response:
Custom Event Property Value Port port command was received on ID 560 Type 1017 Flag 0 Value 1 1 Value 2 1 Value 3 0 Text 1 Button state border command - Set the border of a button state/states. Syntax
^BRD-<addr range>,<button states range>,<border name>
^BRD Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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 Examples:
SEND_COMMAND Panel,^BRD-500.504&510.515,1&2,Double Line Sets the border by name (Double Line) to those buttons with the variable text range of 500-504 & 510-515. Get border name command - Get the current border name. Syntax:
?BRD-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). The response returned is a custom event with the following syntax:
Custom Event Property Value Port port command was received on ID address code of button Type 1014 Flag 0 Value 1 state number Value 2 text length Value 3 0 Text borner name Example:
?BRD SEND COMMAND Panel,?BRD-529,1 Gets the button OFF state border information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1014 Flag 0 Value 1 1 Value 2 22 Value 3 11 Text Double Line Button Focus Command - Set the focus to the text area. Note: Select one button at a time (single variable text address). Do not assign a variable text address range to set focus to multiple buttons. Only one variable text address can be in focus at a time. Syntax:
^BSF
^BSF-<addr range>,<selection value>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. selection value: Unselect = 0 and select = 1. Example:
SEND_COMMAND Panel,^BSF-500,1 Sets the focus to the text area of the button.
^BSM Button Submit Text Command - This command causes the text areas to send their text as strings to the NetLinx Controller. Syntax
^BSM-<addr range>
VARIA Touch Panels - Configuration & Programming Manual
| TOC 119 Button Commands Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. Example:
SEND_COMMAND Panel,^BSM-500 Returns a String of format <button name>-<text>. The string is returned on the port a ^BIT command was received on, or if that has not occurred, is sent on the address port. Button state sound - 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-<addr range>,<button states range>,<sound name>
^BSO Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). sound name: Sound file name. If blank or file not found the sound is cleared. Example:
SEND_COMMAND Panel,^BSO-500,1&2,music.wav Assigns the sound music.wav to the button Off/On states. Set Button Size and Position Command - Set the button size and its position on the page. Syntax:
^BSP-<addr range>,<left>,<top>,<right>,<bottom>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. left: position of left edge of the button on the panel top: position of the top edge of the button on the panel right: position of right edge of the button on the panel bottom: position of the bottom edge of the button on the panel Example:
^BSP SEND_COMMAND Panel,^BSP-530,20,100,50,130 Makes the button with variable text address 530 appear at (20,100) and be 30px by 30px As of firmware version 1.6.3, this command has been modified to support default parameters. To specify a default parameter you can either use -1 or leave it empty. This simplifies operations such as button moves where you dont want to calculate a right and bottom. The meaning of a given defaulted parameter is as follows:
left: use the current left position top:
use the current top position right: calculate a new right position which is the left position plus the width bottom:
calculate a new bottom position which is the top position plus the height Note: To accept unspecified parameters, use either ,, or ,-1. If left or top is unspecified, then the current values for the button will be used. If right or bottom is unspecified, the current width and height is used to maintain the button size. This effectively creates a button move command (also works with %R in ^BMF - see page 114). Example (An easy button move):
SEND_COMMAND Panel,^BSP-530,20,100 Button State Word Wrap Enable/Disable - Set the button word wrap feature to those buttons with a defined address range. By default, word-wrap is Off. Syntax:
^BWW-<addr range>,<button states range>,<word wrap>
^BWW Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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. Get Button State Word Wrap - Get the current word wrap flag status. Syntax:
?BWW-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). Response is a custom event with the following properties:
Custom Event Property Value
?BWW Port port command was received on ID address of the button Type 1010 Flag 0 Value 1 state number VARIA Touch Panels - Configuration & Programming Manual
| TOC 120 Button Commands Value 2 0 = no word wrap, 1 = word wrap Value 3 0 Text Example:
SEND COMMAND Panel,?BWW-529,1 Gets the button OFF state word wrap information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1010 Flag 0 Value 1 1 Value 2 1 Value 3 0 Text
^CPF
^DPF Clear Page Flip Command - Clear all page flips from a button. This only clears PageFlip actions from the Button Release event action. Syntax:
^CPF-<address range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. Example:
SEND_COMMAND Panel,^CPF-500 Clear all page flip actions from button address 500 RELEASE event action list. Delete Page Flips Command - Delete page flips from a button release event if it already exists. Syntax
^DFP-<addr range>,<actions>,<page name>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. actions:
Stan[dardPage] - Flip to standard page Prev[iousPage] - Flip to previous page Show[Popup] - Show Popup page Hide[Popup] - Hide Popup page Togg[lePopup] - Toggle popup state ClearG[roup] - Clear popup page group from all pages ClearP[age] - Clear all popup pages from a page with the specified page name ClearA[ll] - Clear all popup pages from all pages page name: name of page or popup to affect. Example:
SEND COMMAND Panel,^DPF-409,Prev Deletes the assignment of a button from flipping to a previous page. Button Enable Command - Enable or disable buttons with a set variable text range. Syntax:
^ENA-<addr range>,<command value>
^ENA Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. command value: 0 = disable, 1 = enable Example:
SEND_COMMAND Panel,^ENA-500.504&510.515,0 Disables buttons with variable text range 500-504 & 510-515. Button state set font command - Set a font to a specific font filename and size for those buttons with a defined address range. Syntax
^FON-<addr range>,<button states range>,<font filename>[:font size],[alternate font filename] [:alternate font size]
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). font filename: The filename of the font to display in the state. This is used as the primary font file for all button states font size (optional): The size of the font to use. alternate font filename: The filename of the alternate font to display in the state. This is used as the alternate font file for a Listview button font size (optional): The size of the alternate font to use in a Listview button.
^FON Examples:
SEND_COMMAND Panel,^FON-500.504&510.515,1&2,arialb.ttf:48 Sets the font file to arial bold (arialb.ttf) for the On and Off states of buttons with the address range of 500-504 &
510-515. Set the font size to 48. SEND_COMMAND Panel,^FON-505,1&2,arialb.ttf:48,arial.ttf:24 VARIA Touch Panels - Configuration & Programming Manual
| TOC 121 Button Commands Sets the primary font file to arial bold (arialb.ttf) for the selected (2) and unselected (1) states of Listview buttons with the address range of 505. Set the primary font size to 48. Sets the alternate font file to arial (arial.ttf) and the alternate font size to 24. Get button state font command - Get the current font filename and size. Syntax:
?FON-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). Response is a custom event with the following properties:
Custom Event Property Value
?FON Port port command was received on ID address of the button Type 1007 Flag 0 Value 1 state number Value 2 font index Value 3 font size Text font filename If the button is a Listview, an additional custom event with the following properties are sent as well. Custom Event Property Value Port port command was received on ID address of the button Type 1019 Flag 0 Value 1 state number Value 2 0 Value 3 alternate font size Text alternate font filename Example:
SEND COMMAND Panel,?FON-529,1 Gets the button OFF state font information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1007 Flag 0 Value 1 1 Value 2 1 Value 3 48 Text arialb.ttf Bargraph drag increment command - Change the bargraph drag increment. Syntax:
^GDI-<addr range>,<bargraph drag increment>
^GDI Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. bargraph drag increment: The amount to change the level on a drag. The default drag increment is 256. Example:
SEND_COMMAND Panel,^GDI-7,128 Sets the bargraph with address code 7 to a drag increment of 128. Bargraph invert command - Invert the bargraph to move in the opposite direction. Syntax
^GIV-<addr range>,<invert=1, non-inverted=0>
^GIV Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. invert flag: For a bargraph 1 = Invert, 0 = Non Invert Example:
SEND_COMMAND Panel,^GIV-500,1 Invert the bargraph. Set Bargraph High Range Command - Sets the bargraph max range to <bargraph hi>. This does NOT affect the LEVEL value (if any) associated with this bargraph. Syntax:
^GLH
^GLH-<addr range>,<bargraph hi>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. bargraph hi: The new high value. It must be larger than the current low value. Example:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 122 Button Commands SEND_COMMAND Panel,^GLH-100,128 Set the max bargraph value to 128. Set Bargraph Low Range Command - Sets the bargraph min range to <bargraph low>. This does NOT affect the LEVEL value (if any) associated with this bargraph. Syntax:
^GLL-<addr range>,<bargraph low>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. bargraph low: The new low value. It must be smaller than the current high value.
^GLL Example:
SEND_COMMAND Panel,^GLL-100,64 Set the min bargraph value to 64. Bargraph set ramp down time command - Change the bargraph ramp-down time in 1/10th of a second increments. Syntax
^GRD-<addr range>,<bargraph ramp down time>
^GRD Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. bargraph ramp down time: Time to ramp down the entire range in 1/10th of a second intervals Example:
SEND_COMMAND Panel,^GRD-500,200 Changes the bargraph ramp down time to 20 seconds. Bargraph set ran up time command - Change the bargraph ramp-up time in 1/10th of a second increments. Syntax:
^GRU-<addr range>,<bargraph ramp up time>
^GRU Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. bargraph ramp up time: Time to ramp down the entire range in 1/10th of a second intervals Example:
SEND_COMMAND Panel,^GRU-500,100 Changes the bargraph ramp up time to 10 seconds. Bargraph set slider color command - Change the bargraph slider color. A user can also assign the color by name or R,G,B value RRGGBB or RRGGBBAA). Syntax:
^GSC-<addr range>,<color value>
^GSC Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. color value: See the color table on page 165 for more information. Note: Colors can be set by Color Numbers, Color name, RGB alpha colors (RRGGBBAA) or RGB colors values (RRGGBB). RGBA and RGB color are given in HEX ASCII prepended by a #. Example:
SEND_COMMAND Panel,^GSC-500,12 Changes the bargraph slider color to Very Light Yellow. Bargraph slider display type command - Sets the display type for a slider. In G5, the default bargraph display type is to allow the center of the slider to move to the end of the bargraph and will be clipped visually. In G4 (legacy), the bargraph display type is to allow only the end of the slider to move to the end of the bargraph and the slider is not clipped visually. This command allows the bargraph slider display type to be changed from the G5 (default) type to the G4 type. Syntax:
^GSD-<addr range>,<display type (g4 or g5)>
^GSD Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. display type: Set the slider display type. A value of g4 will set the display to the G4 type, anything else will set to the G5 (default) type. Example:
SEND_COMMAND Panel,^GSD-10,g4 Set the display type of the bargraph with address code 10 to the g4 (legacy) type. SEND_COMMAND Panel,^GSD-10,g5 Set the display type of the bargraph with address code 10 to the g5 (default) type. Bargraph set slider name command - Change the bargraph slider name. Slider names can be found in the TPDesign5 slider name drop-down list. Syntax:
^GSN-<addr range>,<bargraph slider name>
^GSN Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. bargraph slider name: Name of valid sliders. At this point, the valid names are none, Circle -L, Circle -M, Circle -S, Precision, Rectangle -L, Rectangle -M, and Rectangle -S. Example:
SEND_COMMAND Panel,^GSN-500,Rectangle -S Changes the bargraph slider name to Rectangle -S. VARIA Touch Panels - Configuration & Programming Manual
| TOC 123 Button Commands Set button state bitmap alignment command - Set bitmap/picture 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
^JSB-<addr range>,<button states range>,<new alignment>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). new alignment: Value of 0- 11 (see Justification Values on page 166).
^JSB Example:
SEND_COMMAND Panel,^JSB-500.504&510.515,1&2,1 Sets the off/on state bitmap alignment to upper left corner for those buttons with address ranges of 500-504 & 510-515. Get button state bitmap alignment value - Get the current bitmap alignment. Syntax:
?JSB-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). index: The bitmap index to get the value of. Response is a custom event with the following properties:
Custom Event Property Value Port port command was received on ID address of the button Type 1005 Flag 0 Value 1 state number Value 2 alignment value 0-10 Value 3 bitmap index Text alignment description The alignments description will be one of the following: absolute, top-left, top-center, top-right, middle-left, middle-
center, middle-right, bottom-left, bottom-center, bottom-right, scale-to-fit, scale-maintain-aspect-ratio. If the alignment is absolute, the X and Y offsets will be specified in the text as well: absolute,xoffset,yoffset Example:
SEND COMMAND Panel,?JSB-529,1,2 Gets the button OFF state bitmap justification information for bitmap at index 2. The result sent to the Controller would be:
Custom Event Property Value
?JSB Port port command was received on ID address of the button Type 1005 Flag 0 Value 1 state number Value 2 5 Value 3 2 Text middle-center Set button state text alignment command - Set text alignment 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:
^JST-<addr range>,<button states range>,<new alignment>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state).
^JST new alignment: Value of 0- 11 (see Justification Values on page 152). Example:
SEND_COMMAND Panel,^JST-500.504&510.515,1&2,5 Sets the off/on state text alignment to middle-center for those buttons with address ranges of 500-504 & 510-515. Get button state bitmap alignment value. Syntax:
?JST-<addr range>,<button states range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons 1 = Off state and 2 = On state). Response is a custom event with the following properties:
Custom Event Property Value
?JST Port port command was received on ID address of the button Type 1004 Flag 0 Value 1 state number Value 2 alignment value 0-10 Value 3 0 VARIA Touch Panels - Configuration & Programming Manual
| TOC 124 Button Commands Text alignment description The alignments description will be one of the following: absolute, top-left, top-center, top-right, middle-left, middle-center, middle-right, bottom-left, bottom-center, bottom-right, scale-to-fit. If the alignment is absolute, the X and Y offsets will be specified in the description as well: absolute,xoffset,yoffset Example:
SEND COMMAND Panel,?JST-529,1,2 Gets the button OFF state text justification information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID address of the button Type 1004 Flag 0 Value 1 state number Value 2 0 Value 3 0 Text absolute,10,10 Subpage add command - Adds a subpage to a viewer button without changing the anchor subpage. If the named subpage is not present in the set it will be added in the specified position. If no position parameter is supplied the subpage is added to the end of the set. The anchor subpage will not be changed. If the named subpage is already present, it will be hidden from the set and re-added in the specified position. The anchor subpage will not be changed, unless the named subpage is currently the anchor. In that case, the next appropriate subpage will become the anchor and the named subpage will be added at the appropriate position. If no subpages are in the set, this command is effectively a Subpage Show command (^SSH). Syntax:
^SAD-<addr range>,<name>,<optional position>,<optional time>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. name: Specifies the name of the subpage to be shown or added. position: Specifies where to add the named subpage in the set with 0 representing the beginning of the set. If this value is left out (or set to 65535) then the new subpage is placed at the end of the list. time: Can range from 0 to 30 and represents tenths of a second. This is the amount of time used to move the subpages around when subpages are added or removed from a button.
^SAD Example:
SEND_COMMAND Panel,^SAD-400,media1 Add the media1 subpage at the end of the set. Subpage custom event command - Configure subpage custom events. This command can be used to enable or disable the transmission of custom events to the controller whenever certain operations occur. For example, the system programmer may want to be notified whenever a subpage enters the anchor position. The notification mechanism is a custom event. The ^SCE command takes the form of a addr range specifying one or more subpage viewer buttons followed by a comma separated list of custom event numbers. If the number is 0 or blank for a given event type then no custom event will be transmitted when that event occurs. If a number is specified, then it is used as the EVENTID value for the custom event. The range of 32001 to 65535 has been reserved in the panel for user custom event numbers. A different value could be used but might collide with other AMX event numbers. Event configuration is not permanent and all event numbers revert to the default of 0 when the panel restarts. Syntax:
^SCE-<addr range>,<optional anchor event num>,<optional onscreen event num>,
<optional offscreen event num>,<optional reorder event num>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. anchor event number: 0 for no event or a value from 32001 to 65535. onscreen event number:
0 for no event or a value from 32001 to 65535. offscreen event number: 0 for no event or a value from 32001 to 65535. reorder event number: 0 for no event or a value from 32001 to 65535. The events are:
anchor - a new subpage has docked in the anchor position. onscreen - a docking operation has been completed and the subpages in the list are now onscreen. This list will include the
^SCE anchor along with any subpages that may be partially onscreen. offscreen - a docking operation has been completed and the subpages in the list are now offscreen. reorder - the user has reordered the subpages in the set and the list contains all subpages in the new order without regard to onscreen or offscreen state. In response to any or all of the above events, the panel will create a string which is a list of subpage names separated by a pipe
(|) character. The string for the anchor event is a single subpage name. If this string is too long to be transmitted in a single custom event, then multiple custom events will be created and transmitted. If defined, the events are sent in this order when a docking operation completes on a given viewer button: anchor, onscreen, offscreen. If reorder is defined and occurs, it is sent first: reorder, anchor, onscreen, offscreen. The format of the custom event transmitted to the controller is as follows:
Custom Event Property Value Port port command was received on ID address of the button generating the event Type the non-zero event number in the ^SCE command Flag 0 Value 1 which one of possible multiple events this is (1 based) Value 2 total number of events needed to send the entire string Value 3 the total size of the original string in bytes Text pipe character separated list of subpage names VARIA Touch Panels - Configuration & Programming Manual
| TOC 125 Button Commands Example:
SEND_COMMAND Panel, ^SCE-200,32001,0,0,0 If the subpage named TV_Favorite_SyFy enters the anchor position on a subpage viewer button with an address of 200, the following event would be transmitted to the controller when the user had sent this command to the panel:
Custom Event Property Value Port port command was received on ID 200 Type 32001 Flag 0 Value 1 1 Value 2 1 Value 3 16 Text TV_Favorite_SyFy Query Subpage Custom Event Numbers Command - Query the assigned subpage custom event numbers for a subpage viewer button. A series of custom events for the subpage viewer button may be sent as a response. Syntax:
?SCE-<addr range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. The format of the custom event transmitted to the controller is as follows:
Custom Event Property Value Port port command was received on ID address of the button generating the event Type the non-zero event number in the ^SCE command Flag 0 Value 1 which one of possible multiple events this is (1 based) Value 2 total number of events needed to send the entire string Value 3 the total size of the original string in bytes Text pipe character separated list of subpage names Example (Assuming the previous command, ^SCE-200,32001,0,0,0, has been sent):
?SCE SEND_COMMAND Panel, ?SCE-200 If the subpage named TV_Favorite_SyFy enters is in the anchor position on a subpage viewer button with an address of 200, the following event would be transmitted to the controller when the user had sent this command to the panel:
Custom Event Property Value Port port command was received on ID 200 Type 32001 Flag 0 Value 1 1 Value 2 1 Value 3 16 Text TV_Favorite_SyFy Streaming digital video loop count - This command allows a button state that has video fill to a streaming URL to set a number of times to play a video. This applies to local file video streams primarily. Syntax:
^SDL-<Address range>,<State range>,<loop count>
^SDL Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). loop count: number of times to loop a completed video. 0 = loop indefinitely (default), >0 = number of times to loop. Example:
SEND_COMMAND Panel,^SDL-10,1&2,1 Set the loop count to 1 for address 10 on and off states.
^SDM Button State Streaming Digital Media Command - Starts or stops a streaming session. Stream starts if a valid URL is specified and stops if server URL string is empty or invalid. To use this command, the current page should have one visible streaming button. Syntax:
^SDM-<address range>,<button states range>,<URL>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). URL: <protocol://><host name or host ip><:video port><:optional audio port> URL for connected MXA-MPL = udp://169.254.11.12:5700 Protocol could have the following values: udp = MPEG2 transport stream over UDP http = Motion JPEG (JFIF format over MIME Multipart) [Varia Panels Only] rtpmpeg2 = MPEG2 elementary stream over RTP/RTCP [Varia Panels do not support] rtpmpeg4 = MPEG4 elementary stream over RTP/RTCP [Varia Panels do not support] If the optional audio port is not specified, video port + 2 is used for audio. VARIA Touch Panels - Configuration & Programming Manual
| TOC 126 Button Commands Playing a video f ile stored on a USB drive attached to the panel Enter the path of the video file on the attached USB drive with file:///udisk/ as the prefix:
^SDM-<Address range>,<State range>,file:///udisk/path_to_video_file_on_usb_drive Note: There are three slashes after file:, not two as in a standard URL. If there arent three slashes, the video file wont be found to be played. For example, for a video file named test-video.mp4 in a directory named videos on the USB drive, enter:
file:///udisk/videos/test-video.mp4 Playing a video file stored on the panel Enter the filename of the video file with amxdir:/// as the prefix.
^SDM-<Address range>,<State range>,amxdir:///video_file Note: There are three slashes after amxdir:, not two as in a standard URL. If there arent three slashes, the video file wont be found. For example, for a video file named test-video.mp4, enter:
amxdir:///test-video.mp4 To change the video using the ^SDM command to a different video (that has been transfered to the panel), use the same URL scheme as the prefix (amxdir:///). Note that any files that are transfered to the amxdir:/// directory are not cleared by a panel file transfer or via Remove User Pages. The only way to clear the file is to do a Factory Data Reset, or to upload an empty file with the same filename. To get around this, you can specify the file to be in amxdir:///AMXPanel/images/filename instead. To do this using NetLinx Studio File Transfer, set the Controller Directory to \AMXPanel\images\ in the device mapping. This will put the file in the panel file images directory. A TP5 file transfer will not remove the file, but a Remove User Pages will. The Streaming Source value in the TP5 file will have to correspond to the same path. Refer to the Streaming a Video File Saved on the Panel via Custom URL Scheme section on page 179 for an example workflow for playing a video file in the G5 panels internal storage. Examples:
SEND_COMMAND Panel,^SDM-400,1,file:///udisk/Video-Clip.mp4 Set the OFF state to play the video file Video-Clip.mp4 located on an attached USB disk. SEND_COMMAND 10001:2:0,^SDM-10,2,udp://234.4.0.4:5500 Sets ON state to play video on multicast address. SEND_COMMAND 10001:2:0,^SDM-10,1,stop Stop playing the current video. SEND_COMMAND 10001:2:0,^SDM-10,1, Stop playing the current video. SEND_COMMAND 10001:1:0,^SDM-10,1,udp://169.254.11.12:5700 Start playing the current video. Note: When using the variable udp, this must be in lower case.
^SDR
^SHA
^SHD Enabling subpage dynamic reordering command - This command can be used to enable or disable dynamic reordering for a given viewer button or set of viewer buttons. It can also be used to set the amount of time to wait before initiating the single finger reorder time. Syntax:
^SDR-<addr range>,<enable state>,<optional hold time>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. enable state: This value can be either on or ON or 1 to enable dynamic reordering for the specified viewer button(s). Any other value will disable dynamic reordering for the specified viewer button(s). hold time: This value is in tenths of a second. The value will be rounded up to the next highest quarter of a second. This is the amount of time that the user must press and hold a subpage with a single finger to trigger a dynamic reordering operation. Subpage Hide All Command - Hide all subpages in a subpage viewer button. Syntax:
^SHA-<addr range>
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. Example:
SEND_COMMAND Panel,^SHA-200 Remove all subpages from subpage viewer button with address 200. Subpage Hide Command - This command will hide the named subpage and relocate the surrounding subpages as necessary to close the gap. If the subpage to be hidden is currently offscreen then it is removed without any other motion on the subpage viewer button. Syntax:
^SHD-<addr range>,<name>,<optional time>
Variables:
address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. name: name of subpage to hide. If name is __all, then all subpages are hidden. time: Can range from 0 to 30 and represents tenths of a second. This is the amount of time used to move the subpages around when subpages are hidden from a button. Example:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 127 Button Commands SEND_COMMAND Panel,^SHD-200,menu1,10 Remove the menu1 subpage from subpage viewer button with address 200 over one second. Button Show/Hide Command. Show or hide a button. Syntax:
^SHO-<addr range>,<command value>
Variables:
^SHO address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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. Subpage Padding Command - Set the padding between subpages on a subpage viewer button. Syntax:
^SPD-<addr range>,<padding>
^SPD Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. padding: percentage from 0 to 100 of the first subpage in a set to set as a padding between subpages. For a horizontal subpage viewer button it is a percentage of the width and for a vertical subpage viewer button it is a percentage of the height. Example:
SEND_COMMAND Panel, ^SPD-400,10 Set the padding between subpages in the set to 10% of the dimension of the first subpage in the set. If the named subpage is hidden in the set associated with the viewer button it will be shown in the anchor position. If the named subpage is not present in the set it will be added to the set and shown in the anchor position. If the named subpage is already present in the set and is not hidden, then the viewer button will move it to the Subpage Show Command - This command will perform one of three different operations based on the following conditions:
a) b) c) anchor position. The anchor position is the location on the subpage viewer button specified by its weighting. This will either be left, center or right for horizontal subpage viewer buttons or top, center or bottom for vertical subpage viewer buttons. Surrounding subpages are relocated on the viewer button as needed to accommodate the described operations. Syntax:
^SSH-<addr range>,<name>,<optional position>,<optional time>
Variables:
^SSH address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. name: Specifies the name of the subpage to be shown or added. position: Specifies where to add (or show) the named subpage in the set with 0 representing the beginning of the set. If this value is left out (or set to 65535) then the weighting value for the viewer button is used to place the new subpage, i.e. left/top, center or right/bottom. When using the weighting locations, set insertion positions can vary based on the current onscreen locations of existing subpages. time: Can range from 0 to 30 and represents tenths of a second. This is the amount of time used to move the subpages around when subpages are added or removed from a button. Example:
SEND_COMMAND Panel,^SSH-400,media1,0,10 Add or show the media1 subpage in the anchor position over one second. Subpage Toggle Command - If the named subpage is hidden, then this command activates a subpage show command. If the named subpage is present, then a subpage hide command is activated. Syntax:
^STG-<addr range>,<name>,[optional position],[optional time]
^STG Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. name: Specifies the name of the subpage to be shown or added. position: Specifies where to show the named subpage in the set with 0 representing the beginning of the set. If this value is left out (or set to 65535) then the weighting value for the viewer button is used to place the new subpage, i.e. left/ top, center or right/bottom. When using the weighting locations, set insertion positions can vary based on the current onscreen locations of existing subpages. If the subpage is being hidden this parameter is ignored. time: Can range from 0 to 30 and represents tenths of a second. This is the amount of time used to move the subpages around when subpages are added or removed from a button. Example:
SEND_COMMAND Panel,^STG-400,media1,0,10 Show or hide the media1 subpage over one second. Set text effect color command - 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 TPD5. You can also assign the color by name or RGB value (RRGGBB or RRGGBBAA). Syntax:
^TEC
^TEC-<addr range>,<button states range>,<color value>
Variables:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 128 Button Commands address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). color value: See color table for more information. Note: Colors can be set by Color Numbers, Color name, RGB alpha colors (RRGGBBAA) or RGB colors values (RRGGBB). RGBA and RGB color are given in HEX ASCII prepended by a #. 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. Get text effect color command - Get the current text effect color. Syntax:
?TEC-<addr range>,<button states range>
Variables:
address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). The format of the custom event transmitted to the controller is as follows:
Custom Event Property Value
?TEC Port port command was received on ID address of the button generating the event Type 1009 Flag 0 Value 1 button state number Value 2 actual length of string Value 3 0 Text Hex encoded color value (ex: #000000FF) Example:
SEND COMMAND Panel,?TEC-529,1 Gets the button OFF state text effect color information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID address of the button generating the event Type 1009 Flag 0 Value 1 1 Value 2 9 Value 3 0 Text #5088F2AE Set the current text effect command - Set the current text effect. Syntax:
^TEF-<addr range>,<button states range>,<text effect name/number>
^TEF Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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/number: See the Text Effect Name/Numbers table on page 137 for text effect names and numbers. 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. Get the current text effect command - Get the current text effect. Syntax:
?TEF-<addr range>,<button states range>
Variables:
address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). The format of the custom event transmitted to the controller is as follows:
Custom Event Property Value
?TEF Port port command was received on ID address of the button generating the event Type 1008 Flag 0 Value 1 button state number Value 2 actual length of string Value 3 text effect number Text text effect name Example:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 129 Button Commands SEND COMMAND Panel,?TEF-529,1 Gets the button OFF state text effect name information. The result sent to the Controller would be:
Custom Event Property Value Port port command was received on ID 529 Type 1008 Flag 0 Value 1 1 Value 2 18 Value 3 27 Text Hard Drop Shadow 3
^TXT
?TXT Set button state text command - Assign a Non-Unicode, non-UTF-8 text string to those buttons with a defined address range. Note that this command has been replaced by ^UTF, but is being kept for backwards compatibility. It supports ASCII characters, but extended ASCII (i.e. characters from 128-255) are interpreted according to the Latin-1 character set (ISO 8859-1). Unicode
(i.e. characters > 255) are not supported Syntax:
^TXT-<addr range>,<button states range>,<new text>
Variables:
address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). new text: new text as 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. Query button state text command - Get the text of a button state. Syntax:
?TXT-<addr range>,<button states range>[,<optional index>]
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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. The response returned is a custom event with the following syntax:
Custom Event Property Value Port port command was received on ID address of the button generating the event Type 1001 Flag 0: Legacy Latin-1 (ISO-8859-1) encoded characters
(^ENC must have previously been sent to change default encoding method) 1: Legacy AMX Hex Quad encoded Unicode characters 2: UTF-8 encoded Characters (default encoding; ASCII-
compatible) Value 1 button state number Value 2 actual length of string Value 3 optional index Text text from the button, encoded with the method specified by Flag Example:
SEND_COMMAND Panel,?TXT-529,1 Gets the button OFF state text information. Example Response:
Custom Event Property Value Port port command was received on ID 529 Type 1001 Flag 2 Value 1 1 Value 2 14 Value 3 0 Text This is a test Set button state legacy unicode text command - Set Unicode text in the legacy G4 format. For the ^UNI command, the Unicode text is sent as ASCII-HEX nibbles. Note: In the legacy format, Unicode text is always represented in a HEX value. TPD generates (through the Text Enter Box dialog) Unicode HEX values. Refer to the TPDesign Instruction Manual for more information. This command has been replaced by ^UTF, but is being kept for backwards compatibility. Syntax:
^UNI
^UNI-<addr range>,<button states range>,<unicode text>
Variables:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 130 Button Commands address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. 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 Sets the buttons unicode character to A. SEND_COMMAND TP,^UNI-1,0,0041 Send the variable text A in unicode to all states of the variable text button 1, (for which the character code is 0041 Hex). Set button state text using UTF-8 text command - Set State Text Command using UTF-8 (replaces the ^TXT and ^UNI commands). Assign a text string encoded with UTF-8 (which is ASCII-compatible) to those buttons with a defined address range. Note: This command replaces the legacy ^TXT command and the legacy ^UNI command, but text must be encoded with UTF-8. While UTF-8 is ASCII compatible, extended ASCII characters in the range 128-255 will be encoded differently based on UTF-8. his command also supports Unicode characters using UTF-8 (which is the encoding method used in >80% of web servers), making the old AMX Hex quad Unicode encoding obsolete (though the ^UNI command is still supported for backwards compatibility). Syntax:
^UTF-<vt addr range>,<button states range>,<new text>
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). unicode text: Unicode UTF-8 text.
^UTF Example:
SEND_COMMAND Panel,^UTF-500.504&510.515,1&2, ASCII ExtendedASCII Unicode Sets the On and Off state text for buttons with the variable text ranges of 500-504 & 510-515. VARIA Touch Panels - Configuration & Programming Manual
| TOC 131 Text Effect Name/Numbers Text Effect Name/Numbers Number Name Number Name 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 None Outline -S Outline -M Outline -L Outline -X Glow -S Glow -M Glow -L Glow -X Soft Drop Shadow 1 Soft Drop Shadow 2 Soft Drop Shadow 3 Soft Drop Shadow 4 Soft Drop Shadow 5 Soft Drop Shadow 6 Soft Drop Shadow 7 Soft Drop Shadow 8 Med Drop Shadow 1 Med Drop Shadow 2 Med Drop Shadow 3 Med Drop Shadow 4 Med Drop Shadow 5 Med Drop Shadow 6 Med Drop Shadow 7 Med Drop Shadow 8 Hard Drop Shadow 1 Hard Drop Shadow 2 Hard Drop Shadow 3 Hard Drop Shadow 4 Hard Drop Shadow 5 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 Hard Drop Shadow 6 Hard Drop Shadow 7 Hard Drop Shadow 8 Soft Drop Shadow 1 with Outline Soft Drop Shadow 2 with Outline Soft Drop Shadow 3 with Outline Soft Drop Shadow 4 with Outline Soft Drop Shadow 5 with Outline Soft Drop Shadow 6 with Outline Soft Drop Shadow 7 with Outline Soft Drop Shadow 8 with Outline Medium Drop Shadow 1 with Outline Medium Drop Shadow 2 with Outline Medium Drop Shadow 3 with Outline Medium Drop Shadow 4 with Outline Medium Drop Shadow 5 with Outline Medium Drop Shadow 6 with Outline Medium Drop Shadow 7 with Outline Medium Drop Shadow 8 with Outline Hard Drop Shadow 1 with Outline Hard Drop Shadow 2 with Outline Hard Drop Shadow 3 with Outline Hard Drop Shadow 4 with Outline Hard Drop Shadow 5 with Outline Hard Drop Shadow 6 with Outline Hard Drop Shadow 7 with Outline Hard Drop Shadow 8 with Outline VARIA Touch Panels - Configuration & Programming Manual
| TOC 132 Dynamic Image Commands Dynamic Image Commands
^BBR Button State Bitmap Resource Command - Assign a resource to those buttons with a defined address range. Syntax:
^BBR-<vt addr range>,<button states range>,<resource name>,[optional bitmap index], [optional justification]
Variables:
address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. button states range: 1 - 256 for multi-state buttons (0 = All states, for General buttons, 1 = Off state and 2 = On state). resource name: name of resource Optional bitmap index: 1 - 5, the state bitmap index to assign the resource. If not present, will place the referenced resource in index 1. The indexes are defined as:
0
- Chameleon Image (if present) 1
- Bitmap 1 2
- Bitmap 2 3
- Bitmap 3 4
- Bitmap 4 5 - Bitmap 5 Optional justification: 0-11 (see Justification Values on page 166). If absolute justification (0) is set, the next two parameters are the X and Y offset of the bitmap for the referenced index. If no justification is specified, the current justification is used. Example:
SEND_COMMAND Panel,^BBR-500.504&510.515,1,image_xray Sets the OFF state picture for the buttons with variable text ranges of 500-504 & 510-515 to the resource named image_xray. Resource Add Command - 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 on page 141. Note: For server authentication to occur, the %U (username) and %S (password) Embedded Codes must be included, and they must match the credentials required by the server. Syntax:
^RAF-<resource name>,<data>
Variables:
^RAF resource name: name of the resource to add. data: Refers to the embedded codes, see the
^RAF, ^RMF - Embedded Codes on page 141. Note: The %P, %U, %S, %H, %A, and %F values can be entered In a single string . 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 0 for an HTTP connection
%H (host name) is AMX.COM
%A (file path) is Lab/Test_file %F
(file name) is test.jpg. Note: the %%5F in the file path is actually encoded as %5F.
^RFR Refresh Resource Command - Force a refresh of the given resource. The command will refresh when the resource is visible onscreen. If it is not onscreen, it will be deferred until it is visible to do the refresh. An optional notification option can be set to receive a custom event from the panel when the resource refresh is complete. Optional width and height parameters can be specified to refresh the image at a specific resolution. If width and height parameters are not specified, the resource will be refreshed at the resolution(s) of any active buttons to which it is assigned. If there are no active buttons currently assigned that resource, it will be refreshed at its native resolution adjusted by any project scale factor. Syntax:
^RFR-<resource name>,[notification option],[width],[height]
Variables:
Resource name: name of the resource to refresh Notification option: An optional notification option at the end of the command with the following possible values: On -
notifications are sent whenever the named dynamic image resource is loaded/refreshed. Off - notifications are not sent (default). Once - notifications are sent one time whenever the named dynamic image resource is loaded/refreshed. Notifications are not sent on subsequent loads/refreshes. width: Specifies the width at which the resource should be refreshed (the image will be scaled as needed). height: Specifies the height at which the resource should be refreshed (the image will be scaled as needed). Example:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 133 SEND_COMMAND Panel,^RFR-Sports_Image,on Force a refresh on Sport_Image when the resource is visible onscreen and enable completion notifications. SEND_COMMAND Panel,^RFR-Sports_Image,off Force a refresh on Sport_Image when the resource is visible onscreen and disable completion notifications. SEND_COMMAND Panel,^RFR-Sports_Image,once Force a refresh on Sport_Image when the resource is visible onscreen and enable a onetime completion notification. SEND_COMMAND Panel,^RFR-Sports_Image,once,800,600 Force a refresh on Sport_Image at the resolution 800x600 when the resource is visible onscreen and enable a onetime completion notification.
^RFRP Resource Refresh Prefetch Command - Force a refresh of the given resource. The command will prefetch the resource even if it is not currently visible. Syntax:
^RFRP-<resource name>,[notification option],[width],[height]
Variables:
Resource name: name of the resource to refresh Notification option: An optional notification option at the end of the command with the following possible values:
On - notifications are sent whenever the named dynamic image resource is loaded/refreshed. Off - notifications are not sent (default). Once - notifications are sent one time whenever the named dynamic image resource is loaded/refreshed. Notifications are not sent on subsequent loads/refreshes. width: Specifies the width at which the resource should be refreshed (the image will be scaled as needed). height: Specifies the height at which the resource should be refreshed (the image will be scaled as needed). Example:
SEND_COMMAND Panel,^RFRP-Sports_Image,on Force a refresh on Sport_Image immediately and enable completion notifications. SEND_COMMAND Panel,^RFRP-Sports_Image,off Force a refresh on Sport_Image immediately and disable completion notifications. SEND_COMMAND Panel,^RFRP-Sports_Image,once Force a refresh on Sport_Image immediately and enable a one-time completion notification. SEND_COMMAND Panel,^RFRP-Sports_Image,once,800,600 Force a refresh on Sport_Image immediately at the resolution 800x600 and enable a onetime completion notification.
^RMF Resource Modify Command - Modifies 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 on page 131. Note: For server authentication to occur, the %U (username) and %S (password) Embedded Codes must be included, and they must match the credentials required by the server. Syntax:
^RMF-<resource name>,<data>
Variables: resource name: name of the resource to modify data: Refers to the embedded codes, see the ^RAF, ^RMF -
Embedded Codes on page 131. Note: The %P, %U, %S, %H, %A, and %F values can be entered In a single string. 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: the %%5F in the file path is actually encoded as %5F.
^RSR Resource Rate Command - Change the refresh rate for a given resource. Syntax:
^RSR-<resource name>,<refresh rate>
Variables:
Resource name: name of the resource to set the refresh rate 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 ^RAF and ^RMF commands add and modify any and all resource parameters by sending embedded codes and data:
^RAF-<resource name>,<data>
^RMF-<resource name>,<data>
The <data> variable uses the embedded codes described in the ^RAF and ^RMF Embedded Codes table on page 131. 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^RAF and ^RMF Escape Sequences table on page 132.
^RAF,
^RMF -
Embedded Codes
^RAF,
^RMF -
Escape Sequences VARIA Touch Panels - Configuration & Programming Manual
| TOC 134
1 2 | Users Manual-4 | Users Manual | 1.18 MiB | May 25 2023 / November 22 2023 |
^RAF and ^RMF Embedded Codes / Escape Sequences NOTE: The %P, %U, %S, %H, %A, and %F values can be entered In a single string.
^RAF and ^RMF Embedded Codes Parameter Embedded Code Code Description protocol
%P<0|1|2>
Set protocol: Either HTTP (0) or FTP (1), or HTTPS(2) Notes:
FTP is not supported at this time. HTTPS (%P2) is supported in G5 panel firmware v1.4.9 and higher. user
%U <user>
Set Username for authentication. password
%S <password>
Set Password for authentication. host
%H <host>
Set Host Name (fully qualified DNS or IP address). path
%A <path>
file
%F <file>
refresh
%R <refresh 1-65535>
preserve
%V <0-1>
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 the FTP protocol, regular expressions. The file or program that will return the resource. The file must be a valid HTTP URL minus the protocol, host, and path. The only exception to this is the inclusion of special escape sequences and in the case of the FTP protocol, regular expressions. 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, which means to only download the resource once for each time it comes into view (or if preserve is set, only once period). Note: For Motion JPEGs, the Refresh interval should always be 0. Set the value of the preserve flag. A value of 0 (the default) means the resource should be reloaded each time it comes into view. A value of 1 means the resource should be preserved in cache after the first time it is loaded, and not reloaded each time it comes into view. This value is ignored if the Refresh interval is greater than 0. dynamo
%D Enable/disable Fast Dynamo. Panel will attempt to accelerate this resource in hardware. Note: Fast Dynamo is not yet supported. notification
%C<on,off,once>
URL
%L <URL>
on - notifications are sent whenever the named dynamic image resource is Indicates whether a notification is required when a Dynamic Image is loaded/ refreshed. The string following the %C can be:
1. loaded/refreshed. 2. 3. resource is loaded/refreshed. Notifications are not sent on subsequent loads/refreshes. If the %C code is not sent as part of a ^RAF command, the notifications are set to off. If the %C code is not sent as part of a ^RMF command, the notifications are not changed from the current setting. off - notifications are not sent (default). once - notifications are sent one time whenever the named dynamic image Set the complete URL as a single value. URL is in the format set in RFC 2396. Code Block http://username:password@host:port/directory/file?query#fragment Note: The %P, %U, %S, %H, %A, and %F values can be entered In a single string. Note:
If the URL is the first part of the resource data, then the %L is assumed and need not be included. See example below. Example:
The following send commands are equivalent. All examples set the resource Image1 to a URL of http://server/folder1/image.jpg with a username of username, password of password, notifications on, and refresh time of 30 seconds:
SEND_COMMAND Panel,^RMF-Image1,%Lhttp://username:password@
server/folder1/image.jpg%Con%R30 SEND_COMMAND Panel,^RMF-
Image1,%P0%Uusername%Spassword%Hserver%
Afolder1%Fimage.jpg%Con%R30 SEND_COMMAND Panel,^RMF-
Image1,http://username:password@server/
folder1/image.jpg%Con%R30 SEND_COMMAND Panel,^RMF-
Image1,http://server/folder1/image. jpg%Con%R30%Uusername%Spassword VARIA Touch Panels - Configuration & Programming Manual
| TOC 135
^RAF and ^RMF Escape Sequences Sequence Panel Information Sequence Panel Information
$DV
$SY
$IP
$HN
$MC
$PX
$PY
$ST
$AC Device Number System Number IP Address Host Name Mac Address X resolution of current panel mode/file Y resolution of current panel mode/file Current state Address code
$AP
$CC
$CP
$LC
$LP
$BX
$BY
$BN Address port Channel code Channel port Level code Level port X Resolution of Current button Y Resolution of Current button Name of Button VARIA Touch Panels - Configuration & Programming Manual
| TOC 136 Listview (Data Access) Commands The Data Access commands described in the following table represent a set of Button (^) Send Commands that support the use of dynamic data for Listview buttons in NetLinx code. Note that the address range indicated in the syntax examples represents the address of the Listview button, and works the same as it does for all other (^) Button Send Commands. Many Listview Send Commands take a boolean parameter. Any of the following values can be used:
Will resolve to true Will resolve to false true TRUE on ON 1 false FALSE off OFF 0
(empty) Terminology The NetLinx Data Access Send Commands use the following terminology:
Netlinx Data Access Send Commands - Terminology Name DataFeed DataRecord DataField Description A DataFeed is a descriptor with a unique name used to publish data records. A DataFeed can be created by a NetLinx program and then published to the NetLinx web server for external consumption by devices like the G5 touch panel for use with Listview buttons. DataFeeds can also be sourced from a server running the AMX XPort software. A DataRecord represents a container of data fields and the index/ordinal position of the row in the recordset. A DataRecord may contain metadata and/or content fields. SA DataField represents the value that stores the actual data elements. All raw data in the NetLinx data access APIs are stored and managed as values and (one or more) attributes. Listview Commands Listview Cache Configure - This command configures the image cache used by the Listview. Syntax:
^LVC-<configuration_option=configuration_value>
Variables: a comma separated list of one or more configuration parameters followed by an equal sign and the configuration setting. Configuration Options:
^LVC clear: Clear the current memory and disk cache used for Listview image loading. mem_size: The size of the memory cache, either as a percentage of the available application memory or as total size. Percentages are specified as floating point. Percentage values are 2% (0.02) to 20% (0.20) and totals are 16 to 256 MB. The default is 10%.(0.10) disk_size: The size of the disk cache. Valid values are 16 to 500 MB The default is 200. Example:
SEND_COMMAND Panel,^LVC-clear Clear the Listview cache. Set Listview Data Source - This command sets the data source to drive the Listview entries. Note that this command only configures the data source it does not actually cause the data to be fetched. The ^LVR refresh command (page 154) must be issued to load the data. Syntax:
^LVD
^LVD-<addr range>,<URL to data source or Dynamic Data Resource name>,
<configuration_option=configuration_value>
Variable: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. Data source URL/Dynamic Data Resource name (required): If the suffix of the URL is .csv or .CSV then the URL will be assumed to point to a csv file. Otherwise the type is assumed to be the XPort amxstandard.xml format. Supported URL schemes are HTTP, HTTPS, and FILE. VARIA Touch Panels - Configuration & Programming Manual
| TOC 137 Listview Commands Data Source URL Notes:
HTTPS is supported in G5 panel firmware version v1.4.9 and higher. HTTPS is not supported by TPDesign5 dynamic image resources at this time. A file on the panels local filesystem can be specified using the file:/// option. There must be three forward slashes after file:. An FTP URL scheme is not supported. Refer to Notes on Using Image URLs With Listview Buttons on page 145 for additional details. option list: a optional comma separated list of one or more configuration parameters followed by an equal sign and the configuration setting. Configuration Options:
user - The user name to use for authenticating to the web server when retrieving the feed data source file. If specified when URL is a Dynamic Data Resource, this value will override the username inside the Dynamic Data Resource. Note: For server authentication to occur, the Username (user) and Password (pass) must be included in the ^LVD command, and they must match the credentials required by the server. pass - The password to use for authenticating to the web server when retrieving the feed data source file. If specified when URL is a Dynamic Data Resource, this value will override the password inside the Dynamic Data Resource. Note: For server authentication to occur, the Username (user) and Password (pass) must be included in the ^LVD command, and they must match the credentials required by the server. csv - a boolean indicating whether or not to parse the data source as a CSV file. If not present, defaults to false. has_headers - a boolean indicating that the first line of the CSV file has column headers which will be used to name the content fields for each data record. If true it automatically implies that csv is also true. If this option is not present then the default for a CSV file is false. In the absence of headers, the content fields will be named using the following convention: column1, column2, column3... (CSV files only, since XML always has field names specified within the file). Example:
SEND_COMMAND Panel,^LVD-42,http://192.168.220.231/public/lv42data.csv, has_headers=1 Configures the Listview button to use the CSV file at the URL as its data source. The first line of the CSV file should be parsed as field names and not as Listview entry record data. Set ListView custom event number - This command sets the custom event number reported by Listview refresh operations. Syntax:
^LVE-<addr range>,<Listview custom event number>
Variable: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. event number: The custom event number to report Listview events. At this time, only refresh events are reported. A value of 0 turns off custom event reporting, A value > 0 assigns the value to the Listview custom event number for that address. The default value is 1401 (custom events reported). When enabled, the custom event format reported is:
Custom Event Property Value Port port command was received on ID address of the button Type button event number set by ^LVE Flag StartRefresh = 1; FinishRefresh = 2; Error = 0xffff
($FFFF); Value 1 If flag is StartRefresh (1) or FinishRefresh (2):
InitRefresh = 0; (refresh by dynamic resource) ManualRefresh = 1; (refresh by send command TimedRefresh = 2; (refresh by timer) If flag is Error:
Error = -1; (some form of error, see custom.text for description) InvalidUrl = -2; (URL is null, should never happen) LoginFailed = -3; (could not authenticate to web server). Value 2 data load id. Every data load is assigned a unique id that counts up from 0. This is used to correlate StartRefresh/ FinishRefresh/Error events on particular addresses. Value 3 When Custom.flag == FinishRefresh, this is the number of records in list. Otherwise is 0. Text feed URL string, or error message if flag is Error Example:
SEND_COMMAND Panel,^LVE-42,1401 Configures the Listview widget to send Listview custom events on event 1401.
^LVE Listview Filter - This command can be used to programmatically change the filter contents of the Listview widget. When the filter contents is changed, the filter will be applied to the current Listview data which can change the number of items displayed based on those that meet the filter sequence. The filter changes immediately, and the filter can be set or cleared with this command. Syntax:
^LVF
^LVF-<addr range>,<filter character sequence>
Variable: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. VARIA Touch Panels - Configuration & Programming Manual
| TOC 138 Listview Commands filter character sequence: All characters including white space characters will be applied to the filter. Example:
SEND_COMMAND Panel,^LVF-42,amx Sets the filter sequence to amx. Only items in the data set that contain the sequence amx will be displayed. SEND_COMMAND Panel,^LVF-42, Clears the filter sequence. All items in the data set can be viewed in the Listview. Listview Layout - This command sets the layout configuration to configure the visual representation of the Listview entries. Syntax:
^LVL-<vt addr range>,<layout_option=layout_value>
Variables:
Variable text address range = 1 - 4000. A comma separated list of one or more layout configuration parameters followed by an equal sign and the configuration setting. Layout Options: columns - Number of columns parameter. An integer that represents the number of columns to display. The number must be at least 1 and a value that exceeds the minimum cell width will truncate to the maximum. Note: Valid tags for the columns parameter are columns=, nc=, and numcol=. comp - Component parameter. An integer that is a value which determines which graphical components are present in the cell. When the component values are bitwise ord together, it creates the encoding for the cell components that are populated. If a configuration parameter is not in the current command, the last value for the configuration parameter is used. Note: Valid tags for the comp parameter are c= and comp=. Component Value Description 1 2 4 The image (i) is used in the cell. The primary text field (t1) is used in the cell. The secondary text field (t2) is used in the cell Not all variations of component values are valid. To have the secondary text field present, the primary text field must be preset as well. Component Combinations Description
^LVL 0 1 2 3 4 5 6 7 Invalid. No component displayed. The image (i) is the only component displayed. The primary text field (t1) is the only component displayed. The image (i) and the primary text field (t1) are displayed. Secondary text (t2) only. Invalid. Secondary text (t2) cannot be displayed without the primary text
(t1). Secondary text (t2) and image (i). Invalid. Secondary text (t2) cannot be displayed without the primary text (t1). The primary text (t1) and secondary text (t2) are displayed. The image (i), primary text (t1), and secondary text (t2) are displayed cellheight - An integer or percentage that sets the height of a cell. The value can be an integer >= the minimum cell height (48), or a percentage of the list height (5% up to 95%). To specify a percentage, append a % to the end of the value. Note: Valid tags for the cellheight param are ch= and cellheight=. layout - An integer that sets the layout configuration of each cell. Note: valid tags for the layout parameter are l= and layout=. Layout Value Description 1 2 3 4 5 6 Horizontal layout with image on the left and text(s) on the right. If multiple texts are selected then the texts are stacked vertically. Horizontal layout with image on the right and text(s) on the left. If multiple texts are selected then the texts are stacked vertically. Horizontal layout with text1 on the left, image in the center, and text2 on the right. If multiple texts are selected then the texts are stacked vertically. Vertical layout with the image on the top and text(s) below the image. If multiple texts are selected then text1 is below the image and text2 is below text1. Vertical layout with the image on the bottom and text(s) above the image. If multiple texts are selected then text1 is on top, text2 is below text1, and the image is below text2. Vertical layout with text1 on top, the image below text1, and text2 below the image. p1 - layout percentage 1. Sets the boundaries between cell components in different layouts. An integer between 10 and 90 that sets the boundary between components as a percentage of the cell dimension. The percentage can be specified as a number between 5-95 with an optional percentage sign % at the end. p2 - layout percentage 2. Sets the boundaries between cell components in different layouts.An integer between 10 and 90 that sets the boundary between components as VARIA Touch Panels - Configuration & Programming Manual
| TOC 139 Listview Commands a percentage of the cell dimension. The percentage can be specified as a number between 5-95 with an optional percentage sign % at the end. filter - Enable or disable the search filter on the Listview. To enable set to true, on, or 1. To disable set to false, off, or 0. Note: Valid tags for the filter parameter are f= and filter=. filterheight - An integer or percentage that sets the height of the filter in the Listview. The value can be an integer >= the minimum filter height (24), or a percentage of the list height (5% to 25%). To specify a percentage, append a % to the end of the value. Note: Valid tags for the filterheight param is fh= and filterheight=. alphascroll - Enable or disable the alpha scroll on the Listview. To enable set to true, on, or 1. To disable set to false, off, or 0. Note: Valid tags for the alphascroll parameter are as= and alphascroll=. Examples:
SEND_COMMAND Panel,^LVL-42, layout=1, comp=7, columns=1, cellheight=120, p1=40%, p2=66%
Sets the Listview configuration display an image and 2 text fields (comp=7), in a layout 1 configuration (layout=1 horizontal layout of the image on left and text1 and text2 to the right of the image). There is 1 column (columns=1) and the cell is 120 pixels high (h=120). The image width will be 40% of the cell width (p1=40%) with text1 and text2 having a width of 60% of the cell width. The height of text1 will be 66% of the cell height (p2=66%) with text2 height of 34% of the cell height. SEND_COMMAND Panel,^LVL-42,l=4, c=3, ch=150, nc=4, p1=70 Sets the Listview configuration display an image and 1 text fields (c=4), in a layout 4 configuration (l=4 vertical layout of the image on top and text1 below the image). There are 4 columns (nc=4) and the cell is 150 pixels high (ch=150). The image height will be 70% of the cell height (p1=70) with text1 having a height of 30% of the cell height. SEND_COMMAND Panel,^LVL-42,layout=3, comp=6, ch=100, numcol=1, p1=50 Sets the Listview configuration display 2 text fields (comp=6), in a layout 3 configuration (layout=2 horizontal layout of text1 on the left and text2 on the right). There is 1 column (numcol=1) and the cell is 100 pixels high (ch=100). The text1 width will be 50% of the cell width (p1=50) with text2 having a width of 50% of the cell width. SEND_COMMAND Panel,^LVL-42,filter=1, fh=10%, as=false Sets the Listview search filter enabled (filter=1), the search filter textview height to 10% of the Listview height (fh=10%), and disables the alphascroller on the Listview. Listview Map Fields - This command maps the fields from the data source to the display elements of a Listview entry. Each list entry corresponds to a record if the data came from the NetLinx data access API or XPort. If the data source is a csv file, then each list entry corresponds to a row in the file. A list entry can have up to two lines of text and a URL that points to an image. Each display element for a list entry has to be mapped to a field in the record. If no mapping is specified, then a default mapping is used which is simply to map the fields in order based on the screen layout of the list entry. So, if the list type was an image and two lines of text, the first content field in the record would be interpreted as the URL to the image, the next field would be the first line of text and the next field would be the second line of text. To override this default behavior, the ^LVM command should be used to specify the correct mapping. Syntax:
^LVM-<addr range>,<display_element=field_expression|<display_element=
field_expression>|... Variable: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. display element list: A pipe character | separated list of mapping expressions. A pipe is used because typical field expressions may use more common characters such as the comma or semicolon. Display Elements: t1 - the first text element t2 - the second text element i1 - the first image future display types may support more text and image elements which will follow the same convention: t3... i2... Field Expressions:
An expression that can be used to map field values to display elements. Any time a field name is used, it follows the form
${field_name}. Other text characters can be used to construct a more complex string using multiple fields. Examples:
SEND_COMMAND Panel,^LVM-42,i1=${image}
Configures the Listview widget to map an image field to the image display element. In this example, the Listview type is assumed to be a single image only. SEND_COMMAND Panel,^LVM-42,i1=${image}|t1=${lname}, ${fname}|t2=${number}
The Listview widget is the type that has an image and two lines of text. The top line will consolidate two different fields in the form of last name, first name. The second line of text will be the phone number. SEND_COMMAND Panel,^LVM-42,t1=${column2}, ${column1}|t2=${column3}|i1=${column4}
This is the same example as the one above it but the source of the data Listview Navigate - This command can be used to move the Listview widget. Navigation commands will be range checked. The command will attempt to position the specified list entry on the top line of the Listview widget. When navigating at the end of the list, however, the widget will position the last item in the list on the bottom line and will not leave blank lines at the bottom. The only exception to this case will be when the Listview has fewer entries than the number of displayable entries. If the optional select boolean is present, and the navigation command used support the select option, the item at the destination will be selected and a item selected custom event will be initiated. Syntax:
^LVN-<addr range>,<navigation_command>[,<boolean_select_param>]
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. navigation command. optional select boolean Navigation Commands: t or T - move to the top of the list (supports an optional select boolean). b or B - move to the bottom of the list (supports an optional select boolean). d or D - page down (DOES NOT support the optional select boolean. A select boolean will be ignored if present). n - move to a specific list entry number at position n. n is a zero based index. (supports an optional select boolean).
^LVM
^LVN VARIA Touch Panels - Configuration & Programming Manual
| TOC 140 Listview Commands
(Note: If n is < 0 and select is true then the current selected item is deselected.) u or U - page up (DOES NOT support the optional select boolean. A select boolean will be ignored if present). Examples:
SEND_COMMAND Panel,^LVN-42,B Move to the bottom of the list. SEND_COMMAND Panel,^LVN-42,d Move the list down a page. SEND_COMMAND Panel,^LVN-42,3,1 Move the list to position 3 in the list and select the item at position 3.
^LVR
^LVS Listview Refresh Data - This command has two different functions. If it is sent without any parameters, it causes the Listview widget to load data from its configured data source. If optional parameters are included with the command, then the automatic data refresh options are configured. The typical behavior for auto refresh is that the last modified time of the data source is tracked. At the refresh interval, the last modified time of the data source is compared against the stored value. If the data is newer, then it is reloaded and the Listview widget is refreshed with the updated data. If the data is unchanged, then it is not reloaded. The default for auto refresh is off. Syntax:
^LVR-<addr range>[,<refresh_interval>,<force_reload>]
Variable: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. refresh_interval - the optional interval (in seconds) at which to check for newer data. 0 (the default) means auto refresh is off. Minimum is 5 seconds. If not specified, the current refresh interval is retained. force_reload - the optional parameter to force the Listview to ignore and data file timestamps and to force a clear on image caches for refreshed Listview images. Not specified or 0 will not force a reload, 1 will force a reload of data file and images associated with data file. Note: This can cause the images in a Listview to flicker upon the reload. This is the expected behavior due to the images being reloaded from the server. Examples:
SEND_COMMAND Panel,^LVR-42 Commands the Listview widget to load the data from the data source and populate the Listview display widget. SEND_COMMAND Panel,^LVR-42,15 Commands the Listview widget to check for an updated data source every 15 seconds. SEND_COMMAND Panel,^LVR-42,600,1 Commands the Listview widget to check for an updated data source every hour, and to force a reload of the data and the images. Listview Sort Data - This command sets the columns that are used for sorting of lists, as well as the type of sorting that is done. The multiple columns are allowed in the sort procedure. The order of the columns in the command determine the order of the sorting. The first column is the primary sorting data, the second would be used for sorting with rows of data that are equal in the primary columns, and so on for however many columns are used for sorting. If no columns are listed in the command, then the current sorting columns are used if they have been previously defined. The type of sort is an optional part of the command and follows the sort columns. Initially, there are four different sort types available. None (n) - No sorting is performed. Ascending (a) - Ascending sort using localized character weighting. Descending (d) - Descending sort using localized character weighting. Override (*) - Override sort syntax portion of command determines sorting. The override sort syntax allows for complex SQLite ORDER BY syntax for sorting. When override is selected, the sort columns that were set in the command or previously are ignored and the entire sorting statement must be in the override sort syntax. The words ORDER BY should not be in the syntax. They are inserted by the firmware. Syntax:
^LVS-<addr range>,<primary sort column name, secondary sort column name,..., final sort column name>[;<sort type>[;<override sort syntax>]]
Variables: address range: Address codes of buttons to affect. A . between addresses includes the range, and & between addresses includes each address. Sort columns - comma separated list of sort columns in the order of sort priority. Sort columns can be specified using the
${column name} syntax that is used in the ^LVM command. Columns can be Content Fields or Metadata Fields in the controller Datafeed XML file generated by the controller. Metadata fields are prepended with meta in front of the label attribute of the field. Sort Type - A character indicating the sorting algorithm to use. a - ascending d - descending
* - override. Sort command syntax must follow in the next part of the command. n - none (default). Any character that is not a,d, or * will set sort to none. Override sort syntax - A SQLite ORDER BY statement to use as the sort. Examples:
^LVS
(Cont.) SEND_COMMAND Panel,^LVS-42, ${artist name},${title};a Commands the Listview widget to sort the data source by the artist name and then title in an ascending order. Equates to artistname, title COLLATE LOCALIZED ASC override syntax. VARIA Touch Panels - Configuration & Programming Manual
| TOC 141 Listview Commands SEND_COMMAND Panel,^LVS-42, ${artist name},${title};d Commands the Listview widget to sort the data source by the artist name and then title in an descending order. Equates to artistname COLLATE LOCALIZED DESC, title COLLATE LOCALIZED DESC override syntax. SEND_COMMAND Panel,^LVS-42,;n Commands the Listview widget to not sort the current data. SEND_COMMAND Panel,^LVS-150,${user name},${text};*;meta${Record timestamp} ASC Commands the panel to sort by the meta data field Record timestamp in ASCENDING order. The username and test fields are ignored. SEND_COMMAND Panel,^LVS-150,;*;meta${Record timestamp} ASC Commands the panel to sort by the meta data field Record timestamp in ASCENDING order. The username and test columns are ignored. SEND_COMMAND Panel,^LVS-150,;*;LENGTH(${description}),${description} ASC Command the panel to sort by the number of characters in the description field, and then by the contents of the description field in ASCENDING order. Note: Refer to Appendix B: Using NetLinx to Define a Data Source (Listview Buttons) on page 182 for information on using NetLinx Code to define a data source for Listview buttons. Notes on Using Image URLs With Listview Buttons Since a Listview button can retrieve images to display as part of the Listview, the column in the data table that sets the image URL will require the servers username and password be included as part of the image URL. The following example represents the contents of a .CSV file that has image URLs as part of the data. The URL Path column has some URLs with using http and no authentication credentials, some using http and user/password credentials, and one using https and user/password credentials:
File Type, No, URL Path GIF, 1, http://www.w3schools.com/images/compatible_chrome.gif GIF, 2, http://www.w3schools.com/images/compatible_ie.gif GIF, 3, http://www.w3schools.com/images/compatible_firefox.gif PNG, 4, http://user:password@controller-ni3100/xsimple_green.png PNG, 5, https://user:password@controller-nx1200/__AMX__Varia-mute-
off.png PNG, 6, http://user:password@controller-nx1200/__AMX__Varia-
mute-on.png NOTE: HTTPS is supported in G5 panel firmware version v1.4.9 and higher. NOTE: HTTPS is not supported by TPDesign5 dynamic image resources at this time. VNC Commands BVNC is handled via an external application and is displayed in a window. To enable a VNC connection to a remote device, a VNC App window must be created in the TPD project. A single window can support connections to multiple destinations, though not simultaneously. Once a window is open, the parameters such as host, username, and password can be changed via send commands. The following send commands are available to control VNC sessions. The application window name (from TPDesign5) is used as the key to update VNC parameters. If an existing window is open, the session should be logged out first before changing any parameters to avoid undefined behavior. Once all the parameters have been changed, then login to connect with the new parameters. VNC Send Commands VNC Client Window update parameter command - Update parameter list. Syntax:
^BVG-<app window name>,<param list>
Variables:
app window name: The name of the application window to act upon. param list: the key/value sets(s) for the VNC parametric. Key/value sets are comma separated. Parameter Name Description Values Default Value Required Type
^BVG colorModel color depth of VNC window C24bit, C256, C64, C8, C4, C2 forceFull Request for full-screen updates true,false C24bit false ipAddress server name or IP address password Authentication password VARIA Touch Panels - Configuration & Programming Manual No No Yes No String Boolean String String
| TOC 142 VNC Send Commands port server port number 5900 Yes Integer prefEncoding Preferred server encoding scaling Scaling options 0 (Raw), 1 (Copy Rect Encoding), 2 (RRE Encoding), 4 (CoRRE Encoding), 5 (Hextile Encoding), 6 (Zlib Encoding), 7 (Tight Encoding), 16 (ZRLE Encoding) 0 (fit to screen), 1 (one-to-one), 2 (zoom) useLocalCursor Local mouse pointer (set to true if pointer is invisible) true, false Restart App Restart application is already running true, false 7 (Tight Encoding) No String 0 (fit to screen) No Integer false true No Boolean Yes Boolean This command is a generic form of the remainder of the commands. Any parameter in the VNC App Parameter List from TPDesign can be updated with this command by including the Key/Value pair in the list. Note: One limitation is that no commas may be used in any of the fields. Delimiters are not escaped at this time. Example:
SEND_COMMAND Panel,^BVG-VNCClient,ipAddress=192.168.200.25,port=5901, password=myNewPassword Change the application window name VNCClient to connect to server IP 192.168.200.25, port 5901 with a password of myNewPassword. VNC Client Window login command - Login/out of an existing session. For logon, if the window is not open, the window is opened and the session is connected using the current parameters. If the window is already open, then the session is updated to new/current parameters. Logoff will close the session and window. Syntax:
^BVL-<appWindowName>,<1=logon|0=logoff>
^BVL Variables:
app window name: The name of the application window to act upon. logon/logoff: 1 to logon to server, 0 to logoff Example:
SEND_COMMAND Panel,^BVL-VNCClient,0 Command the application window name VNCClient to logout/disconnect from the VNC server. VNC Client Window Update server IP command - Update VNC server ip address/name for the application window. Syntax:
^BVN-<appWindowName>,<vnc server ip address or name>
Variable:
^BVN app window name: The name of the application window to act upon. server name or ip: The servers DNS name or IP address. Examples:
SEND_COMMAND Panel,^BVN-VNCClient,192.168.200.25 Command the application window name VNCClient to set the VNC server to 192.168.200.25. SEND_COMMAND Panel,^BVN-VNCClient,vncserver Command the application window name VNCClient to set the VNC server to the server with a DNS name of vncserver. VNC Client Window Update server port - Update VNC server port for the application window. Syntax:
^BVT-<appWindowName>,<server port>
Variables:
^BVT app window name: The name of the application window to act upon. server port: The servers port. Example:
SEND_COMMAND Panel,^BVT-VNCClient,5901 Command the application window name VNCClient to set the VNC server port to 5901. VARIA Touch Panels - Configuration & Programming Manual
| TOC 143 Programming Numbers Color Table Index No. Name Red Green Blue Index No. Name Red Green Blue 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 Very Light Red Light Red Red Medium Red Dark Red Very Dark Red 255 223 191 159 127 95 0 0 0 0 0 0 Very Light Orange 255 128 Light Orange 223 112 Orange Medium Orange Dark Orange Very Dark Orange 191 159 127 95 96 80 64 48 Very Light Yellow 255 255 Light Yellow 223 223 Yellow 191 191 Medium Yellow 159 159 Dark Yellow 127 127 Very Dark Yellow 95 95 Very Light Lime 128 255 Light Lime 112 223 Lime Medium Lime Dark Lime Very Dark Lime Very Light Green Light Green Green 96 80 64 48 0 0 0 191 159 127 95 255 223 191 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 0 0 45 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 Medium Aqua 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 0 0 0 0 0 0 0 0 0 128 112 96 80 64 48 Very Light Magenta 255 Light Magenta Magenta Medium Magenta Dark Magenta 223 191 159 127 Very Dark Magenta 95 Very Light Pink Light Pink Pink Medium Pink Dark Pink Very Dark Pink 255 223 191 159 127 95 80 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 159 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 VARIA Touch Panels - Configuration & Programming Manual
| TOC 144 Color Table 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 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 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 159 127 95 0 0 0 255 128 223 112 191 159 127 95 96 80 64 48 255 255 223 223 191 191 159 159 127 127 95 95 128 255 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 White Grey1 Grey3 Grey5 Grey7 Grey9 Grey4 Grey6 Grey8 Grey10 Grey12 Grey13 Grey2 Grey11 Grey14 Black 112 223 255 TRANSPARENT 96 191 255 255 255 238 238 238 204 204 204 170 170 170 136 136 136 102 102 102 187 187 187 153 153 153 119 119 119 85 51 34 85 51 34 85 51 34 221 221 221 68 17 0 99 68 17 0 53 68 17 0 99 VARIA Touch Panels - Configuration & Programming Manual
| TOC 145 Justification Values Button State Number Justification Value Justification Absolute top-left top-middle top-right center-left center-middle center-right bottom-left bottom-center bottom-right scaled-to-fit scale-maintain-aspect-ratio Border Styles Border Styles Justification Value Justification Parameters 0 1 2 3 4 5 6 7 8 9 10 11 0,<x offset,y offset>
none none none none none none none none none none none
Border Style
Border Style
Border Style
Border Style 1 None 41 Diamond 65 81 Menu Btm Rounded 25 121 Menu Rt Rounded 45 AMX Elite -L 42 Diamond 75 82 Menu Btm Rounded 35 122 Menu Rt Rounded 55 AMX Elite -M 43 Diamond 85 83 Menu Btm Rounded 45 123 Menu Rt Rounded 65 AMX Elite -S 44 Diamond 95 84 Menu Btm Rounded 55 124 Menu Rt Rounded 75 2 3 4 5 6 7 8 9 Bevel -L Bevel -M Bevel -S Circle 15 Circle 25 10 Circle 35 11 Circle 45 12 Circle 55 13 Circle 65 14 Circle 75 15 Circle 85 16 Circle 95 17 Circle 105 18 Circle 115 19 Circle 125 20 Circle 135 21 Circle 145 45 Diamond 105 46 Diamond 115 47 Diamond 125 48 Diamond 135 49 Diamond 145 50 Diamond 155 51 Diamond 165 52 Diamond 175 53 Diamond 185 54 Diamond 195 85 Menu Btm Rounded 65 125 Menu Rt Rounded 85 86 Menu Btm Rounded 75 126 Menu Rt Rounded 95 87 Menu Btm Rounded 85 127 Menu Rt Rounded 105 88 Menu Btm Rounded 95 128 Menu Rt Rounded 115 89 Menu Btm Rounded 105 129 Menu Rt Rounded 125 90 Menu Btm Rounded 115 130 Menu Rt Rounded 135 91 Menu Btm Rounded 125 131 Menu Rt Rounded 145 92 Menu Btm Rounded 135 132 Menu Rt Rounded 155 93 Menu Btm Rounded 145 133 Menu Rt Rounded 165 94 Menu Btm Rounded 155 134 Menu Rt Rounded 175 55 Double Bezel -L 95 Menu Btm Rounded 165 135 Menu Rt Rounded 185 56 Double Bezel -M 96 Menu Btm Rounded 175 136 Menu Rt Rounded 195 57 Double Bezel -S 97 Menu Btm Rounded 185 137 Menu Lt Rounded 15 58 Double Line 98 Menu Btm Rounded 195 138 Menu Lt Rounded 25 59 Fuzzy 60 Glow -L 61 Glow -M 99 Menu Top Rounded 15 139 Menu Lt Rounded 35 100 Menu Top Rounded 25 140 Menu Lt Rounded 45 101 Menu Top Rounded 35 141 Menu Lt Rounded 55 VARIA Touch Panels - Configuration & Programming Manual
| TOC 146 Border Styles 22 Circle 155 23 Circle 165 24 Circle 175 25 Circle 185 26 Circle 195 62 Glow -S 63 Help Down 102 Menu Top Rounded 45 142 Menu Lt Rounded 65 103 Menu Top Rounded 55 143 Menu Lt Rounded 75 64 Neon Active -L 104 Menu Top Rounded 65 144 Menu Lt Rounded 85 65 Neon Active -S 105 Menu Top Rounded 75 145 Menu Lt Rounded 95 66 Neon Inactive -L 106 Menu Top Rounded 85 146 Menu Lt Rounded 105 27 Cursor Bottom 67 Neon Inactive -S 107 Menu Top Rounded 95 147 Menu Lt Rounded 115 28 Cursor Bottom w/hole 68 Oval H 60x30 108 Menu Top Rounded 105 148 Menu Lt Rounded 125 29 Cursor Top 69 Oval H 100x50 109 Menu Top Rounded 115 149 Menu Lt Rounded 135 30 Cursor Top w/hole 70 Oval H 150x75 110 Menu Top Rounded 125 150 Menu Lt Rounded 145 31 Cursor Left 71 Oval V 30x60 111 Menu Top Rounded 135 151 Menu Lt Rounded 155 32 Cursor Left w/hole 72 Oval V 50x100 112 Menu Top Rounded 145 152 Menu Lt Rounded 165 33 Cursor Right 73 Oval V 75x150 113 Menu Top Rounded 155 153 Menu Lt Rounded 175 34 Cursor Right w/hole 74 Oval V 100x200 114 Menu Top Rounded 165 154 Menu Lt Rounded 185 35 Custom Frame 75 Picture Frame 115 Menu Top Rounded 175 155 Menu Lt Rounded 195 36 Diamond 15 76 Quad Line 116 Menu Top Rounded 185 37 Diamond 25 77 Single Line 117 Menu Top Rounded 195 38 Diamond 35 78 Windows Style Popup 118 Menu Rt Rounded 15 39 Diamond 45 79 Windows Style Popup (status bar) 119 Menu Rt Rounded 25 40 Diamond 55 80 Menu Btm Rounded 15 120 Menu Rt Rounded 35 ISO-8859-1 Character Encoding/Decoding table ISO-8859-1 Character Encoding/Decoding Character value
(decimal) Character value
(hex)
^TXT and ^UTF interchangeable
?TXT Response Flag in Backwards Compatibility Mode (^ENC-1 was sent) ASCII 0-127 0x00-0x7F Yes 0 (Latin-1) Latin-1
(Windows-1252 remap range) 128-159 0x80-0x9F Latin-1 Unicode 160-255
>255 0xA0-0xFF
>0xFF No No No 1 (Hex-quad) 0 (Latin-1) 1 (Hex-quad)
?TXT Response Flag in default
(UTF-8) Mode 2 (UTF-8) 2 (UTF-8) 2 (UTF-8) 2 (UTF-8) Resource Escape Codes Resource Escape Codes Sequence Panel Information Sequence Panel Information
$DV
$SY
$IP
$HN Device number System number IP address Host name
$AP
$CC
$CP
$LC Address port Channel code Channel port Level code VARIA Touch Panels - Configuration & Programming Manual
| TOC 147 Resource Escape Codes
$MC
$PX
$PY
$ST
$AC MAC address X resolution of current panel mode/file Y resolution of current panel mode/file Current state Address code Virtual Keystroke Commands Virtual Keystroke Commands Keycode Key Keycode 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 Soft-L Soft-R Home Back Call End Call 0 1 2 3 4 5 6 7 8 9
DPad-U DPad-D DPad-L DPad-R DPad-Center Vol Up Vol Dn Power n/a Clear A B C D E F G H I J K 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
$LP
$BX
$BY
$BN Level port X resolution of current button Y resolution of current button Name of button Key
Apostrophe
Num Headset Hook Focus
Menu Notification Search Media Play/Pause Media Stop Media Next Media Prev Media Rew Media FF Mute Page Up Page Down Pict Symbols Switch Charset Button A Button B Button C Button X Button Y Button Z Button L1 Button R1 Button L2 Button R2 Button Thumb L Button Thumb R Button Start Button Select Button Mode Escape Forward Delete Keycode Key 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 Numpad 3 Numpad 4 Numpad 5 Numpad 6 Numpad 7 Numpad 8 Numpad 9 Numpad /
Numpad *
Numpad -
Numpad +
Numpad . Numpad , Numpad Enter Numpad =
Numpad (
Numpad ) Volume Mute Info Chan Up Chan Down Zoom In Zoom Out TV Window Guide DVR Bookmark Captions Settings TV Power TV Input STB Power STB Input AVR Power AVR Input Prog Red Prog Green Prog Yellow VARIA Touch Panels - Configuration & Programming Manual
| TOC 148 Virtual Keystroke Commands 40 41 42 43 44 45 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 L M N O P Q R S T U V W X Y Z
. Alt-L Alt-R Shift-L Shift-R TAB Space Sym Explorer Envelope Enter Delete Grave
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 139 140 141 142 143 144 145 146 Ctrl-L Ctrl-R Caps Lock Scroll Lock Meta L Meta R Function SysReq / Print Screen Break Move Home Move End Insert Forward Media Play Media Pause Media Close Media Eject Media Record F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 Num Lock Numpad 0 Numpad 1 Numpad 1 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 Prog Blue App Switch Button 1 Button 2 Button 3 Button 4 Button 5 Button 6 Button 7 Button 8 Button 9 Button 10 Button 11 Button 12 Button 13 Button 14 Button 15 Button 16 Language Switch Manner Mode 3D Mode Contacts Calendar Music Calculator Zenkaku Hankaku Eisu Mhenkan Henkan Katakana Hiragana Yen Ro Kana Assist VARIA Touch Panels - Configuration & Programming Manual
| TOC 149 SSH Commands Overview The panel has a SSH server that listens for connections on port 22. The SSH server can be enabled and disabled in the Settings menu. To connect, the SSH client must provide a user and password. The user is amx and the password is the Configuration Password used in the Settings menu on the panel. The SSH server provides a shell that allows for commands to be entered and also has an interactive menu for many commands. SSH Commands help ?
back clear date debug Displays this help or help about a command Syntax:
*:help [command]
Arguments: command The command for which help is needed. Displays this help or help about a command Syntax:
*:back [options]
Options:
--help Display this help message Clears the console buffer. Syntax:
*:clear Gets/sets the current system date. An interactive menu is available when using the set proxy (i.e. set date). Syntax:
*:date [options] [date] Arguments:
date New date in format: YYYY-MM-DD Options:
--config, -c, --set Set the system date.
--day, -d Day of month (1-31, defaults to -1),
--help Display this help message --info,
Display the current date on screen.
--month, -m Month (1-12, defaults to -1).
--verbose, -v Display verbose date information.
--year, -y Year (XXXX, defaults to -1). View/set debug level for msg logging. An interactive menu is available when using the set proxy (i.e. set debug). Syntax:
*:debug [options] [action] Arguments:
action: enable or disable mode action to perform enable, on: enable debug mode. disable,off: disable debug mode. Options:
--config, -c, --set Set the debug level.
--disable, -d, --off, -
F Disable debug mode. --
enable, -e, --on, -N Enable debug mode.
--help Display this help message --info,
Display the current debug level. echo Echoes or prints arguments to STDOUT. Syntax:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 150 SSH Commands logout exit quit g5:cache g5:config g5:profile g5:prof g5:sensor g5:settings g5:setup
*:echo [options] [arguments]
Arguments: arguments Arguments to display separated by whitespaces. Options:
--help Display this help message
--newline, -n Do not print the trailing newline character. Terminate the command shell session. Syntax:
*:logout Cache command - dump or purge cache contents. Syntax:
G5:cache [options]
Options:
--help Display this help message
-purge Purge.
--verbose, -v, -vb Verbose. Display configuration information for NetLinx and IP. Syntax: g5:config
[options] Options:
--help Display this help message
--info, -i Return configuration info. Dumps profile configuration (all profiles if none specified) Syntax:
G5:profile [options]
Options:
--help Display this help message
-name Profile name to dump -verbose,
-v, -vb verbosity (currently 1 or 2) Sensor commands. Syntax:
G5:sensor [options] sensor Arguments: sensor Target sensor <motion|light> Options:
--help Display this help message.
-calibrate, -c Calibrate light sensor.
-enable, -e Enable.
-thresh, -t Threshold. Display the panel settings. Syntax:
G5:settings [options] [category]
Arguments: category Settings category to display (all, status, sound, controller, config, sensors, ethernet) Options:
--help Display this help message --info, -?
Display the current settings. Launch the panel settings utility. Syntax:
G5:setup [options]
Options:
--help Display this help message VARIA Touch Panels - Configuration & Programming Manual
| TOC 151 SSH Commands g5:touch g5:version g5:ver g5:webu g5:window-stats g5:ws get history ip Touch panel overlay self test and diagnostics. Syntax:
G5:touch [options] [watchEnable] Arguments:
watchEnable Optional on/off to enable/disable persistent diagnostics watching Options:
--help Display this help message
--watchTime, -w Time interval for watching overlay diagnostics in seconds (default is 1). Display the G5 version. Syntax:
G5:version [options]
Options:
--help Display this help message Start a firmware update from a web server Syntax:
G5:webu [options] url Arguments:
url URL to the firmware kit file, including the http://server/kit-filename. Options:
--help Display this help message Get the application window statistics. Syntax:
G5:window-stats [options]
[package] Arguments: package A package to filter on. Options:
--help Display this help message. Get information about a specific target provided as an argument. Acts on any command that has the --info option. Syntax:
*:get arguments Arguments:
arguments Command arguments to pass through. Prints command history. Syntax:
*:history Gets/sets the IP settings of the device. An interactive menu is available when using the set proxy (i.e. set ip). Syntax:
*:ip [options]
Options:
--config, -c, --set Configure the ip info interactively.
--dns1, -d1 The IP address of the primary DNS server.
--dns2, -d2 The IP address of the secondary DNS server.
--domain, -dn The domain name for the network.
--gateway, -gw The IP address of the gateway.
--help Display this help message.
--hostname, -hn The hostname for the device. (Alpha-numeric values and no spaces. Dashes are OK.) --info, -?
Display the current IP settings.
--ipaddress, -ip The static IP address for the device
--mode, -m Set the connection mode. (DHCP, Static)
--reset, -r Reset IP settings to factory default. VARIA Touch Panels - Configuration & Programming Manual
| TOC 152 SSH Commands
--subnetmask, -sm The subnet mask address for the device key man msg netlinx Issue a keystroke to the system. Syntax:
*:key [options] [keystroke]
Arguments:
keystroke: The keystroke to issue. (Multiple keystrokes may be included.) Options:
--help Display this help message --
info, -?
List available keystroke names Displays this help or help about a command. Syntax:
*:man
[command]
Arguments:
command The command to get help for. Enable/disable diagnostics message logging. An interactive menu is available when using the set proxy (i.e. set msg). Syntax:
*:msg [options] [instruction]
[filters] Arguments: instruction Diagnostics message command instruction. once: display the diagnostics messages one time and exit on: enable diagnostics messages off: disable diagnostics messages filter: sets optional log filters (provided by filters argument) add: add optional log filters (provided by filters argument) remove: removed optional log filters (provided by filters argument) clear: clear optional log filters delete: delete current log filters Optional log message filters (separated by spaces). Options:
--add-filter, -af Add a filter to the current diagnostics log filters.
--clear-filter, -cf Remove all filters from diagnostics logging.
--clear-history, -ch, -d Delete the diagnostics log history.
--config, -c, --set Enable/disable diagnostics message output.
--filter, -f Optional log message filter.
--help Display this help message --info,
Display current diagnostic message output status.
--off, -F, --disable, --stop Disable diagnostics message output.
--on, -N, --enable, --start Enable diagnostics message output.
--remove-filter, -rf Remove one or more filters form the current diagnostics log filter.
--show-filter, -sf Display all existing filters applied to diagnostics logging.
--verbose, -v Display verbose diagnostics message status information. Gets/sets the NetLinx ICSP connection settings. An interactive menu is available when using the set proxy (i.e. set netlinx). Syntax:
*:netlinx [options]
VARIA Touch Panels - Configuration & Programming Manual
| TOC 153 SSH Commands ping reboot scope set support Options:
--clear-credentials, -cc Clear the username and password settings. --config,
-c, --set Set NetLinx (ICSP) connection settings. --device, -
d Set the device number. --
help Display this help message.
--info, -?
Display the current NetLinx settings. --mode,
-m Set the connection mode (AUTO, URL, LISTEN). --password, -
pw Set the password for secure mode. --reset,
-r Reset NetLinx settings to factory default.
--system, -s Set the system number. --url,
-u Set the URL of the controller controller.
--username, -un Set the username for secure mode. Test TCP/IP network connectivity with another IP address. Syntax:
*:ping [options]
address Arguments:
address IP Address or URL. Options:
--help Display this help message.
--retry-count, -c Retry Count (number of packets). --timeout, -w Reboot the device. Syntax:
*:reboot [options]
Options:
--help Display this help message.
--silent, -s, -Y Do not prompt for confirmation; proceed with reboot. Switch to an alternate command namespace scope. An interactive menu is available when using the set proxy
(i.e. set scope). Syntax:
*:scope [options] [namespace]
Arguments: namespace The targeted namespace scope to switch to. Options:
--config, -c Prompt the user to configure a new scope. --help Display this help message --info,
Display the current scope.
--reset, -r Reset the current scope to the default scope. Set the configuration for a specific command provided as an argument. Acts on any command that has the --
config option. Syntax:
*:set command Arguments:
command Command to set values and command arguments. Support utility command. Allows capturing of system runtime status. Syntax:
*:support [options] [instruction] [params]
Arguments:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 154 SSH Commands temp time instruction Support command instruction. bug-report: Print bug report. Includes dump-log, dump-system, and kernel-msg. dump-log: Print current logs. dump-system: Print system data for running services. kernel-msg: Print kernel messages. params Optional instruction parameters. See details on exact commands in OS docs. Options:
--help Display this help message Report the device temperature in Celsius. Syntax:
*:temp [options]
[monitor] Arguments: monitor Optional on/off to enable/disable continuous temperature monitoring. Options:
--help Display this help message --info,
Display current system temperature.
--interval, -w, -i Time interval for continuous temperature monitoring in seconds (default is 5).
--off, -F, --disable, --stop Disable continuous temperature monitoring.
--on, -N, --enable, --start Enable continuous temperature monitoring. Gets/sets the current system time. An interactive menu is available when using the set proxy (i.e. set time). Syntax:
*:time [options] [time] [ampm] Arguments:
time New time in format: 00:00:00 ampm AM or PM (not needed if using 24 hour format). Options:
--am, -am AM (used when setting time)
--config, -c, --set Set the system time.
--help Display this help message
--hour, -h Hour (0-24, defaults to -1) --info,
Display the current time on screen.
--millisecond, -ms Millisecond (0-999,defaults to -1).
--minute, -m Minute (0-59, defaults to -1)
--pm, -pm PM (used when setting time)
--second, -s Second (0-59, defaults to -1)
--verbose, -v Display verbose time information. VARIA Touch Panels - Configuration & Programming Manual
| TOC 155 Appendix A: Upgrading Firmware via NetLinx Studio Overview The latest firmware (*.kit) file for each panel is available to download from www.amx.com. To download firmware files, go to the catalog page for your panel type, and click the link under Firmware Files on the right side of the catalog page. The ZIP file that is downloaded via this link contains the firmware (*.kit) file that can be loaded on the panel, as well as release notes and any relevant programming instructions. NetLinx Studio 4 The latest version (4.x) of the NetLinx Studio software program is available to download from www.amx.com:
1. Go to Products > Integration Software > Development Tools and click on NetLinx Studio to open the NetLinx Studio catalog page. 2. Click the NetLinx Studio 4 link download the installation file (FIG. 156):
FIG. 156 NetLinx Studio v4 download links on www.amx.com NOTE: The following instructions assume that the G5 touch panel is connected and communicating with a NetLinx Controller, and that communication with the controller has been established in NetLinx Studio. Refer to NetLinx Studio online help and the NetLinx Studio 4 Instruction Manual for instructions on using NetLinx Studio. Upgrading Firmware via NetLinx Studio (v4 or Higher) G5 touch panels use an Ethernet connection for programming, firmware updates, and touch panel file transfer via NetLinx Studio. If you have access to the panels network, you may transfer files directly to the panel through NetLinx Studio. NetLinx Studio features the ability to transfer G5 firmware files directly to a G5 touch panel via HTTP (via a stand-alone web server). This feature is provided to shorten the amount of time required for transferring a G5 *.kit file by removing the NetLinx Controller from the transfer path.
*.kit files for G5 panels contain a token to signify to NetLinx Studio that a web server file transfer can take place, as indicated in the file information window of the Send To NetLinx Device dialog:
Look for **** HTTP File Transfer Capable **** at the end of the file (see FIG. 159 on page 180). When NetLinx Studio detects that the file is a G5 *.kit file, it will automatically attempt to send the file via HTTP (using the standalone web server that is started by NetLinx Studio). 1. In NetLinx Studio, open the Online Tree tab of the Workspace bar. 2. Under System, select a G5 panel for the firmware update (FIG. 157):
FIG. 157 NetLinx Studio Online Tree (MXT-1001 selected) 3. Right-Click on the G5 panel, and select Firmware Transfer from the context menu (FIG. 158):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 156 FIG. 158 NetLinx Studio Online context menu (Firmware Transfer selected) This invokes the Send To NetLinx Device dialog. 4. Under Location. click the Browse (...) button to locate and select the directory containing the G5 firmware (*.kit) file that will be transferred, in the Browse For Folder dialog. 5. 6. Click OK to close the Browse For Folder dialog and populate the Files window with a listing of *.kit files found in the selected folder. In the Files window, click to select the G5 *.kit file to transfer (FIG. 159):
FIG. 159 NetLinx Studio - Send to NetLinx Device dialog This invokes the Send To NetLinx Device dialog. 7. Click Send to initiate the firmware file transfer. The progress of the transfer is indicated in the progress bars (FIG. 160):
FIG. 160 NetLinx Studio - Send to NetLinx Device dialog (Progress bars indicating an active firmware file transfer) 8. 9. The Panel will display the Message Updating System Files, then restart itself. The Installing System Update page will be displayed on the panel until the firmware upgrade process is complete. At this point, the panel will reboot and open its home page. VARIA Touch Panels - Configuration & Programming Manual
| TOC 157 HTTP Server Transfer Error If an error occurs during this type of transfer, then the HTTP Server Transfer Error dialog is invoked (FIG. 161):
FIG. 161 NetLinx Studio v3.4 or higher - HTTP Server Error dialog In this case, there are two options for proceeding with the firmware transfer:
Select Transfer the KIT File via the NetLinx Controller Controller (legacy KIT file transfer method)... to proceed using the standard (non-
HTTP) method used for other NetLinx Devices (via the controller controller) when OK is clicked. Note that depending on network speed and the size of the *.kit file, this method could take up to 20-30 minutes to complete. More specifically, timed tests indicate that it takes approximately 60 seconds per 9.5MB of a *.kit file to transfer. The following table indicates the approximate length of time to send a *.kit file via the legacy file transfer method:
File Size 0-150MB 150-200MB 200-250MB 250-300MB 300-350MB
>350MB Time Required to Complete Transfer (legacy file transfer method) 10 - 15 minutes 15 - 20 minutes 20 - 25 minutes 25 - 30 minutes 30 - 35 minutes
> 35 minutes By default, Change the HTTP Port used to transfer the KIT file... is selected. Use this option to change the HTTP port assignment, in cases where the IP port (default = 80) is in conflict or blocked on the PC. This option will restart the web server with a different HTTP port assignment and restart the file transfer when OK is clicked. Select the appropriate option and click OK to restart the file transfer. Click Cancel to cancel the current file transfer. VARIA Touch Panels - Configuration & Programming Manual
| TOC 158 Appendix B: Using NetLinx to Define a Data Source
(Listview Buttons) Example Listview Workflow - NetLinx Data Source The following section describes an example workflow for implementing a Listview button that uses NetLinx code as the data source. The use case for this example is that of a contact list for a SIP phone system. In this case, the user finds and presses a contact on the screen to initiate the call. The workflow in this example describes each step required to implement a data source for a Listview button via NetLinx Code:
1. 2. 3. 4. Creating a Listview button on a G5 panel page and set button properties Creating a data source in NetLinx code Conf iguring and populating the Listview Configuring a response to a user selection 1) Create the Listview Button and Set Button Properties Create a Listview button in TPDesign5 and configure the display characteristics for the default and selected states. Although not currently being rendered correctly in the screenshot below, this Listview has two lines of text and an image Varia on the left for each Listview entry. 1. 2. In TPDesign5 (v1.0.2 or greater), use the Button Draw Tool to draw a new button. In the General tab of the Properties window, select Listview as the Type (FIG. 162):
FIG. 162 TPDesign5 - Listview button 3. Use the TPD5 Properties window to set General, Programming, States and Events properties to configure the list items and the display characteristics for the Default and Selected states, as well as provide the Listview button with an Address code assignment. Note that Listview buttons use standard button properties, as well as several new properties that are specific to Listview buttons:
a. In the General tab, set properties to specify basic display characteristics for the selected Listview button (FIG. 163). VARIA Touch Panels - Configuration & Programming Manual
| TOC 159 FIG. 163 TPDesign5 - General Properties for Listview buttons General button properties that are specific to Listview buttons include:
Listview Buttons - General Properties VARIA Touch Panels - Configuration & Programming Manual
| TOC 160 List View Components This property controls which components (Primary Text, Secondary Text and Image) will be displayed on the selected Listview button. With a Listview button selected in the Design View, click the browse (...) button on the Listview Components (General) property to open the Edit Listview Components dialog. Use this dialog to specify which components (Primary Text, Secondary Text and Image) will be displayed on the selected Listview button. If only Primary Text is selected in the Edit Listview Components dialog (the default setting for new Listview buttons), each list item is represented with a single line of text using center-middle justification and the font face and size specified by the Text Color, Font and Font Size (State) properties (as well as Text Effect and Text Effect Color if desired). The List View Components (General) Property will indicate single-line text. If Primary Text and Secondary Text are selected, each list item is represented with a two lines of text. The two lines of text are stacked vertically, with each line centered horizontally. The font face and size are specified by the Secondary Font and Secondary Font Size (State) properties. The text is rendered within a two-pixel margin of the button boundary. Note that the Secondary Text option is only enabled if Primary Text is selected. Secondary Text uses the same Text Color settings as the Primary Text. The List View Components (General) Property will indicate two-line text. VARIA Touch Panels - Configuration & Programming Manual
| TOC 161 Listview Buttons - General Properties List View Components
(Cont.) If Primary Text, Secondary Text and Image are selected, each list item is represented with two lines of text and an image on the left side. The image is left-justified within a six-pixel margin of the top, bottom, and left item boundaries, and is scaled-to-fit within a square region. The two lines of text are stacked vertically and centered horizontally in the remaining item region. The top line
(Primary Text) is rendered using the font face and size specified by the Font and Font Size (State) properties. The bottom line (Secondary Text) is rendered using the font face and size specified by the Secondary Font and Secondary Font Size (State) properties. The text is rendered within a two-pixel margin of the button boundary. The List View Components (General) Property will indicate two-line text w/ Image. If only Image is selected in the Edit Listview Components dialog, each list item is represented with a single image centered horizontally within the item region, within a six-pixel margin of the item region. The List View Components (General) Property will indicate image only. If Primary Text and Image are selected in the Edit Listview Components dialog, each list item is represented with a single line of text and an image on the left side. The image is left-justified within a six-pixel margin of the top, bottom, and left item boundaries, and is scaled-to-fit within a square region. The text is center-middle justified in the remaining portion of the item region within a two-pixel margin, using the font and font size specified by the Font and Font Size (States) properties. The List View Components (General) Property will indicate single-line text w/ Image. Item Height This property controls the height for the list view items (in pixels). List View Columns This property controls the number of columns to display. By default, this value is set to 1. This property provides the ability to present a grid view on the Listview button, if desired. List View Item Layout This property controls the layout of the components (Primary Text, Secondary Text and Image) specified to display on the list view items in the selected Listview button. Listview components are selected via the List View Components (General) property. Click in this field to select from a drop-down of layout options for list items (horizontal - image left, horizontal - image right and vertical - image top). Primary Partition (%) This property sets the position of the separation between the Image and the Primary/Secondary Text components. Secondary Partition
(%) If the List View Item Layout property is set to is set to horizontal - image right, the Secondary Partition (%)sets If the List View Item Layout property is set to is set to horizontal - image left (the default setting), the Secondary Partition
(%) sets the position of the separation between the Primary Text and the Image as a percentage of cell height (allowed range = 5%-95%). the position of the separation between the Primary Text and the Image as a percentage of cell height (allowed range =
5%-95%):
used by the Image. In this case, Secondary Partition (%) sets the position of the separation between the Image and the Primary Text as a percentage of cell height (allowed range = 5%-95%). If the List View Item Layout property is set to vertical- image top, the Secondary Partition represents thearea Filter Enabled Use this property to enable/disable the filter (Search) feature on the selected Listview button. By default, this property is set to no (disabled). VARIA Touch Panels - Configuration & Programming Manual
| TOC 162 Listview Buttons - General Properties Filter Height Alphabet Scrollbar Dynamic Data Source To enable this feature, select yes from the drop-down menu. If enabled, a search window will be rendered at the top of the Listview button, with a height specified by the Filter Height property. The remaining area of the Listview button will be available for the display of list items:
Use this property to specify the height of the filter entry box for a Listview button (in pixels).Note that this property is available only if Filter Enabled is set to Yes.The minimum allowed value (and the default setting) is 24 pixels. This property enables/disables the alphabet scrollbar feature for Listview buttons. This property specifies the data source (CSV or XML) to use as the source for content that will be displayed on the selected Listview button. b. In the Programming tab, assign a unique Address Port and Address Code to the selected Listview button:
Listview Buttons - Programming Properties Address Code Select or enter the address code sent to the controller on the specified Address Port. The options available to the Address Code property depend on the Address Port selection:
If 1 is selected as the Address Port, then the options for Address Code are None and Auto-Assign. Select None to leave the Address Code unspecified. Select Auto-Assign to automatically assign the next available Address Code to the selected TPD5 element. If 0-Setup Port is selected as the Address Port, then the options for Address Code are Advanced Codes or Basic Codes. By default, the Basic Address Codes are displayed:
Click on Date Display to select from a list of date display formats. Click on Time Display to select from a list of time display formats. Click Advanced Codes to view the Advanced Channel Code options:
Click on None to leave the Address Code unspecified. Click on Panel Setup to select Connection Status. This option will display the panels current connection status on the selected element. Address Port Select or enter the port to which the selected elements Address Code will be associated. The options are 1 (the default setting) and 0-setup port:
If 1 is selected as the Address Port, then the options for the Address Code property are None and Auto-
Assign. If 0-Setup Port is selected as the Address Port, then the options for Address Code are Advanced Codes or Basic Codes. By default, the Basic Address Codes are displayed. Note that Listview buttons do not use Channel Port and Channel Code assignments. The combination of Address Port and Address Code must be unique. See Address Codes (Basic and Advanced) in the TPD5 online help for details. c. In the States tab, set (font) properties to specify font display characteristics for the Default and Selected states for the selected Listview button. States properties that are specific to Listview buttons include:
Secondary Font Secondary Font Size In the Events tab, set event properties for the selected Listview button. Listview button support three Events properties that are d. specific to Listview buttons. However, these Events support the same actions as existing events:
Item Selected Scrollbar Begin Scrollbar End NOTE: Refer to the TPDesign5 online help for descriptions of all button properties. 2) Create the Data Source Follow the example NetLinx code (below) to create a data source in NetLinx and publish the data source to the NetLinx Controllers internal web server. The Data_PublishFeed() function (see NetLinx.axi) will return a URL for the published data. NetLinx Usage Example - ASCII PROGRAM_NAME=Listview Example DEFINE_DEVICE dvTP = 10001:1:0 DEFINE_CONSTANT VARIA Touch Panels - Configuration & Programming Manual
| TOC 163
// Listview button address INTEGER btnListview = 11 DEFINE_VARIABLE CHAR publishedURL[DATA_MAX_VALUE_LENGTH] CHAR recordsetID[DATA_MAX_ID_LENGTH]
DEFINE_FUNCTION CreateDataFeed()
STACK_VAR DATA_FEED datafeed STACK_VAR DATA_RECORD record
// CREATE A NEW DATA FEED
- datafeed.name = phonelist datafeed.description
= Employees datafeed.source = netlinx Listview Example code DATA_CREATE_FEED(datafeed)
// A recordset id is required for adding records to the feed recordsetID = phonelist
// DEFINE AND POPULATE THE DATA FIELDS
// This example will have 10 names in a phone list
// Records can have metadata fields and content fields. In this
// example we wont use any metadata SET_LENGTH_ARRAY(record.metadata, 0)
// We will have 3 content fields per record: photo, name and phone number SET_LENGTH_ARRAY(record.content, 3)
// Initialize the field attributes that will be the same for every record
// the first field in a record will be the image record.content[1].id = photo;
record.content[1].type = DATA_TYPE_IMAGE;
record.content[1].format = DATA_FORMAT_URL;
// The label can be something different from the id but in our case well
// keep them the same record.content[1].label = photo;
// The second field in a record will be the name record.content[2].id = name; record.content[2].type
= DATA_TYPE_STRING; record.content[2].format = ;
record.content[2].label = name;
// The third field will be the phone number record.content[3].id = number; record.content[3].type
= DATA_TYPE_STRING; record.content[3].format =
DATA_FORMAT_PHONE; record.content[3].label = number;
// The next step is to put in the actual values for the 3 fields
// Do this for the first record record.content[1].value = http://192.168.222.333/ftp/listview/hunter.jpg record.content[2].value = Hunter Pence record.content[3].value = 888-
555-1111
// Add the record to the feed DATA_ADD_RECORD(datafeed.name, recordsetID, record)
// The same record can be reused for the rest of the list // Just change the relevant values and add the record to the feed record.content[1].value =
http://192.168.222.333/ftp/listview/pablo.jpg record.content[2].value = Pablo Sandoval record.content[3].value =
888-555-2222 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/buster.jpg record.content[2].value = Buster Posey record.content[3].value =
888-555-3333 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/angel.jpg record.content[2].value = Angel Pagan record.content[3].value =
888-555-4444 DATA_ADD_RECORD(datafeed.name, recordsetID, record) VARIA Touch Panels - Configuration & Programming Manual
| TOC 164 record.content[1].value =
http://192.168.222.333/ftp/listview/jeremy.jpg record.content[2].value = Jeremy Affeldt record.content[3].value =
888-555-5555 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/madison.jpg record.content[2].value = Madison Bumgarner record.content[3].value =
888-555-6666 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/timh.jpg record.content[2].value = Tim Hudson record.content[3].value =
4888-555-7777 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/timl.jpg record.content[2].value = Tim Lincecum record.content[3].value =
888-555-8888 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/javier.jpg record.content[2].value = Javier Lopez record.content[3].value =
888-555-9999 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/jake.jpg record.content[2].value = Jake Peavy record.content[3].value =
888-555-1010 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/sergio.jpg record.content[2].value = Sergio Romo record.content[3].value = 888-
555-1020 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/ryan.jpg record.content[2].value = Ryan Vogelsong record.content[3].value =
888-555-1030 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/brandon.jpg record.content[2].value = Brandon Belt record.content[3].value = 888-
555-1040 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/andrew.jpg record.content[2].value = Andrew Susac record.content[3].value =
888-555-1050 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/gregor.jpg record.content[2].value = Gregor Blanco record.content[3].value =
888-555-1060 DATA_ADD_RECORD(datafeed.name, recordsetID, record) record.content[1].value =
http://192.168.222.333/ftp/listview/michael.jpg record.content[2].value = Michael Morse record.content[3].value =
888-555-1070 DATA_ADD_RECORD(datafeed.name, recordsetID, record)
// The final step is to publish the feed publishedURL = DATA_PUBLISH_FEED(datafeed.name)
DEFINE_START CreateDataFeed() DEFINE_EVENT DATA_EVENT[dvTP]
ONLINE:
// Set the URL for the data source for the listviewer in the panel SEND_COMMAND dvTP,^LVD-,ITOA(btnListview),,,publishedURL
// Map the fields in the listviewer to the columns SEND_COMMAND dvTP,^LVM-,ITOA(btnListview),,i1=${photo}|t1=${name}|t2=${number}
// Sort by name VARIA Touch Panels - Configuration & Programming Manual
| TOC 165 SEND_COMMAND dvTP,^LVS-,ITOA(btnListview),,${name};a
// Command the listview to load the data from the controller SEND_COMMAND dvTP,^LVR-,ITOA(btnListview)
// The custom event that is raised whenever a listview item is selected on the panel CUSTOM_ EVENT[dvTP,btnListview,LISTVIEW_ON_ROW_SELECT_EVENT
SLONG payloadId SLONG payloadType CHAR fields[2][16]
CHAR name[DATA_MAX_VALUE_LENGTH] CHAR number[DATA_MAX_VALUE_LENGTH]
DATA_RECORD record
// Get the data access ID from the custom event payloadId = custom.value1
// Get the data type from the custom event payloadType = custom.value2 if (payloadId > 0 && payloadType == DATA_STRUCTURE_DATARECORD)
// Specify which fields we want to retrieve from the payload fields[1] = name fields[2] = number
// Populate a record with the requested fields from the event if (DATA_GET_EVENT_RECORD(dvTP, payloadId, fields, record) > 0)
// All is well so far so retrieve the values that we are
// interested in from the selection that the user made on // the panel. name = record.content[1].value number = record.content[2].value
// Put the name and number that was selected on a popup and
// show the popup SEND_COMMAND dvTP,^TXT-50,0,,name SEND_COMMAND dvTP,^TXT-51,0,,number SEND_COMMAND dvTP,^PPN-Calling THE ACTUAL PROGRAM GOES BELOW
(***********************************************************) DEFINE_PROGRAM
DO NOT PUT ANY CODE BELOW THIS COMMENT
(***********************************************************) END OF PROGRAM
*) 3) Configure the Response to a User Selection Follow the CUSTOM_EVENT example at the end of the NetLinx Usage Example - ASCII (above) to retrieve the phone number that was selected by the user. VARIA Touch Panels - Configuration & Programming Manual
| TOC 166 Appendix C: Text Formatting Text Formatting Codes for Bargraphs Text formatting codes for bargraphs provide a mechanism to allow a portion of a bargraphs text to be dynamically provided information about the current status of the level (multistate and traditional). These codes are entered into the text field along with any other text. The following is a code list used for bargraphs:
Bargraph Text Code Inputs Code
$P
$V
$L
$H
$S
$A
$R
Bargraph Multi-State Bargraph Display the current percentage of the bargraph (derived from the Adjusted Level Value as it falls between the Range Values) 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 Raw Level Value Range Low Value Range High Value Current State Adjusted Level Value (Range Low Value subtracted from the Raw Level Value) Adjusted Level Value (Range Low Value subtracted from the Raw Level Value) Low Range subtracted from the High Range Low Range subtracted from the High Range Dollar sign 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 Dollar sign 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%
32%
$A out of $R 32 out of 100
$A of 0 - $R 32 of 0 - 100
$V of $L - $H 532 of 500 - 600 Text Area Input Masking Text Area Input Masking may be used to limit the allowed/correct characters that are entered into a text area. For example, in working with a zip code, a user could limit the entry to a max length of only 5 characters; with input masking, this limit could be changed to 5 mandatory numerical digits and 4 optional numerical digits. A possible use for this feature is to enter information into form fields. The purpose of this feature is to:
Force the use of correct type of characters (i.e. numbers vs. characters) VARIA Touch Panels - Configuration & Programming Manual
| TOC 167 Limit the number of characters in a text area Suggest proper format with f ixed characters Right to Left Required or Optional Change/Force a Case Create multiple logical f ields Specify range of characters/number for each field With this feature, it is not necessary to:
Limit the user to a choice of selections Handle complex input tasks such as names, days of the week, or month by name Perform complex validation such as Subnet Mask validation Input mask character types These character types define what information is allowed to be entered in any specific instance. The following table lists what characters in an input mask will define what characters are allowed in any given position. Character Types Character Masking Rule 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) NOTE: 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 page 112.
^BMF subcommand %MK - sets the input mask of a text area - see page 114. Input Mask Ranges These ranges allow a user to specify the minimum and maximum numeric value for a field. Only one range is allowed per field. Using a range implies a numeric entry ONLY. Input Mask Ranges Character Meaning
Start range End range Range Separator An example from the above table:
[0|255] This allows a user to enter a value from 0 to 255. Input Mask Operations Input Mask Operators change the behavior of the field in the following way:
Input Mask Operators Character Meaning VARIA Touch Panels - Configuration & Programming Manual
| TOC 168
Forces all characters to be converted to lowercase Forces all characters to be converted to uppercase Input Mask Literals To define a literal character, enter any character, other than those shown in the above table (including spaces, and symbols). A back-slash (\) causes the character that follows it to be displayed as the literal character. For example, \A is displayed just as the letter A. To define one of the following characters as a literal character, precede that character with a back-slash. Text entry operation using Input Masks. A keyboard entry using normal text entry is straightforward. However, once an input mask is applied, the behavior of the keyboard needs to change to accommodate the input masks requirement. When working with masks, any literal characters in the mask will be skipped by any cursor movement, including cursor, backspace, and delete keys. When operating with a mask, the mask should be displayed with placeholders. The - character should display where you should enter a character. The arrow keys will move between the - characters and allow you to replace them. The text entry code operates as if it is in the overwrite mode. If the cursor is positioned on a character already entered and you type in a new (and valid) character, the new character replaces the old character. There is no shifting of characters. When working with ranges specified by the [] mask, the keyboard allows you to enter a number between the values listed in the ranges. If a user enters a value that is larger than the maximum, the maximum number of right-most characters is used to create a new, acceptable value. Example 1: If you type 125 into a field accepting 0-100, then the values displayed will be 1, 12, 25. Example 2: If the max for the field was 20, then the values displayed will be 1, 12, 5. 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. Input Mask Output Examples The following are some common input masking examples Output Examples Common Name IP Address Quad Hour Minute/Second Frames Input Mask
[0|255]{.}
[1|12]{:}
[0|59]{:}
[0|29]{:}
Phone Numbers
(999) 000-0000 Zip Code 00000-9999 Input 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-info-home.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/company-info-home.asp. NOTE: Any legal HTTP syntax can be used. Special Escape Sequences The system has only a limited knowledge of URL formats, as it transparently passes the URL information onto the server for translation. A user can then pass any parameters to the server side programs such as CGI scripts or active server pages. However; the system will parse the URL looking for special escape codes. When it finds an escape code, it replaces that code with a particular piece of panel, button, or state information. For example, http://www.amx.com/img.asp?device=$DV would become http://www.amx.com/img.asp?device=10001. Other used escape sequences include:
VARIA Touch Panels - Configuration & Programming Manual
| TOC 169 Escape Sequences Sequence Panel Information
$DV
$SY
$IP
$HN
$MC
$PX
$PY
$BX
$BY
$BN
$ST
$AC
$AP
$CC
$CP
$LC
$LP Device Number System Number IP Address Host Name Mac Address 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 VARIA Touch Panels - Configuration & Programming Manual
| TOC 170 Appendix D: Bargraph Functions Overview For drag operations on Bargraph and Multi-State Bargraph buttons, each movement increments based on the drag increment field. For centering, the bargraph/multistate bargraph will return to the middle - either the 50% mark for bargraphs, or the median state number, once the touch point is released. Setup Codes Bargraph Functions - Setup Codes Code Code Description Channel Channel Channel Channel Channel 2 3 6 7 8 Panel Setup:Brightness Up Panel Setup: Brightness Down Panel Setup: Controller Volume Up Panel Setup: Controller Volume Down Panel Setup: Controller Volume Mute Channel 158 Panel Setup: Mic Volume Mute Channel 171 Panel Setup: Call Volume Up Channel 172 Panel Setup: Call Volume Down Channel 1403 Panel Setup: Notification Alarm Volume Mute Channel 1404 Panel Setup: Notification Volume Up Channel 1405 Panel Setup: Notification Volume Down Channel 1407 Panel Setup: Alarm Volume Up Channel 1408 Panel Setup: Alarm Volume Down Address Address 33 35 Panel Setup: Brightness Panel Setup: Controller Volume Address 144 Time Display: AM|PM Address 46 Panel Setup: Call Volume Address 450 Panel Setup: Notification Volume Address 451 Panel Setup: Alarm Volume Level Level Level Level Level 1 3 9 Panel Setup: Brightness Panel Setup: Controller Volume Panel Setup: Call Volume 450 Panel Setup: Notification Volume 451 Panel Setup: Alarm Volume VARIA Touch Panels - Configuration & Programming Manual
| TOC 171 Appendix E: Video Streaming Optimizing Motion JPEG Video Presentation and Speed In some cases, multiple Motion JPEG streams may slow presentation of individual screen popups, or prevent all of the streams from showing at the same time. This may happen even though the Panel Preview in TPDesign 5 may show no issues. To minimize this and assure a smooth and non-sluggish stream, try these options:
Limit the number of simultaneous Motion JPEG streams to eight or fewer streams at a time. Remove any unnecessary buttons associated with the Motion JPEG streams. Make sure that the Refresh rate on a Motion JPEG is set to 0. Make sure to hide the preview popup before displaying the full image. If possible, uncheck the Scale to Fit option, as scaling is very resource-intensive. Dial down the frame rate of the server. The frame rate of a Motion JPEG is determined by the server. When you go from a page with multiple previews to a page with a single full screen video, it is best to do a page flip rather than popup attach, or hide the preview windows first. Otherwise, the preview windows will continue to decode (taxing the system), even though they may be completely or partially obstructed by the popup. Verify that the full-screen image is set for acceleration by checking the Dynamo box in Resource Manager. Motion JPEG Support for VARIA Panels Baseline mode:
ISO 10918-1 Encoding:
ISO-10918-5 (JFIF) Maximum Resolution:
720p Recommended resolution:
720x480-NTSC or 720x576-PAL (or less). If the video is defined in the Resource Manager as opposed to video fill, consideration must be made for the video being decoded by the panel, which cannot decode 720p. Maximum Frame Rate:
Up to 30fps Latency:
From 1-3 seconds, depending on multiple factors including button size, resolution and network performance. Streaming a Video File Saved on the Panel via Custom URL Scheme To use a custom URL scheme and File Transfer (in NetLinx Studio) to play a video stored in the G5 touch panels internal storage:
1. In NetLinx Studio 4, select Tools -> File Transfer to open the File Transfer dialog - Send tab (FIG. 164):
Fig. 164 NetLinx Studio 4 - File Transfer dialog 2. Click Add to open the Select Files for File Transfer dialog, open the Individual Files tab and select Send Non-System File (FIG. 165):
VARIA Touch Panels - Configuration & Programming Manual
| TOC 172 Fig. 165 NetLinx Studio 4 - Select Files for File Transfer dialog (Individual Files tab) 3. Click Add to select the video file you want to use: Select the video file in the Open dialog and click OK to invoke the Enter Device Mapping Information dialog (FIG. 166):
Fig. 166 NetLinx Studio 4 - Enter Device Mapping Information dialog 4. 5. 6. 7. 8. 9. Enter device mapping information (D:P:S) for the target G5 panel Leave the Controller Directory field blank. Click OK to save changes and close the Enter Device Mapping Information dialog. Click OK to close the Select File For File Transfer dialog. Click Send in the File Transfer dialog to transfer the file (this may take time for large video files). In TPDesign5, select the page/button state you want to play the video file. In the desired state tab, set the Video Fill property to streaming video (FIG. 167). Note that this selection enables the Streaming Source property. Fig. 167 TPDesign5 - Video Fill (State) property 10. For the Streaming Source property, enter the filename of the video file with amxdir:/// as the prefix. For example, if the video filename is test-video.mp4 then enter the Streaming Source as amxdir:///test-video.mp4 (FIG. 168):
Fig. 168 TPDesign5 - Streaming Source (State) property NOTE: There are three slashes after amxdir:, not two as in a standard URL. If there arent three slashes the video file wont be found. 11. Load the TP5 file on the panel and the desired state should continually play the video. If you desire to change the video using the ^SDM command to another that you have transfered, use the same URL scheme as the prefix
(amxdir:///). Any file that is transfered to the amxdir:/// directory is not cleared by a panel file transfer or Remove User Pages. The only way to transfer is to do a Factory Data Reset, or to upload an empty file with the same filename. VARIA Touch Panels - Configuration & Programming Manual
| TOC 173 To get around this, you can specify a file to be amxdir:///AMXPanel/images/filename instead. To do this using NetLinx Studio File Transfer, set the Controller Directory to \AMXPanel\images\ in the device mapping. This will put the file in the panel file images directory. A TP5 file transfer will not remove the file, but a Remove User Pages will. The Streaming Source value in the TP5 file would have to correspond to the same path. NOTE: See page 132 for details on the ^SDM Button State Streaming Digital Media command. Transcoding Guidelines For certain H.264 video and audio streaming , you may observe a drift between audio and video the longer the content is streamed. This drift can be more pronounced when streaming from a non- MXA-MPL source such as a Vision 2 steaming server. If the panel detects excessive drift, it will attempt to restart the stream decode. During the restart, the audio will be temporarily interrupted and the video will be frozen on the last frame until the restart is complete (typically a couple of seconds). To reduce the drift issue for Vision 2 H264 steaming, video transcoding tools (such as HandBrake or FFMPEG) are available to convert H.264 video into lower bitrates, reduced resolution and/or lower H.264 profiles. For example you can try the H.264, 2mbps bit rate, 480p resolution, Baseline profile. If this does not work, try transcoding the stream into MPEG2 video, which is less susceptible to A/V drift. NOTE: Third-party encoders and digital television devices have not been tested with VARIA touch panels, and are not supported by AMX. The table below lists the typical synchronization and latency times for each supported video and audio stream:
Video Performance Device Typical A/V Sync
(offset/
hr) Typical A/V Sync Restart Rate Expected Latency Typical Expected Latency -
Max 3rd Party Solutions H.264 N/A N/A N/A N/A MPEG2 N/A N/A N/A N/A Notes:
Third-party encoders and digital television devices have not been tested with Varia touch panels, and are not supported by AMX. Network congestion can cause video glitches. We recommend the panel be installed behind a smart Ethernet switch to filter unintended multicast packets reaching the panel and consuming panel resources. We recommend maintaining aspect ratio of source and following usage guidelines regarding window/button placement. Third-party encoders and digital television devices have not been tested with Varia touch panels, and are not supported by AMX. Network congestion can cause video glitches. We recommend the panel be installed behind a smart Ethernet switch to filter unintended multicast packets reaching the panel and consuming panel resources. We recommend maintaining aspect ratio of source and following usage guidelines regarding window/button placement. VARIA Touch Panels - Configuration & Programming Manual
| TOC 174 About AMX by HARMAN Founded in 1982 and acquired by HARMAN in 2014, AMX is dedicated to providing AV solutions for an IT World. AMX solves the complexity of managing technology with reliable, consistent and scalable systems comprising control, video switching and distribution, digital signage and technology management. AMX systems are deployed worldwide in conference rooms, classrooms, network operation/command centers, homes, hotels, entertainment venues and broadcast facilities, among others. AMX is part of the HARMAN Professional Group, the only total audio, video, lighting, and control vendor in the professional AV market. HARMAN designs, manufactures and markets premier audio, video, infotainment and integrated control solutions for the automotive, consumer and professional markets. 2019 Harman. All rights reserved. Specifications subject to change. LAST REVISED: 05/21/2019 www.amx.com | +1.469.624.7400 | 800.222.0193
1 2 | ID Label/Location Info | ID Label/Location Info | 199.16 KiB | May 25 2023 / May 28 2023 |
WARNING:pdfminer.pdfpage:The PDF <_io.BufferedReader name='/Volumes/Scratch/Incoming/eg-scratch/6551225.pdf'> contains a metadata field indicating that it should not allow text extraction. Ignoring this field and proceeding. Use the check_extractable if you want to raise an error in this case Back view of EUT
1 2 | Attestation Statements | November 10 2023 / November 13 2023 |
1 2 | C2PC FCC permissive change letter | Cover Letter(s) | 130.33 KiB | November 10 2023 / November 13 2023 |
Harman Professional, Inc. 8500 Balboa Blvd. Northridge, CA 91329 USA
+1 (818) 893-8411 Federal Communications Commission 7435 Oakland Mills Road Columbia MD 21046 Requesting permissive change To Whom It May Concern:
Date: October 20, 2023 The purpose of this letter is to request a Permissive change for FCC ID: 2AUHEVARIA-150, Original grant date: May 28, 2023 The major change filed under this application is 1. Evaluation has been done to ensure compliance of EMC and RF exposure. 2. The hardware design of this transmitter that may affect compliance is remained unchanged in this permissive change application. 3. The RF parameters of this transmitter that may affect compliance are remained unchanged in this permissive change application. 4. Changing the loop antenna coil length from 3.5mm to 5.5mm. Sincerely, ___________________ Name: Caio Collet Title: Sr. Manager - Global Product Compliance On behalf of: Harman Professional, Inc. Telephone: +14696246841 Email: caio.collet@harman.com
1 2 | Attestation Statements | November 10 2023 / November 13 2023 |
1 2 | Attestation Statements | November 10 2023 / November 13 2023 |
1 2 | Request for Confidentiality | Cover Letter(s) | 129.28 KiB | November 10 2023 / November 13 2023 |
Harman Professional, Inc. Date: October 20, 2023 Federal Communication Commission Equipment Authorization Branch 7435 Oakland Mills Road Columbia, MID 21046 REQUEST FOR CONFIDENTIALITY - FCC FCC ID: 2AUHEVARIA-150 Pursuant to Sections 0.457(d) and 0.459 of the Commissions Rules and FCC Guidance document 726920, we hereby request permanent confidential treatment of exhibits identified as such in the table below and request they are permanently withheld from public review based on the documents containing trade secrets and proprietary information not customarily released to the public. The public disclosure of this information might be harmful to the applicant and provide unjustified benefits to its competitors. We also request short-term confidentiality on certain exhibits until the intended date of marketing as outlined below. We request the exhibits be withheld from public view for a period of 180 days. We attest marketing of the product will only commence after the period of short-term confidentiality expires, or if marketing is to commence before the requested number of days listed above, the grantee will inform Nemko to release the Short-Term Confidentiality information withheld on the FCC equipment authorization website. Exhibit Block Diagrams Operation Description Parts List & Placement/BOM Tune-Up Procedure Schematic Diagrams External Photos Internal Photos Test Setup Photos Users Manual Type of Confidentiality Requested Permanent Permanent Permanent Permanent Permanent
Permanent*
Permanent*
Short Term Short Term Short Term Short Term Short Term Short Term Short Term Short Term Short Term The asterisked items (*) require further information to be provided in this justification letter before permanent confidentiality will be extended to these exhibits. Please refer to FCC KDB 726920 D01 found at:
https://apps.fcc.gov/oetcf/kdb/forms/FTSSearchResultPage.cfm?switch=P&id=41731 and review section II, 3) regarding specific information that must accompany these requests. Note: any documents held under the Short-Term confidentiality will automatically become public after the requested time if an appropriate extension request has not been received. Any exhibits (i.e., schematic diagrams) that may have already been requested to have Permanent confidentiality as shown above need not be repeated under Short-Term confidentiality request. Sincerely, Signed:
Printed name: Caio Collet Title: Sr. Manager - Global Product Compliance Company Name: Harman Professional, Inc.
1 2 | Test Setup Photos | Test Setup Photos | 1.43 MiB | November 10 2023 / May 09 2024 | delayed release |
1 2 | Attestation Statements | Attestation Statements | 142.97 KiB | May 25 2023 / May 28 2023 |
Harman Professional, Inc. 8500 Balboa Blvd. Northridge, CA 91329 USA
+1 (818) 893-8411 Federal Communications Commission Authorization and Evaluation Division 7435 Oakland Mills Road Columbia, MD 21046 USA Date: May 9, 2023 Ref: Attestation Statements Part 2.911(d)(5)(i)&(ii) Filing FCC ID: 2AUHEVARIA-150 Statement for 47 CFR section 2.911(d)(5)(i)
[Harman Professional, Inc.] (the applicant) certifies that the equipment for which authorization is sought is not covered equipment prohibited from receiving an equipment authorization pursuant to section 2.903 of the FCC rules. Statement for 47 CFR section 2.911(d)(5)(ii)
[Harman Professional, Inc.] (the applicant) certifies that, as of the date of the filing of the application, the applicant is not identified on the Covered List as an entity producing covered equipment. Sincerely, Signature: ____________________ Printed Name /Title: Caio Collet / Sr. Manager - Global Product Compliance Company Name: Harman Professional, Inc.
1 2 | Confidentiality | Cover Letter(s) | 172.01 KiB | May 25 2023 / May 28 2023 |
Harman Professional, Inc. 8500 Balboa Blvd. Northridge, CA 91329 USA
+1 (818) 893-8411 Date: May 9, 2023 Federal Communication Commission Equipment Authorization Branch 7435 Oakland Mills Road Columbia, MID 21046 REQUEST FOR CONFIDENTIALITY - FCC FCC ID: 2AUHEVARIA-150 Pursuant to Sections 0.457(d) and 0.459 of the Commissions Rules and FCC Guidance document 726920, we hereby request permanent confidential treatment of exhibits identified as such in the table below and request they are permanently withheld from public review based on the documents containing trade secrets and proprietary information not customarily released to the public. The public disclosure of this information might be harmful to the applicant and provide unjustified benefits to its competitors. We also request short-term confidentiality on certain exhibits until the intended date of marketing as outlined below. We request the exhibits be withheld from public view for a period of 180 days. We attest marketing of the product will only commence after the period of short-term confidentiality expires, or if marketing is to commence before the requested number of days listed above, the grantee will inform Nemko to release the Short-Term Confidentiality information withheld on the FCC equipment authorization website. Exhibit Block Diagrams Operation Description Parts List & Placement/BOM Tune-Up Procedure Schematic Diagrams External Photos Internal Photos Test Setup Photos Users Manual Type of Confidentiality Requested Permanent Permanent Permanent Permanent Permanent
Permanent*
Permanent*
Short Term Short Term Short Term Short Term Short Term Short Term Short Term Short Term Short Term The asterisked items (*) require further information to be provided in this justification letter before permanent confidentiality will be extended to these exhibits. Please refer to FCC KDB 726920 D01 found at:
https://apps.fcc.gov/oetcf/kdb/forms/FTSSearchResultPage.cfm?switch=P&id=41731 and review section II, 3) regarding specific information that must accompany these requests. Note: any documents held under the Short-Term confidentiality will automatically become public after the requested time if an appropriate extension request has not been received. Any exhibits (i.e., schematic diagrams) that may have already been requested to have Permanent confidentiality as shown above need not be repeated under Short-Term confidentiality request. Sincerely, Signed:
Printed name: Caio Collet Title: Sr. Manager - Global Product Compliance Company Name: Harman Professional, Inc.
1 2 | Declaration of authorization | Cover Letter(s) | 59.77 KiB | May 25 2023 / May 28 2023 |
Harman Professional, Inc. 8500 Balboa Blvd. Northridge, CA 91329 USA
+1 (818) 893-8411 TO:
Federal Communication Commission Equipment Authorization Branch 7435 Oakland Mills Road Columbia, MID 21046 Regarding FCC ID: 2AUHEVARIA-150 To whom it may concern:
Date: May 9, 2023 We, the undersigned, hereby authorize SGS Taiwan Ltd. Jim Chang to act on our behalf in all manners relating to application for equipment authorization with respect to the FCC ID above, including signing of all documents relating to these matters. Any and all acts carried out by the agent on our behalf shall have the same effect as acts of our own. We, the undersigned, hereby certify that we are not subject to a denial of federal benefits, that includes FCC benefits, pursuant to Section 5301 of the Anti-Drug Abuse Act of 1988, 21 U.S.C. 862. Further, no party, as defined in 47 CFR 1.2002 (b), to the application is subject to denial of federal benefits, that includes FCC benefits. We also declare that the information provided to the FCC is true and correct to the best of our knowledge
(47 CFR 2.911(d)) and we have been informed of the grantee responsibilities (47 CFR 2.909) with regard to certified equipment. This authorization is valid until further written notice from the applicant. Sincerely, Signature: ____________________ Printed Name /Title: Caio Collet / Sr. Manager - Global Product Compliance Company Name: Harman Professional, Inc.
frequency | equipment class | purpose | ||
---|---|---|---|---|
1 | 2023-11-13 | 13.56 ~ 13.56 | DXX - Part 15 Low Power Communication Device Transmitter | Class II Permissive Change |
2 | 2023-05-28 | 13.56 ~ 13.56 | DXX - Part 15 Low Power Communication Device Transmitter | Original Equipment |
app s | Applicant Information | |||||
---|---|---|---|---|---|---|
1 2 | Effective |
2023-11-13
|
||||
1 2 |
2023-05-28
|
|||||
1 2 | Applicant's complete, legal business name |
Harman Professional, Inc.
|
||||
1 2 | FCC Registration Number (FRN) |
0028780849
|
||||
1 2 | Physical Address |
8500 Balboa Boulevard
|
||||
1 2 |
Northridge, CA
|
|||||
1 2 |
Northridge, California 91329
|
|||||
1 2 |
United States
|
|||||
app s | TCB Information | |||||
1 2 | TCB Application Email Address |
c******@telefication.com
|
||||
1 2 |
C******@telefication.com
|
|||||
1 2 | TCB Scope |
A1: Low Power Transmitters below 1 GHz (except Spread Spectrum), Unintentional Radiators, EAS (Part 11) & Consumer ISM devices
|
||||
app s | FCC ID | |||||
1 2 | Grantee Code |
2AUHE
|
||||
1 2 | Equipment Product Code |
VARIA-150
|
||||
app s | Person at the applicant's address to receive grant or for contact | |||||
1 2 | Name |
C******** C********
|
||||
1 2 | Title |
Sr. Manager - Global Product Compliance
|
||||
1 2 | Telephone Number |
+1469********
|
||||
1 2 | Fax Number |
+1469********
|
||||
1 2 |
C******@harman.com
|
|||||
app s | Technical Contact | |||||
1 2 | Firm Name |
SGS Taiwan Ltd
|
||||
1 2 |
SGS Taiwan Ltd.
|
|||||
1 2 | Name |
J******** C******
|
||||
1 2 | Physical Address |
134, Wu Kung Road, WuKu Industrial Zone
|
||||
1 2 |
Taiwan
|
|||||
1 2 | Telephone Number |
886 2********
|
||||
1 2 |
+8862********
|
|||||
1 2 | Fax Number |
886 2********
|
||||
1 2 |
88622********
|
|||||
1 2 |
j******@sgs.com
|
|||||
app s | Non Technical Contact | |||||
1 2 | Firm Name |
SGS Taiwan Ltd
|
||||
1 2 |
SGS Taiwan Ltd.
|
|||||
1 2 | Name |
J****** C******
|
||||
1 2 | Physical Address |
134, Wu Kung Road, WuKu Industrial Zone
|
||||
1 2 |
Taiwan
|
|||||
1 2 | Telephone Number |
886 2********
|
||||
1 2 |
+8862********
|
|||||
1 2 | Fax Number |
886 2********
|
||||
1 2 |
88622********
|
|||||
1 2 |
j******@sgs.com
|
|||||
app s | Confidentiality (long or short term) | |||||
1 2 | Does this application include a request for confidentiality for any portion(s) of the data contained in this application pursuant to 47 CFR § 0.459 of the Commission Rules?: | Yes | ||||
1 2 | Long-Term Confidentiality Does this application include a request for confidentiality for any portion(s) of the data contained in this application pursuant to 47 CFR § 0.459 of the Commission Rules?: | Yes | ||||
1 2 | If so, specify the short-term confidentiality release date (MM/DD/YYYY format) | 05/09/2024 | ||||
1 2 | 11/22/2023 | |||||
if no date is supplied, the release date will be set to 45 calendar days past the date of grant. | ||||||
app s | Cognitive Radio & Software Defined Radio, Class, etc | |||||
1 2 | Is this application for software defined/cognitive radio authorization? | No | ||||
1 2 | Equipment Class | DXX - Part 15 Low Power Communication Device Transmitter | ||||
1 2 | Description of product as it is marketed: (NOTE: This text will appear below the equipment class on the grant) | 15.6 inches Touch Panel | ||||
1 2 | Related OET KnowledgeDataBase Inquiry: Is there a KDB inquiry associated with this application? | No | ||||
1 2 | Modular Equipment Type | Does not apply | ||||
1 2 | Purpose / Application is for | Class II Permissive Change | ||||
1 2 | Original Equipment | |||||
1 2 | Composite Equipment: Is the equipment in this application a composite device subject to an additional equipment authorization? | No | ||||
1 2 | Related Equipment: Is the equipment in this application part of a system that operates with, or is marketed with, another device that requires an equipment authorization? | No | ||||
1 2 | Grant Comments | C2PC: loop antenna coil length chenged from 3.5mm to 5.5mm. | ||||
1 2 | Is there an equipment authorization waiver associated with this application? | No | ||||
1 2 | If there is an equipment authorization waiver associated with this application, has the associated waiver been approved and all information uploaded? | No | ||||
app s | Test Firm Name and Contact Information | |||||
1 2 | Firm Name |
SGS Taiwan Ltd. Central RF Lab
|
||||
1 2 | Name |
R**** W****
|
||||
1 2 | Telephone Number |
+886-******** Extension:
|
||||
1 2 |
r******@sgs.com
|
|||||
Equipment Specifications | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Line | Rule Parts | Grant Notes | Lower Frequency | Upper Frequency | Power Output | Tolerance | Emission Designator | Microprocessor Number | |||||||||||||||||||||||||||||||||
1 | 1 | 15C | 13.56000000 | 13.56000000 | |||||||||||||||||||||||||||||||||||||
Line | Rule Parts | Grant Notes | Lower Frequency | Upper Frequency | Power Output | Tolerance | Emission Designator | Microprocessor Number | |||||||||||||||||||||||||||||||||
2 | 1 | 15C | 13.56000000 | 13.56000000 |
some individual PII (Personally Identifiable Information) available on the public forms may be redacted, original source may include additional details
This product uses the FCC Data API but is not endorsed or certified by the FCC