AMX DVX-21XXHD Webconsole & Programming Manual Download Page 98 | Manualshive

Page: 98 / 116

AMX DVX-21XXHD Webconsole & Programming Manual Download Page 98

Terminal (Program Port/Telnet) Commands

98

NetLinx Integrated Controllers (Firmware v4)- WebConsole & Programming Guide

Terminal Commands (Cont.)

Command

Description

SHOW LOG

Displays the log of messages stored in the Master's memory. The Master logs all internal messages

and keeps the most recent messages. The log contains:·
• Entries starting with first specified or most recent
• Date, Day, and Time message was logged
• Which object originated the message
• The text of the message:

SHOW LOG [start] [end]

SHOW LOG ALL

- <start> specifies message to begin the display.
- If start is not entered, the most recent message will be first.
- If end is not entered, the last 20 messages will be shown.
- If <ALL> is entered, all stored messages will be shown, starting with the most recent.

Example:

>SHOW LOG

Message Log for System 50 Version: v2.10.75

Entry Date/Time Object Text

-------------------------------------------------------

1: 11-01-2001 THU 14:14:49 ConnectionManager

Memory Available = 11436804 <26572>

2: 11-01-2001 THU 14:12:14 ConnectionManager

Memory Available = 11463376 <65544>

3: 11-01-2001 THU 14:10:21 ConnectionManager

Memory Available = 11528920 <11512>

4: 11-01-2001 THU 14:10:21 TelnetSvr

Accepted Telnet connection:socket=14 addr=192.168.16.110 port=2979

5: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 10002:1:50

6: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 128:1:50

7: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OffLine 128:1:50

8: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 96:1:50

9: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OffLine 96:1:50

10: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 128:1:50

11: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 96:1:50

12: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 5001:16:50

13: 11-01-2001 THU 14:05:51 Interpreter

CIpEvent::OnLine 5001:15:50

14: 11-01-2001 THU 14:05:51 Interpreter

To display only the startup log, use the SHOW START LOG command (see page 99).

«
...
96
97
98
99
100
...
»

Summary of Contents for DVX-21XXHD

Page 1: ...WEBCONSOLE PROGRAMMING GUIDE NETLINX INTEGRATED CONTROLLERS FIRMWARE VERSION 4 0 OR HIGHER NI 700 900 NI 2100 3100 4100 NI 3101 SIG DVX 21XXHD DVX 315XHD ...

Page 2: ...and the point where they exit from the apparatus 11 ONLY USE attachments accessories specified by the manufacturer 12 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 13 UNPLUG this apparatus during lightning storms or when unused for l...

Page 3: ...ler for LAN Communication 17 Using the ID Button to Change the Master Device Value 18 Obtaining the NI Controller s IP Address using DHCP 19 Assigning a Static IP to the NI Controller 20 Communicating Via IP Address 21 Upgrading Firmware 24 Overview 24 NI Controllers Firmware Files 24 NI Master Firmware 24 Device Controller Firmware 24 Enova DVX 24 NI Master Firmware 24 Device Controller Firmware ...

Page 4: ...curity Configuration 34 Login Rules 35 User Name and Password Rules 35 System Security System Level 35 System Level Security System Security Settings 35 Access Options 36 LDAP Options 37 Configuring ICSP Connectivity with LDAP Enabled 37 Accepting Changes 37 Testing the Connection to the LDAP Server 38 System Security Group Level 38 Adding a New Group 38 Group and User Security Access Options 39 V...

Page 5: ...tificate Entries 53 Displaying SSL Server Certificate Information 54 Creating a Request for an SSL Certificate 54 Self Generating an SSL Certificate 54 Regenerating an SSL Server Certificate Request 54 Exporting an SSL Certificate Request 54 Importing an SSL Certificate 55 Manage System Clock Manager Options 56 Setting the Mode for the Clock Manager 56 Setting Daylight Savings Rules 57 Selecting a...

Page 6: ...ce Discovery 70 Manage Devices URL List 70 Adding a URL To The Master s List Of Devices 70 Manage Devices Device Number 71 Manage Devices Control Emulate 71 Manage Devices Log 72 Manage Devices Diagnostics 73 NetLinx Programming 74 Overview 74 Port Assignments by NetLinx Master 74 Master SEND_COMMANDs 74 CLOCK 74 G4WC 74 IGNOREEXTERNALCLOCKCOMMANDS 74 Master IP Local Port SEND_COMMANDs 75 UDPSENDT...

Page 7: ...P 83 XCH 83 XCHM 83 Input Output SEND_COMMANDs 84 GET DBT 84 SET DBT 84 GET INPUT 84 SET INPUT 85 Terminal Program Port Telnet Commands 86 Overview 86 Establishing a Terminal Connection Via the Program Port 86 PC COM Port Communication Settings 86 Establishing a Terminal Connection Via Telnet 86 Terminal Commands 87 Help D P S 87 or Help 87 AUTO LOCATE ENABLE DISABLE STATUS 87 BOOT STATUS 87 CLEAR...

Page 8: ...UE 91 SEND_STRING D P S or NAME STRING 91 SET DATE 91 SET DNS D P S 91 SET DUET MEMORY 91 SET ETHERNET MODE CMD 92 SET FTP PORT 92 SET HTTP PORT 92 SET HTTPS PORT 92 SET ICSP PORT 92 SET ICSP TCP TIMEOUT 92 SET IP D P S 93 SET LOG COUNT 93 SET QUEUE SIZE 93 SET SECURITY PROFILE 94 SET SNMP 95 SET SSH PORT 95 SET SYSTEM NUMBER 95 SET TELNET PORT 95 SET THRESHOLD 96 SET TIME 96 SET TIMELINE LOOPCNT ...

Page 9: ...ient 107 Appendix A LDAP Implementation Details 108 Overview 108 Assumptions and Prerequisites 108 AMX LDAP Client Authentication Sequence 108 Example Setting Up User s Access Rights 109 Administrator Access Example 109 User Access Example 109 ICSP Connectivity Security Example 110 Appendix B SMTP Support 111 Overview 111 SMTP Server Configuration 111 Sending Mail 112 Appendix C Clock Manager NetL...

Page 10: ..._TIMESERVER CONSTANT CHAR IP 113 CLKMGR_GET_TIMESERVERS CLKMGR_TIMESERVER_STRUCT T 114 CLKMGR_ADD_USERDEFINED_TIMESERVER CONSTANT CHAR IP CONSTANT CHAR URL CONSTANT CHAR LOCATION 114 CLKMGR_DELETE_USERDEFINED_TIMESERVER CONSTANT CHAR IP 114 CLKMGR_GET_START_DAYLIGHTSAVINGS_RULE 114 CLKMGR_SET_START_DAYLIGHTSAVINGS_RULE CONSTANT CHAR RECORD 114 CLKMGR_GET_END_DAYLIGHTSAVINGS_RULE 115 CLKMGR_SET_END...

Page 11: ...for more detailed information on the use of Dynamic Device Discovery DDD Enova DVX All In One Presentation Switchers NOTE Refer to Products All in One Presentation Switchers page at www amx com for details and variations available for these products Enova DVX 21xxHD DVX 315xHD Enova DVX 21xxHD All in One Presentation Switchers utilize an NI 2100 Controller therefore all controller related informat...

Page 12: ... Program port Set the System Value being used with the on board Master Re assign any Device values You can then either get a DHCP Address for the on board Master or assign a Static IP to the on board Master Once the IP information is determined rework the parameters for Master Communication in order to connect to the on board Master via the LAN and not the Program port Update the On board Master a...

Page 13: ...ompt you for User ID and Password before displaying the configuration pages for the selected device Notice that the serial number is appended to the name of the device At this point the device can be configured changing IP settings NetLinx settings User settings etc via the pages in the Web Console see the Onboard WebConsole User Interface section on page 31 FIG 1 Internet Explorer with Bonjour pl...

Page 14: ... the latest version The default location for the NetLinx Studio application is Start Programs AMX Control Disc NetLinx Studio NetLinx Studio 2 Verify that an LAN ICSNet cable is connected from the NI Controller to the LAN Hub 3 Connect an programming cable RS 232 from the Program Port on the Central Controller to a COM port on the PC being used for programming NI 4000 4100 only Verify that any con...

Page 15: ...n the Serial tab set the COM port parameters used to communicate to the NetLinx Master Default serial settings for NetLinx Masters are 7 Click OK to close the Communication Settings dialog 8 Note that the serial configuration is indicated in the Configuration text field FIG 6 FIG 4 Communication Settings dialog Recent tab FIG 5 Communications Settings dialog Serial tab Comm Port COM 1 Baud Rate 38...

Page 16: ...should appear in the Device Tree FIG 7 If not verify that the Serial cable is connected properly and that the Baud Rate settings on the Controller set via the Program Port DIP Switch match the settings in NetLinx Studio Once Serial communication has been established use NetLinx Studio to configure the Controller for LAN Communication as described below FIG 6 Master Communication Settings dialog in...

Page 17: ... work 2 Select Diagnostics Network Addresses from the menu bar to open the Network Addresses dialog FIG 8 Use the options in this dialog to select to either use DHCP or specify an IP Address 3 Click Get IP Information to enable the fields for editing FIG 9 4 Enter the System Device 0 for NetLinx Masters and Host Name information NOTE Host names may contain only the ASCII letters a through z in a c...

Page 18: ...h ID Mode function in NetLinx Studio to establish a NetLinx Device ID for the device The steps described and the dialogs shown in this section are in the NetLinx Studio application NetLinx Studio is available to download from www amx com Refer to the NetLinx Studio on line help for information on using NetLinx Studio 1 Access the Device Addressing dialog FIG 12 by selecting Diagnostics Device Addr...

Page 19: ...g dialog Refer to the Manage System System Number section on page 44 for more detailed instructions on setting a system value 3 Click Get IP Information to configure the on board Master for DHCP usage and then read the IP Address obtained from the DHCP Server This action enables the Use DHCP and Specify IP Address options NOTE DO NOT enter ANY IP information at this time this step only gets the Sy...

Page 20: ...ialog FIG 16 2 Verify that both the System number corresponds to the System value previously assigned within the Device Addressing tab and that zero 0 is entered into the Device field NOTE The system value must correspond to the Device Address previously entered in the Device Addressing tab Refer to the Manage System System Number section on page 44 for more detailed instructions on setting a syst...

Page 21: ...to establish communication via the LAN connected Master 1 Use NetLinx Studio to obtain the IP Address of the NI Controller from your System Administrator If you do not have an IP Address follow the steps outlined in either the Obtaining the NI Controller s IP Address using DHCP section on page 19 or the Assigning a Static IP to the NI Controller section on page 20 2 Select Settings Master Communic...

Page 22: ...e the Master is initially responding online before establishing full communication If the authentication is required for connecting to the Master at this address enter a User Name and Password in the text fields provided 7 Click OK to close the New TCP IP Settings dialog and return to the Communication Settings dialog FIG 22 a Click on the new IP address entry in the List of Addresses window b Cli...

Page 23: ...nel of the NetLinx Master the STATUS and OUTPUT LEDs should begin to alternately blink during the incorporation Wait until the STATUS LED is the only LED to blink 11 Click the OnLine Tree tab in the Workspace window to view the devices on the System The default System value is one 1 12 Right click the associated System number and select Refresh System This establishes a new connection to the speci...

Page 24: ...contain three devices NI Master Device Controller and A V Switcher Scaler each of which require a separate Kit file These three devices must be kept at compatible firmware versions for proper operation Therefore all three files should be used when upgrading any firmware associated with the Enova DVX All In One Presentation Switchers FIG 24 NetLinx Studio Sample OnLine Tree NI Controllers Firmware ...

Page 25: ...tral Controller and associated devices are listed in the OnLine Tree 4 Check the appropriate product page on www amx com for the latest NI Master Device Controller and A V Switcher Scaler firmware files in the case of Enova DVX for your device If necessary follow the procedures outlined in the following sections to obtain these firmware kit files from www amx com and then transfer the new firmware...

Page 26: ...amx com for the latest NI Master Device Controller and A V Switcher Scaler firmware kit files for your Enova DVX All In One Presentation Switcher Firmware file links are available along the right side of the catalog page FIG 26 Firmware files are bundled in a ZIP file along with a Readme TXT file that provides details on this firmware release 1 Accept the AMX Licensing Agreement 2 Download the ZIP...

Page 27: ...space Bar to view the devices on the System 2 In the OnLine Tree tab click Display and select Refresh System from the context menu This establishes a new connection to the System and populates the device tree with devices on that system 3 After the Communication Verification dialog indicates active communication between the PC and the Central Controller verify the Master and associated devices inc...

Page 28: ...ware files All device files must be kept at compatible firmware versions for proper operation Therefore all files should be used when upgrading any firmware associated with the Integrated Controllers Be sure to follow the required order for installing firmware files See the Required Order of Firmware Updates for NI Controllers section on page 27 See the Required Order of Firmware Updates for DVX C...

Page 29: ...Send to NetLinx Device dialog FIG 31 Verify the target s Device and System numbers matches the value listed within the System folder in the Workspace window 9 Select the Control Card s Kit file from the Files section FIG 31 in our above example we chose to update the NXC VOL4 card 10 Enter the System and Device numbers associated with the desired Master listed in the Workspace window A device valu...

Page 30: ... Addressing from the Main menu 2 Click the Set Device System to Factory Default button FIG 32 This resets both the system value and device addresses for definable devices to their factory default settings The system information in the OnLine Tree tab of the Workspace window refreshes and then displays the new information NOTE By setting the system to its default value 1 Modero panels that were set...

Page 31: ...ter see the WebConsole Security Options section on page 34 System Click to access the System Details page The options on this page allow you to view and configure various aspects of the NetLinx System see the WebConsole System Options section on page 44 Accessing the WebConsole From any PC that has access to the LAN that the target Master resides on 1 Open a web browser and type the IP Address of ...

Page 32: ...is Master Use the plus and minus symbols to the left of each item in the Device Tree to expand the view to include System devices ports and individual Port settings At the Port view you can use the Device Tree to make specific port assignments including Channel and Level assignments FIG 35 FIG 35 Online Device Tree all Collapsed NI 700 ports expanded System devices expanded NI 700 Port 1 expanded ...

Page 33: ...ions on this page to view edit the device s network settings Refer to the Manage Devices Network Settings section on page 69 for details ZeroConfig Networking Use these radio buttons to enable disable the new Zero Configuration zeroconf client in the Master By default zeroconf is enabled On option selected With zeroconf enabled the Master s web interface will be registered via zeroconf and can be ...

Page 34: ...ting Security Profiles Default Security Configuration By default the NetLinx Master creates the following accounts access rights directory associations and security options FTP Security is always enabled on the Masters The Admin Change Password Security option in the Group and User Level Security Details pages is enabled by default All other security options are disabled by default FIG 37 System S...

Page 35: ...User Level pages of the Security section NOTE This username and password information is also used by both G4 touch panels within the System Connection firmware page and AMX software applications such as NetLinx Studio to communicate securely with a Master using encrypted communication User Name and Password Rules Case sensitive Must be between 4 and 20 characters The following special characters a...

Page 36: ...tware components This feature works in tandem with the Require Encryption option see below to require that any application or hardware communicating with the Master must provide a valid username and password In a Master to Master system the Master which accepts the IP connection initiates the authentication process This configuration provides compatibility with existing implementations and provide...

Page 37: ...aster due to the authentication algorithms used for this type security Before LDAP is enabled a user account must be set up with the username password and privileges matching the ones stored on the LDAP server If there is a mismatch with the username or password the AMX hardware or software component will not be allowed access If there is a mismatch with the access privileges the master will use t...

Page 38: ...modifying or deleting a group s rights and also allows for the definition of the files directories accessible by a particular group Adding a New Group 1 Select the Group Level tab in the Security section to open the Group Security Details page 2 Click the Add New Group button see FIG 39 to access the Add a group and modify settings page FIG 40 3 In the Group Name field enter a unique name for the ...

Page 39: ...p user to alter the current Master s security and communication settings via NetLinx Studio This includes such things as IP configuration Reset URL list settings Master communication settings and security parameters ICSP Connectivity If selected a valid username and password is required to communicate with the NetLinx Master via an ICSP connection TCP IP UDP IP and RS 232 This feature allows commu...

Page 40: ...hin the associated group does not remove that right from the user The only way to remove a group s available security right from a target user is either to not associate a group to a user or to alter the security rights of the group being associated Deleting a Group 1 Select the Group Level tab in the Security section to open the Group Security Details page 2 Press the Delete button to remove the ...

Page 41: ... section to open the User Security Details page 2 Click the Add New User button see FIG 43 to access the Add Modify User page FIG 44 3 In the User Name field enter a unique name for the new group The name must be a unique alpha numeric character string 4 20 characters and is case sensitive The words administrator and NetLinx cannot be used since they already exist by default 4 In the Group drop do...

Page 42: ...k the Edit button to edit the Security Access options for the selected User Click Delete to delete the selected User from the Master Deleting a User 1 Select the User Level tab in the Security section to open the User Security Details page 2 Press the Delete button to remove the selected User and refresh the page The system will prompt you to verify this action click OK to proceed If you are not l...

Page 43: ...e target Master and the ICSP Connectivity option must be enabled within the System Level Security page Compression Options The checkboxes at the bottom of this page allow you to choose from two compression options Use compression to decrease response delay when viewing G4 Web Control windows over a bandwidth restricted network or over the Internet By default both compression options are disabled U...

Page 44: ...escribed in the following subsections Manage System System Number The options on this page display the current System Number assigned to the target Master read only and allow you to change the system number see FIG 47 Changing the System Number On the Master 1 Enter the new numeric value into the New System Number field 2 Click the Accept button to save this new value to the system on the target M...

Page 45: ...sages which appear to a specified device to have come from the Master To Emulate a device means that the program generates messages which appear to the Master to have come from a specified device physical or virtual When Emulate is selected a Push button is added to the Channel Code section see FIG 48 NOTE The System Number Device Number and Port Number fields are read only Instead of specifying t...

Page 46: ...e device Master responds to the push message 5 In the Level Code section enter a valid Level number and Level data value for the specified D P S and press the Send button to transmit the level data The Level number range is 1 65535 The table below lists the valid Level data types and their ranges 6 In the Command and String fields enter any character strings that can be sent as either a String or ...

Page 47: ... FIG 50 The options on this page allow authorized users to enable and monitor various diagnostic messages coming from and going to System Devices NOTE The System Number Device Number and Port Number value fields are read only disabled Instead of specifying these values for a System Device select a device via the Device Tree to populate these fields with that device s values as described below Enab...

Page 48: ... To enable diagnostic messages from this device click on one of the Edit buttons along the bottom of the Diagnostics Options table This opens the Edit Options window FIG 52 where you can select which Diagnostics messages to enable or disable for this device FIG 51 Select Diagnostics from within a selected Device s Network Settings page Click on Diagnostics from within the device s Network Settings...

Page 49: ...Repeat steps 1 3 Alternatively you can click one of the Edit buttons to open the Edit Options window and specify a System Number Device and Port for a known System Device Select the Diagnostics messages that you want to enable for this device and click Update FIG 52 Edit Options window FIG 53 Edit Options window Click to delete this device from the Diagnostics page disables all diagnostics on this...

Page 50: ... to enable notifications A value of 0 for any option gives you all of the systems devices or ports This dialog also allows you to store recall presets Messages Online Offline Generates a message when there is a change in the target device s online offline status Configuration Generates a message when there is a change in the target device s configuration Status Generates a message when there is a ...

Page 51: ... Manage System tab to access the Server Options page FIG 55 The options on this page allow you to Change the port numbers used by the Master for various Web services Configure the SSL settings used on the Master Manage existing and pending license keys manage the active NetLinx system communication parameters Configure modify the SSL certificates on the target Master The options on this page are d...

Page 52: ... 192 99 HTTPS SSL The port value used by web browser to securely communicate between the web server UI and the target Master This port is also used to simultaneously encrypt this data using the SSL certificate information on the Master as a key This port is used not only used to communicate securely between the browser using the web server UI and the Master using HTTPS but also provide a port for ...

Page 53: ...certificates Longer key lengths result in increased certificate processing times Common Name The Common Name of the certificate must match the URL Domain Name used for the Master Example If the address used is www amxuser com that must be the Common name and format used The Common Name can not be an IP Address If the server is internal the Common Name must be Netbios For every website using SSL th...

Page 54: ...enerating an SSL Server Certificate Request This action allows you to is used to modify or recreate a certificate already on the Master For example if the company has moved from Dallas to Houston all of the information is reentered exactly except for the City 1 Click the Create SSL Certificate link in the Server Options page to open the Create SSL Certificate window 2 Modify the certificate inform...

Page 55: ... CA server certificate Before importing an SSL Certificate you must First have a self generated certificate installed onto your target Master Second enable the HTTPS SSL feature from the Server Options page FIG 55 to establish a secure connection to the Master prior to importing the encrypted CA certificate 1 Copy the returned certificate signed by the CA to your clipboard 2 Click the Import SSL C...

Page 56: ...connect to a specific NIST Internet Time Service Server Setting the Mode for the Clock Manager 1 In the Mode Settings tab FIG 59 select a Time Synch option Network Time This option allows the Master to manage it s clock by connecting to a NIST Internet Time Service Server When this option is selected the Master will connect to the default NIST Server to get date and time information You can select...

Page 57: ...date March 21 When Fixed is selected use the Day Month and Starts fields to specify the date and time hh mm to start Daylight Savings time Select by Occurrence to specify the calendar date when the rule applies as a heuristic the 3rd Sunday in March When by Occurrence is selected use the Week of the Month Day of the Week Month and Starts fields to specify the occurrence to start Daylight Savings t...

Page 58: ...er s location in the Location field This is used only to help the user manage entries and it is not verified or used internally by the clock manager 5 Click Accept to save these settings to the Master Removing an NIST Server From the List 1 Click on the Remove x button to the right of a user added NIST Server in the NIST Server Manager list 2 Click Accept to save these settings to the Master NOTE ...

Page 59: ...ge 3 Enter the Product Key into the Key fields The Product Key is Master specific and is typically provided by AMX upon registration Example AMX Meeting Manager and i Voting applications are examples of products that require both a Product serial number and a Master specific key prior to usage 4 Press the Accept button to save the information If there are no errors with the information on this pag...

Page 60: ...ption System Displays the System value being used by the listed NetLinx Master Device Displays the assigned device value of the listed unit This Device entry applies to both the Master and those NDP capable devices currently connected to that Master Device Type Displays a description of the target Master or connected device and its current firmware version Example NI Master v3 01 323 File Name Dis...

Page 61: ...d a VCR is detected in the system auto binding can then be accomplished If there were two VCRs defined within the application auto binding could not be completed due to the lack of a clearly defined one to one correspondence When this option is not selected no auto binding activity takes place and all binding of the newly discovered devices must be accomplished manually via the Web control interfa...

Page 62: ...Manage Devices tab to access the Manage Device Bindings page FIG 66 Use the options on this page to configure application defined Duet virtual devices with discovered physical devices The table on this page displays a list of all application defined devices including each device s Friendly Name the Duet virtual device s D P S assignment the associated Duet Device SDK class indicating the type of t...

Page 63: ...1 DUET_DEV_TYPE_DISC_DEVICE My DVD DUET_DEV_POLLED DYNAMIC_POLLED_PORT COM2 DYNAMIC_APPLICATION_DEVICE dvRECEIVER1 DUET_DEV_TYPE_RECEIVER My Receiver THE EVENTS GO BELOW DEFINE_EVENT DATA_EVENT dvRECEIVER1 Duet Virtual device data events go here Sample code can be found within the DEFINE_START section as shown in FIG 67 This code gives the Master a heads up notification to look for those devices m...

Page 64: ...evices attached to the port Dynamic application devices either display a Bind or Unbind button Dynamic application devices that have been bound display an Unbind button When the user selects Unbind any associated Duet module is then destroyed and the link between the application device and the physical device is then broken Dynamic application devices that have not been bound to a physical device ...

Page 65: ...y Use the drop down list to select the control method associated with the physical target device IR IP Serial Relay Other SDK Class Use the drop down list to select the closest Device SDK class type match for the physical target device The SDK Class Types table below provides a listing of the available choices GUID Enter the manufacturer specified device s GUID Global Unique Identification informa...

Page 66: ...ce has an inboard HTTP or FTP server If Module Search via Internet is NOT enabled the search does NOT query the AMX online database nor will it pull any manufacturer specified URLs that do not match the IP Address of the physical device itself Modules that are retrieved from either the Internet or from the manufacturer s device are then placed into the unbound directory and automatically overwrite...

Page 67: ...olled Ports link in the Manage Devices tab to access the Manage Polled Ports page FIG 73 The options on this page allow you to view modify settings for all polled ports in the System NOTE Polled Ports must be specified in the Master s code in order for this page to be populated FIG 72 View All Active Devices Device Properties pop up FIG 73 System Manage Devices Manage Polled Ports Hold the mouse c...

Page 68: ... port in the Physical Port list to access the Edit Port Settings page FIG 74 Use the drop down menus to modify the Port settings Click Reset to Default Settings to return this port to its default configuration FIG 74 Manage Polled Ports Edit Port Settings Default Port Settings Baud Rate 9600 Data Bits 8 Parity None Stop Bits 1 Flow Control None 485 Disabled ...

Page 69: ...enable disable the Zero Configuration ZeroConfig client in the Master By default ZeroConfig Networking is enabled On option selected With ZeroConfig enabled the Master s web interface will be registered via ZeroConfig and can be viewed through a ZeroConfig browser plug in such as Bonjour for IE NDP Beacon Use these radio buttons to enable disable the NetLinx Discovery Protocol NDP beacons client i...

Page 70: ...ased Device Discovery beacons Manage Devices URL List With the Master selected in the Device drop down menu click the URL List link in the Manage Devices tab to access the URL List page FIG 76 The options on this page allow you to view and edit the URL List of devices for the Master Adding a URL To The Master s List Of Devices In the Manage Devices URL List page click the Add URL button to open th...

Page 71: ...the Device Number for Masters should remain set to zero Manage Devices Control Emulate With the Master selected in the Device drop down menu click the Control Emulate link in the Manage Devices tab to access the Control Emulate Options page FIG 79 This page can also be accessed via the Manage System options as described in the Manage System Control Emulate Options section on page 45 See the Contro...

Page 72: ...sole Programming Guide Manage Devices Log With the Master selected in the Device drop down menu click the Log link in the Manage Devices tab to access the Message Log For Device page FIG 80 This page displays message logs for the Master FIG 80 Manage System Message Log For Device ...

Page 73: ...gnostics link in the Manage Devices tab to access the Diagnostics Options page FIG 81 This page can also be accessed via the Manage System options as described in the Manage System Diagnostics Options section on page 47 See the Enabling Diagnostics On a Selected System Device section on page 47 for details FIG 81 Diagnostics Options Page with diagnostic messages enabled Diagnostic Options table ...

Page 74: ...er The date and time settings are propagated over the local bus Syntax SEND_COMMAND DEV CLOCK mm dd yyyy hh mm ss Variables mm dd yyyy Month day and year Month and day have 2 significant digits Year has 4 significant digits hh mm ss Hour minute and seconds Each using only 2 significant digits Example SEND_COMMAND 0 CLOCK 04 12 2005 09 45 31 Sets the Master s date to April 12 2005 with a time of 9 ...

Page 75: ... IP_UDP_2WAY 3 Syntax SEND_COMMAND D P S UDPSENDTO IP or URL UDP Port Number Variables IP or URL A string containing the IP Address or URL of the desired destination UDP Port Number A String containing the UDP port number of the desired destination Example 1 SEND_COMMAND 0 3 0 UDPSENDTO 192 168 0 1 10000 Any subsequent SEND_STRING to 0 3 0 are sent to the IP Address 192 168 0 1 port 10000 Example ...

Page 76: ...millisecond delay between all transmitted characters CHARDM Set the delay time between all transmitted characters to the value specified in 1 Millisecond increments Syntax SEND_COMMAND DEV CHARDM time Variable time 0 255 Measured in 1 millisecond increments Example SEND_COMMAND RS232_1 CHARDM 10 Sets a 10 millisecond delay between all transmitted characters CTSPSH Enable Pushes Releases and Status...

Page 77: ...s the RS232_1 device from transmitting received characters to the Master RXON Start transmitting received characters to the Master default Enables sending incoming received characters to the Master This command is automatically sent by the Master when a CREATE_BUFFER program instruction is executed Syntax SEND_COMMAND DEV RXON Example SEND_COMMAND RS232_1 RXON Sets the RS232_1 device to transmit r...

Page 78: ...s RS 485 mode and enables RS 422 485 Enable Enables RS 485 mode and disables RS 422 Note The only valid 9 bit combination is baud N 9 1 Example SEND_COMMAND RS232_1 TSET BAUD 115200 N 8 1 485 ENABLE Sets the RS232_1 port s communication parameters to 115 200 baud no parity 8 data bits 1 stop bit and enables RS 485 mode TXCLR Stop and clear all characters waiting in the transmit out buffer and stop...

Page 79: ...he RS232_1 device s ninth data bit to 0 on all character transmissions 27 18 1 Set the ninth data bit to 1 for all subsequent characters to be transmitted Used in conjunction with the B9MON command Syntax SEND_STRING DEV 27 18 1 Example SEND_STRING RS232_1 27 18 1 Sets the RS232_1 device s ninth data bit to 1 on all character transmissions 27 19 time Insert a time delay before transmitting the nex...

Page 80: ...umber Variable channel number 0 199 Example SEND_COMMAND IR_1 CH 18 This device performs the following Transmits IR signals for 1 IR code 11 The transmit time is set with the CTON command Waits until the time set with the CTOF command elapses Transmits IR signals for 8 IR code 18 Waits for the time set with the CTOF command elapses If the IR code for Enter IR code 21 is programmed the Controller p...

Page 81: ... designated port Syntax SEND_COMMAND DEV IROFF Example SEND_COMMAND IR_1 IROFF Immediately halts and clears all IR output signals on the IR_1 port POD Disable previously active PON power on or POF power off command settings Channel 255 changes are enabled This command is used in conjunction with the I O Link command Syntax SEND_COMMAND DEV POD Example SEND_COMMAND IR_1 POD Disables the PON and POF...

Page 82: ... 1 10ths of a second Default is 15 1 5 seconds Example SEND_COMMAND IR_1 PTOF 15 Sets the time between power pulses to 1 5 seconds for the IR_1 device PTON Set the time duration of the power pulses in 10 second increments This time increment is stored in permanent memory This command also sets the pulse length for each pulse generated by the PON or POF send commands in tenths of seconds Syntax SEN...

Page 83: ... set by the XCHM send command Syntax SEND_COMMAND DEV XCH channel Variable channel 0 9999 Example For detailed usage examples refer to the XCHM command Note This command supports 4 digit channels XCHM Changes the IR output pattern for the XCH send command Syntax SEND_COMMAND DEV XCHM extended channel mode Variable extended channel mode 0 4 Example SEND_COMMAND IR_1 XCHM 3 Sets the IR_1 device s ex...

Page 84: ...Mode 6 Example x x x x SEND_COMMAND IR_1 XCH 3 Transmits the IR code as 0 0 0 3 SEND_COMMAND IR_1 XCH 34 Transmits the IR code as 0 0 3 4 SEND_COMMAND IR_1 XCH 343 Transmits the IR code as 0 3 4 3 SEND_COMMAND IR_1 XCH 1343 Transmits the IR code as 1 3 4 3 I O SEND_COMMANDs Command Description GET DBT Get Debounce Time Syntax GET DBT n Variable n the channel number of the I O input port SET DBT Se...

Page 85: ...w or contact closure Channel changes Pushes and Releases generate reports based on their active state Setting an input to ACTIVE HIGH will disable the ability to use that channel as an output Syntax SEND_COMMAND DEV SET INPUT channel state Variable channel Input channel 1 8 state Active state HIGH or LOW default Example SEND_COMMAND IO SET INPUT 1 HIGH Sets the I O channel to detect a high state c...

Page 86: ...erminal session via the Program Port the PC COM RS232 port on your PC must be physically connected to the Program port on the NetLinx Master You will also need to know the current baud rate setting for the Master so that you can verify that it matches the settings on your PC 1 In Windows go to Start Programs Accessories Communications to launch the HyperTerminal application to open the Connection ...

Page 87: ...e Help or a question mark and Enter to access the Help Menu and display the Program port commands described below Terminal Commands Command Description Help D P S Extended diag messages are OFF D P S Device Port System If omitted assumes Master or Help Displays this list of commands AUTO LOCATE ENABLE DISABLE STATUS Enables Disables queries the auto locate feature on the Master Auto locate adds ad...

Page 88: ... as measured in Megabytes An example is a value of 5 5 MB GET ETHERNET MODE Displays the current LAN configuration setting Settings are either auto in which the LAN driver will discover it s settings based on the network it is connected to OR speed and duplex where speed is either 10 or 100 and duplex is either full or half Example GET ETHERNET MODE Ethernet mode is auto Note See SET ETHERNET MODE...

Page 89: ...ormation messages turned on MSG OFF Extended diagnostic information messages turned off MSG STATS Calculates incoming and outgoing messages over a time interval NETLINX LOG LEVEL Configure the current setting for the NetLinx AMX_LOG facility Example netlinx log level NetLinx Log Level is WARNING Set NetLinx Log level to 1 ERROR 2 WARNING 3 INFO 4 DEBUG Enter selection or press return to keep curre...

Page 90: ...o Module Count 1 1 Name is i PCLinkPowerPointTest File Names 2 1 C Program Files AMX Applications i PCLinkPowerPoint 2 C Program Files Common Files AMXShare AXIs NetLinx axi 2 Name is MDLPP File Names 2 1 C AppDev i PCLink PowerPoint i PCLinkPowerPointMod axs 2 C Program files Common Files AMXShare AXIs NetLinx axi PULSE D P S or NAME CHAN Pulses a specified channel on a device on and off The devi...

Page 91: ... is entered with NetLinx string syntax SET DATE Prompts you to enter the new date for the Master When the date is set on the Master the new date will be reflected on all devices in the system that have clocks i e touch panels By the same token if you set the date on any system device the new date will be reflected on the system s Master and on all connected devices Note This command will not updat...

Page 92: ... rebooted to enable new settings Example SET HTTPS PORT Current HTTPS port number 443 Enter new HTTPS port number Usually 443 0 disable HTTPS Once you enter a value and press the ENTER key you get the following message Setting HTTPS port number to New HTTPS port number set reboot the Master for the change to take effect SET ICSP PORT Sets the Master s IP port listened to for ICSP connections Note ...

Page 93: ... log count 1000 Enter new log count between 50 10000 Once you enter a value and press the ENTER key you get the following message Setting log count to New log count set reboot the Master for the change to take effect SET QUEUE SIZE Provides the capability to modify maximum message queue sizes for various threads Example set queue size This will set the maximum message queue sizes for several threa...

Page 94: ...account passwords conform to the new standard all existing user accounts are deleted and the built in administrator and netlinx account passwords are set to the secure default of Amx1234 Failed login attempts will force a 4 second delay before a subsequent login attempt can occur Three consecutive login failures from any location will cause a 15 minute lockout for the specified user account If a b...

Page 95: ...Contact AMX LLC Location Richardson TX USA Read Community public Write Community private Is this correct Type Y or N and Enter Note The System Description System Contact and System Location are the values that will be published for the Master via SNMP The system must be rebooted once the new values are entered SET SSH PORT Sets the Master s IP port listened to for SSH connections Note The Master m...

Page 96: ...tem that have clocks i e touch panels By the same token if you set the time on any system device the new time will be reflected on the system s Master and on all connected devices Note This will not update clocks on devices connected to another Master in Master to Master systems Example SET TIME Enter Date hh mm ss SET TIMELINE LOOPCNT Sets the Master s timeline event max loopcount SET UDP BC RATE...

Page 97: ...te Records older than 90 days will be automatically purged The entire database of audit records can be purged manually from Telnet SSH terminal session using the CLEAR AUDIT LOG command see page 87 SHOW BUFFERS Displays a list of various message queues and the number of buffers in each queue Example show buffers Thread TX RX Queued Axlink 0 UDP 0 0 Sent NO Waiting NO IPCon Mgr 0 Con Manager 0 Inte...

Page 98: ... Text 1 11 01 2001 THU 14 14 49 ConnectionManager Memory Available 11436804 26572 2 11 01 2001 THU 14 12 14 ConnectionManager Memory Available 11463376 65544 3 11 01 2001 THU 14 10 21 ConnectionManager Memory Available 11528920 11512 4 11 01 2001 THU 14 10 21 TelnetSvr Accepted Telnet connection socket 14 addr 192 168 16 110 port 2979 5 11 01 2001 THU 14 05 51 Interpreter CIpEvent OnLine 10002 1 5...

Page 99: ...00108 Channels Commands SHOW REMOTE Displays the Remote Device List Master Master This is a list of the devices this system requires input from and the types of information needed If when a NetLinx Master connects to another NetLinx Master the newly connecting system has a device that the local system desires input from the new system is told what information is desired from what device Note The l...

Page 100: ...7 NXI Download 00001 AMX Corp 00260 v1 00 20 PID 0 OID 0 Serial 0 0 0 0 0 0 0 0 0 0 0 0 Physical Address NeuronID 000189145801 00257 NXI NXI 1000 Boot 00001 00261 v1 00 00 PID 0 OID 1 Serial 0 0 0 0 0 0 0 0 0 0 0 0 10002 00003 PHAST PLK IMS 00001 Phast Corp 0003 v3 12 PID 0 OID 0 Serial 0000000000000000 Physical Address NeuronID 0100417BD800 START LOG ON OFF Enables and disables the collection of ...

Page 101: ...tup 3 The Setup Security menu shows a list of choices and a prompt To select one of the listed choices simply enter the number of the choice 1 17 at the prompt and press Enter Each option in the Setup Security menu displays a submenu specific to that option The following subsections describe using each of the Setup Security menu options NOTE Changes made to the target Master from within the Termin...

Page 102: ... the Edit Group Menu so you can edit the group s rights see page 104 9 Delete group This selection will prompt you select a group to delete A group can only be deleted if there are no users assigned to that group 10 Show list of authorized groups This selection displays a list of groups 11 Set Telnet Timeout in seconds This selection allows you to set the time a telnet session waits for a user to ...

Page 103: ...LDAP Security enter 7 and press Enter The same menu will be sent to the screen with LDAP Security set to Enabled Press enter to return to the Security Setup menu 5 When back to the Security Setup menu enter 13 and press Enter A prompt to enter the LDAP URI will be displayed Once the URI is entered and enter is pressed a prompt for the next LDAP parameter will be displayed This will continue until ...

Page 104: ...l communication must be encrypted 7 LDAP Security Enabled Disabled This selection enables disables LDAP Security Refer to Appendix A LDAP Implementation Details on page 108 for details on LDAP Implementation Edit User Menu Command Description 1 Change User Password This selection prompts you to enter the new password twice for the user Once the new password is entered the user must use the new pas...

Page 105: ...ient access rights to login to a Terminal session if this option is enabled 2 Admin Change Password Access Enable Disable Enables disables Administrator Change Password Access The account has sufficient access rights to change the administrator password if this option is enabled 3 FTP Access Enable Disable Enables disables FTP Access The account has sufficient access rights to access the NetLinx M...

Page 106: ... tools While these commands are available for any user to execute their output is interpretable primarily by an AMX Technical Support Engineer Logging Out of a Terminal Session NOTE It is very important to execute the logout command prior to disconnecting from a Master Simply removing the RS 232 connector from the Program Port maintains your logged in status until you either return to logout via a...

Page 107: ...e keypad 1 then hit keypad 0 then release ALT The standard line feed code is entered decimal 10 Windows will perform an ANSI to OEM conversion on some codes entered this way because of the way Windows handles languages and code pages The following codes are known to be altered but others may be affected depending on the computer s setup Characters 15 21 22 and any characters above 127 This affects...

Page 108: ...s that account must have access to cn attributes for all groups of which it is a member 9 Group membership for users will be defined by the GroupOfNames object class GroupOfUniqueNames is not supported due to ambiguities associated with implementations which use unique ID s appended to membership DN s 10 When performing searches for group membership no restrictions exist which would the restrict r...

Page 109: ...ration options are described on page 37 Example Setting Up User s Access Rights In order to give AMX equipment users access rights to the Master group memberships for users will be defined by the GroupOfNames object class refer to LDAP RFC4519 Two records need to be created in the database One that represents users with administrative privileges Admin Change Password Access Terminal RS232 Access F...

Page 110: ...strator groupOfNames objectClass on the server 1 On the System Security Details page disable LDAP by clearing the LDAP Enabled checkbox and disable ICSP Connectivity by clearing the ICSP Connectivity checkbox 2 Click the User level tab and navigate to the User Security Details page 3 Create a new user by clicking Add New User 4 Enter the User name and password as set up on the LDAP server for exam...

Page 111: ...offer for authentication If username length is set to 0 authentication is not attempted PASSWORD Password to offer for authentication If password length is set to 0 authentication is still attempted but simply uses a zero length password FROM Mail address to populate to the Mail From field in outgoing emails REQUIRE_TLS SMTP server must support TLS in order to establish a connection Valid values a...

Page 112: ...et to NULL_STR SMTP_SEND returns a signed integer If the return value is negative 0 that is an indication there was a failure in handing the message off to the mail service most likely due to an invalid argument supplied to the SMTP_SEND call If the return value is positive 0 then the value is the index associated with the mail being sent Mail sends are asynchronous to the normal processing of the...

Page 113: ..._MODE_NETWORK or CLK MGR_MODE_STANDALONE CLKMGR_IS_DAYLIGHTSAVINGS_ON Returns FALSE 0 or TRUE 1 default FALSE 0 CLKMGR_SET_DAYLIGHTSAVINGS_MODE CONSTANT INTEGER ONOFF Can be set to ON TRUE or OFF FALSE CLKMGR_GET_TIMEZONE Returns Timezone as a string in the format UTC HH MM CLKMGR_SET_TIMEZONE CONSTANT CHAR TIMEZONE Input string must have the correct format UTC HH MM CLKMGR_GET_RESYNC_PERIOD Retur...

Page 114: ...ave the form occurence OCCURENCE DAY OF WEEK MONTH HH MM SS with all fields as numeric except for the word occurence OCCURANCE range 1 5 5 indicates the LAST occurrence of a particular day of the month DAY OF WEEK translates as 1 Sunday 2 Monday 3 Tuesday 4 Wednsday 5 Thursday 6 Friday 7 Saturday Examples fixed 5 10 16 00 00 October 5 at 4 00PM occurence 5 1 10 02 00 00 last Sunday in October at 2...

Page 115: ...es fixed 5 10 16 00 00 October 5 at 4 00PM occurence 5 1 10 02 00 00 last Sunday in October at 2 00AM CLKMGR_SET_END_DAYLIGHTSAVINGS_RULE CONSTANT CHAR RECORD Sets the END Daylight Savings rule to the specified string which MUST be in either the Fixed Date format or the Occurence Of Day format The function returns a negative SLONG value if it encounters an error The Fixed Date rules have the form ...

Page 116: ...t assume responsibility for errors or omissions AMX also reserves the right to alter specifications without prior notice at any time The AMX Warranty and Return Policy and related documents can be viewed downloaded at www amx com 3000 RESEARCH DRIVE RICHARDSON TX 75082 AMX com 800 222 0193 469 624 8000 1 469 624 7400 fax 469 624 7153 AMX UK LTD AMX by HARMAN Unit C Auster Road Clifton Moor York YO...

Reviews:

No comments

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands