Professional Documents
Culture Documents
MOTOTRBO Application Development Kit Overview
MOTOTRBO Application Development Kit Overview
MOTOTRBO Application Development Kit Overview
Version 01.02
4/15/2008
COPYRIGHTS
Motorola disclaims any liability for any use of the specification. Motorola limits all
warranties to the extent allowed by law. Furthermore, Motorola reserves the right to
change this specification at any time without any prior notification, and there is no
guarantee that such changes will be backwards compatible with previous versions of the
specification.
Version 01.02
4/15/2008
MOTOTRBO
Application Development Kit
Overview
TABLE OF CONTENTS
Section 1 .................................................................................................................... 4
1.0 What is MOTOTRBO?................................................................................... 4
Section 2.................................................................................................................... 6
2.0 Extending the MOTOTRBO Product ............................................................. 6
2.1 MOTOTRBOOption Board ADK............................................................. 6
2.2 MOTOTRBOXCMP-Based IP Capable Peripheral ADK ........................ 8
2.3 MOTOTRBO Non- IP Capable Peripheral ADK ..................................... 9
2.4 MOTOTRBOTelemetry ADK................................................................ 11
2.5 MOTOTRBOLocation Data ADK.......................................................... 13
2.6 MOTOTRBOText Messaging ADK ...................................................... 14
2.7 MOTOTRBOAutomatic Registration Service (ARS) ADK .................... 16
2.8 Presence Notifier..................................................................................... 17
2.9 Data Services .......................................................................................... 18
Section 3.................................................................................................................. 20
3.0 Professional Radio Application Developer Program ....................................... 20
Section 4.................................................................................................................. 22
4.0 Service & Support for Application Development ............................................. 22
Section 5.................................................................................................................. 23
5.0 Further Information and Contact ..................................................................... 23
Section 6.................................................................................................................. 24
6.0 Appendix: ADK Document Map ...................................................................... 24
Version 01.02
MOTOTRBO
Application Development Kit
Overview
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Section 1
1.0
What is MOTOTRBO?
Version 01.02
MOTOTRBO
Application Development Kit
Overview
18
19
Version 01.02
MOTOTRBO
Application Development Kit
Overview
20
Section 2
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
2.0
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
Aside from the functionality embedded in the radio, the MOTOTRBO subscribers
capabilities can be extended through defined application programming interfaces for 3rd
party developer use. The MOTOTRBO Application Development Kits (ADKs) offer an
opportunity to customize a solution specifically to a customers need.
The MOTOTRBO ADKs are comprised of protocol specifications and development
guidelines that are intended as technical references for the external vendor. These
ADKs not only include software specifications, but also include electrical and
mechanical specifications, where applicable. Each interfaces set of technical
references also detail the specific domain knowledge required to successfully
implement a 3rd party application for the MOTOTRBO product.
These are the primary ADKs for developer use:
Please refer to the individual ADK sections for more information on the interface. Refer
also to the Appendix: ADK Document Map for more information on document
components for each ADK.
Version 01.02
MOTOTRBO
Application Development Kit
Overview
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
option board can activate or de-activate specific functionality, such as scan, the
menu system, or an over-the-air data session, to execute the behavior of a new
feature.
The option board interface uses a Synchronous Serial Interface (SSI) to transport
the XCMP control and data messages within XCMP Network Layer (XNL)
packets to and from the radio and its available services. The SSI is comprised of
four logic lines: clock, sync, data in, and data out. The option board uses the SSI
to transport logical and audio data to and from the radio. There are no dedicated
analog audio lines on the option board interface. Whether the MOTOTRBO
radio is operating in analog or digital mode, all audio is encoded into digital
format and transported on the SSI bus.
The SSI bus is a multi-slotted Time Division Multiplexed (TDM) communication
channel that is shared with other chips and devices contained within or attached
to the Radio Host.
MOTOTRBO
Application Development Kit
Overview
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
For more information about the MOTOTRBO Option Board interface, please
see the following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.02
MOTOTRBO
Application Development Kit
Overview
139
140
141
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Radio Network
CAI
MOTOTRBO
Radio
TM
XCMP
XNL
TCP
IP
RNDIS
USB
USB
XCMP
XNL
TCP
IP
NDIS
USB
Mic Audio
Speaker Audio
IP Capable
Device
Application
Accessory Connector
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
Version 01.02
MOTOTRBO
Application Development Kit
Overview
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
The CDC/ACM class driver is used as the USB device stack to communicate with
the Non-IP Capable Peripheral USB system driver.
XCMP/XNL is used as the application communication protocol between the NonIP Capable Peripheral and the MOTOTRBO radio. The Non-IP Capable
Peripheral is considered a non-master device within the XCMP/XNL architecture.
The XCMP/XNL protocol provides a set of commands for an external device to
control and manage the MOTOTRBO radios.
The USB and XNL connections are independent of the analog/digital RF modes
of operation. The Non-IP Capable peripheral does not need to re-establish the
USB or XNL connections after mode change.
As an example, Figure 4 illustrates the interface architecture for the
MOTOTRBO Non-IP capable peripheral.
Application
Application
XCMP
XCMP
XNL (Slave)
XNL (Master)
CDC ACM
CDC ACM
USB Host
USB Device
USB Cable
MOTOTRBO Radio
For more information about the Non-IP capable peripheral and also its operation
with other applications offered by the MOTOTRBO radio, please see the
following references:
Version 01.02
10
MOTOTRBO
Application Development Kit
Overview
191
192
193
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
Version 01.02
11
MOTOTRBO
Application Development Kit
Overview
TP
UDP
IP
RNDIS
USB
Telemetry
Services
Application
MOTOTRBOTM
Radio
PC Environment
TP
UDP
IP
CAI
Radio Network
TP
UDP
IP
CAI
GPIO
MOTOTRBOTM
Radio
213
214
215
216
217
218
219
220
221
222
223
224
225
GPIO
Version 01.02
12
MOTOTRBO
Application Development Kit
Overview
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
PC Environment
LBS
Application
Radio Network
LRRP
UDP
IP
CAI
LRRP
UDP
IP
RNDIS
USB
LRRP
UDP
IP
CAI
MOTOTRBOTM
Radio
LRRP
GPS
Component
MOTOTRBOTM
Radio
244
245
Version 01.02
13
MOTOTRBO
Application Development Kit
Overview
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
Messages for requests and responses for location data are handled through the
Location Request and Response Protocol (LRRP). LRRP is a location data
reporting protocol that is optimized for use within the MOTOTRBO Radio
Network. LRRP control and data messages are sent via the Radio Network within
UDP/IP packets that are transported over the Common Air Interface (CAI). The
LRRP messages are processed directly by the embedded GPS components
inside the MOTOTRBO radio as well as within the LBS PC application. The
Location Data interface can also interoperate with the MOTOTRBO Option
Board interface to route location data directly to a custom option board device.
273
274
275
276
277
278
279
280
281
282
283
284
285
The Location Data interface facilitates asset tracking via location-based services.
For example, a LBS application can provide an Automated Vehicle Location
(AVL) capability to track the position of delivery trucks in the coverage area of the
MOTOTRBO system.
For more information about the MOTOTRBO Location Data interface, please
see the following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.02
14
MOTOTRBO
Application Development Kit
Overview
PC Environment
TMS
Application
Radio Network
TMP
UDP
IP
CAI
TMP
UDP
IP
RNDIS
USB
UDP
IP
CAI
TMP
TMP
TMS
Component
MOTOTRBOTM
Radio
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
TMS
Component
MOTOTRBOTM
Radio
Text messages are routed within the Radio Network as UDP/IP packets
transported over the MOTOTRBO Common Air Interface (CAI). The
destination of text messages is determined by the target IP address and port
number. This enables the routing of text messages to two logically different
devices that are physically connected together (e.g. PC attached to
MOTOTRBO radio via USB). In addition, the Text Message interface
interoperates with the MOTOTRBO Option Board interface to route text
messages directly to the option board for processing.
The Text Messaging Services interface provides alternate methods for sending
and receiving text messages within the MOTOTRBO system. A model
implementation of this interface would be a PC-based dispatch messaging
center. The messaging center contains a user interface for typing text messages
to be sent to an individual radio or a group of radios as well as an output screen
for displaying received messages.
Version 01.02
15
MOTOTRBO
Application Development Kit
Overview
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
336
337
338
Version 01.02
16
MOTOTRBO
Application Development Kit
Overview
339
340
341
342
343
344
345
346
347
348
349
350
For more information on the application of the ARS interface and its protocol,
please see the following references:
351
352
353
354
355
356
357
358
359
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Backend
Application
TM
MOTOTRBO
Radio
Automatic
Registration
Service
UDP
IP
CAI
Radio Network
Notification
UDP
IP
Subscription
Presence
Notifier
UDP
IP
360
361
362
363
364
365
366
367
368
369
370
Version 01.02
17
MOTOTRBO
Application Development Kit
Overview
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
The Presence Notifier tracks the state of each MOTOTRBO radio on the Radio
Network and reports each radios state to each Backend Application. Each
backend application must subscribe with the Presence Notifier in order to receive
notifications of each MOTOTRBO radio of interest. Information between each
Backend Application and the Presence Notifier is exchanged as UDP/IP packets.
387
388
389
390
391
392
393
394
395
For more information about the Presence Notifier, please see the following
references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Aside from the data application capability of the MOTOTRBO product for
telemetry, location, and text messaging, the MOTOTRBO radios can also be
used as a generic UDP/IP pipe for the transport of data between multiple IPcapable devices. These devices, such as laptop or desktop PCs, must be
attached to subscriber units operating within the Radio Network. The Data
Services capability is available while the MOTOTRBO product is operating in
digital mode only.
Version 01.02
18
MOTOTRBO
Application Development Kit
Overview
UDP/IP
over USB
MOTOTRBO
Mobile
Radio Network
MOTOTRBO
Mobile
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
UDP/IP
over USB
The attached PCs are mapped to an IP space that is separate from the
MOTOTRBO radio IP address range. Therefore, data intended to the attached
IP-capable device or the MOTOTRBO radio can be routed to the appropriate
endpoint.
For more information about the Data Services capability, please see the following
reference:
For more information about the other interfaces, please refer to the appropriate
sections contained in this overview.
Version 01.02
19
MOTOTRBO
Application Development Kit
Overview
411
Section 3
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
3.0
Registered User
Licensed Developer
Application Partner / Application Provider
Version 01.02
20
MOTOTRBO
Application Development Kit
Overview
431
432
433
434
435
436
437
438
439
440
441
442
Version 01.02
21
MOTOTRBO
Application Development Kit
Overview
443
Section 4
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
4.0
The MOTOTRBO Application Development Kits (ADKs) are only one component of
the service and support for 3rd party developers. The Professional Radio Application
Developer Program for MOTOTRBO is staffed with full-time engineers whose primary
responsibility is to support 3rd party application developers world-wide. Application
developers have direct access to Motorola resources to assist in the development and
certification of the 3rd party application.
This service and support includes, but is not limited to, the following items:
Technical training on the use and capability of the developer interfaces on the
MOTOTRBO radio
Application notes and FAQs on relevant MOTOTRBO development topics
Technical consultation service during the design and development phases of the
3rd party product
Access to a MOTOTRBO system test environment with subscribers and
infrastructure for 3rd party product verification (where supported by the local
business region)
Version 01.02
22
MOTOTRBO
Application Development Kit
Overview
478
Section 5
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
5.0
For further information about MOTOTRBO and MOTODEV, please visit the following
websites:
Version 01.02
23
MOTOTRBO
Application Development Kit
Overview
501
Section 6
502
6.0
Version 01.02
MOTOTRBO
Location Data
MOTOTRBO
Text Messaging
MOTOTRBO
XCMP-Based
Applications
MOTOTRBO
Non- IP
Applications
MOTOTRBO
Telemetry
Document
MOTOTRBO
Option Board
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
24
*6880309T32*
6880309T32