Programming
81
Modero G4 Touch Panels - Configuration & Programming Manual
^RAF, ^RMF - Embedded Codes
The ^RAF and ^RMF commands add and modify any and all resource parameters by sending embedded codes and data:
"'^RAF-<resource name>,<data>'"
"'^RMF-<resource name>,<data>'"
The <data> variable uses the embedded codes described in the following table:
Dynamic Image Commands (Cont.)
^RMF
Modifies any and all resource parameters by sending embedded codes and data.
Since the embedded codes are preceded by a '%' character, any '%' character contained in the URL must be escaped with a
second '%' character (see example).
The file name field (indicated by a
%F
embedded code) may contain special escape sequences as shown in the
Syntax
:
"'^RMF-<resource name>,<data>'"
Variables
:
• resource name = 1 - 50 ASCII characters
• data = Refers to the embedded codes, see the
Example
:
SEND_COMMAND Panel,"'^RMF-Sports_Image,%ALab%%5FTest/Images%Ftest.jpg'"
Changes the resource ’Sports_Image’ file name to ’test.jpg’ and the path to ’Lab_Test/Images’. Note that the
%%5F
in the file
path is actually encoded as
%5F
.
^RSR
Change the refresh rate for a given resource.
Syntax
:
"'^RSR-<resource name>,<refresh rate>'"
Variable
:
resource name = 1 - 50 ASCII characters.
refresh rate = Measured in seconds.
Example
:
SEND_COMMAND Panel,"'^RSR-Sports_Image,5'"
Sets the refresh rate to 5 seconds for the given resource (’Sports_Image’).
^RAF, ^RMF - Embedded Codes
Parameter
Embedded Code
Description
protocol
’%P <0-1>’
Set protocol: either HTTP (0) or FTP (1)
user
’%U <user>’
Set Username for authentication
password
’%S <password>’
Set Password for authentication.
host
’%H <host>’
Set Host Name (fully qualified DNS or IP address).
path
’%A <path>’
Set directory path. The path must be a valid HTTP URL minus the protocol, host, and
filename. The only exception to this is the inclusion of special escape sequences and
in the case of the FTP protocol, regular expressions.
file
’%F <file>’
The file or program that will return the resource. The file must be a valid HTTP URL
minus the protocol, host, and path. The only exception to this is the inclusion of
special escape sequences and in the case of the FTP protocol, regular expressions.
refresh
’%R <refresh 1-65535>’
The number of seconds between refreshes in which the resource is downloaded again.
Refreshing a resource causes the button displaying that resource to refresh also. The
default value is 0, which means to only download the resource once for each time it
comes into view (or if preserve is set, only once period).
Note: For Motion JPEGs, the Refresh interval should always be 0.
newest
’%N <0-1>’
Set the newest file. A value of 1 means that only the most recent file matching the
pattern is downloaded.
Note: The 'newest file' option only applies to FTP Dynamic Images, and only those that
have pattern matching as part of their filename. Neither 'newest file' nor pattern
matching apply to HTTP Dynamic Images. When set, the panel will first pull a list of files
matching the given pattern from the specified FTP server and path. The timestamps of
the items in the list will be compared, with the newest one being displayed on the panel.
This is useful for source devices that place a uniquely named still image in a folder at
constant intervals, allowing the panel always to display the most recent one.
preserve
’%V <0-1>’
Set the value of the preserve flag. A value of 0 (the default) means the resource should
be reloaded each time it comes into view.
A value of 1 means the resource should be preserved in cache after the first time it is
loaded, and not reloaded each time it comes into view.
This value is ignored if the Refresh interval is greater than 0.