AMX NMX-MM-1000 Programming Manual
AMX NMX-MM-1000 Programming Manual

AMX NMX-MM-1000 Programming Manual

Enzo meeting presentation system
Hide thumbs Also See for NMX-MM-1000:

Advertisement

PRO GRA M M ERS G U IDE
N M X - M M - 1 0 0 0
E N Z O ™ M E E T I N G P R E S E N TAT I O N SYST E M

Advertisement

Table of Contents
loading

Summary of Contents for AMX NMX-MM-1000

  • Page 1 PRO GRA M M ERS G U IDE N M X - M M - 1 0 0 0 E N Z O ™ M E E T I N G P R E S E N TAT I O N SYST E M...
  • Page 2 AMX. The three-year warranty period will be extended to the life of the product (Limited Lifetime Warranty) if the war- ranty card is filled out by the dealer and/or end user and returned to AMX so that AMX receives it within thirty (30) days of the installation of equipment but no later than six (6) months from original AMX sales invoice date.
  • Page 3: Important Safety Instructions

    IMPORTANT SAFETY INSTRUCTIONS! 1) READ these instructions. 2) KEEP these instructions. 3) HEED all warnings. 4) FOLLOW all instructions. 5) DO NOT use this apparatus near water. 6) CLEAN ONLY with dry cloth. 7) DO NOT block any ventilation openings. Install in accordance with the manufacturer's instructions. 8) DO NOT install near any heat sources such as radiators, heat registers, stoves, or other apparatus (including amplifiers) that produce heat.
  • Page 4 Grounding straps, conductive smocks, and conductive work mats are specifically designed for this purpose. Anyone performing field maintenance on AMX equipment 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 WARNING: Do Not Open! Risk of Electrical Shock.
  • Page 5: Table Of Contents

    Overview ........................... 1 Default Connection Settings and Access Credentials ............1 Connecting to Enzo via AMX Shell ..................2 Using a Windows Terminal Client to Connect to Enzo via AMX Shell ............. 2 Shell Commands........................ 2 Command Auto-Complete ........................2 Command Scopes ...........................
  • Page 6: Amx Shell Commands

    Enzo Meeting Presentation System (FG3211-01) platform for integration with a NetLinx system. AMX Shell is a Java implementation of a command shell that can be implemented to expose remote access and management to the Enzo device. To access AMX Shell, the Enzo device must have Secure Shell (SSH) enabled. Refer to Diagnostics in the Enzo Administrators Guide for more details on enabling SSH.
  • Page 7: Connecting To Enzo Via Amx Shell

    > ssh amx@192.168.0.1 -p22 [ENTER] In the above example, amx serves as the user name. The default port number is 22. Use the -p attribute to connect to a different port number. After pressing ENTER, type the password at the password prompt. (The default password is 1988.) Using a Windows Terminal Client to Connect to Enzo via AMX Shell The terminal client used to connect to Enzo must support SSH connections.
  • Page 8: Command Scopes

    AMX Shell Commands Command Scopes AMX Shell registers all commands with a "scope" attribute. The scope is an additional qualifier that can help distinguish duplicate command names at run/execution time. (Duplicate commands using the same command name and scope names are not permitted.)
  • Page 9: System Scope

    AMX Shell Commands System Scope All AMX Shell system commands are registered with the scope identifier "*" (asterisk). System-scoped commands are given the highest priority for command resolution. Scope Command The scope command is provided as a default system command. Use the scope command to specify a scope at runtime in which to work.
  • Page 10: Command Options

    AMX Shell Commands Command Options AMX Shell supports command options. Command options always start with a hyphen ("-") character. Command options are used to provide additional (and often optional) content or instructions to the command execution. NOTE: Long option names start with two hyphen characters. Example: "--system" Abbreviated (short) option names start with a single hyphen character.
  • Page 11: Get/Set Command Proxies

    FIG. 16 Get/Set Command Proxies Amx Shell defines specialized "get" and "set" commands to help establish a convention across all implementing products so that a common command syntax/notation for obtaining (get) information or applying (set) configuration settings. The "get" and "set" commands are considered command proxies because all they do is execute the targeted underlying command with a prefixed command line option.
  • Page 12 Reset IP settings to the factory default --subnetmask, -sn The subnet mask for the device logout Exits the shell and terminates the user's connection. (Same as "quit" or "exit") Syntax: *:logout Continued Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 13 Timeout wait (number of seconds to wait for a response) --retry-count, -c Retry count (number of packets) quit Exits the shell and terminates the user's connection. (Same as "logout") Syntax: *:quit Continued Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 14 Command proxy used to set configuration on a specific target (command). See the Get/Set Command Proxies section on page 6 for more information. Syntax: *:set arguments Arguments: arguments - Command arguments to pass through. Continued Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 15 Minute (0-59) (defaults to -1) --millisecond, -ms Millisecond (0-999). (defaults to -1) --config, -c, --set Set the system time. --pm, -pm PM (used when setting time) --verbose, -v Display verbose time information. Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 16: Enzo Shell Commands

    Set the audio output port. --help Display a help message --info, -? Display the current audio output port. --out, -o Set audio output (HDMI, Analog). --verbose, -v Include detailed/verbose information about audio settings. Continued Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 17 --host, -h Set the URL of the SMTP host --password, -p Set the password --port, -P Set the port number --test, -t Set a test email --user, -u Set the user name Continued Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 18 Display a help message --info, -? Display the current video output resolution settings --out, -o Set the display video resolution (1080p, 720p, EDID) --reboot, -r Reboot the system after applying the new video resolution Continued Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 19 Perform a web update where the new firmware kit file is provided by the specified URL. Syntax: enzo:webu [options] url Arguments: url - The URL address to open Options: --help Display a help message Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 20: Netlinx Programming

    NetLinx Programming NetLinx Programming Overview This chapter defines all programming commands and system responses available for the NMX-MM-1000 Enzo Meeting Presentation System. Device Ports: The following table details the device ports on an Enzo system: Port Name Description Enzo API exposed on this device port controls the core Enzo platform, settings, and Enzo operating environment.
  • Page 21: Netlinx Commands

    • "App name" for single app mode (TV, MirrorOp, or Browser) or "MULTI" for multiple app mode • The App Mode Purge value of Yes, No, or Interactive. Please see the APP.MODE_PURGE for more info. Syntax: ?APP.MODE Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 22 Closes any active blanking activity display. Syntax: SEND_COMMAND <DEV>, "’BLANK.CLOSE’" BLANK.LOGO Displays the blanking screen with the optional animated AMX spinning logo. Syntax: SEND_COMMAND <DEV>, "’BLANK.LOGO’" BROWSER Opens the default web browser starting at the default home page. The browser options AUTOSTART are Firefox (default) and Browser.
  • Page 23 <item-key> = (required) The desired item path to share Example: SEND_COMMAND 10005:0:1,"’CONTENT.ACTION.SHARE-/folder/sub-folder/content- item.xxx’" Response: CONTENT.ACTION.SHARE.SUCCESS-<item-path> Note: If any error is encountered while trying to share the content item, the following error event notif ication will be broadcast. CONTENT.ACTION.SHARE.ERROR-<error-message>,<item-path> Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 24 CONTENT.ITEMS.RECORD-<relative-record-index>,<absolute-record-index>,<source- id>,<item-path>,<item-name>,<item-type>,<item-size>,<item-last-modified>,<item- read-only> Note: If any error is encountered while trying to query the list of content items, the following error event notif ication will be broadcast. CONTENT.ITEMS.ERROR-<error-message> Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 25 Note: If the requested path is not found or any other error is encountered while trying to assign the content cursor path, the following error event notif ication will be broadcast. CONTENT.PATH.ERROR-<error-message>,<requested-path> Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 26 CONTENT.SOURCE.ERROR-<error-message>,<requested-source-id> If not in session then you will get the following error: CONTENT.ERROR-The Enzo session is not active; please start a session first. Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 27 SEND_COMMAND 10005:0:1,"'?CONTENT.SOURCE-usb'" Response: CONTENT.SOURCE-<source-id>, <source-name>, <source-root-path>, <source-is-ready:true|false> Note: If the requested source is not found or if another error occurs, then the following error event notif ication will be broadcast. CONTENT.SOURCE.ERROR-<error-message>,<requested-source-id> Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 28 Issues an ARROW-DOWN keystroke to the active app. Actual results will be app-specific. Syntax: SEND_COMMAND <DEV>, "’DOWN’" DOWNLOAD.ABORT Causes current AMX content sharing transfer to be aborted. Syntax: SEND_COMMAND 10005:0:1,"DOWNLOAD.ABORT" ENTER Issues a ENTER keystroke to the active app. Actual results will be app-specific.
  • Page 29 Note: Receiver name from the About Screen is limited to 30 characters or less. With $NAME the receiver name can be longer, but we still recommend 30 characters or less. Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 30 = (optional) true or false. Display a text version of the URL. Example: SEND_COMMAND 1001:1:0,"’QR-http://www.amx.com,,true’" Shows a QR code for the AMX website without a title but with a text version of the URL. Note: Title suggested length is 60 characters or less. However, no hard limit is set. QR.CLOSE Closes any active QR code display.
  • Page 31 TV app if it is not already running. Syntax: TV.CHANNEL-<channel id>/<channel name> Variables: channel id = specifies which channel number to change to. channel name = specifies which channel name to change to. Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 32 Line 57 (15:22:58):: Command From [10021:1:1]-[TV.CHANNEL-TWB-TV1,1] Line 58 (15:22:58):: Command From [10021:1:1]-[TV.CHANNEL-PS-TV1,10] Line 59 (15:22:58):: Command From [10021:1:1]-[TV.CHANNEL-PS-TV2,11] Line 60 (15:22:58):: Command From [10021:1:1]-[TV.CHANNEL-SWB1-1-TV1, 20150120120411086] Line 61 (15:22:58):: Command From [10021:1:1]-[TV.CHANNEL-SWB1-2-TV2, 20150120120433092 Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 33 This command starts a video as a VOD with the TV app. Syntax: SEND_COMMAND <DEV>, "’TV.VOD-<url>’{,<name>}'" Example: TV.VOD-http://10.35.84.138/v2/Archives/Archive1/0005/09/TS/High/video.ts,Bugs Issues an ARROW-UP keystroke to the active app. Actual results will be app-specific. Syntax: SEND_COMMAND <DEV>, "’UP’" Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 34 Mutes the audio on the attached display. Arguments: mute - • true/on/1 = muted • false/off/0 = unmuted Syntax: SEND_COMMAND <dev>,'VOLUME.MUTE-<mute>' Example SEND_COMMAND 1001:1:0,'VOLUME.MUTE-off' WAKE Wakes the Enzo display Syntax: SEND_COMMAND <dev>,'WAKE' Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 35: Enzo System Responses

    ERROR-Invalid Command is sent when the URL is invalid, or command is so malformed or that it never gets sent. ERROR-Exception encountered is sent when the processing of a command results in an exception Continued  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 36 A content source change occurs when: • The content source is changed/updated via the content API commands. (CONTENT.SOURCE-<source-id>) • A removable content source is attached or removed. • An authenticated content source is authenticated/unauthenticated. Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 37: Programming A Channel List

    Id - a unique identifier for a given channel. If 1 channel id is provided, then you should supply a unique id for all channels.  Description - describes what is on a channel.  Icon - is a URL to a custom image for a channel.  more  Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 38 - true to save configuration when exiting session or false for temporary channels Example: TV.CHANNELS-ftp://username:passwordAsNumber@ip/file.json,<retain> Another way to upload this file is using the Enzo WebUI as described in the Enzo Administrators Guide available at http://www.amx.com/products/NMX-MM-1000. Programmers Guide - NMX-MM-1000 Enzo Meeting Presentation System...
  • Page 39: Enzo Keypad

    FIG. 19 Installing the Enzo Keypad onto a NetLinx Master A source code example for the Enzo keypad is available for download at www.amx.com. The example code is stored in a .zip file. The .zip file contains two files: EnzoKeypad.axi - An .axi file is an include file that is included in the compiling process without having to reside in the Master ...
  • Page 40 © 2016 Harman. All rights reserved. Enzo, NetLinx, AMX, AV FOR AN IT WORLD, HARMAN, and their respective Last Revised: logos are registered trademarks of HARMAN. Oracle, Java and any other company or brand name referenced may 8/01/2016 be trademarks/registered trademarks of their respective companies.

Table of Contents