User Manual

RM Series (RM-CR/RM-CG/RM-TT/RM-WAP) Remote Control Protocol Specifications Version 2.0.0
20
3. Command Specifications
Event List
Applicable devices
RM-CR
RM-CG
RM-TT
RM-WAP
Usage example(s)
event
event <EventID> <Data> …
↓
OK event <EventID> <Data> ...
No. Case Action EventID Data
Model
RM-CR RM-CG RM-TT RM-WAP
1 Update request event RM:FirmwareUpdate “<xxxxxxxxxx>” string <xxxxxxxxxx>: update data source path
¡ ¡ ¡ ¡
2 Update start notification
NOTIFY event RM:FirmwareUpdateStarted - -
¡ ¡ ¡ ¡
3 Update finish notification
NOTIFY event RM:FirmwareUpdateFinished “<xxxxxx>” - “<xxxxxx>” : success/failed/skip
¡ ¡ ¡ ¡
4 Send the controller
notification of device internal
failure via alert message
NOTIFY event RM:Alert “<xx>:[xxxxxxxxx],[xxxxx]”
RM:Alert “01:SYSTEM ERROR,fault”
string <xx>: alert number (Hex)
[xxxxxxxxx] : alert message
[xxxxx]:warning/error/fault
¡ ¡ ¡ ¡
5 Time zone setting event RM:SetTimeZone “<xx>” string “<xx>” : time zone (0-32)
*See Timezone data table
¡ ¡ ¡ ¡
6 Time zone query event RM:GetTimeZone “” - -
¡ ¡ ¡ ¡
7 DST enable/disable setting event RM:SetDstEnable “<xxxxx>” string <xxxx> : Enable/Disable
¡ ¡ ¡ ¡
8 DST enable/disable query event RM:GetDstEnable “” string -
¡ ¡ ¡ ¡
9 DST start time setting event RM:SetDstStartTime “month=<xx>,
week=[x],day=[x],hour=(xx)”
string <xx> : month (1-12)
[x] : week (1-5) specifies which week of the month
[x] : day (0-6, Sunday = 0)
<xx> : hour (0-23)
¡ ¡ ¡ ¡
10 DST start time query event RM:GetDstStartTime “” - -
¡ ¡ ¡ ¡
11 DST end time setting event RM:SetDstEndTime “month=<xx>,
week=[x],day=[x],hour=(xx)”
string <xx> : month (1-12)
[x] : week (1-5) specifies which week of the month
[x] : day (0-6, Sunday = 0)
<xx> : hour (0-23)
¡ ¡ ¡ ¡
12 DST end time query event RM:GetDstEndTime “” - -
¡ ¡ ¡ ¡
13 NTP support enable/disable
setting
event RM:SetNtpEnable “<xxxx>” string <xxxx> : Enable/Disable
¡ ¡ ¡ ¡
14 NTP support enable/disable
query
event RM:GetNtpEnable “” - -
¡ ¡ ¡ ¡
15 NTP server (1-4) setting event RM:SetNtpServer1 “<xxxxxxxxxx>”
RM:SetNtpServer2 “<xxxxxxxxxx>”
RM:SetNtpServer3 “<xxxxxxxxxx>”
RM:SetNtpServer4 “<xxxxxxxxxx>”
string <xxxx> : NTP server address
¡ ¡ ¡ ¡
16 NTP server (1-4) query event RM:GetNtpServer1 “”
RM:GetNtpServer2 “”
RM:GetNtpServer3 “”
RM:GetNtpServer4 “”
- -
¡ ¡ ¡ ¡
17 Initiate call event rm:callaction “dial=(line name):(number)” string • Possible line names:
sip1/sip2
¡
18 Answer call event rm:callaction “offhook=(line name)” string • Possible line names:
sip1/sip2/usb/bt
¡
19 Hold event rm:callaction “holdorresume=(line name)” string • Possible line names:
sip1/sip2/usb/bt/aux
¡
20 Resume event rm:callaction “holdorresume=(line name)” string Same as above
¡
21 Disconnect event rm:callaction “hangup=(line name)” string • Possible line names:
sip1/sip2/usb/bt
¡
22 DTMF notification event
rm: callaction “dtmf=(line name):
(single-digit number or single character)”
string • Possible line names:
sip1/sip2
¡
23 Join conference event rm:callaction “joinorsplit=(line name)” string • Possible line names:sip1/sip2/usb/bt/aux
¡
24 Individual split event rm:callaction “joinorsplit=(line name)” string • Possible line names:sip1/sip2/usb/bt/aux
¡
25 Split all event rm:callaction “splitall” string
¡
26 Hold/resume conference event rm:callaction “holdorresumeconf” string
¡
27 Disconnect from conference event rm:callaction “hangupconf” string
¡
28 Status query event rm:getcallstatus “” - Possible attribute/value included in the response
settings:
sip1=(line status), sip2=(line status), usb=(line status),
bt=(line status), aux=(line status),
confstate=(conference status), serverregist=(SIP
server connection status), vm-count=(voicemail
count), sip1number=(SIP1 opposite party number),
sip2number=(SIP2 opposite party number),
ownId=(own SIP ID), ownname=(own SIP username)
• Line statuses listed on “Dialer Line Status” sheet
• Conference status
(no lines in conference=idle/in conference=active/
on hold=onhold)
• SIP server connection status (3-digit number)
¡
29 Status change notification
NOTIFY event rm:changedcallstatus “(attribute)=(value)” string Same as above
¡