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
 
(9 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
Line 28: Line 28:
|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
Line 40: Line 40:
|Logs
|Logs
|-
|-
|[[R2D2 - StopPortLog|StopPortLog]]
|[[StopPortLog|StopPortLog]]
|Stop Log for a Port
|Stop Log for a Port
|PortIndex UniqueID
|PortIndex UniqueID
Line 46: Line 46:
|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]
Line 52: Line 52:
|Network
|Network
|-
|-
|[[R2D2 - GetModemInfo|GetModemInfo]]
|[[GetModemInfo|GetModemInfo]]
|Get Modem Informations
|Get Modem Informations
|PortIndex
|PortIndex
Line 58: Line 58:
|General
|General
|-
|-
|[[R2D2 - ImsiAttach|ImsiAttach]]
|[[ImsiAttach|ImsiAttach]]
|Attach a SIM to the Network
|Attach a SIM to the Network
|PortIndex
|PortIndex
Line 64: Line 64:
|Network
|Network
|-
|-
|[[R2D2 - ImsiDetach|ImsiDetach]]
|[[ImsiDetach|ImsiDetach]]
|Detach a SIM from the Network
|Detach a SIM from the Network
|PortIndex
|PortIndex
Line 70: Line 70:
|Network
|Network
|-
|-
|[[R2D2 - ImsiStatus|ImsiStatus]]
|[[ImsiStatus|ImsiStatus]]
|Get SIM Registration status
|Get SIM Registration status
|PortIndex
|PortIndex
Line 76: Line 76:
|Network
|Network
|-
|-
|[[R2D2 - StartGsmPort|StartGsmPort]]
|[[StartGsmPort|StartGsmPort]]
|Open/Start a GSM Port
|Open/Start a GSM Port
|PortIndex
|PortIndex
Line 82: Line 82:
|General
|General
|-
|-
|[[R2D2 - StopGsmPort|StopGsmPort]]
|[[StopGsmPort|StopGsmPort]]
|Close/Stop a GSM Port
|Close/Stop a GSM Port
|PortIndex
|PortIndex
Line 88: Line 88:
|General
|General
|-
|-
|[[R2D2 - SendAtCommand|SendAtCommand]]
|[[SendAtCommand|SendAtCommand]]
|Send AT Command to GSM Port
|Send AT Command to GSM Port
|PortIndex ATCommand
|PortIndex ATCommand
Line 94: Line 94:
|General
|General
|-
|-
|[[R2D2 - SendSmsText|SendSmsText]]
|[[SendSmsText|SendSmsText]]
|Send a specified Text as a SMS
|Send a specified Text as a SMS
|PortIndex Number SMS text [SMSC [Timeout]]     
|PortIndex Number SMS text [SMSC [Timeout]]     
Line 100: Line 100:
|SMS
|SMS
|-
|-
|[[R2D2 - GetSmsCenter|GetSmsCenter]]
|[[GetSmsCenter|GetSmsCenter]]
|Get SMS Centers numbers
|Get SMS Centers numbers
|PortIndex
|PortIndex
Line 106: Line 106:
|SMS
|SMS
|-
|-
|[[R2D2 - SetSmsCenter|SetSmsCenter]]
|[[SetSmsCenter|SetSmsCenter]]
|Set SMS Center Number
|Set SMS Center Number
|PortIndex SMSNumber
|PortIndex SMSNumber
Line 112: Line 112:
|SMS
|SMS
|-
|-
|[[R2D2 - ConnectData|ConnectData]]
|[[ConnectData|ConnectData]]
|Establish Data Connection
|Establish Data Connection
|PortIndex
|PortIndex
Line 118: Line 118:
|Data
|Data
|-
|-
|[[R2D2 - GetDataStatus|GetDataStatus]]
|[[GetDataStatus|GetDataStatus]]
|Get Status of the Data Connection
|Get Status of the Data Connection
|PortIndex
|PortIndex
Line 124: Line 124:
|Data
|Data
|-
|-
|[[R2D2 - SetDataParameters|SetDataParameters]]
|[[SetDataParameters|SetDataParameters]]
|Set Data Connection parameters
|Set Data Connection parameters
|Port index APN, UserName Password [Timeout PDP_Header_Compression PDP_Data_Compression IP_Address IP_Mask Primary_DNS Secondary_DNS Authentication_type]  
|Port index APN UserName Password [...]  
|[[R2D2 Error Codes|Error Code]] in case of error
|[[R2D2 Error Codes|Error Code]] in case of error
|Data
|Data
|-
|-
|GetDataParameters
|[[GetDataParameters|GetDataParameters]]
|Get Data Connection Parameters
|Get Data Connection Parameters
|PortIndex
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|[[R2D2 Error Codes|Error Code]] in case of error
|Data
|Data
|-
|[[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
|}
|}

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"