User manual INFOCUS LP820 - Document

Command Line Interface on the LP820 Purpose ......................................................................................................................................................................................... 2 Message Format ............................................................................................................................................................................ 2 Write Commands ........................................................................................................................................................................... 2 Increment Commands .................................................................................................................................................................... 2 Decrement Commands................................................................................................................................................................... 3 Read Commands ............................................................................................................................................................................ 4 Error Handling .............................................................................................................................................................................. 5 Limitations ..................................................................................................................................................................................... 6 Serial Communications Configuration .................................................................................................. 7 Table Of End User Commands............................................................................................................... 8 1 Purpose This specification defines the serial command line streams for controlling an InFocus projector through the RS232 connector to the projector. These commands are intended to provide a simple set of controls to the projector through what InFocus calls the Command Line Interface (CLI). The CLI is designed for use by what the industry commonly calls boardroom controllers. The CLI will accept commands via RS232 to control the necessary features used by most boardroom controllers. This CLI language uses a simple human readable protocol to help facilitate the installers' time necessary to setup or diagnose a problem with boardroom control installations. However, the CLI is not a guaranteed delivery system. Message Format As commonly used in math notation, everything is evaluated in the parenthesis first, as the parentheses are designed to group things together. This same parenthesis nomenclature is used to group a command and its data together (nested parenthesis are not supported). All commands are three alpha characters followed by the request. The request can be a "?" symbol that signifies a read request, or a numerical number represented by 1 to 4 ASCII digits, that signifies a write request. Not all commands support reading and writing. The command table indicates the commands and requests that are supported. Write Commands Write commands have the following format: (AAA####) where, ( AAA #### ) - starts the CLI command - denotes the CLI function - denotes the value to be written (leading zeros are not necessary) - ends the CLI command Some functions have ranges for settings while others are Boolean. Settings with ranges range from zero to a maximum number. If a number greater than the maximum is received, it is automatically limited to the maximum number for that function. IT IS SUGGESTED THAT EACH FUNCTION BE QUERIED FOR ITS RANGE WITH A READ COMMAND BEFORE ISSUING A WRITE COMMAND. Boolean settings consider 0 as off and 1-9999 as on. The only exception is the Power command. The only valid write values that will be accepted will be `0' for turning the power off and `1' for turning the power on. Examples: Brightness Command Volume Command Freeze Command Freeze Command Power Command Power Command Power Command (BRT10) (VOL0000) (FRZ1) (FRZ9999) (PWR0) (PWR1) (PWR9999) Sets the brightness to 10 Set the volume to 0 Freeze the display Freeze the display Turn power off Turn power on Command not recognized Increment Commands Increment commands have the following format: (AAA+####) where, ( - starts the CLI command AAA + #### ) - denotes the CLI function - denotes Increment command - Is optional and denotes number of steps to be incremented (leading zeros are not necessary) - ends the CLI command Examples: Brightness Command Brightness Command (BRT+10) (BRT+) Increment brightness 10 steps Increment brightness 1 step Decrement Commands Increment commands have the following format: (AAA-####) where, ( AAA #### ) . Examples: Brightness Command Brightness Command (BRT-10) (BRT-) Decrement brightness 10 steps Decrement brightness 1 step - starts the CLI command - denotes the CLI function - denotes decrement command - Is optional and denotes number of steps to be decrement (leading zeros are not necessary) - ends the CLI command Read Commands Read commands have the following format: (AAA?) where, ( AAA ? ) - starts the CLI command - denotes the CLI function - denotes the read request - ends the CLI command A read command returns the current setting in an ASCII format enclosed in parentheses. The following Format is defined: 1) Range Format (r-R, V) 2) String Format (S) Range Format: (r-R, V) Where ( r R V ) Examples: (VOL?) (BRT?) Read the current range and value of the projector's volume Returns: (0-127,64) Read the current range and value of the projector's brightness Returns: (0-255,128) open parenthesis marks the start of the CLI response minimum value of the setting's range maximum value of the setting's range the current value of the setting closing parenthesis marks the end of the CLI response String Format: (S) Where ( S ) Examples: (VER?) Read the current software version Returns: (v2.0) open parenthesis marks the start of the CLI response character string closing parenthesis marks the end of the CLI response Error Handling When the closing parenthesis is received, the command is validated before it is processed. If the received command is determined to be invalid, a question mark character will be returned as a error response. Examples: (123?) (VOL ?) "123" is not a valid CLI command prefix. This read request will return `?' "VOL" is a valid CLI command prefix, but the spaces between the prefix and the question mark character invalidates the command. This read request will return `?'. Not all settings are readable. If an attempt is made to read from a write-only setting, the projector will return a question mark. Example: (RST?) If the RST CLI command is write only, this read request will return `?'. A more descriptive error message on the errors can then be queried with the (ERR?) command. The following message are defined: (No Error Detected) (Unknown command) (Unknown parameter) (Command not supported by this projector) (Command only available in Power on) (Projector not ready to be turned on) (Command only available with valid input source) (Command only available with external module) (Command failed) (Write only Command) (Command only available in RGB) (Command only available in VIDEO) (Command only available in NTSC) Limitations The CLI cannot respond to commands coming in at a high rate. Therefore, a delay must occur between commands to ensure that the command is properly executed before the next one is received. The recommended approach for interfacing to the projector is: Read: 1. Send the read command 2. Receive read response Write 1. Send the write command 2. Verify that an error response `?' was not received. Continually query (for a predefined time) the setting until the value has changed Some settings don't implement the full range of values in the setting's defined range. If an attempt is made to change the setting to an unsupported value, the CLI will round down to the nearest supported value. SERIAL COMMUNICATIONS CONFIGURATION The following table describes the serial communication configuration that should be used when interfacing to the CLI via the serial port. Windows HyperTerminal or ProComm are two tools that can be used to send CLI commands across the serial port. Setting Bits per second Data bits Parity Stop bits Flow Control Table 1 Configuration Value 19200 8 None 1 None TABLE OF END USER COMMANDS NA = Not Available, Src.dep = Source depended use a read request with ? to get current supported range. Function Power Rear Ceiling Display Message Power Save Auto Power Enable Low Power Enable Screen Saver Blank Screen Blank Screen Color Command PWR REA CEL DMG PSV APO LPE SSV BLK BSC Attribute R&W Range 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­2 0 ­ black 1 ­ blue 2 ­ white 0 ­ 10 0 ­ Blank 1 ­ Mute 2 ­ Mask 3 ­ Aspect Ratio 4 ­ Source 5 ­ Auto Image 6 ­ Freeze 7 ­ Zoom 8 ­ About 9 ­ PiP 10 ­ Screen Trigger 0 ­ 11 0 ­ English 1 ­ French 2 ­ German 3 ­ Spanish 4 ­ Chinese Traditional 5 ­ Japanese 6 ­ Korean 7 ­ Portuguese 8 ­ Russian 9 ­ Norwegian 10 ­ Chinese Simplified 11 ­ Italian 0­1 0 ­ disable 1 ­ enable 0­4 0 ­ up 1 ­ down 4 ­ select ? Default 0 0 0 1 1 0 0 0 0 0 R&W R&W R&W R&W R&W R&W R&W R&W R&W Effect Key EFK R&W 0 Language LAN R&W 0 Menu Enable Menu Navigation MNU NAV R&W R&W 0 NA Error Message ERR R NA Table 2 System Commands Function Horizontal Keystone Correction Vertical Keystone Correction Contrast Brightness Color Tint Aspect ratio Command DKH DKV CON BRT CLR TNT ARZ Attribute R&W R&W R&W R&W R&W R&W R&W Range 0-100 0-100 0-100 0-100 0-100 0-100 0­2 0 ­ native 1 ­ 16:9 2 ­ 4:3 0 ­ 12 0 ­ Presentation 1 ­ Photography 2 ­ Film 10 ­ User1 11 ­ User 2 12 ­ User 3 0­1 0 ­ Off 1 ­ On Default 50 50 50 50 50 50 0 Presets PST R&W 1 Freeze Display FRZ R&W 0 Table 3 Picture Function Sharpness Command SHP Attribute R&W Range 0­4 0­ Softest 1 ­ Soft 2­ Standard 3 ­ sharp 4 ­ sharpest 0-100 0-100 0-100 0­4 0­ Coolest 1 ­ Cool 2 ­ Warm 3 ­ Warmest 4 ­ User 1 0-100 Default 2 Color Temp User Blue Color Temp User Green Color Temp User Red Color Temp BCG GCG RCG TMP R&W R&W R&W R&W 50 50 50 1 Auto Image Phase Tracking H Position V Position Mask AIM MSS MTS HPS VPS MSK W R&W R&W R&W R&W R&W Src.dep Src.dep Src.dep 0-1000 1 NA NA NA NA 0 Table 4 Picture Advance Function Source 1 Comm and SR1 Attribute R&W Range 0­5 0 ­ Computer1 1 ­ Computer2 2 ­ Computer3 3 ­ Video1 4 ­ Video2 5 ­ Video3 6 ­ Video1Rgb 0­5 0 ­ Computer1 1 ­ Computer2 2 ­ Computer3 3 ­ Video1 4 ­ Video2 5 ­ Video3 6 ­ Video1Rgb 0­5 0 ­ Computer1 1 ­ Computer2 2 ­ Computer3 3 ­ Video1 4 ­ Video2 5 ­ Video3 6 ­ Video1Rgb 0­5 0 ­ Computer1 1 ­ Computer2 2 ­ Computer3 3 ­ Video1 4 ­ Video2 5 ­ Video3 6 ­ Video1Rgb 0­7 0 ­ Computer1 1 ­ Computer2 2 ­ Computer3 3 ­ Video1 4 ­ Video2 5 ­ Video3 6 ­ Video1Rgb 7 ­ Last Used 0­1 0 ­ Off 1 ­ On 1 1 ­ Perform advance 1 1 ­ Perform advance 0­5 0 ­ Computer1 1 ­ Computer2 2 ­ Computer3 3 ­ Video1 4 ­ Video2 5 ­ Video3 6 ­ Video1Rgb 0­1 0­ Not Locked 1 ­ Locked and displayed 1 1 ­ Save User 1 Setting 1 1 ­ Save User 2 Setting 1 1 ­ Save User 14Setting Default NA Source 2 SR2 R&W NA Source 3 SR3 R&W NA Source 4 SR4 R&W NA Power Up Source DSC R&W NA Auto source Computer source advance Video source advance Source ASC CAD VAD SRC W W R&W NA NA NA NA Image Locked and Displayable ILK R NA Save User 1 Settings Save User 2 Settings Save User 3 Settings US1 US2 US3 W W W NA NA NA Table 5 Sources Function Factory Reset Perform lamp hours reset Time lamp 1 lasted (hours) Time lamp 2 lasted (hours) Time lamp 3 lasted (hours) Time lamp 4 lasted (hours) Time lamp 5 lasted (hours) Lamp Lit Lamp Time (hours) Number of lamp resets Lamp total time on for all bulbs (hours) Command RST LRT LB1 LB2 LB3 LB4 LB5 LML LMP LMR LMT Attribute W W R R R R R R R R R Range 1 1 ­ Perform Factory Reset 1 1 ­ Lamp hours Reset 0-100000 0-10000 0-10000 0-10000 0-10000 0-1 0 ­ Lamp not Lit 1 ­ Lamp Lit 0-10000 0-10000 0-1000000 Default NA NA NA NA NA NA NA NA NA NA NA Table 6 Service Function Treble Bass Balance Volume Mute Loudness Shime Internal Command TRB BAS BAL VOL MTE LOD ACE INT Attribute R&W R&W R&W R&W R&W R&W R&W R&W Range 0-100 0-100 0-100 0-100 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On 0­1 0 ­ Off 1 ­ On Default 50 50 50 50 0 0 0 0 Table 7 Audio Function Zoom Pan Horizontal Pan Vertical Current Status Command ZOM PNH PNV CST Attribute R&W R&W R&W R Range 0 - Input Width in pixels 0 - Input Width in pixels 0 - Input Height in pixels 0 - Standby 1 ­ Lamp Strike 2 ­ Lamp on Warming up 3 - Searching 4 ­ Source detected 5 - Image Locked and Displayable 6 ­ Lamp off cooling ? Response is the current Status Word in hex( 0000-FFFF) Bit D0: Power Bit D1: Valid Source Bit D2: Signal Source Change Bit D3: Module Change Bit D4: State Change Bit D5-D7: Reserved Bit D8: Fan Stop Bit D9: High Temperature Bit D10: Lamp Time Expired Bit D11-D15 Reserved Default 0 NA NA NA Status Word STA R NA Table 8 Projector Management Function Ip address byte 1 Ip address byte 2 Ip address byte 3 Ip address byte 4 Netmask byte 1 Netmask byte 2 Netmask byte 3 Netmask byte 4 Gateway byte 1 Gateway byte 2 Gateway byte 3 Gateway byte 4 DHCP Save & Load1 Command IP1 IP2 IP3 IP4 NM1 NM2 NM3 NM4 GT1 GT2 GT3 GT4 DHP SVN Attribute R&W R&W R&W R&W R&W R&W R&W R&W R&W R&W R&W R&W R&W W Range 0-255 0-255 0-255 0-255 0-255 0-255 0-255 0-255 0-255 0-255 0-255 0-255 0­1 0 ­ disable 1 ­ enable 1 1 ­ Save & Load parameters Default 192 168 0 2 255 255 255 0 192 168 0 1 1 NA Table 9 Network 1 Always us the SVN command to save and load the new settings to the network controller Function IR Keyboard Command IRE KBE Attribute R&W R&W Range 0­1 0 ­ disable 1 ­ enable 0­1 0 ­ disable 1 ­ enable Default 1 1 Table 10 Misc. The Misc. commands are not saved in NVRAM and have the following state at Power On: IRE ­ Enabled Keyboard ­ Enabled