You are on page 1of 31

RAP1 Control Protocol

PART 5B
Advanced
Automatic Radio Control System
(ARCS) / 3rd Generation Automatic
Link Establishment (3G ALE)

Date: 06/03/2014
Revision: 030
Rapid Mobile (Pty) Ltd

PO Box 121
Persequor Park
South Africa
0020

Building C, D, F2
Apex Corporate Park
Quintin Brand Street
Persequor Park
0020

Fax: +27 12 349-0010


Tel: +27 12 349-0000

e-mail: info@rapidm.com
www: www.rapidm.com

Document
RM-RAP1-0018DOC
Number:

Reference: RM-RAP1-0018DOC030.docx

Revision: 030

All rights reserved. No part of this publication may be reproduced or transmitted in any form
or by any means, electronic, mechanical, photocopying, recording, or by any other means or
media now known or to become known, without prior written permission from Rapid Mobile
(Pty) Ltd.
Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

TABLE OF CONTENTS
1 Part 5 Overview ......................................................................................................... 4
1.1 Scope .................................................................................................................. 4
1.2 Overview ............................................................................................................. 5
1.3 Persistence .......................................................................................................... 5
2 ARCS Configuration Interface....................................................................................... 6
2.1 Network-Wide Configuration................................................................................... 6
2.1.1 Broadcast LDL Repeat Count ............................................................................ 6
2.2 Address List Configuration ..................................................................................... 7
2.2.1 LSU Subnet Table Delete .................................................................................. 7
2.2.2 LSU Subnet Table Size ..................................................................................... 7
2.2.3 LSU Subnet Table Entry ................................................................................... 8
2.2.4 Subnet Alias Lookup ........................................................................................ 9
2.2.5 LSU Group Table Delete ................................................................................... 9
2.2.6 LSU Group Table Size ...................................................................................... 9
2.2.7 LSU Group Table Entry................................................................................... 10
2.2.8 Group Alias Lookup ....................................................................................... 11
2.3 System Configuration .......................................................................................... 12
2.3.1 LSU Mode..................................................................................................... 12
2.3.2 FLSU Periodic LQA ......................................................................................... 13
2.3.3 Occupancy Detection Mode ............................................................................. 14
2.3.4 LBT Duration ................................................................................................ 15
2.3.5 Fixed Channel Mode ...................................................................................... 17
2.4 Packet Link Configuration .................................................................................... 18
2.4.1 xDL Max Missed ............................................................................................ 18
2.4.2 HDLP RxDropTimeout .................................................................................... 19
2.4.3 HDLP Packet Size .......................................................................................... 19
2.4.4 HDLP Constellation ........................................................................................ 20
2.4.5 Allow Incomplete Broadcast Packets ................................................................ 20
2.5 Permission Configuration ..................................................................................... 21
2.5.1 LSU Promiscuous Mode .................................................................................. 21
2.5.2 Accept Broadcast TOD Responses from Anyone ................................................. 22
2.6 Channel History Table Configuration ...................................................................... 23
2.6.1 Channel History Table Delete .......................................................................... 23
2.6.2 Channel History Table Add Entry ..................................................................... 23
2.6.3 Channel History Table Entry ........................................................................... 24
2.6.4 Channel History Table Current Size ................................................................. 24
2.6.5 Channel History Table Maximum Size .............................................................. 25
2.6.6 Channel History Deleted Indication .................................................................. 25
2.6.7 LQA Averaging Algorithm ............................................................................... 26
2.6.8 LQA Behaviour when LQA not received............................................................. 26
3 ARCS Control Interface ............................................................................................. 27
3.1 Packet Link Control ............................................................................................. 27
3.1.1 Packet-To-Circuit Request .............................................................................. 27
3.2 Packet Link Status & Indications ........................................................................... 28
3.2.1 Start of Message ........................................................................................... 28
3.2.2 End of Message ............................................................................................. 28
3.2.3 Packet-To-Circuit Result ................................................................................. 29
3.3 DTE Link Control ................................................................................................. 30
3.3.1 Voice Switch Request .................................................................................... 30
3.4 DTE Link Status & Indications............................................................................... 31
3.4.1 Voice Switch Result ....................................................................................... 31

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 3


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

1 P A R T 5 OV E RV I E W

1.1 S COPE
This document defines the 3G-ALE (S4538 ARCS) interface RapidM Application Protocol 1
(RAP1) messages

Part 1
RAP1 Common and Transport Protocols

Part 2 Part 3 Part 4 Part 5 Part 6 Part 7 Part 8 Part 9 Part 10


Circuit switched Data Modem
System Control & Hardware

V/UHF Data Modem


Signal Detection
ARCS / 3G-ALE

Radio Control

TC4 Crypto
Telemetry
2G-ALE

V-05

Figure 1: RAP1 Documentation Structure

Page 4 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

1.2 O VERVIEW
All of the messages described in this document fall under one of the following interfaces:

Host (PC or Laptop)


Serial Port Serial Port

1 5 6a 6b
ARCS ARCS ARCS ARCS
Configuration Control Packet Data DTE Data
Interface Interface Interface Interface
Remote Control Port

Initial Network Session


Radio Parameters (INP) Manager (SM)
Programming
Interface
TC4 ARCS
Radio Control
Waveforms (WF)
2b Manager (RCM)

Radio Control Port Audio Port


Radio Radio Radio
Programming Control Audio
Interface Interface Interface

2a 3 4

Radio Control Port Radio Audio Port

Radio

Figure 2: Interfaces

1.3 P ERSISTENCE
Configuration persistence (saving to non-volatile memory, as well as loading from non-volatile
memory) shall be handled by the Management Information Base (MIB), if present. Any
configuration value which is to be persisted shall be identified in this document as either
normal-priority or high-priority. High-priority values, such as port configurations, shall be
persisted as soon as they are changed. Normal-priority values shall be persisted when
appropriate, so as to maximise the lifetime of the non-volatile memory.

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 5


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2 A R C S C ON F I G U R A T I ON I N T E R F A C E

2.1 N ETWORK -W IDE C ONFIGURATION


These messages are used to configure fundamental, network-wide functionality. It is
important to note that each and every station in the entire network must have the exact same
network-wide configuration.

2.1.1 BROADCAST LDL REPEAT COUNT


This message sets/gets the number of times that each broadcast LDL fragment will be
transmitted over the air.

This normal-priority value is saved to non-volatile memory.

Default Repeat Count: 2


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 156 157 157
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1 – 16: The number of times that each broadcast LDL fragment
6 Repeat Count
will be transmitted over the air.

Table 1: Broadcast LDL Repeat Count

Page 6 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.2 A DDRESS L IST C ONFIGURATION


2.2.1 LSU SUBNET TABLE DELETE
This message deletes all entries from the Subnet Table.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 38 - -
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) - -

Table 2: LSU Subnet Table Delete

2.2.2 LSU SUBNET TABLE SIZE


The message below gets the size of the Subnet Table.

Byte No Identifier Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 42 42
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type - 2 (Command) 3 (Response)

Table 3: LSU Subnet Table Size

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 7


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.2.3 LSU SUBNET TABLE ENTRY


The message below sets/gets an entry in the Subnet Table.

Up to 256 normal-priority entries are saved to non-volatile memory.

ATT EN T I O N
RapidM recommends the use of Groups rather than Subnets. Groups are less
restrictive than Subnets and they perform the same function. To avoid conflicts do
not configure the Subnet Table. Leave the Subnet Table empty (delete the Subnet
Table and do not add entries).
A subnet address may not be equal to any other existing subnet address, or to
any existing group address.
A subnet may not be empty.
All of the subnet members must belong to the same scan group.
None of the subnet members may belong to any other subnet.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 39 40 40
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Get
6→7 Index 0 – 255: Index of the entry in the Subnet Table.
Application Message: Command Set
1: add
2: modify
6 Subnet Status
3: delete
4: insert
Application Message: Response Get
6 Subnet Status 5: return
Application Message: Command Set & Response Get
0 – 255: Index of this entry in the Subnet Table.
7→8 Subnet Index
Ignored if Subnet Status is 1 (add).
0 – 1022: The 10-bit multipoint address for the
9 → 10 Subnet Arcs Address
subnet.
The alias of the subnet: 3 – 15 ASCII-38 characters
11 → 25 Subnet Alias
(null terminated if less than 15).
26 Reserved 0 (value ignored).
27 → 28 Subnet Member Count Number of members in the array (n).
An array of 2-byte (10-bit) addresses for the
29 → (29+2n-1) Subnet Member Addresses
members of the subnet.

Table 4: LSU Subnet Table Entry

Page 8 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.2.4 SUBNET ALIAS LOOKUP


This message gets the subnet index and subnet address from the subnet alias.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID - 137 137
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Get & Response Get
The alias of the subnet: 3 – 15 ASCII-38 characters (null
6 → 20 Subnet Alias
terminated if less than 15).
Application Message: Response Get
21 → 22 Subnet Index The index of the subnet in the Subnet Table.
23 → 24 Subnet Address 0 – 1022: The 10-bit address of the subnet.

Table 5: Subnet Alias Lookup

2.2.5 LSU GROUP TABLE DELETE


This message deletes all entries from the Group Table.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 43 - -
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) - -

Table 6: LSU Group Table Delete

2.2.6 LSU GROUP TABLE SIZE


The message below gets the size of the Group Table.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID - 47 47
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type - 2 (Command) 3 (Response)
Application Message: Response Get
6→7 Size The size of the table.

Table 7: LSU Group Table Size

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 9


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.2.7 LSU GROUP TABLE ENTRY


The message below sets/gets an entry in the Group Table.

Up to 256 normal-priority entries are saved to non-volatile memory.

ATT EN T I O N
A group address may not be equal to any other existing group address, or to any
existing subnet address.
A group may not be empty.
All of the group members must belong to the same scan group.
All of the group members must belong to the same subnet (i.e. the group belongs
to a subnet), or all of the group members must belong to the same network that
does not have any subnets (i.e. the group belongs to a network with no subnets).

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 44 45 45
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Get
6→7 Index 0 – 255: Index of the entry in the Group Table.
Application Message: Command Set
1: add
2: modify
6 Group Status
3: delete
4: insert
Application Message: Response Get
6 Group Status 5: return
Application Message: Command Set & Response Get
0 – 255: Index of this entry in the Group Table.
7→8 Group Index
Ignored if Group Status is 1 (add).
0 – 1022: The 10-bit multipoint address for the
9 → 10 Group Arcs Address
group.
The alias of the group: 3 – 15 ASCII-38 characters
11 → 25 Group Alias
(null terminated if less than 15).
26 Reserved 0 (value ignored).
27 → 28 Group Member Count Number of members in the array (n).
An array of 2 byte addresses for the members of the
29 → (29+2n-1) Group Member Addresses
group.

Table 8: LSU Group Table Entry

Page 10 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.2.8 GROUP ALIAS LOOKUP


This message gets the group index and group address from the group alias.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID - 139 139
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
The alias of the group: 3 – 15 ASCII-38 characters (null
6 → 20 Group Alias
terminated if less than 15).
Application Message: Response Get
21 → 22 Group Index The index of the group in the Group Table.
23 → 24 Group Address 0 – 1022: The 10-bit address of the group.

Table 9: Group Alias Lookup

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 11


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.3 S YSTEM C ONFIGURATION


These messages are used to configure advanced system functionality.

It is important to note that using these messages might lead to unexpected behavior.

2.3.1 LSU MODE


The message below sets/gets the LSU Mode.

This normal-priority value is saved to non-volatile memory.

Default Mode: 2 (Fast LSU Mode synchronised)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 20 21 21
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
2: Fast LSU Mode synchronised
6 Mode
3: Fast LSU Mode asynchronised

Table 10: LSU Mode

Page 12 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.3.2 FLSU PERIODIC LQA


The set message handles the activation or deactivation of automatic periodic execution of
FLSU LQA Sound or Exchange. The interval between the sounding/exchange executions is also
set.

The get message requests the current settings of the automatic periodic execution of FLSU
LQA Sound or Exchange.

These normal-priority values are saved to non-volatile memory.

Default Activation Flag: 0 (None)


Default LQA Interval: 0
Default Destination Address: 0
Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 93 94 94
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
0: None
6 Activation Flag 1: LQA Sound
2: LQA Exchange
The period (interval) in seconds between LQA Protocols.
7 → 10 LQA Interval
Not used if Activation Flag is None.
0 – 1022: The 10-bit point address of the destination PU.
11 → 12 Destination Address Not used if Activation Flag is None.
Not used if Activation Flag is LQA Sound.

Table 11: FLSU Periodic LQA

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 13


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.3.3 OCCUPANCY DETECTION MODE


This message sets/gets the occupancy detection mode.

If the Occupancy Detection Mode is set to 1 (never), then occupancy detection will never be
done.

If the Occupancy Detection Mode is set to 2 (if-there-is-time), then occupancy detection will
be done if there is time. Asynchronous link setup will begin as soon as possible, irrespective
of when the call channel is scanned by the destination scan group. Therefore, occupancy
detection will be done on the call channel. If separate call and traffic channels are being used,
then occupancy detection will also be done on the traffic channel. Synchronous link setup
will begin the next time that the call channel is scanned by the destination scan group. If
there is time before the call channel is scanned by the destination scan group, then occupancy
detection will be done on the call channel. If there is time before occupancy detection is done
on the call channel, and only if separate call and traffic channels are being used, then
occupancy detection will also be done on the traffic channel.

If the Occupancy Detection Mode is set to 3 (always), then occupancy detection will always be
done. Asynchronous link setup will begin as soon as possible, irrespective of when the call
channel is scanned by the destination scan group. Therefore, occupancy detection will be done
on the call channel. If separate call and traffic channels are being used, then occupancy
detection will also be done on the traffic channel. Synchronous link setup will begin the next
time that the call channel is scanned by the destination scan group, after occupancy detection
has been done.

This normal-priority value is saved to non-volatile memory.

ATT EN T I O N
Occupancy detection is only done during link setup (if it is done at all).
Occupancy detection is never done during packet link renegotiation.

Default Mode: 3 (Always do occupancy detection)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 124 125 125
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1: Never do occupancy detection.
6 Mode 2: Do occupancy detection if there is time.
3: Always do occupancy detection.

Table 12: Occupancy Detection Mode

Page 14 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.3.4 LBT DURATION


This message sets/gets the LBT duration.

The following figure illustrates the different LBT scenarios:

Scenario 1: LBT on Call & Traffic.

Traffic LBT Call Tune Call LBT

Scenario 2: LBT on Call only.

Call Tune Call LBT

Scenario 3: No LBT.

Call Tune

Figure 3: LBT Scenarios

At the start of every dwell, FLSU decides whether to scan, or whether to start the LBT
scenario. However, because LBT scenarios need to end at a specific time (~368 milliseconds
after the start of the call dwell), they seldom need to start on a dwell boundary.

The following figure illustrates that the first action of the LBT scenario (Traffic LBT or Call
Tune) will usually be allowed extra time.

Transmit Time Transmit Time Transmit Time

Dwell Dwell Dwell

Scenario starts on dwell boundary, ends before transmit time.

LBT Scenario

Scenario starts after dwell boundary, ends on transmit time.

Extra Time LBT Scenario

Figure 4: Extra Time for LBT Scenario

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 15


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

The following figure illustrates that Call LBT will be allowed extra time if Call Tune completes
early:

Transmit Time

Tune Time (Max) LBT Time (Min) Call Time (Exact)

Call tune completes early; extra time for call LBT.

Call Tune Call LBT Call

Figure 5: Extra Time for Call LBT

This normal-priority value is saved to non-volatile memory.

Default Duration: 1300 ms


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 158 159 159
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
6→7 Duration 1300 ms – 60000 ms

Table 13: LBT Duration

Page 16 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.3.5 FIXED CHANNEL MODE


This message can be used to “fix” the ALE 3G system to a single channel in the Scan List. This
will allow the ALE 3G system to work with a radio that does not (or cannot) allow radio
control, without limiting the rest of the network to a single-channel scan list.

If fixed channel mode is enabled, then the following restrictions apply:

ATT EN T I O N
The local station will always scan on the fixed channel, while the rest of the
network will scan through the Scan List.
LQA links, whether for sounding or for exchange, will be rejected. This
applies to both incoming, as well as outgoing LQA links.
When making a call, if the Call Channel Selection Type is Next or Best, then
the fixed channel will always be selected.
When making a call, if the Call Channel Selection Type is Specified, then the
specified channel must be equal to the fixed channel.
When making a call, the Traffic Channel Selection Type must be Same.
When making a call, the link request will be sent when the destination next
scans on the call channel, not when the local station next scans on the call
channel.

Default Mode: 1 (Disabled)


Default Channel Index: 255 (Unspecified)
Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 160 161 161
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1: Disabled
6 Mode
2: Enabled
0 – 254: Index of the channel in the Channel Pool. The channel
must be one of the first N channels in the Scan List, where N is
7 Channel Index equal to the Scan Channel Count.

255: Unspecified. Only valid if Mode is 1 (Disabled).

Table 14: Fixed Channel Mode

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 17


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.4 P ACKET L INK C ONFIGURATION


These messages are used to configure advanced packet link functionality.

It is important to note that using these messages might lead to unexpected behavior.

2.4.1 XDL MAX MISSED


This message sets/gets the maximum number of consecutively missed Tx Frames before the
xDL (HDL, LDL or HDLP) slave terminates the xDL transfer; and the maximum number of
consecutively missed ACKs before the xDL master terminates the xDL transfer.

These normal-priority values are saved to non-volatile memory.

Default HDL Max Missed Tx Frames: 15


Default HDL Max Missed ACKs: 16
Default LDL Max Missed Tx Frames: 15
Default LDL Max Missed ACKs: 16
Default HDLP Max Missed Tx Frames: 15
Default HDLP Max Missed ACKs: 16
Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 114 115 115
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set, Command Get & Response Get
1: HDL
6 xDL Type 2: LDL
3: HDLP
Application Message: Command Set & Response Get
1 – 255: The maximum number of consecutively missed Tx
Frames before the xDL slave terminates the xDL transfer.
7 Max Missed Tx Frames
NOTE: An xDL Tx Frame not entirely received within the
expected time is considered missed entirely.
1 – 255: The maximum number of consecutively missed
ACKs before the xDL master terminates the xDL transfer.

8 Max Missed ACKs NOTE: An LDL_ACK indicating that the LDL_DATA was not
received correctly, or an HDL_ACK/HDLP_ACK indicating that
NO HDL_DATA/HDLP_DATA was received correctly, is
considered missed.

Table 15: xDL Max Missed

Page 18 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.4.2 HDLP RXDROPTIMEOUT


This message sets/gets the HDLP RxDropTimeout.

This normal-priority value is saved to non-volatile memory.

Default Number of HDLP_DHDR: 2


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 126 127 127
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
The number of HDLP_DHDR PDUs to include in the
6 Number of HDLP_DHDR RxDropTimeout calculation:
1 – 255

Table 16: HDLP RxDropTimeout

2.4.3 HDLP PACKET SIZE


This message sets/gets the HDLP packet size.

This normal-priority value is saved to non-volatile memory.

Default HDLP Packet Size: 3 (Optimal)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 128 129 129
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1 – 280 bytes
6 HDLP Packet Size 2 – 568 bytes
3 – Optimal

Table 17: HDLP Packet Size

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 19


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.4.4 HDLP CONSTELLATION


This message sets/gets the HDLP constellation.

This normal-priority value is saved to non-volatile memory.

Default HDLP Constellation: 8 (Optimal)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 130 131 131
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1 – 2PSK ½ Rate
2 – 2PSK ¾ Rate
3 – 4PSK ¾ Rate
4 – 8PSK ¾ Rate
6 HDLP Constellation
5 – 16QAM ¾ Rate
6 – 64QAM ¾ Rate
7 – 64QAM Uncoded
8 – Optimal

Table 18: HDLP Constellation

2.4.5 ALLOW INCOMPLETE BROADCAST PACKETS


This message sets/gets whether or not the receiver will allow incomplete broadcast packets.

Each broadcast packet is composed of a number of fragments. Each fragment is repeated a


number of times, to increase the probability of reception. If none of the repeats of a specific
fragment are received, then that fragment is considered missing. If at least one fragment of a
specific broadcast packet is missing, then that broadcast packet is considered incomplete.

If the receiver does not allow incomplete broadcast packets, then it will not pass an
incomplete broadcast packet to the user.

If the receiver does allow incomplete broadcast packets, then it will pass an incomplete
broadcast packet to the user (provided that the first fragment is not missing). Each missing
fragment will be replaced with an equal number of zeros.

This normal-priority value is saved to non-volatile memory.

Default Allow: 1 (Disabled)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 164 165 165
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1: Disabled
6 Allow
2: Enabled

Table 19: Allow Incomplete Broadcast Packets

Page 20 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.5 P ERMISSION C ONFIGURATION


These messages are used to configure advanced permissions.

It is important to note that using these messages might lead to unexpected behavior.

2.5.1 LSU PROMISCUOUS MODE


This message sets/gets the Link Setup Promiscuous Mode.

If the Link Setup Promiscuous Mode is Disabled, then an outgoing point-to-point call will only
be allowed to an address in the Address Table.

If the Link Setup Promiscuous Mode is Disabled, then an incoming call will only be accepted
from an address in the Address Table.

If the Link Setup Promiscuous Mode is Enabled, then an outgoing point-to-point call will be
allowed to any address. If the address is not in the Address Table, then the caller will use its
own Network Address, Link Protection Key and/or Scan Group when making the call.

If the Link Setup Promiscuous Mode is Enabled, then an incoming call will be allowed from any
address.

This normal-priority value is saved to non-volatile memory.

Default Mode: 1 (Disabled)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 140 141 141
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1 – Disabled
6 Mode
2 – Enabled

Table 20: LSU Promiscuous Mode

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 21


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.5.2 ACCEPT BROADCAST TOD RESPONSES FROM ANYONE


This message determines whether responses to a broadcast time-of-day request may be
accepted from anyone, or whether they may only be accepted from the network control
station or the alternate network control station.

This normal-priority value is saved to non-volatile memory.

Default Accept: 1 (No)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 110 111 111
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1: No, only accept broadcast TOD responses from the network control
6 Accept station or the alternate network control station.
2: Yes, accept broadcast TOD responses from any station.

Table 21: Accept Broadcast TOD Responses from Anyone

Page 22 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.6 C HANNEL H ISTORY T ABLE C ONFIGURATION


These messages are used to configure the Channel History Table.

It is important to note that using these messages might lead to unexpected behavior.

2.6.1 CHANNEL HISTORY TABLE DELETE


This message is used to delete the entire Channel History Table.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 97 - -
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) - -

Table 22: Channel History Table Delete

2.6.2 CHANNEL HISTORY TABLE ADD ENTRY


This message is used to add/set a Channel History Table Entry. This shall always be an
“Append” in the S4538 Protocol’s Channel History Table. If an entry for the specified
Destination Address, Channel Index, and Time Slot already exists, the existing entry shall be
deleted and this entry added to the end. This is done because the Channel History table is a
chronological table where the newest entries are added at the end so that when the table is
full the older entries at the start are overwritten.

This message should preferably be used to populate the Channel History Table upon start-up.
It is recommended that the Channel History table be deleted before the table is populated.

When an entry in the Channel History Table is changed/added through LQA information that
was received, a Set-Indication shall be generated and the Process containing the MIB must
have registered for this Set-Indication in order to receive the updated information. This
message shall also serve as the Set-Indication when a Channel History Table Entry is changed
due to new LQA information that was received.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID 83 - -
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) - -
Application Message: Command Set
0 – 1022: The 10-bit address of the destination PU to which
6→7 Destination Address
the entry refers.
8 Channel Index 0 – 254: Index of the channel in the Channel Pool.
1 – 24: The timeslot of this entry. A day is divided into 60
9 Time Slot
minute (1 hour) slots.
10 SNR -127 – 127: The SNR value for this entry.
11 → 12 BER 0 – 7: The BER value for this entry.

Table 23: Channel History Table Add Entry

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 23


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.6.3 CHANNEL HISTORY TABLE ENTRY


This paragraph defines the message used to get a Channel History Table Entry for a specific
entry Index. It is advised that the “Channel History Table Current Size Get” message is used
to get the current number of entries in the table and then use this to traverse the entries.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID - 84 84
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type - 2 (Command) 3 (Response)
Application Message: Command Get & Response Get
The 0-based index of the entry within the channel history
6→9 Entry Index
table.
Application Message: Response Get
0 – 1022: The 10-bit address of the destination PU to which
10 → 11 Destination Address
the entry refers.
12 Channel Index 0 – 254: Index of the channel in the Channel Pool.
The timeslot of this entry. A day is divided into 60 minute (1
13 Time Slot hour) slots; therefore the Time Slot can be a number from 1
to 24.
14 SNR The last SNR value received.
15 → 16 BER The last BER value received.

Table 24: Channel History Table Entry

2.6.4 CHANNEL HISTORY TABLE CURRENT SIZE


This paragraph defines the message to get the Channel History Table’s current Size and the
get message’s response.

Byte No Description Command Set Command Get Response Get


PDU Header
0→1 Group ID 20
2→3 Message ID - 86 86
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type - 2 (Command) 3 (Response)
Application Message: Response Get
6→7 Size The current size of the table in bytes.
8→9 Num Entries The current number of entries in the channel history table.

Table 25: Channel History Table Current Size

Page 24 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.6.5 CHANNEL HISTORY TABLE MAXIMUM SIZE


This message sets/gets the maximum size of the Channel History Table. This is the maximum
size that the Channel History can grow to. When this maximum is reached the oldest entries
are overwritten so that the maximum is not exceeded.

Default Maximum Size: 32760 (almost 32 Kbyte)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 95 96 96
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
6→7 Maximum Size The maximum size of the table in bytes.

Table 26: Channel History Table Maximum Size

2.6.6 CHANNEL HISTORY DELETED INDICATION


This message indicates that a channel history entry has been deleted.

Byte No Description Indication


PDU Header
0→1 Group ID 20
2→3 Message ID 123
4 Message Seq No 0-255: Unique identifier as determined by the sender
5 Message Type 4 (Indication)
Application Message: Indication
6→ 7 Destination Address 0 – 1022: The 10-bit address of the destination PU to which the
entry refers.
8 Channel Index 0 – 254: Index of the channel in the Channel Pool.
9 Time Slot The timeslot of this entry. A day is divided into 60 minute (1
hour) slots; therefore the Time Slot can be a number from 1 to
24.

Table 27: Channel History Deleted Indication

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 25


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

2.6.7 LQA AVERAGING ALGORITHM


This message sets/gets the LQA Averaging Algorithm to be used when adding new LQA values
to the Channel History Table.

This normal-priority value is saved to non-volatile memory.

Default Algorithm Option: 2 ((old+new)/2)


Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 106 107 107
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1: No averaging
2: (old+new)/2
6 Algorithm Option
3: ((3*old)+new)/4
4: ((7*old)+new)/8

Table 28: LQA Averaging Algorithm

2.6.8 LQA BEHAVIOUR WHEN LQA NOT RECEIVED


This message sets/gets the LQA behaviour for the case where LQA information is expected for
an channel during either LQA SOUND or LQA EXCHANGE, but is not received

These normal-priority values are saved to non-volatile memory.

Default Type: 1 (Degrade)


Default Degrade Amount: 1
Byte No Description Command Set Command Get Response Get
PDU Header
0→1 Group ID 20
2→3 Message ID 112 113 113
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 2 (Command) 2 (Command) 3 (Response)
Application Message: Command Set & Response Get
1: Degrade LQA entry.
6 Type
2: Delete LQA entry.
0 – 10 dB.
7 Degrade Amount
Ignored if Type is Delete LQA entry.

Table 29: LQA Behaviour when LQA not received

Page 26 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

3 A R C S C ON T R O L I N T E R F A C E

3.1 P ACKET L INK C ONTROL


These messages are used to provide advanced control for ARCS packet links.

It is important to note that using these messages might lead to unexpected behavior.

3.1.1 PACKET-TO-CIRCUIT REQUEST


This message requests that the current packet link change to a circuit link, if it is not busy
delivering a packet.

Byte No Description Indication


PDU Header
0→1 Group ID 21
2→3 Message ID 21
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 4 (Indication)
Application Message: Indication
1: ANLG_VOICE
2: DGTL_VOICE
3: ANDVT
6 Traffic Type
51: HF_1_2400
52: HF_1_1200
53: HF_1_600

Table 30: Packet-To-Circuit Request

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 27


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

3.2 P ACKET L INK S TATUS & I NDICATIONS


These messages are used to provide advanced information regarding ARCS packet links.

It is important to note that using these messages might lead to unexpected behavior.

3.2.1 START OF MESSAGE


This message indicates the transmit time (timestamp) of the FLSU_REQ_2Way PDU used
during packet link setup.

Byte No Description Indication


PDU Header
0→1 Group ID 21
2→3 Message ID 19
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 4 (Indication)
Application Message: Indication
The time when the transmission of the FLSU_REQ_2Way PDU will
6→9 Timestamp
be started.

Table 31: Start of Message

3.2.2 END OF MESSAGE


This message indicates the transmit time (timestamp) of the first xDL_EOM (End of Message)
PDU used at the end of packet delivery.

Byte No Description Indication


PDU Header
0→1 Group ID 21
2→3 Message ID 20
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 4 (Indication)
Application Message: Indication
The time when the transmission of the first xDL_EOM PDU will be
6→9 Timestamp
started.

Table 32: End of Message

Page 28 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

3.2.3 PACKET-TO-CIRCUIT RESULT


This message indicates the result of the preceding Packet-To-Circuit Request.

Byte No Description Indication


PDU Header
0→1 Group ID 21
2→3 Message ID 22
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 4 (Indication)
Application Message: Indication
1: ANLG_VOICE
2: DGTL_VOICE
3: ANDVT
6 Traffic Type
51: HF_1_2400
52: HF_1_1200
53: HF_1_600
1: Failure
7 Result
2: Success
1: Unknown.
2: Not linked.
3: Linked, but not a packet link.
8 Reason 4: New circuit traffic type not valid.
5: Packet link not ready.

Ignored if Result is Success.

Table 33: Packet-To-Circuit Result

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 29


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

3.3 DTE L INK C ONTROL


These messages are used to provide advanced control for ARCS DTE links.

It is important to note that using these messages might lead to unexpected behavior.

3.3.1 VOICE SWITCH REQUEST


This message requests that the current voice link be changed to a different voice link.

Byte No Description Indication


PDU Header
0→1 Group ID 22
2→3 Message ID 16
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 4 (Indication)
Application Message: Indication
1: ANLG_VOICE
2: DGTL_VOICE
3: ANDVT
51: HF_1M_2400
52: HF_1M_1200
6 Traffic Type
53: HF_1M_600
56: HF_1T_2400
57: HF_1T_1200
58: HF_1T_600
59: HF_1T_300

Table 34: Voice Switch Request

Page 30 Rapid Mobile (Pty) Ltd. © Copyright 2012 Rev : 030


Control Protocol Definition Document
RM-RAP1-0018DOC
Proprietary

3.4 DTE L INK S TATUS & I NDICATIONS


These messages are used to provide advanced information regarding ARCS DTE links.

It is important to note that using these messages might lead to unexpected behavior.

3.4.1 VOICE SWITCH RESULT


This message indicates the result of the preceding Voice Switch Request.

Byte No Description Indication


PDU Header
0→1 Group ID 22
2→3 Message ID 17
4 Message Seq No 0-255: Unique identifier as determined by sender
5 Message Type 4 (Indication)
Application Message: Indication
1: ANLG_VOICE
2: DGTL_VOICE
3: ANDVT
51: HF_1M_2400
52: HF_1M_1200
6 Traffic Type
53: HF_1M_600
56: HF_1T_2400
57: HF_1T_1200
58: HF_1T_600
59: HF_1T_300
1: Failure
7 Result
2: Success
1: Unknown.
2: Not linked.
3: Not linked for voice.
8 Reason 4: New traffic type is invalid.
5: Voice link is not idle.

Ignored if Result is Success.

Table 35: Voice Switch Result

Rev : 030 Rapid Mobile (Pty) Ltd. © Copyright 2012 Page 31

You might also like