Since version 2.0 format of configurational file was changed. Description of format of configurational file for versions 1.X could be found here.
You may find some predefined configuration files in cfg-examples/Server-style directory:
You may find some predefined configuration files for Bemused emulation in cfg-examples/Bemused-emulation directory:
All examples have on-screen help binded to "* *" (press "*" two times).
I hope after investigation of these configuration files You'll become more familiar with its format. Description of that format could be found in file cfg-examples/conf-file-explanation.cfg
Description of configurational file format (Server-style):
AutoRepeat=false
Auto repeat feature (as on PC keyboard - about 10 events per second). Usefull for mouse emulation, for example. Default value is false.
Baudrate=19200
Baudrate to use; default value is 19200
Device=bluetooth:10
Device to connect; default value is /dev/rfcomm0.
If kAnyRemote works as server correct value for Device could be: Device=socket:"port" or Device=bluetooth:"channel"or just Device=bluetooth (to choose first available channel).
Log=true
Print or not to print logging info to the file /tmp/kanyremote.log, default value is false.
Debug=true
Print or not to print verbose logging info to the file /tmp/kanyremote.log, default value is true.Works only if Log=true.
Screen=true
Send or don't send any commands (SetStatus(), SetTitle(), etc.) to phone. Default value is false.
[Aliases] section
Format:
Key_Code=New_alias
1=One 49=Oneand then use "One" in [Keys] section instead of "1" or "49"
[Keys] section
A short example:
[Keys] (Init)=Exec(kdialog --msgbox "Initialized"); (Connect)=Exec(kdialog --msgbox "Connected on $(Time)") (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() 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]
It is possible to write rather 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)
Set() command
This command used to control GUI of Java client. It is possible to change: caption of screen, title and status fields, arrange icons from predefined icon set and to show some text on the screen of cell phone. | ![]() |
![]() |
Thare are several ways to use this command:
Set(icons, ...)
Format: SetI(icons,caption,1,name1,2,name2...,*,name11,#,name12)
where nameX specifies desired action. This command sets the caption of Java client window and reports to Java client to dynamically change shown icons.
1=Exec(xmmsctrl play);Set(icons,XmmsPlaying,5,stop,1,kill);
if You do not want to change the caption of Java client window then it is possible to write:
2=Exec(xmmsctrl play);Set(icons, SAME,5,stop,1,kill);
Set(title, ...)
Format: Set(title, new_title)
This command set the title field of Java client
3=Exec(xmms);Set(title,XMMS);
Set(status, ...)
Format: Set(status, new_status) This command set the status field of Java client
4=Exec(xmmsctrl play);Set(status, Playing)
Set(text, ...)
Format: Set(help, title, _long_text_) This command shows help test on the screenof cell phone.
#=Exec(xmmsctrl quit);Set(text, Help, To run Xmms press 1)
It is possible to add line break characters to the text. It could be done with "\n". The length of the text which can transferred to phone limited by Java realization in the phone. Anyway 1/2 Kbyte should be handled properly.
ExecAndSet()Format: ExecAndSet(tag,command)
This command similar to the Set(), but uses the output of command specified as a string to set GUI element of Java client specified in tag field..
5=ExecAndSet(title,dcop amarok player nowPlaying); 6=ExecAndSet(status,date)Timer()
Format: Timer(timerId, timeout, maxTimes, tag, command)
This command similar to the ExecAndSet(), but it will be executed peridicallly by timer.
For example, the following command run 'dcop amarok player nowPlaying' command 2 times with timeout equal to 5 sec and set result to the title field of Java client:
7=Timer(id1, 5, 2, title, dcop amarok player nowPlaying)
The following command run 'date' command every 10 sec and set result to the status field of Java client:
8=Timer(id2, 10, 0, status, date)
It is impossible to have two active timer commands with the same timerId. If results of the executed command is the same as previous one, then results will not be sent to Java client.
CancelTimerCmd()Format: CancelTimetCmd(timerId)
This command deletes timer previously created by Timer() command by specified timerId.
9=CancelTimetCmd(id1)
The following commands used mainly in Bemused-emulation:
Send()
Format: Send(string, string_value)
or Send(byte, byte_value1, byte_value2,...)
Send to the Java client specified string or sequence of bytes. This command is used mainly 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=SendBytes(35, 42, 0)
ExecAndSend()
Format: ExecAndSend(tag,command)
This command similar to the Send(tag, ...), but uses the output of command specified as a string to send. This command is used mainly in Bemused server emulation.
3=ExecAndSend(string,date)
There are several "internal" commands:
TempDisconnect used to temporary (1 minute) disconnecting from phone:
1=TempDisconnect;
Exit command used to exit from application:
2=Exit;
Switch off "remote control" functionality without disconnecting:
3=RemoteOff;
Switch on "remote control" functionality:
4=RemoteOn;
Change mode:
5=SetMode(xmms)
There are several "events" could be triggered:
(Init) event will be fired when anyRemote is initialized:
(Init)=Exec(kdialog --msgbox "Initialized")
(Connect) event will be fired when connection established:
(Connect)=Exec(kdialog --msgbox "Connected on $(Time)")
(Disconnect) event will be fired when connection is lost:
(Disconnect)=Exec(kdialog --msgbox Disconnected)
If mode is changed by SetMode() then (ExitMode) event for current mode and (EnterMode) event for the new mode will be fired:
*=SetMode(XMMS) (ExitMode)=Exec(kdialog --msgbox "Exiting from current mode") [Mode]=XMMS % Do some initialization steps (EnterMode)=Exec(kdialog --msgbox "Enter to XMMS mode");Exec(xmms) % Do some cleanup steps (ExitMode)=Exec(kdialog --msgbox "Exiting from XMMS mode");Exec(killall xmms)
Auto-lock example:
(Connect)=Exec(killall kdesktop_lock) (Disconnect)=Exec(kdesktop_lock --forcelock)
Variable substitution:
Current time will be substituted instead of $(Time):
2=Exec(kdialog --msgbox $(Time))
Current mode be substituted instead of $(Mode):
3=SetMode(xmms);Exec(kdialog --msgbox "New mode is $(Mode)")
[Alarms] section
Format:
Alarm_file=command1;command2;...
When file Alarm_file will be created, then command1, command2 ... will be executed.
/tmp/alarm1=SetStatus("xmms was stopped")