Skip to content

# anyRemote

# Configuration file format: Server mode

## Configuration file examples

You may find some predefined configuration files in cfg-data/Server-mode and cfg-data/Bemused-emulation directories. After investigation of these configuration files You became more familiar with its format.

## Format

Line starting with a % considered as a comment line.

    %This is a comment

Long command can be splitted into the several lines. You have to put backslash (\) as the last character to continue a command to the next line.

    1=Exec(echo "this is first line");\
    Exec(echo "this is second line");

## Parameters section

GuiAppName="application name"

GuiAppBinary="name of executable"|"command which returns name of executable"

GuiAppRun="command do determine is application running or not; must returns OK or NOK"

GuiAppIcon="icon name"

GuiAppType=Application|Custom|Example

GuiAppModes=Server|AT|Bemused

GuiAppDesc=Some text

These parameters is used by GUI frontends only.

    GuiAppName=Amarok
    GuiAppBinary=amarok
    GuiAppRun=echo 'A=`dcop | grep amarok`; if [ "x$A" == "x" ]; \
       then echo NOK; else echo OK; fi'|bash -f -s
    GuiAppIcon=amarok.png
    GuiAppType=Application
    GuiAppModes=Server
    GuiAppDesc=Application decription

    [Protocol]=Server
    One=Exec(echo "Hello world!");
    ...

## [Protocol] section

A short example:

    [Protocol]=Server
    (Init)=Exec(kdialog --msgbox "Initialized");
    (InCall)=Exec(kdialog --msgbox "A call from $(CallId)");\
             Make(remote,off);
    (EndCall)=Make(remote,on);Exec(kdialog --msgbox CALL_END)
    (Connect)=Exec(kdialog --msgbox "Connected")
    (Disconnect)=Exec(kdialog --msgbox "Disconnected")
    1=Exec(kdialog --msgbox 1)
    2=Exec(kdialog --msgbox 2)
    3=Exec(kdialog --msgbox 3)
    4=Exec(kdialog --msgbox 4)
    5=Exec(kdialog --msgbox 5)
    [End]

### Format:

Key_Codes=Command1;Command2;Command3;....

Where CommandX could be:

- Exec(...);
- Emulate(...);
- Exit;
- Macro(...);
- Make(...);
- Set(...);
- ExecAndSet(...);
- Timer(...);
- Load(...);
- Include(...);
- Send(...);
- ExecAndSend(...);
- Get(...);
- End();

### Exec() command

    1=Exec(kdialog --msgbox 1)
    2=Exec(kdialog --msgbox 2)

It is possible to define multi-key commands

    3 1=Exec(kdialog --msgbox 3_1)
    3 2=Exec(kdialog --msgbox 3_2)
    3 3 1=Exec(kdialog --msgbox 3_3_1)

It is not good idea to define:

    3 3=Exec(kdialog --msgbox 3_3)
    3 3 1=Exec(kdialog --msgbox 3_3_1)

simultaneously, since only one command will works (which one - depends on search order).

It is possible to group keymappings in so-called "mode" to set more than one command to the key:

    1=Exec(kdialog --msgbox 1)
    2=Exec(kdialog --msgbox 2)
    [Mode]=1
    1=Exec(kdialog --msgbox 1_in_Mode_1)
    2=Exec(kdialog --msgbox 2_in_Mode_1)
    [ModeEnd]
    [Mode]=2
    1=Exec(kdialog --msgbox 1_in_Mode_2)
    2=Exec(kdialog --msgbox 2_in_Mode_2)
    [ModeEnd]

If current mode is not default mode (see Make(mode ...); command), then firstly key will be searched in current mode and if not found then it will be searched in default mode. As a result it needs to use (EnterMode) and (ExitMode) "events" very carefully in default mode.

It is possible to write quite complex commands inside Exec(), for example:

    1=Exec(echo 'D=`dcop | grep digikam`;\
           if [ "x$D" == "x" ]; then digikam \
           else dcop $D MainApplication-Interface quit;' | bash -f -s)

### Macro() command

This command used to create new keymapping:

    1=Macro(Macro1)
    Macro1=Exec(kdialog --msgbox 1);Exec(kdialog --msgbox 2)

Macro() command can contains condition:

    0=Make(var,macro_test,echo "0");
    1=Macro(Macro1,by_value,$(macro_test));
    2=Macro(Macro2, if [ -f /tmp/file_name ];\
                    then true; else false; fi; echo $?)
    Macro2=Exec(kdialog --msgbox "Condition is OK")

Conditional Macro() will be execute only if a result of variable substitution or execution of the command is equal to string "0".

Note: In shells result code of command execution stored in $? environment variable.

### Set() command

These commands used to control and customize GUI of Java client. See detailed description here.

It is possible to change:

- caption of screen
- title and status fields
- arrange icons from predefined icon set,
- change background and foreground color,
- change font size
- change icon layouts (skins)
- use internal vibrator of the phone
- set fullscreen mode
- set debug mode
- show text on the screen of cell phone
- show list on the screen of cell phone
- add custom menus

### ExecAndSet() command

Format: ExecAndSet(tag,command)

This command similar to the Set(), but uses the output of command specified as a string to set GUI elements of Java client specified in tag field. See detailed description here.

    5=ExecAndSet(title,dcop amarok player nowPlaying);
    6=ExecAndSet(status,date)

### Timer()

Format:

Timer(key, timeout, maxTimes) or

Timer(key, cancel|pause|continue|reset|restart)

This command sets/removes a timer for the key specified. A command sequence, associated with this key will be executed periodically.

For example, the following commands run 'dcop amarok player nowPlaying' command 2 times with timeout equal to 5 sec and set result to the title field of Java client:

    1=Timer(TimerCmd, 5, 2)
    TimerCmd=ExecAndSet(title, dcop amarok player nowPlaying)

The following command run 'date' command every 10 sec and set result to the status field of Java client:

    2=Timer(Timer2, 10, 0)
    Timer2=ExecAndSet(status, date)

It is impossible to have two active timer commands with the same key.

To delete existing timer use the following command:

    3=Timer(TimerName,cancel)

To reset timer use the following command:

    4=Timer(TimerName,reset)

To completely restart timer use the following command:

    5=Timer(TimerName,restart)

This command resets timer and resets counter of timer's executions

Also, see note about data caching.

### Load() command

This command used to load commands from file and execute them:

    1=Load(file_name.cmds)

### Include() command

This command used to include definitions from external configuration file:

    1=Include(xmms.cfg)

Definitions from included file will not rewrite any of existing definitions.

### Send() command

Format:

Send(string, string_value) or

Send(byte, byte_value1, byte_value2,...)

Sends to the Java client specified string or sequence of bytes. This command is used in Bemused server emulation.

    1=Send(string, simple_string)

byte_valueX is string representation of 1 - 255 values. Send(byte, ...) command sends to the Java client specified bytes of data, one by one. Mainly this command is used to Bemused server emulation.

    2=Send(bytes,35,42,0)

### ExecAndSend() command

Format:

ExecAndSend(tag,command)

This command similar to the Send(tag, ...), but uses the output of command specified as a string to send. So, it is possible to execute dynamically created command. This command is used in Bemused server emulation.

    3=ExecAndSend(string,date)
    4=Exec(echo "Set(title,dynamic title)">/tmp/command.txt);\
      ExecAndSend(string,cat /tmp/command.txt)

### Get() command

Format:

Get(screeen_size|cover_size|model|version|cursor|password|ping) or

Get(is_exists,16|32|64,_icon_name_)

This command used to retrieve from phone some information.

    3=Get(screeen_size)
    4=Get(model)
    5=Get(is_exists,16,next)
    6=Get(cover_size)
    7=Get(version)
    8=Get(cursor)
    9=Get(ping)
    0=Get(password)

Get(screeen_size) used to get screen size of cell phone. As a response to this command two replies will be send: SizeX(width,) and SizeY(height,). SizeX(width,) reply will be the first one.

Get(model) used to get "microedition.platform" property of Java client. For many phones this property contains manufacturer and model number (like "SonyEricssonK750i/R1CA021" for SE-K750). As a response to this command Model(,_string_) reply will be sent.

Get(is_exists,...) used to determine was icon with given name and size uploaded to phone or not. As a response to this command IconExists(_icon_name_,) or IconNotExists(_icon_name_,) reply will be send.

Get(cover_size) used to determine maximalsize of cover image which can be shown by Set(cover, ...) command. As a response to this command one reply will be send: CoverSize(_size_,)

Get(version) used to retrieve java client version. As a response to this command Version(,_version_) reply will be sent.

Get(cursor) user to determine cursor position on Image screen of java client. Two replies PosX(x_coord,) and PosY(y_coord,) will be sent. PosX() event will be first one. If current screen of java client is not Image screen then no replies will be sent.

Get(ping) user to send "keepalive" messages to java client. As a response to this command Ping reply will be sent.

Get(password) user to ask password from java client. As a response to this command _PASSWORD_(,_password_) reply will be sent. This reply handled by anyRemote internally, so generally users should not worry about it.

Password should be stored in $HOME/.anyRemote/password file in a plain text.

### End() command

Format:

End()

This command used only if -http command line option is used. This commmand used internally and should not be used in configuration files. The purpose of the command is to inform anyremote2html about fact what command sequence is finished.

### Make() command

Format:

Make(flush|disconnect|mode|remote|var|alarm[,....])

This command used control local state of anyRemote.

    0=Make(flush)
    1=Make(mode,mode_2)
    2=Make(remote,on)
    3=Make(var,my_var,date)

See detailed description here.

### Event handlers

There are several "events" could be triggered. See Event handlers page for details.

### Variable substitution

In Exec(), Make(var,...), Load(), Include() commands is it possible to use internal "variables". See Variable substitution page for details.

Maintained by anyRemote. Website by m.lettner.