List of R2D2 Commands: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
Tag: 2017 source edit
 
(30 intermediate revisions by the same user not shown)
Line 5: Line 5:
!Category
!Category
|-
|-
| [[R2D2 - BackupCDR|BackupCDR]]|| Backup CDR files
| [[BackupCDR|BackupCDR]]|| Backup CDR files
|BackupFileName
|BackupFileName
|[[R2D2 Error Codes|Error Code]] in case of error
|[[R2D2 Error Codes|Error Code]] in case of error
|CDR
|CDR
|-
|-
|[[R2D2 - DeletePortLogs|DeletePortLogs]]
|[[DeletePortLogs|DeletePortLogs]]
|Delete Logs of a Port
|Delete Logs of a Port
|PortIndex
|PortIndex
Line 16: Line 16:
|Logs
|Logs
|-
|-
|[[R2D2 - GetCDR|GetCDR]]
|[[GetCDR|GetCDR]]
|Get CDR File Path
|Get CDR File Path
|None.
|None.
Line 22: Line 22:
|CDR
|CDR
|-
|-
|[[R2D2 - GetCDRLine|GetCDRLine]]
|[[GetCDRLine|GetCDRLine]]
|Get Line of CDR File
|Get Line of CDR File
|PortIndex, CdrFileName, LineNumber
|PortIndex CdrFileName LineNumber
|CdrLine, [[R2D2 Error Codes|Error Code]] in case of error
|CdrLine, [[R2D2 Error Codes|Error Code]] in case of error
|CDR
|CDR
|-
|-
|[[R2D2 - ResetCDR|ResetCDR]]
|[[ResetCDR|ResetCDR]]
|Purges CDR, GSM and Data Logs
|Purges CDR, GSM and Data Logs
|None.
|None.
Line 34: Line 34:
|CDR
|CDR
|-
|-
|[[R2D2 - StartPortLog|StartPortLog]]
|[[StartPortLog|StartPortLog]]
|Start Log for a Port
|Start Log for a Port
|PortIndex, UniqueID
|PortIndex UniqueID
|[[R2D2 Error Codes|Error Code]] in case of error
|[[R2D2 Error Codes|Error Code]] in case of error
|Logs
|Logs
|-
|-
|[[R2D2 - StopPortLog|StopPortLog]]
|[[StopPortLog|StopPortLog]]
|Stop Log for a Port
|Stop Log for a Port
|PortIndex, UniqueID
|PortIndex UniqueID
|[[R2D2 Error Codes|Error Code]] in case of error
|[[R2D2 Error Codes|Error Code]] in case of error
|Logs
|Logs
|-
|-
|[[R2D2 - GsmRegistrationMode|GsmRegistrationMode]]
|[[GsmRegistrationMode|GsmRegistrationMode]]
|Set/Get GSM Auto Registration Mode
|Set/Get GSM Auto Registration Mode
|Port index, [Registration mode]
|Port index [Registration mode]
|Command status or Registration mode
|Command status or Registration mode
|Network
|Network
|-
|-
|[[R2D2 - GetModemInfo|GetModemInfo]]
|[[GetModemInfo|GetModemInfo]]
|Get Modem Informations
|Get Modem Informations
|Port Index
|PortIndex
|Modem informations
|Modem informations
|General
|General
|-
|-
|ImsiAttach
|[[ImsiAttach|ImsiAttach]]
|
|Attach a SIM to the Network
|
|PortIndex
|
|[[R2D2 Error Codes|Error Code]] in case of error
|
|Network
|-
|[[ImsiDetach|ImsiDetach]]
|Detach a SIM from the Network
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Network
|-
|[[ImsiStatus|ImsiStatus]]
|Get SIM Registration status
|PortIndex
|IMSI status (ATTACHED or DETACHED)
|Network
|-
|[[StartGsmPort|StartGsmPort]]
|Open/Start a GSM Port
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|General
|-
|[[StopGsmPort|StopGsmPort]]
|Close/Stop a GSM Port
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|General
|-
|[[SendAtCommand|SendAtCommand]]
|Send AT Command to GSM Port
|PortIndex ATCommand
|Response from the GSM modem
|General
|-
|[[SendSmsText|SendSmsText]]
|Send a specified Text as a SMS
|PortIndex Number SMS text [SMSC [Timeout]]   
|[[R2D2 Error Codes|Error Code]] in case of error
|SMS
|-
|[[GetSmsCenter|GetSmsCenter]]
|Get SMS Centers numbers
|PortIndex
|SMS Centers Numbers
|SMS
|-
|[[SetSmsCenter|SetSmsCenter]]
|Set SMS Center Number
|PortIndex SMSNumber
|[[R2D2 Error Codes|Error Code]] in case of error
|SMS
|-
|[[ConnectData|ConnectData]]
|Establish Data Connection
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Data
|-
|[[GetDataStatus|GetDataStatus]]
|Get Status of the Data Connection
|PortIndex
|Data Status
|Data
|-
|[[SetDataParameters|SetDataParameters]]
|Set Data Connection parameters
|Port index APN UserName Password [...]
|[[R2D2 Error Codes|Error Code]] in case of error
|Data
|-
|-
|ImsiDetach
|[[GetDataParameters|GetDataParameters]]
|
|Get Data Connection Parameters
|
|PortIndex
|
|[[R2D2 Error Codes|Error Code]] in case of error
|
|Data
|-
|-
|ImsiStatus
|[[DisconnectData|DisconnectData]]
|
|Disconnect Data Connection
|
|PortIndex
|
|[[R2D2 Error Codes|Error Code]] in case of error
|
|Data
|-
|[[AcceptCall|AcceptCall]]
|Accept a Call
|PortIndex
|Status (CONNECTED or NO INCOMING CALL)
|Voice
|-
|[[GetGsmAudioMode|GetGsmAudioMode]]
|Get the port audio mode
|PortIndex
|Audio mode configured
|Voice
|-
|[[HangupCall|HangupCall]]
|Hangs up an existing call
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlaceCall|PlaceCall]]
|Place a call
|PortIndex, DetinationNumber
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlaceCallAndPlay|PlayCallAndPlay]]
|Place a call and play a wav file
|PortIndex,DestinationNumber,WavFile,CallDuration,[Timeout]
|Call Status, [[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlaceCallAndWaitConnect|PlaceCallAndWaitConnect]]
|Place a call and wait until call is connected
|PortIndex,DestinationNumber,Timeout]
|Call Status
|Voice
|-
|[[PlaceShortCall|PlaceShortCall]]
|Place a call and disconnect within one second
|PortIndex,DestinationNumber,Duration(ms)
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlayVoice|PlayVoice]]
|Disconnect Data Connection
|PortIndex,WavFileToPlay,[PlayEverFlag]
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[RecordVoice|RecordVoice]]
|Disconnect Data Connection
|PortIndex,WavFile,[PCMSampleRate16bits]
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[SendDtmf|SendDtmf]]
|Play a set of DTMF
|PortIndex,DTMFSequence
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[StopRecording|StopRecording]]
|Stop voice recording
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitAcceptCallAndRecord|WaitAcceptCallAndRecord]]
|Wait Call and record audio file
|PortIndex,WavFile,[Timeout],[PCM16Flag]
|Calling Number, [[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitAndAcceptCall|WaitAndAcceptCall]]
|Wait incoming call and connect it
|PortIndex, [Timeout]
|Calling Number,[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitAndRejectCall|WaitAndRejectCall]]
|Wait incoming call and reject it
|PortIndex, [Timeout], [Reject Cause]
|Calling Number,[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitCall|WaitCall]]
|Wait call
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|}
|}
See Also:
* [[R2D2 API architecture|R2D2 API Architecture]]
* [[R2D2 API Description]]

Latest revision as of 10:55, 27 March 2025

R2D2 Command Description Input Arguments Returns Category
BackupCDR Backup CDR files BackupFileName Error Code in case of error CDR
DeletePortLogs Delete Logs of a Port PortIndex Error Code in case of error Logs
GetCDR Get CDR File Path None. CDR File Path CDR
GetCDRLine Get Line of CDR File PortIndex CdrFileName LineNumber CdrLine, Error Code in case of error CDR
ResetCDR Purges CDR, GSM and Data Logs None. None. CDR
StartPortLog Start Log for a Port PortIndex UniqueID Error Code in case of error Logs
StopPortLog Stop Log for a Port PortIndex UniqueID Error Code in case of error Logs
GsmRegistrationMode Set/Get GSM Auto Registration Mode Port index [Registration mode] Command status or Registration mode Network
GetModemInfo Get Modem Informations PortIndex Modem informations General
ImsiAttach Attach a SIM to the Network PortIndex Error Code in case of error Network
ImsiDetach Detach a SIM from the Network PortIndex Error Code in case of error Network
ImsiStatus Get SIM Registration status PortIndex IMSI status (ATTACHED or DETACHED) Network
StartGsmPort Open/Start a GSM Port PortIndex Error Code in case of error General
StopGsmPort Close/Stop a GSM Port PortIndex Error Code in case of error General
SendAtCommand Send AT Command to GSM Port PortIndex ATCommand Response from the GSM modem General
SendSmsText Send a specified Text as a SMS PortIndex Number SMS text [SMSC [Timeout]] Error Code in case of error SMS
GetSmsCenter Get SMS Centers numbers PortIndex SMS Centers Numbers SMS
SetSmsCenter Set SMS Center Number PortIndex SMSNumber Error Code in case of error SMS
ConnectData Establish Data Connection PortIndex Error Code in case of error Data
GetDataStatus Get Status of the Data Connection PortIndex Data Status Data
SetDataParameters Set Data Connection parameters Port index APN UserName Password [...] Error Code in case of error Data
GetDataParameters Get Data Connection Parameters PortIndex Error Code in case of error Data
DisconnectData Disconnect Data Connection PortIndex Error Code in case of error Data
AcceptCall Accept a Call PortIndex Status (CONNECTED or NO INCOMING CALL) Voice
GetGsmAudioMode Get the port audio mode PortIndex Audio mode configured Voice
HangupCall Hangs up an existing call PortIndex Error Code in case of error Voice
PlaceCall Place a call PortIndex, DetinationNumber Error Code in case of error Voice
PlayCallAndPlay Place a call and play a wav file PortIndex,DestinationNumber,WavFile,CallDuration,[Timeout] Call Status, Error Code in case of error Voice
PlaceCallAndWaitConnect Place a call and wait until call is connected PortIndex,DestinationNumber,Timeout] Call Status Voice
PlaceShortCall Place a call and disconnect within one second PortIndex,DestinationNumber,Duration(ms) Error Code in case of error Voice
PlayVoice Disconnect Data Connection PortIndex,WavFileToPlay,[PlayEverFlag] Error Code in case of error Voice
RecordVoice Disconnect Data Connection PortIndex,WavFile,[PCMSampleRate16bits] Error Code in case of error Voice
SendDtmf Play a set of DTMF PortIndex,DTMFSequence Error Code in case of error Voice
StopRecording Stop voice recording PortIndex Error Code in case of error Voice
WaitAcceptCallAndRecord Wait Call and record audio file PortIndex,WavFile,[Timeout],[PCM16Flag] Calling Number, Error Code in case of error Voice
WaitAndAcceptCall Wait incoming call and connect it PortIndex, [Timeout] Calling Number,Error Code in case of error Voice
WaitAndRejectCall Wait incoming call and reject it PortIndex, [Timeout], [Reject Cause] Calling Number,Error Code in case of error Voice
WaitCall Wait call PortIndex Error Code in case of error Voice
Retrieved from "https://wiki.ultiroam.com/index.php?title=List_of_R2D2_Commands&oldid=4346"