API for the “AR-DV1 Tablet App Interface Web Adapter “ hardware
v1.22019.04.19
AOR, Ltd.Authority On Radio Communications
This API is free to use for commercial and non-commercial purposes. However it is provided “as is” without warranty nor technical support.
®
© 2019, AOR, LTD. 1
Table of contents
1. Introduction..................................................................................................3
2. Hardware requirements...............................................................................3
3. API frame....................................................................................................3
4. API list.........................................................................................................4
5. API details
1. Authenticate......................................................................................5
2. Power................................................................................................7
3. ReceiverState...................................................................................8
4. Time..................................................................................................9
5. Frequency.......................................................................................10
6. DemodulateMode............................................................................11
7. IFbandwidth....................................................................................12
8. FrequencyStep................................................................................15
9. FrequencyStepAdjust......................................................................16
10. DigitalDataOutput............................................................................18
11. LevelSquelch..................................................................................20
12. Volume............................................................................................22
13. VFO.................................................................................................24
14. DigitalAdditionalInfo........................................................................26
15. SpectrumCenter..............................................................................27
16. SpectrumSpan................................................................................29
17. SpectrumData.................................................................................31
18. Smeter............................................................................................32
19. ReceiverStateNotification................................................................33
20. Adapter...........................................................................................34
� Shutdown.................................................................................34
� Restart.....................................................................................35
� Network interface.....................................................................36
� Wireless network adapter........................................................37
� SSH service.............................................................................39
21. CTCSS............................................................................................40
22. DCS................................................................................................44
23. DCREncryptionCode.......................................................................48
24. TTCSlot...........................................................................................50
6. Websocket API..........................................................................................52
w-1. Sound..................................................................................52
w-2. ReceiverState......................................................................52
w-3. DigitalAdditionalInfo.............................................................53
© 2019, AOR, LTD. 2
1. Introduction
This manual is a description of the WEB API to control the AR-DV1 receiverconnected to the "AR-DV1 Tablet App Interface Web Adapter" hardware.
For details on each command used in this API, please refer to the AR-DV1COMMAND LIST.
2. Hardware requirements
-AR-DV1 receiver-"AR-DV1 Tablet App Interface Web Adapter" hardware, connected to the receiver-Network environment
3. API frame
API endpoints:[Address to the “AR-DV1 Tablet App Interface Web Adapter” hardware]:3000/api If you are accessing from within the network, the “AR-DV1 Tablet App Interface Web Adapter” hardware can be accessed with the 192.168.0.20 IP address.
Protocol:http
Character encoding:UTF-8
© 2019, AOR, LTD. 3
4. API list
No. Name Desc1 Autenticate Set authentication parameters2 Power Turn the receiver on or off3 ReceiverState Get the state of the receiver4 Time Set the receiver clock5 Frequency Set the receive frequency6 DemodulateMode Set the demodulation mode7 IFbandwidth Set or get the IF bandwidth8 FrequencyStep Set the frequency step9 FrequencyStepAdjust Set the step adjust value 10 DigitalDataOutput Toggle the digital header information on or off and g
et its state11 LevelSquelch Set or get the level squelch value12 Volume Set or get the receiver volume value13 VFO Set or get the VFO parameters14 DigitalAdditionalInfo Get the digital header information15 SpectrumCenter Set or get the spectrum’s center frequency16 SpectrumSpan Set or get the spectrum’s span value17 SpectrumData Get the spectrum graph data18 Smeter Get the S-Meter values19 ReceiverStateNotification Set the receiver state notifications interval20 Adapter Operate the “AR-DV1 Tablet App Interface Web Ad
apter” hardware21 CTCSS Set or get information from the tone squelch. 22 DCS Set or get information from the DCS squelch23 DCREncryptionCode Set or get the DCR/NXDN 15bit digital scrambling co
de value24 TTCSlot Select the slot number of the Tetra traffic channel
© 2019, AOR, LTD. 4
5. API details
1.Authenticate
Description:
This is the authentication API to take advantage of the API.
� Login
Content
Endpoint[POST] /adapter/login
HeaderContent-Type
application/json;charset=UTF-8request
passwordIf you are connecting to the「AR-DV1 Tablet App Interface Web Adapter」 hardware from inside the network, null is allowed.String
responseStatus code (code)
Number0
Normal-1
Authentication error-99
Abnormal termination
© 2019, AOR, LTD. 5
� Set a password
Content
Endpoint[POST] /adapter/password
HeaderContent-Type
application/json;charset=UTF-8request
passwordPassword when connecting from outside the 「AR-DV1 Tablet App Interface Web Adapter」 hardware’s network.MandatoryString
responseSatus code (code)
Number0
Normal-1
Authentication error-4
other error-99
Abnormal termination
© 2019, AOR, LTD. 6
2.Power
Description
To switch the receiver ON or OFF. When switching ON, allow 15 seconds until thereceiver is ready for use.
Content
Endpoint[POST] /receiver/power
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryString
'0'Switches the receiver OFF
'1'Switches the receiver ON
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 7
3.ReceiverState
Description
Get the current state of the receiver.
Content
Endpoint[GET] /receiver/receiver_state
HeaderContent-Type
application/json;charset=UTF-8request
-
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal terminationVFO mode (vfo)
String"A"
VFO-A"B"
VFO-B"Z"
VFO-Zfrequency (receive frequency)
NumberstepFrequency (Frequency step)
Number(in kHz)mode (receive mode)
Stringdan (code formatting). Same than the AR-DV1 command “MDdan”
smeter (S-meter value)Stringkkkc (code formatting). Same than the AR-DV1 command “LMkkkc”
© 2019, AOR, LTD. 8
4.Time
Description
Set the receiver clock.
Content
Endpoint[POST] /receiver/time
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryStringSpecify date and time in the YYMMDDHHmm format.
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 9
5.Frequency
Description
Set the receive frequency.
Content
Endpoint[POST] /receiver/frequency
HeaderContent-Type
application/json;charset=UTF-8request
Either the frequency’s value or the frequency step can be specified. If you specify both, the value applies.
valueNumberUnit: MHz
stepNumber
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 10
6.DemodulateMode
Description
Set the demodulation mode.
Content
Endpoint[POST] /receiver/demodulate_mode
HeaderContent-Type
application/json;charset=UTF-8request
Receive mode (value)MandatoryStringdan (code formatting). Same than the AR-DV1 command “MDdan”
d: Digital demodulation readout mode0 (digital off),1 (D-STAR),2 (YAESU),3 (ALINCO),4 (D-CR/NXDN),5 (P25),6 (dPMR),7 (DMR)
a: Digital demodulation setting mode0 (digital auto),1 (D-STAR),2 (YAESU),3 (ALINCO),4 (D-CR/NXDN),5 (P25),6 (dPMR),7 (DMR),F (digital demodulation off)
n: Analog demodulation mode (Selections possible 0 to 6. Default is 0. If 1 to6, a is set to F.
0 (FM),1 (AM),2 (SAH),3 (SAL),4 (USB),5 (LSB),6 (CW)response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
© 2019, AOR, LTD. 11
7.IFbandwidth
Description
Set or get the IF bandwidth.
� Set
Content
Endpoint
[POST] /receiver/ifbandwidthHeader
Content-Typeapplication/json;charset=UTF-8
requestvalue
MandatoryStringThe IF bandwidth is specified in the code and depends on the analog demodulation mode in the settings. The code/value correspondence is as follows.
FM'0'
200KHz'1'
100KHz'2'
30kHz'3'
15KHz'4'
6KHzAM
'0'15KHz
'1'8KHz
'2'5.5KHz
'3'3.8KHz
SAH, SAL'0'
5.5KHz'1'
3.8KHzUSB, LSB
'0'2.6KHz
© 2019, AOR, LTD. 12
'1'1.8KHz
CW'0'
500Hz'1'
200Hzresponse
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
© 2019, AOR, LTD. 13
� Get
Content
Endpoint[GET] /receiver/ifbandwidth
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
IF bandwidth (value)String
© 2019, AOR, LTD. 14
8.FrequencyStep
Description
Set the frequency step.
Content
Endpoint[POST] /receiver/frequency_step
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryNumberUnit: kHz0.01, 0.05, 0.1, 0.5, 1.0, 2.0, 5.0, 6.25, 8.33, 9.0, 10.0, 12.5, 15.0, 20.0, 25.0, 30.0, 50.0, 100.0, 500.0
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 15
9.FrequencyStepAdjust
Description
Set or get the frequency step adjust value
� Set
Content
Endpoint[POST] /receiver/frequency_step_adjust
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryNumberUnit: kHz0.05, 0.25, 0.5, 1.0, 2.5, 3.12, 4.16, 4.5, 5.0, 6.25, 10.0, 12.5, 15.0, 25.0, 50.0, 250.0
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 16
� Get
Content
Endpoint[GET] /receiver/frequency_step_adjust
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Step adjust (value)Number
© 2019, AOR, LTD. 17
10.DigitalDataOutput
Description
Toggle the digital header information on or off and get its state.
� Set
Content
Endpoint[POST] /receiver/digital_data_output
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryStringToggles the digital information header on or off
'0'Toggle the digital information header OFF
'1'Toggle the digital information ON
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 18
� Get
Settings
Endpoint[GET] /receiver/digital_data_output
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Toggle the digital header informatio ON/OFF (value)String
© 2019, AOR, LTD. 19
11.LevelSquelch
Description
Set or get the level squelch value.
� Set
Content
Endpoint[POST] /receiver/level_squelch
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryNumberSpecify the level squlch value (0〜99, 0: Fully open, 99: Fully closed)
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 20
� Get
Content
Endpoint[GET] /receiver/level_squelch
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Level squelch (value)Number
© 2019, AOR, LTD. 21
12.Volume
Description
Set or get the receiver volume value.
� Set
Content
Endpoint[POST] /receiver/volume
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryNumber(0〜99, 0: Muted)
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 22
� Get
Content
Endpoint[GET] /receiver/volume
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Volume (value)Number
© 2019, AOR, LTD. 23
13.VFO
Description
Set or get the VFO parameters.
� Set
Content
Endpoint[POST] /receiver/vfo
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryString
'A'VFO-A
'B'VFO-B
'Z'VFO-Z
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 24
� Get
Retrieve the VFO information.
Content
Endpoint[GET] /receiver/vfo
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
VFO information (value)ArrayVFO information
MapVFO (vfo)
StringFrequency (frequency)
NumberFrequency step (stepFrequency)
NumberStep adjust (stepAdjustFrequency)
NumberMode (mode)
String
© 2019, AOR, LTD. 25
14.DigitalAdditionalInfo
Description
Get the digital header information.
Content
Endpoint[GET] /receiver/digital_additional_info
HeaderContent-Type
application/json;charset=UTF-8request
-
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal terminationDigital header information (value)
String
© 2019, AOR, LTD. 26
15.SpectrumCenter
Description
Set or get the spectrum’s center frequency
� Get
Content
Endpoint[GET] /spectrum_center
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Spectrum’s center frequency (value)Number
© 2019, AOR, LTD. 27
� Set
Content
Endpoint[POST] /spectrum_center
HeaderContent-Type
application/json;charset=UTF-8request
Spectrum’s center frequency (value)MandatoryNumber
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal terminationSpectrum’s center frequency (value)
Number
© 2019, AOR, LTD. 28
16.SpectrumSpan
Description
Set or get the spectrum span value.
� Get
Content
Endpoint[GET] /receiver/spectrum_span
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0Normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Spectrum span (value)Number
© 2019, AOR, LTD. 29
� Set
Content
Endpoint[POST] /receiver/spectrum_span
HeaderContent-Type
application/json;charset=UTF-8request
Spectrum span (value)MandatoryNumber
responseStatus code (code)
Number0
Normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 30
17.SpectrumData
Description
Get the spectrum graph data.
Content
Endpoint[GET] /receiver/spectrum_data
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Spectrum graph data (value)String
© 2019, AOR, LTD. 31
18.Smeter
Description
Get the S-meter values.
Content
Endpoint[GET] /receiver/smeter
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
valueString
© 2019, AOR, LTD. 32
19.ReceiverStateNotification
Description
Set the receiver state notifications interval.
Content
Endpoint[GET] /receiver/receiver_state_notification
HeaderContent-Type
application/json;charset=UTF-8request
valueMandatoryNumberSpecifies the interval between each notification. Interval: 0〜95。0 stops the notifications.
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 33
20.Adapter
� Shutdown
Description
Shuts down the “AR-DV1 Tablet App Interface Web Adapter” hardware.
Content
Endpoint[POST] /adapter/shutdown
HeaderContent-Type
application/json;charset=UTF-8request
-- response
Status code (code)Number
0normal
-1Authentication error
-4Other error
-99Abnormal termination
© 2019, AOR, LTD. 34
� Restart
Description
Restarts the “AR-DV1 Tablet App Interface Web Adapter” hardware.
Content
Endpoint[POST] /adapter/reboot
HeaderContent-Type
application/json;charset=UTF-8request
-- response
Status code (code)Number
0normal
-1Authentication error
-4Other error
-99Abnormal termination
© 2019, AOR, LTD. 35
� Network interface
Description
Get information on the network interface to which the “AR-DV1 Tablet App InterfaceWeb Adapter” is connected to.
Content
Endpoint[GET] /adapter/network_interfaces
HeaderContent-Type
application/json;charset=UTF-8request
-- response
Status code (code)Number
0normal
-1Authentication error
-4Other error
-99Abnormal termination
Network interface information (value)Array
Network interface nameString
Network interface information
ArrayIP address (address)
StringSubnet mask (netmask)
StringFamily (family)
StringMAC address (mac)
StringCIDR (cidr)
StringThe routing prefix is an IPv4 or IPv6 address as assigned by CIDR. If the netmask is invalid, this property is set to null.
Internal (internal)Boolean“True” for loopback network interface which cannot be remote accessed. “False” for else.
© 2019, AOR, LTD. 36
� Wireless network adapter
Description
Set up and get information on the wireless network adapter of the “AR-DV1 Tablet App Interface Web Adapter” hardware.
� Get
Content
Endpoint[GET] /adapter/wifi
HeaderContent-Type
application/json;charset=UTF-8request
-- response
Status code (code)Number
0normal
-1Authentication error
-4Other error
-99Abnormal termination
Wireless network adapter configuration information (value)Operation mode (operationMode)
String"a"
IEEE 802.11a"b"
IEEE 802.11b"g"
IEEE 802.11gCountry (country)
StringISO/IEC 3166-1
SSID(ssid)String
Channel number (channel)String
Pass phrase (passphrase)String
© 2019, AOR, LTD. 37
� Set up
Content
Endpoint[POST] /adapter/wifi
HeaderContent-Type
application/json;charset=UTF-8request
Operation mode (operationMode)MandatoryStringSets the operating mode of the wireless network adapter.
"a"IEEE 802.11a
"b"IEEE 802.11b
"g"IEEE 802.11g
Country (country)MandatoryStringSet up the country code as defined by ISO/IEC 3166-1.
SSID(ssid)MandatoryString
Channel number (channel)MandatoryString
Passphrase (passphrase)MandatoryString
responseStatus code (code)
Number0normal-1Authentication error-4Other error-99Abnormal termination
© 2019, AOR, LTD. 38
� SSH service
Description
Set the “AR-DV1 Tablet App Interface Web Adapter” hardware’s SSH service ON orOFF.
Content
Endpoint[POST] /adapter/ssh
HeaderContent-Type
application/json;charset=UTF-8request
SSH service ON/OFF (value)MandatoryString
"1"Sets SSH service to ON
"0"Sets SSH service to OFF
responseStatus code (code)
Number0normal-1Authentication error-4Other error-99Abnormal termination
© 2019, AOR, LTD. 39
21. CTCSS
Description
Set or get information from the tone squelch.
� Get
Content
Endpoint[GET] /receiver/ctcss
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
Tone squelch behavior (value)String
"0"OFF
"1"ON CTCSS
"2"ON REV.T
© 2019, AOR, LTD. 40
� Set
Content
Endpoint[POST] /receiver/ctcss
HeaderContent-Type
application/json;charset=UTF-8request
Tone squelch behavior (value)String
"0"OFF
"1"ON CTCSS
"2"ON REV.T
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 41
� Get the CTCSS tone frequency
Content
Endpoint[GET] /receiver/ctcss_frequency
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
CTCSS tone frequency (value)String01〜52Response value to the receiver’s CN command in nn format.If tone search is set, format is "99nn".nn = 00 ~ 52 00 represents a condition where no tone has been detected.
© 2019, AOR, LTD. 42
� Setup the CTCSS tone frequency
Content
Endpoint[POST] /receiver/ctcss_frequency
HeaderContent-Type
application/json;charset=UTF-8request
CTCSS tone frequency (value)String01〜52, 99Response value to the receiver’s CN command.
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 43
22. DCS
Description
Set or get information from the DCS squelch.
� Get
Content
Endpoint[GET] /receiver/dcs
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
DCS behavior (value)String
"0"OFF
"1"ON
© 2019, AOR, LTD. 44
� Set
Content
Endpoint[POST] /receiver/dcs
HeaderContent-Type
application/json;charset=UTF-8request
Tone squelch behavior (value)String
"0"OFF
"1"ON
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 45
� Get the DCS code value
Content
Enpoint[GET] /receiver/dcs_code
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
DCS code (value)String
Receiver command (DS) value in nnn format. "999nn" format if code search is set. If nnn is 000, it means that the tone has not been detected.017, 023, 025, 026, 031, 032, 036, 043, 047, 050, 051, 053, 054, 065, 071, 072, 073,074, 114, 115, 116, 122, 125, 131, 132, 134, 143, 145, 152, 155, 156, 162, 165, 172,174, 205, 212, 223, 225, 226, 243, 244, 245, 246, 251, 252, 255, 261, 263, 265, 266,271, 274, 306, 311, 315, 325, 331, 332, 343, 346, 351, 356, 364, 365, 371, 411, 412,413, 423, 431, 432, 445, 446, 452, 454, 455, 462, 464, 465, 466, 503, 506, 516, 523,526, 532, 546, 565, 606, 612, 624, 627, 631, 632, 654, 662, 664, 703, 712, 723, 731,732, 734, 743, 754, 999If code search is set, the format is "999nnn".If nnn is 000, it indicates that the tone is not detected.
© 2019, AOR, LTD. 46
� Set up the DCS code
Content
Endpoint[POST] /receiver/dcs_code
HeaderContent-Type
application/json;charset=UTF-8request
DCS code (value)StringReceiver command (DS) value in nnn format.
017, 023, 025, 026, 031, 032, 036, 043, 047, 050, 051, 053, 054, 065, 071, 072, 073, 074, 114, 115, 116, 122, 125, 131, 132, 134, 143, 145, 152, 155, 156, 162, 165, 172, 174, 205, 212, 223, 225, 226, 243, 244, 245, 246, 251, 252, 255, 261, 263, 265, 266, 271, 274, 306, 311, 315, 325, 331, 332, 343, 346, 351, 356, 364, 365, 371, 411, 412, 413, 423, 431, 432, 445, 446, 452, 454, 455, 462, 464, 465, 466, 503, 506, 516, 523, 526, 532, 546, 565, 606, 612, 624, 627, 631, 632, 654, 662, 664, 703, 712, 723, 731, 732, 734, 743, 754, 999999 is for code search.
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 47
23. DCREncryptionCode
Description
Get and set the DCR/NXDN 15bit digital scrambling code value
� Get
Content
Endpoint[GET] /receiver/dcr_encryption_code
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
15bit digital scrambling code (value)String00000〜32767
© 2019, AOR, LTD. 48
� Set
Content
Endpoint[POST] /receiver/dcr_encryption_code
HeaderContent-Type
application/json;charset=UTF-8request
15bit digital scrambling code (value)String00000〜32767
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 49
24. TTCSlot
Description
Get and set the slot number of Tetra’s traffic channel
� Get
Content
Endpoint[GET] /receiver/ttcslot
HeaderContent-Type
application/json;charset=UTF-8request
- response
Status code (code)Number
0normal
-1Authentication error
-2Canceled due to other APIs still running
-3No response from receiver
-4Other error
-99Abnormal termination
T-TC slot number (value)Stringsn formats: 0 (not received), 1~4 (slot currently received)n: Set value 0 (AUTO), 1~4 (selected slot number)Response of receiver command TS.
© 2019, AOR, LTD. 50
� Set
Content
Endpoint[POST] /receiver/ttcslot
HeaderContent-Type
application/json;charset=UTF-8request
T-TC slot number (value)String“0”
AUTO“1”
Slot 1“2”
Slot 2“3”
Slot 3“4”
Slot 4Response of receiver command TS.
responseStatus code (code)
Number0
normal-1
Authentication error-2
Canceled due to other APIs still running-3
No response from receiver-4
Other error-99
Abnormal termination
© 2019, AOR, LTD. 51
6. WebSocket API
It is an API that utilizes the server-driven function using WebSocket.
Endpoint URL
ws://[AR-DV1 Tablet App Interface Web Adapter’s address]:3000If from within the same network, the “AR-DV1 Tablet App Interface Web Adapter” hardware can be accessed via the local IP address [192.168.0.20].
Procedure
To use the WebSocket API, you need first to be authenticated before via the login API.
API list
No. Name Descriptionw-1 Sound API to get sound from the receiverw-2 ReceiverState API that gets periodic notifications from the receiverw-3 DigitalAdditionalInfo API to receive notifications when the receiver receives
digital collateral information
w-1. Sound
API to get sound from the receiver.
Receive (onmessage)
Audio information
PCM data
ArrayBuffer
Format: S16LE
w-2. ReceiverState
API that gets periodic notifications from the receiver
By previsouly settings up the ReceiverStateNotification API to enable periodic notific
ations, as described chapter 19, settings, you will be able to receive the receiving sta
tus that the receiver sends periodically.
Receive (onmessage)
String of characters
String
Returns a JSON-formatted string.
Received commands (command)
"Rx"
Received contents (data)
VFO mode (vfo)
"A"
© 2019, AOR, LTD. 52
VFO-A
"B"
VFO-B
"Z"
VFO-Z
Reception frequency (frequency)
Step frequency (stepFrequency)
Demodulation mode (mode)
Code format (dan). Same as the AR-DV1 command (MDdan)
S-meter value (smeter)
Code format (kkkc). Same as the AR-DV1 command (Lmkkkc)
w-3. DigitalAdditionalInfo
API to receive notifications when the receiver receives digital collateral information.
By previsouly settings up the DigitalDataOutput API to enable notifications, as descri
bed chapter 10, you will be notified of digital incidental information from the receiver.
Receive (onmessage)
String of characters
String
Returns a JSON-formatted string.
Received commands (command)
"DK"
Received contents (data)
Digital incidental information
© 2019, AOR, LTD. 53
Memo:
© 2019, AOR, LTD. 54
®AOR, LTD.www.aorja.com
Authority On Radio Communications
© 2019, AOR, LTD.
(v1.2 20190419)
