System commands #X
Settings of the EA HMI-Series.
Module commands
Set project path (System Projectpath Set) |
<Path> |
|
Send project path (System Projectpath Get) |
||
Backlight: set brightness (System Configure backlight Brightness) |
Brightness, Time (no change), Flash(0) |
|
Backlight: set gradation and frequency (System Configure backlight Frequency) |
Power, Frequency (no change), Flash(0) |
|
Backlight: state auto-dimming (System led AutoState) |
State |
|
Backlight: set auto-dimming (System led Autostate mask) |
Mask, Time1(60), Brightness1(50), Time2(60), Brightness2(10) |
|
Send ASCII-String (System Send Ascii) |
"String" |
|
Send Unicode-String (System Send Unicode) |
"String" |
|
ASCII command to receive buffer (System receive buffer ascii) |
Command |
|
Unicode command to receive buffer (System receive buffer unicode) |
Command |
|
Send hardcopy (System Hardcopy Send) |
Format(1), x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
|
Save hardcopy in file (System Hardcopy File) |
<Name>, Format(1), x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
|
Display hardcopy as image object (System Hardcopy to Object) |
Obj-ID, x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
|
Display hardcopy with background as image object (System Hardcopy to object with Background) |
Obj-ID, x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
|
Display object as new image object (System Hardcopy Id to object) |
Obj-ID, Obj-ID Source |
|
Perform touch adjustment (System Touchabgleich) |
||
Set display orientation (System Configure Orientation) |
Orientation |
|
Send firmware version (System Info Version) |
||
Send module parameters (System Info Display) |
||
Send SD-Card memory overview (System Info Storage) |
||
Send RAM memory overview (System Info RAM) |
||
Set Display-Refresh-Rate (System Configure display Update) |
Option, Flash(0) |
|
Wait command (System Wait hs) |
Time |
|
Set blink time (System Blink Time) |
Time |
|
Reboot (System Firmaware reset) |
Option(0) |
Module commands
#XPS |
<Path> |
The command defines the project path. The module automatically searches for file names under this path, e.g. Macros. Paths are then specified with <P: ...>.
#XPG |
|
The command places the current project path in the send buffer. The feedback is structured as follows:
ESC |
X |
P |
G |
Path |
... |
|
$1B |
$58 |
$50 |
$47 |
'String' completed with $00 |
#XCB |
Brightness, Time (no change), Flash(0) |
The command specifies the Brightness of the backlight [0 ... 150] in %. The parameter Time (in 1/100 s) indicates how quickly the brightness is reached. In the delivery state, the brightness is 100% and changes within 1 second (time = 100). If the brightness exceeds 100%, a derating of the life-time must be expected - we recommend using this setting only for a short time, e.g. in direct sunlight. The Flash parameter determines whether the setting should be saved:
Flash |
|
0 |
Do not save settings |
1 |
Save settings |
Backlight: Set gradation and frequency
#XCF |
Power, Frequency (no change), Flash(0) |
The brightness levels of the backlight are determined using a power function. Depending on the area of application, it makes sense to have more levels in the low range (night vision). For this, the parameter Power must be increased. The default value is 10. The PWM Frequency [5000 ... 65535] of the backlight can also be changed if there are indifferences with ambient light. Default: frequency = 5000. The Flash parameter determines whether the setting should be saved:
Flash |
|
0 |
Do not save settings |
1 |
Save settings |
#XAS |
State |
The command sets the State of the automatic backlight dimming. Default dimming is deactivated:
State |
|
0 |
Off: no dimming |
1 |
On: Auto dimming active |
2 |
Manual retrigger |
#XAL |
Mask, Time1(60), Brightness1(50), Time2(120), Brightness2(10) |
If automatic dimming is activated (see #XAS), the command uses the Mask parameter to set which events retrigger the countdown:
Mask |
|
$01 |
Touch |
$02 |
USB |
$04 |
RS232 |
$08 |
SPI |
$10 |
I²C |
$20 |
Master RS232 |
The mask bits can be set simultaneously with bit decoding. TimeX specifies in seconds when the new brightness (BrightnessX) should be set. The new brightness value is specified relative to the current brightness (0..100).
Send ASCII-String (proprietary interface Short/Small Protocol only)
#XSA |
"String" |
The command places a string or individual codes as ASCII values (8 bits per character) in the send buffer.
Send Unicode-String (proprietary interface Short/Small Protocol only)
#XSU |
"String" |
The command places a string or individual codes as Unicode values (16 bits per character) in the send buffer.
The command places a command including all paramters in the receive buffer. This command is useful in serial master receive macros. This allows data to be copied to the receive buffer of the display.
...
#HRB 0 /**read all received data from RS232 master interface to string register 0
#XRA S0 /**place content of string register S0 into displays receive buffer
...
Send Hardcopy (proprietary interface Short/Small Protocol only)
#XHS |
Format(1), x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
The command takes a screenshot of the position (x, y, Anchor) and places it in the send buffer. Depending on the format in which the picture was requested, a header and the data are returned.
Format |
|
1 |
BMP 24-Bit |
2 |
BMP 16-Bit |
3 |
BMP 8-Bit greyscale |
11 |
epg 32-Bit |
12 |
epg 16-Bit |
13 |
epg 8-Bit greyscale |
21 |
epg 32-Bit compressed |
22 |
epg 16-Bit compressed |
23 |
epg 8-Bit greyscale compressed |
The feedback is structured as follows:
ESC |
X |
H |
S |
Header |
Data |
... |
|
$1B |
$58 |
$48 |
$53 |
... |
... |
#XHF |
<Name>, Format(1), x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
The command takes a screenshot of the position (x, y, Anchor) and writes it to a file (<Name>).
Format |
|
1 |
BMP 24-Bit |
2 |
BMP 16-Bit |
3 |
BMP 8-Bit greyscale |
11 |
epg 32-Bit |
12 |
epg 16-Bit |
13 |
epg 8-Bit greyscale |
21 |
epg 32-Bit compressed |
22 |
epg 16-Bit compressed |
23 |
epg 8-Bit greyscale compressed |
Display hardcopy as image object
#XHO |
Obj-ID, x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
The command creates a screenshot of the position (x, y, Anchor) with the size (Width, Height) and displays it as a new image object with the Obj-ID. The background is transparent and not copied from the source.
Display hardcopy with background as image object
#XHB |
Obj-ID, x(0), y(0), Anchor(7), Width(Display width), Height(Display height) |
The command creates a screenshot of the position (x, y, Anchor) with the size (Width, Height) and displays it as a new image object with the Obj-ID. The background is copied from the source.
Display object as new image object
#XHI |
Obj-ID, Obj-ID Source |
The command creates a new image object with the Obj-ID from the source object (Obj-ID Source) and displays it.
#XXT |
|
The command starts the touch adjustment procedure. Applies only to modules with resistive touch panels.
#XCO |
Orientation |
The command defines the orientation (0, 90, 180, 270) of the display. The default is 0° Landscape.
Send firmware version (proprietary interface Short/Small Protocol only)
#XIV |
type (0) |
The command places the firmware version and the detected touch panel in the send buffer. Type selects the display (=0) or interface (=1) version. The feedback is structured as follows:
ESC |
X |
I |
V |
Version string |
... |
|
$1B |
$58 |
$49 |
$56 |
'String' completed with $00 |
See also version()
Send module parameters (proprietary interface Short/Small Protocol only)
#XID |
|
The command puts module parameters (including resolution and interface settings) in the send buffer. The feedback is structured as follows:
ESC |
X |
I |
D |
Width |
Height |
Color depth |
Touch |
VideoWidth |
VideoHeight |
... |
|
$1B |
$58 |
$49 |
$44 |
16-Bit value |
16-Bit value |
8-Bit value |
8-Bit value |
16-Bit value |
16-Bit value |
Touch |
|
$00 |
No touch |
$03 |
Resistive touch |
$07 |
capacitive touch |
$0F |
Simulator |
See also scrW(), scrH(), touchT(), vidW(), vidH()
Send Flash memory overview (proprietary interface Short/Small Protocol only)
#XIS |
|
The command places the size and free space of the flash in the send buffer. The feedback is structured as follows:
ESC |
X |
I |
S |
Total |
Free |
... |
|
$1B |
$58 |
$49 |
$53 |
32-Bit value |
32-Bit value |
Send RAM memory overview (proprietary interface Short/Small Protocol only)
#XIR |
|
The command places the size and free space of the object RAM in the send buffer. The feedback is structured as follows:
ESC |
X |
I |
R |
Total |
Free |
... |
|
$1B |
$58 |
$49 |
$52 |
32-Bit value |
32-Bit value |
#XCU |
Option, Flash(0) |
The command sets the display refresh rate. The parameter Option is set to 3 by default.
Option |
|
0 |
No display update |
1 |
One-time display update |
2..1000 |
Cyclical display update (time in 1 / 100s) |
The Flash parameter determines whether the setting should be saved:
Flash |
|
0 |
Do not save settings |
1 |
Save settings |
#XXW |
Time |
The command interrupts the execution of commands for the set Time (in 1/100s). We recommend this command for debugging purposes during development only.
#XBT |
Time |
The command can be used to set the blinking time (in 1/100s) of objects.
#XFB |
Option(0) |
The module can be restarted with the command:
Option |
|
0 |
Normal reset |
1 |
Testmode |
2 |
Disable PowerOnMakro |
3 |
Disable Default |
4 |
Boot menu |
5 |
Reserved |
6 |
Reserved |