File: cm-xml.html

package info (click to toggle)
anyremote 6.7.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,524 kB
  • sloc: ansic: 16,504; sh: 4,469; python: 111; makefile: 56
file content (223 lines) | stat: -rw-r--r-- 9,895 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>

	<title>anyRemote &middot; Control your computer with your phone</title>

	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
	<meta name="description" content="anyRemote project page - Bluetooth remote control tool" />

	<link rel="stylesheet" href="data/master.css" type="text/css" media="all" title="Default Style" charset="utf-8" />
	<script src="data/effects.js" type="text/javascript" charset="utf-8"></script>

	<link rel="alternate" title="Feed" href="data/feed.xml" type="application/rss+xml" />

	<link rel="icon" href="data/logo-favicon.png" type="image/png" />
	<link rel="shortcut icon" href="data/logo-favicon.png" type="image/png" />

</head>

<body id="docs">

	<a class="skip" name="top">&nbsp;</a>
	<a class="skip" href="#content">Skip to content</a>

	<div id="head">
		<div id="logo">
			<h1><a href="index.html"><img src="data/logo-head.png" alt="logo" /> anyRemote</a></h1>
		</div>
		<div id="navigation"><div class="padding">
			<a href="index.html"><span>About</span></a>
			<a href="frontend.html"><span>Screenshots</span></a>
			<a href="dload.html"><span>Download</span></a>
			<a href="docs.html" class="active"><span>Documentation</span></a>
			<a href="faq.html"><span>FAQ</span></a>
			<a href="contacts.html"><span>Contact</span></a>
			<a href="thanks.html"><span>Special Thanks</span></a>
		</div></div>
	</div>

	<div id="sidebar"><div class="padding">
		<dl class="info">
			<dt>Information</dt>
			<dd>
				<p>Please use the two sidebar boxes below to browse through the anyRemote Documentation!</p>
			</dd>
		</dl>
		<dl class="docs">
			<dt>Documentation</dt>
			<dd>
				<ul>
					<li><a href="pre-setup.html">Before install</a></li>
					<li><a href="pre.html">Software prerequisites</a></li>
					<li><a href="install.html">Compilation and installation</a></li>
					<li><a href="mode.html">Which mode to choose ?</a></li>
					<li><strong>Setup</strong>
						<ul>
							<li><a href="setup-at.html">Setup: AT mode</a>
								<ul>
									<li><a href="event.html">Event reporting</a></li>
									<li><a href="ckpd-emulation.html">Keypad emulation events</a></li>
								</ul>
							</li>
							<li><a href="setup-server.html">Setup: Server mode</a></li>
						</ul>
					</li>
					<li><a href="use.html">How to use anyRemote</a>
						<ul>
							<li><a href="android-client.html">Android Client</a></li>
							<li><a href="use-jc.html">J2ME Client</a></li>
							<li><a href="web.html">Web Interface</a></li>
							<li><a href="cm-xml.html">XML Services Interface</a></li>
							<li><a href="cfg-howto.html">How to create simple configuration file</a></li>
							<li><a href="bemused.html">Bemused Support</a></li>
							<li><a href="iviewer.html">Command Fusion iViewer support</a></li>
						</ul>
					</li>
					<li><a href="devices.html">Tested devices</a></li>
					<li><a href="phones.html">Phone specific details</a></li>
					<li><a href="tips-tricks.html">Tips &amp; tricks</a></li>
					<li><a href="man.html">Man page</a></li>
				</ul>
			</dd>
		</dl>
		<dl class="docs-advanced">
			<dt>Advanced</dt>
			<dd>
				<ul>
					<li><a href="http://elpraga.bshellz.net/HOWTOstartanyRemoteatboottime.html">miniHOWTO: start anyRemote at boot time and create a multimedia computer</a> (externally maintained)</li>
					<li><strong>Format of configuration files</strong>
						<ul>
							<li><strong>Server mode</strong>
								<ul>
									<li><a href="conf-server.html">Configuration file format</a></li>
									<li><a href="conf-server-ex.html">Configuration file examples</a></li>

									<li><a href="set.html">Set(...) / ExecAndSet(...) commands</a></li>
									<li><a href="set-fm.html">Set(filemanager ... ) command</a></li>
									<li><a href="set-icons.html">Set(icons ...) command and available icon set</a></li>
									<li><a href="set-list.html">Set(list ... ) and Set(iconlist ... ) commands</a></li>
									<li><a href="set-menu.html">Set(menu ... ) command</a></li>
									<li><a href="set-parameter.html">Set(parameter, ... ) commands</a></li>
									<li><a href="set-text.html">Set(text ... ) command</a></li>
									<li><a href="set-window.html">Set(image ... ) command</a></li>
								</ul>
							</li>
							<li><strong>AT mode</strong>
								<ul>
									<li><a href="conf-at.html">Configurational file format</a></li>
									<li><a href="conf-at-ex.html">Configurational file examples</a></li>
								</ul>
							</li>
							<li><strong>Common</strong>
								<ul>
									<li><a href="make.html">Make(...) command</a></li>
									<li><a href="emulate.html">Emulate(...) command</a></li>
									<li><a href="dbus.html">Dbus(...) command</a></li>
									<li><a href="vars.html">Variable substitution</a></li>
									<li><a href="ev-handlers.html">Event handlers</a></li>
									<li><a href="icon-themes.html">Icon themes for J2ME client</a></li>
								</ul>
							</li>
						</ul>
					</li>
				        <li><a href="ir.html">anyRemote and InfraRed</a></li>
				</ul>
			</dd>
		</dl>
		<dl class="contact">
			<dt>Contact</dt>
			<dd>
				<p>We will be pleased for any questions, suggestions, patches and examples of configuration files!</p>
				<ul>
					<li>Post in the <a href="http://sourceforge.net/forum/?group_id=162923">Forum</a></li>
					<li>Please, send e-mails to  <a href="mailto:anyremote&#64;mail&#46;ru">anyremote&#64;mail&#46;ru</a></li>
				</ul>
			</dd>
		</dl>
		<!--HOSTINGLOGO-->
	</div></div> <!-- sidebar -->

	<div id="content"><div class="padding">

		<a class="skip" name="content">&nbsp;</a>

		<h1>XML Services Interface</h1>
		
		<p>It is possible to use anyRemote with Cisco (TM) IP Phones through <a href="http://www.cisco.com/en/US/docs/voice_ip_comm/cuipph/all_models/xsi/5_1/english/programming/guide/ipphsv.html">XML Services Interface</a>.</p>
		
		<p><strong>Note: </strong> This page does not describe how to configure Cisco (TM) IP Phones. Please use 
		<a href="http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/admin/3_3_2/ccmcfg/b06phone.html">Cisco offical site</a> 
		or google around <strong>XMLDefault.cnf.xml</strong> string.</p>

                <h2 class="clear">Short How-To</h2>
		
		<p>To run XML services interface you need to do:</p>
		<p> - <strong>Add line</strong></p>
		<pre>&lt;servicesURL&gt;http://192.168.1.1:5197&lt;/servicesURL&gt;</pre>
		<p>to the file <strong>XMLDefault.cnf.xml</strong> or <strong>SEPXXXXXXXXXXXX.cnf.xml</strong> 
		(where <i>XXXXXXXXXXXX</i> is MAC address of the Cicso IP phone and <i>192.168.1.1:5197</i> 
		is IP address and port of the computer with anyRemote).</p>
		<p> - <strong>Reboot the IP phone</strong>.</p>
 
		<p> - <strong>Configure anyRemote</strong>:</p>
		<ul>
                        <li>if <a href="frontend.html">GUI</a> is used: descend to <a href="g-shots.html#prefs">Setup->Preferences</a> 
                        and tick "Manual Configuration" check box, then enter <strong>-s cmxml:5197</strong> in the edit field.
                        </li>
			<li>if command line is used: 
                        <p> - run anyRemote with "-s cmxml:5197 parameter. It needs to use Server-mode configuration files.</p>
                        </li>
		</ul>

		<p>For example:</p>
		<pre>anyremote -f /path/to/some/cfg.file -s cmxml:5197</pre>
		
		<p>Of cource it is possible to change port <strong>5197</strong> to any other.</p>
		
		<h2>Variables used by <a href="cm-xml.html">XML services interface</a></h2>
                
		<h2>$(RefreshPage)</h2>
                <p><i>[only by <a href="web.html">Web</a> and <a href="cm-xml.html">XML services</a> interfaces]</i> 
		This variable to automatically refresh page. Refresh rate should be specified in seconds.  
		Default value is <strong>-1</strong> that means <strong><i>no refresh</i></strong>.</p>
                <pre>(Init)=Make(var,RefreshPage,by_value,5)</pre>

		<h2>$(IpAddr)</h2>
                <p><i>[only by <a href="cm-xml.html">XML services</a> interface]</i> 
		This variable defines IP address of computer with anyRemote, which will be used in XML replyes. 
		Default value determined by command</p>
		<p><strong>/sbin/ifconfig|grep 'inet addr'|cut -f 2 -d ':'|cut -f 1 -d ' '|grep -v 127.0.0.1|head -1</strong></p>
                <pre>(Init)=Make(var,IpAddr,/sbin/ifconfig|grep 'inet addr'|\
	cut -f 2 -d ':'|cut -f 1 -d ' '|grep -v 127.0.0.1|head -1)</pre>

		<h2>Protocol support status </h2>
		<p><a href="cm-xml.html">XML services interface</a> supports only subset of Set()/Get() commands. 
		The following commands are not supported and will be skipped by <a href="cm-xml.html">XML services interface</a></p>
		<pre>Set(status, ...)
Set(filemanager, ...)
Set(fullscreen, ...)
Set(image,icon|cursor|nocursor|remove_all)
Set(parameter, ...)
Set(repaint, ...)
Set(layout,...,keypad_only|joystick_only|ticker|noticker|choose|up|down,_button,...)
Set(vibrate, ...)</pre>

		<h3>Other limitations</h3>
		<p>Command <strong>Set(iconlist, ...)</strong> interpreted as <strong>Set(list, ...)</strong></p>
		<p><strong>Set(list, ...)</strong> command can not contains more than 99 items.</p>
		<p>All string items used in <strong>Set(title, ...)</strong>, <strong>Set(list, ...)</strong> and <strong>Set(menu, ...)</strong> commands are stripped to 32 characters.</p>
		<p>Command <strong>Set(editfield ...)</strong> supports only <strong>Ok</strong> and <strong>Back</strong> menu items.</p>
		<p>Support of national alphabets depends of IP phones firmware.</p>
		

	</div></div> <!-- content -->

	<div id="foot">
		<p>Maintained by <a href="mailto:anyremote&#64;mail&#46;ru">anyRemote</a>. Website by <a href="http://www.martinlettner.info">m.lettner</a>.</p>
	</div>

</body>
</html>