List of R2D2 Commands
Jump to navigation
Jump to search
| 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 |