ESP communication Reference - eyevis - · PDF fileESP communication Reference Technical Note 29/04/2014 Eyevis GmbH Page 2 of 18 Hundsschleestr. 23 [email protected] 72766 Reutlingen

TECHNICAL NOTE

ESP communication Reference

Revision: Master document

Date Version Modification Pages Author

29 April 2014 V1.0 - 18 HGN

ESP communication Reference Technical Note

29/04/2014

Eyevis GmbH www.eyevis.de Page 2 of 18 Hundsschleestr. 23 [email protected] 72766 Reutlingen Tel.: +49 7121 433 03- 0 Germany Fax: +49 7121 433 03-22

Overview

The eyevis ESP projectors are equipped with a RS232 interface for serial communication. This interface can be used to switch the projectors on or off. It also can be used to configure the projectors during the setup phase. The optional ACT (Automatic Color Tracking) system is a system to automatically adjust the color and brightness of the projector to a homogenous level. If an ACT is used, the ACT system needs to be connected to the RS232 interface of the projectors. This document describes the system layout and the communication protocol for such a configuration.

General Setup

The ESP projectors need to be configured with a unique serial ID. The serial ID need to be set by the DIP-Switches on the control panel of the projectors:

Communication Parameters: - Baud Rate: 38400 - Data Bits: 8 - Stop Bits: 1 - Parity: None - Handshake: None


29/04/2014


In combination with the ACT communication board, the following picture shows a possible layout for a valid configuration:

With this setup, the ACT can communicate with all projectors via RS232 Daisy Chain (primary communication). Notes: - It is important that the IDs are configured as a series (increment by

one) - The serial Daisy-Chain does not need to follow the series of the

IDs.


29/04/2014


External communication interface

To allow an external communication with the projection system, the ACT offer two ways of secondary communication.

For a proper functionality of the ACT, it is important that the ACT always can handle the primary communication to the projectors. If other applications or media control systems need to communicate with the projectors, they need to be connected as a secondary communication interface. There are two ways of secondary communications:

1.) Remote Control of the ACT 2.) RS232 serial Proxy

Remote control of the ACT

The ACT functionality is done by the EC_Lcontrol software. This software is fetching periodically the color and brightness information from the projectors and is adjusting the LED intensity to keep a homogenous color and brightness on all projectors. In addition to that, the software allows several other functions like Presets or custom configurations. These functions can be controlled with the GUI of the software, or by the remote communication port.


29/04/2014


To enable the remote control, the RS232 COM port need to be set in the EC_Lcontrol.ini configuration file:

[REMOTE]

enable=1

interface=COM10

log=0

With this configuration, the ACT is listening on RS232 Port COM10 for remote commands.

Command structure:

CMD(command;value)

No CR or LF is needed. The commands are not case sensitive.

Command list: Command Description HELP Returns a list of all possible

commands POWER Power OFF (Standby) or Power

ON for all projectors or for a single projector.

LOAD_FRAMEWORK Load a framework


29/04/2014


LOAD_SCRIPT Open a file and send all commands inside the file to the projectors.

SET_PRESET Use a specific configured preset GET_STATUS Returns basic status

information GET_INFO Returns basic general system

information DO_ADJUST Force the adjustment of color

and brightness AUTO_SAVE_PRESET Option to enable / disable the

autosave function for presets COLOR_MODE Switch all projectors to a solid

color mode (test image) GET_TARGET_BRIGHTNESS Returns the actual target

brightness value SET_TARGET_BRIGHTNESS Set an new target brightness

value

Command reference:

HELP

Returns a list of all possible commands

Command Parameter value HELP -

POWER

Power OFF (Standby) or Power ON for all projectors or for a single projector.

Command Parameter value Function Power 1 Switch all projectors ON

Start ACT Control-Loop Power 0 Switch all projectors OFF

Stop ACT Control-Loop Power 1;0 Switch projector ID #1 OFF Power 2;1 Switch projector ID #2 ON


29/04/2014


Example:

CMD(POWER;0)

All projectors are switched to standby mode. In addition to that, the ACT control-Loop is automatically stopped. Example:

CMD(POWER;1)

All projectors are switched ON. In addition to that, the ACT control-Loop is automatically started. Example:

CMD(POWER;3;0)

Only the projector with the ID #3 is switched to standby mode. The ACT control-Loop is not affected.

LOAD_FRAMEWORK

Load a framework

Command Parameter value Function LOAD_FRAMEWORK Filename Load the framework at

the specified file location.

LOAD_SCRIPT

Open a file and send all commands inside the file to the projectors.

Command Parameter value Function LOAD_SCRIPT Filename Load scriptfile at the

specified file location.


29/04/2014


SET_PRESET

Use a specific configured preset

Command Parameter value Function SET_PRESET Preset number Activate the preset with the

given number

Example:

CMD(SET_PRESET;1)

Activates the first configured preset.

GET_STATUS

Not implemented yet…

Command Parameter value GET_STATUS -

Not implemented yet…

GET_INFO

Returns basic general system information

Command Parameter value GET_INFO -

Example:

CMD(GET_INFO)

Answer:

INFO: version: EC-Lcontrol v1.6.47 | 04.04.2014

INFO: number of cubes: 4

INFO: com Port: COM32

COLOR: Target Values: x:0,322 y:0,322 L:50


29/04/2014


COLOR_MODE

Switch all projectors to a solid color mode (test image)

Command Parameter value Function COLOR_MODE 0 Switch all projectors to

‘normal’ Mode (DVI Input signal source

COLOR_MODE 1 Switch all projectors to full screen RED

COLOR_MODE 2 Switch all projectors to full screen GREEN

COLOR_MODE 3 Switch all projectors to full screen BLUE

COLOR_MODE 4 Switch all projectors to full screen BLACK

COLOR_MODE 5 Switch all projectors to full screen WHITE

Example:

CMD(COLOR_MODE;3)

All projectors are switched to a full-screen blue image.


29/04/2014


GET_TARGET_BRIGHTNESS

Returns the actual target brightness value

Command Parameter value GET_TARGET_BRIGHTNESS -

Example:

CMD(GET_TARGET_BRIGHTNESS)

Answer:

50,87

Represented GUI configuration:

SET_TARGET_BRIGHTNESS

Set an new target brightness value

Command Parameter value SET_TARGET_BRIGHTNESS New target brightness


29/04/2014


The EC_LControl software incorporates a command-Line to test the Remote commands:


29/04/2014


Serial Proxy interface

If the projectors need to be reached directly, the serial proxy interface of the EC_Lcontrol can be used.

To enable the serial proxy interface, the RS232 COM port need to be set in the EC_Lcontrol.ini configuration file:

[PROXY]

enable=1

interface=COM12

log=0

With this configuration, the ACT is listening on RS232 Port COM12 for direct commands for the projectors. The command structure of the projectors differs from the command structure of the ACT remote control.

Command structure:

SET(ID;command;value)

GET(ID;command)


29/04/2014


No CR or LF is needed. The commands are case sensitive! The SET instruction followed by the ID, the command and the parameter value is used to set a value onto a specific projector. The projector is addressed by the ID. To set data to all projectors at the same time, the ID=0 can be used. With a zero ID, the command is send to all connected projectors.

Command list: The commands are generated by an internal database inside the projector. There are a lot of commands that can be used. The Software ‘eyeDeviceSetup.exe’ is using the internal database to generate the complete List of all possible commands. Please use the ESP Manual to get an instruction how to use the ‘eyeDeviceSetup.exe’Software.

The following list gives only a short overview over possible commands: Command Description Power Power OFF (Standby) or Power ON

projectors. Orientation Projection mode for rear/front/ceiling or

floor projection Gamma Loads default pre-configured gamma

curves. LED_on Number of startup sequences of the

LEDs LED_Timer Total operating hours of the LEDs

The projectors always send back an answer to all commands. SET commands will be answered with an Acknowledge response if the command was executed successfully:

ACK(ID)

If the command can’t be executed, the projector will answer with a Non- Acknowledge response:

NACK(ID)


29/04/2014


Power

Power OFF (Standby) or Power ON projectors.

Command Parameter value Function Power 0 Switch the projector to

standby mode Power 1 Switch on the projector

Example:

SET(1;Power;0)

Switch OFF (Standby) the projector with ID #1 Response:

ACK(1)

Example:

SET(3;Power;1)

Switch ON the projector with ID #1 Response:

ACK(3)

Example:

SET(0;Power;0)

Switch OFF (Standby) all projectors Response:

ACK(1)

ACK(2)

ACK(3)

…


29/04/2014


Example:

GET(1;Power)

Return the Power state of the projector with ID #1 Response:

DATA(1;Power;0)

The response indicates that the projector is in standby mode.

Orientation

Projection mode for rear/front/ceiling or floor projection

Command Parameter value Function Orientation 0, 1, 2, 3 Change the projection

orientation (vertical / horizontal mirroring)

Example:

SET(1;Orientation;0)

Response:

ACK(1)

Example:

GET(1;Orientation)

Response:

DATA(1;Orientation;0)


29/04/2014


Gamma

Loads default pre-configured gamma curves.

Command Parameter value Function Gamma 0 Gamma 2.0 Gamma 1 Gamma 2.1 Gamma 2 Gamma 2.2 Gamma 3 Gamma 2.3 Gamma 4 Film Gamma 5 Graphics Gamma 6 Video Gamma 7 Linear

Example:

SET(1;Gamma;7)

Set the Gamma curve of the projector with ID #1 to linear Gamma. Response:

ACK(1)

LED_on

Number of startup sequences of the LEDs

Command Parameter value

LED_on -

Example:

GET(1;LED_on) Return the number of startup sequences of the LEDs of the projector with ID #1 Response:

DATA(1;LED_on;152) The response indicates that the projector is started 152 times


29/04/2014


LED_Timer

Total operating hours of the LEDs

Command Parameter value

LED_Timer -

Example:

GET(1;LED_Timer) Return the total operating hours of the LEDs of the projector with ID #1 Response:

DATA(1;LED_Timer;26243) The response indicates that the projector was operating for 26243 hours.


29/04/2014

Eyevis GmbH www.eyevis.de page 18 of 18 Hundsschleestr. 23 [email protected] 72766 Reutlingen Tel.: +49 7121 433 03- 0 Germany Fax: +49 7121 433 03-22

Additional Support

For additional support for all eyevis products please contact:

eyevis GmbH Hundsschleestr. 23 D-72766 Reutlingen Germany

Phone: +49 (0) 7121 / 43303-290 Fax: +49 (0) 7121 / 43303-22

e-mail: [email protected] www: www.eyevis.de

As at: October 2014 Copyright © 2014 eyevis GmbH. All rights reserved.

This document, as well as the software described in it, is furnished under copyright and may be used or copied only in accordance with the terms of such right. Except as permitted by copyright, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without prior written permission of eyevis GmbH.

The content of this documentation is furnished for information use only, is subject to change without notice, and should not be construed as a commitment by eyevis GmbH. eyevis GmbH resumes no responsibility or liability for any errors or inaccuracies that may appear in this documentation.

eyevis, the eyevis Logo and eyecon are either registered trademarks or trademarks of eyevis GmbH Deutschland. All other trademarks are the property of their respective owners.

mailto:[email protected]

http://www.eyevis.de/

Documents

ESP communication Reference - eyevis - · PDF fileESP communication Reference Technical Note 29/04/2014 Eyevis GmbH Page 2 of 18 Hundsschleestr. 23 [email protected] 72766 Reutlingen