Ultiroam User Docs - User contributions [en]

MediaWiki:Sidebar

2025-03-27T11:57:06Z

Administrator:

*
** Main Page|INTRODUCTION
* UR Gateways
** PDF Documentation|PDF Documentation
** UR - Digit Map Syntax|Digit Map Syntax
** UR Gateways - FAQ|FAQs
* UR Gateways HTTP API
** HTTP API - Introduction|Introduction
** HTTP API - Send SMS|Send SMS
** HTTP API - Receive SMS|Receive SMS
** HTTP API - Query SMS Sending Result|Query SMS sending result
** HTTP API - Query SMS Delivery Status|Query SMS Delivery Status
** HTTP API - Query Number of SMS Messages to Be Sent|Query SMS Messages to Be Sent
** HTTP API - Stop SMS Sending Task|Stop SMS Sending Task
** HTTP API - Send USSD|Send USSD
** HTTP API - Query USSD Reply|Query USSD Reply
** HTTP API - MMS Configuration|MMS Configuration
** HTTP API - MMS File Upload|MMS File Upload
** HTTP API - Send MMS|Send MMS
** HTTP API - Query MMS Sending Status|Query MMS Sending Status
** HTTP API - Socks5 Proxy|Sock5 Proxy
** HTTP API - Get CDR|Get CDR
** HTTP API - Get Port Information of Gateway|Get Gateway Port Information
** HTTP API - Set Port Information of Gateway|Set Gateway Port Information
** HTTP API - Query STK Info|Query STK Info
** HTTP API - STK Operation|STK Operation
** HTTP API - Query STK Frame ID|Query STK Frame ID
** HTTP API - Get Device Status|Get Device Status
** HTTP API - Push Event|Push Events
** HTTP API - CALL Forward|Call Forward
** HTTP API - Get Configuration|Get Configuration
** HTTP API - Set Configuration|Set Configuration
** HTTP API - NAT|NAT
** HTTP API - FAQ|FAQ - Frequently Asked Questions
* UR R2D2 API Reference
** https://r2d2.ultiroam.com|R2D2 Wiki
** R2D2 API Architecture|R2D2 API Architecture
** R2D2 API Description|R2D2 API Description
** List of R2D2 Commands|List of R2D2 Commands
** Category:R2D2 | All R2D2 Commands
** CDR Files | R2D2 CDR Files
** CDR Data | R2D2 CDR Data
* Additional resources
** https://support.ultiroam.com|Ultiroam Support
** https://www.ultiroam.com|Ultiroam Web Site
** Sales Resources|Sales and Products Resources
* Changes
** recentchanges-url|recentchanges
* SEARCH
* TOOLBOX
* LANGUAGES

MediaWiki:Sidebar

2025-03-27T11:55:46Z

Administrator:

*
** Main Page|INTRODUCTION
* UR Gateways
** PDF Documentation|PDF Documentation
** UR - Digit Map Syntax|Digit Map Syntax
** UR Gateways - FAQ|FAQs
* UR Gateways HTTP API
** HTTP API - Introduction|Introduction
** HTTP API - Send SMS|Send SMS
** HTTP API - Receive SMS|Receive SMS
** HTTP API - Query SMS Sending Result|Query SMS sending result
** HTTP API - Query SMS Delivery Status|Query SMS Delivery Status
** HTTP API - Query Number of SMS Messages to Be Sent|Query SMS Messages to Be Sent
** HTTP API - Stop SMS Sending Task|Stop SMS Sending Task
** HTTP API - Send USSD|Send USSD
** HTTP API - Query USSD Reply|Query USSD Reply
** HTTP API - MMS Configuration|MMS Configuration
** HTTP API - MMS File Upload|MMS File Upload
** HTTP API - Send MMS|Send MMS
** HTTP API - Query MMS Sending Status|Query MMS Sending Status
** HTTP API - Socks5 Proxy|Sock5 Proxy
** HTTP API - Get CDR|Get CDR
** HTTP API - Get Port Information of Gateway|Get Gateway Port Information
** HTTP API - Set Port Information of Gateway|Set Gateway Port Information
** HTTP API - Query STK Info|Query STK Info
** HTTP API - STK Operation|STK Operation
** HTTP API - Query STK Frame ID|Query STK Frame ID
** HTTP API - Get Device Status|Get Device Status
** HTTP API - Push Event|Push Events
** HTTP API - CALL Forward|Call Forward
** HTTP API - Get Configuration|Get Configuration
** HTTP API - Set Configuration|Set Configuration
** HTTP API - NAT|NAT
** HTTP API - FAQ|FAQ - Frequently Asked Questions
* UR R2D2 API Reference
** https://r2d2.ultiroam.com|R2D2 Wiki
** R2D2 API Architecture|R2D2 API Architecture
** R2D2 API Description|R2D2 API Description
** List of R2D2 Commands|List of R2D2 Commands
** All R2D2 Commands|Category:R2D2
** CDR Files | R2D2 CDR Files
** CDR Data | R2D2 CDR Data
* Additional resources
** https://support.ultiroam.com|Ultiroam Support
** https://www.ultiroam.com|Ultiroam Web Site
** Sales Resources|Sales and Products Resources
* Changes
** recentchanges-url|recentchanges
* SEARCH
* TOOLBOX
* LANGUAGES

Category:R2D2

2025-03-27T11:54:38Z

Administrator:

Category:CDR

2025-03-27T11:53:39Z

Administrator: Created page with "R2D2 CDR Management"

R2D2 CDR Management

Category:SMS

2025-03-27T11:52:49Z

Administrator: Created page with "R2D2 commands related to SMS and MMS"

R2D2 commands related to SMS and MMS

Category:R2D2

2025-03-27T11:51:47Z

Administrator:

Category:GENERAL

2025-03-27T11:50:55Z

Administrator: Created page with "General R2D2 commands"

General R2D2 commands

Category:NETWORK

2025-03-27T11:50:29Z

Administrator: Created page with "R2D2 Commands related to Mobile Network"

R2D2 Commands related to Mobile Network

Category:LOGS

2025-03-27T11:49:28Z

Administrator: Created page with "R2D2 Commands related to LOGS"

R2D2 Commands related to LOGS

Category:R2D2

2025-03-27T11:48:55Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

[[:Category:DATA|DATA]] - [[:Category:Voice|Voice & Call]] - [[:Category:SMS|SMS]]
- [[:Category:Voice|CDR]] - [[:Category:General|General Admin -]] [[:Category:Logs|Logs -]] [[:Category:Network|Mobile Network]]

Category:R2D2

2025-03-27T11:48:02Z

Administrator:

Category:Voice

2025-03-27T11:46:00Z

Administrator: Created page with "R2D2 Commands related to Voice"

R2D2 Commands related to Voice

Category:R2D2

2025-03-27T11:45:26Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

[[:Category:DATA|DATA]]

Category:R2D2

2025-03-27T11:44:58Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

[[:Category:DATA]]

Category:R2D2

2025-03-27T11:41:01Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

[[:Category:Data]]

Category:R2D2

2025-03-27T11:40:22Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

[[Category:Data]]

Category:DATA

2025-03-27T11:39:47Z

Administrator: Created page with "R2D2 commands related to DATA"

R2D2 commands related to DATA

Category:R2D2

2025-03-27T11:38:53Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

[[:Category:Data|Data]]

Category:R2D2

2025-03-27T11:37:35Z

Administrator:

This is the list of all R2D2 commands sorted alphabetically.

You can also see commands specifics to some core functions :

Data

Category:R2D2

2025-03-27T11:34:05Z

Administrator: Created page with "Test"

Test

WaitAndReceiveSMS

2025-03-27T11:33:25Z

Administrator: added Category:R2D2 using HotCat

This command waits until a SMS is received on the specified GSM port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|WaitAndReceiveSms
|PortIndex,[Timeout]
|SMS origin number and text, in the case of error, Error Code
|}
'''OUTPUT'''

Command status in the following format:

"SMS RECEIVED from %s %s [%s]\n", origin_number, sms_text, sms_pdu

or

"SMS RECEIVED from MMS %s [%s]\n", sms_text, sms_pdu

"Incoming MMS from %s, Subject: %s, URL: [%s]", sender, subject, url

or

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">
~# WaitAndReceiveSms 0 240
SMS RECEIVED from 0612345678 “Hello?”
[079162393EF216278DAED35287360CC8F71D14969741F977FD07]

~# WaitAndReceiveSms 0 240
TIMEOUT EXPIRED
</syntaxhighlight>
[[Category:SMS]]
[[Category:R2D2]]

WaitAndReceiveAllSms

2025-03-27T11:33:13Z

Administrator: added Category:R2D2 using HotCat

This command waits until a SMS or MMS is received on the specified GSM port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|WaitAndReceiveAllSms
|PortIndex,[Timeout]
|SMS origin number and text, in the case of error, Error Code
|}
'''OUTPUT'''

Command status in the following format:

"SMS RECEIVED from %s %s [%s]\n", origin_number, sms_text, sms_pdu

or

"SMS RECEIVED from MMS %s [%s]\n", sms_text, sms_pdu

"Incoming MMS from %s, Subject: %s, URL: [%s]", sender, subject, url

or

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">

~# WaitAndReceiveAllSms 0 240
SMS RECEIVED from 0612345678 “How are you?” [07911326040000F0040B911346610089F60000208062917314080CC8F71D14969741F977FD07]

~ # WaitAndReceiveAllSms 0
SMS RECEIVED from MMS +381637380797 [07918361050090004406D0CDE61400F561401090346380550B05040B8423F00003A8020283687474703A2F2F3137322E31372E38362E352F6D6D732F776170656E633F6C6F636174696F6E3D3338313634363730353738325F636938692D303030313033267269643D30323200]
Incoming MMS from +381637380797/TYPE=PLMN, Subject: "", URL: [http://172.17.86.5/mms/wapenc?location=381646705782_ci8i-000103&rid=022]

~# WaitAndReceiveAllSms 0 240
TIMEOUT EXPIRED

</syntaxhighlight>

[[Category:SMS]]
[[Category:R2D2]]

WaitAndReceiveAllSms

2025-03-27T11:33:08Z

Administrator: added Category:SMS using HotCat

StopSmsReceiving

2025-03-27T11:32:44Z

Administrator: added Category:R2D2 using HotCat

This command stops automatic SMS receiving on the specified GSM port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|StopSmsReceiving
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

None

'''EXAMPLE'''<syntaxhighlight lang="text">

~# StopSmsReceiving 0

</syntaxhighlight>
[[Category:SMS]]
[[Category:R2D2]]

StartSmsReceiving

2025-03-27T11:32:27Z

Administrator: added Category:R2D2 using HotCat

This command enable the specified port to receive automatically SMS messages.

All received SMS will be read from SIM card, written to CDR file and then purged from the SIM card.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|StartSmsReceiving
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

None

'''EXAMPLE'''<syntaxhighlight lang="text">

~# StartSmsReceiving 0

</syntaxhighlight>
[[Category:SMS]]
[[Category:R2D2]]

SetSmsParameters

2025-03-27T11:32:09Z

Administrator: added Category:R2D2 using HotCat

This command allows to set SMS Center address for the specified GSM port and to set the following parameteres :

* delay between retry,
* SMS validity,
* Timeout (in seconds) for all SMS functions.

:; RetryDelay
:: Retry time must be a multiple of 5 in seconds.
:: The default value is 120 seconds.
:: 0 means no retry.
::

{| class="wikitable"
! colspan="3" |
|-
!Value
!Formula
!Comments
|-
|0 to 143
|(Value+1) x 5 minutes
|5 minutes intervals up to 12 hours
|-
|144 to 167
|12 hours + ((Value -143) x 30 minutes
|30 minutes intervals between 12:30 hours to 24 hours
|-
|168 to 196
|(Value - 166) x 1 day
|1 day intervals between 2 days to 30 days
|-
|197 to 255
|(Value - 192) x 1 week
|1 week intervals between 5 weeks to 63 weeks
|}
'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|SetSmsParameters
|Port index, SMS Center, [RetryDelay, Validity, Timeout]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

None

'''EXAMPLE'''<syntaxhighlight lang="text">

~# SetSmsParameters 0 +333600100100

</syntaxhighlight>

[[Category:SMS]]
[[Category:R2D2]]

SetSmsParameters

2025-03-27T11:32:05Z

Administrator: added Category:SMS using HotCat

SendSmsPduAndWaitDelivery

2025-03-27T11:31:56Z

Administrator: added Category:R2D2 using HotCat

This command sends a SMS using data from a specified PDU buffer on a given port and waits until the SMS Delivery Report is received or timeout (entered in seconds) expired.

The SMS Center number can be specified as an optional parameter.

Command returns as soon as the SMS is submitted to SMSC.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|SendSmsPduAndWaitDelivery
|Port index, PDU buffer, [Timeout]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

Command status in the following format:

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">

~# SendSmsPduAndWaitDelivery 0 "0011000A81607108879200000B25C8329BFD0651D1E939283D078541EDF27C1E3E97416937084AAC82CC6F793B4C07"
DELIVERY REPORT RECEIVED
Message reference(s): 76

~# SendSmsPduAndWaitDelivery 0 0011000A81607108879200000B25C8329BFD0651D1E939283D078541EDF27C1E3E97416937084AAC82CC6F793B4C07 50
TIMEOUT EXPIRED
</syntaxhighlight>
[[Category:SMS]]
[[Category:R2D2]]

SendSmsPdu

2025-03-27T11:31:46Z

Administrator: added Category:R2D2 using HotCat

This command sends a SMS using data from a specified PDU buffer on a given port.

The SMS Center number can be specified as an optional parameter.

Command returns as soon as the SMS is submitted to SMSC.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|SendSmsPdu
|Port index, PDU buffer, [SMSC number, Timeout]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

"SMS SENT to %s %s\n", dest_number, sms_text [smsc_number]

'''EXAMPLE'''<syntaxhighlight lang="text">

~# SendSmsPdu 0 "0011000A81607108879200000B25C8329BFD0651D1E939283D078541EDF27C1E3E97416937084AAC82CC6F793B4C07"
SMS SENT to 0617807829 "text from PDU buffer"
Message reference(s): 76

</syntaxhighlight>
[[Category:SMS]]
[[Category:R2D2]]

GetSmsParameters

2025-03-27T11:31:03Z

Administrator: added Category:R2D2 using HotCat

This command gets SMS Center number set in the robot and in the SIM for the specified GSM port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|GetSmsParameters
|PortIndex
|SMS Center
|}

'''OUTPUT''' SMSC number sets in R2D2 device and SMSC number sets in the SIM used by the robot.

'''EXAMPLE''' <syntaxhighlight lang="text">

~# GetSmsParameters 0
+333600100100 / +333600100100

~# GetSmsParameters 0
+333600100100 / SMSC unknown
</syntaxhighlight>
[[Category:SMS]]
[[Category:R2D2]]

WaitCall

2025-03-27T11:30:24Z

Administrator: added Category:R2D2 using HotCat

This command allows to wait for an incoming call on the specified GSM port.

Command returns as soon as incoming call is presented or specified optional timeout expired.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|WaitCall
|PortIndex, [Timeout(s)]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT''' Incoming call indication in the following format:

"CALLING %s\n", calling_number

or in the case that general/specified timeout expired:

"TIMEOUT EXPIRED\n"

'''EXAMPLE''' <syntaxhighlight lang="text">

~# WaitCall 0
CALLING +33612345678

~# WaitCall 2
TIMEOUT EXPIRED
</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

WaitAndAcceptCall

2025-03-27T11:30:12Z

Administrator: added Category:R2D2 using HotCat

This command allows to wait for an incoming call on the specified GSM port, and to accept it.

An optional timeout (in seconds) can be specified.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|WaitAndAcceptCall
|PortIndex,[Timeout(s)]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

GSM port call status in the following format:

"%s\n", call_status

'''EXAMPLE'''<syntaxhighlight lang="text">

~# WaitAndAcceptCall 1
CONNECTED 0612345678

~# WaitAndAcceptCall 0 120
TIMEOUT EXPIRED

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

WaitAcceptCallAndRecord

2025-03-27T11:29:58Z

Administrator: added Category:R2D2 using HotCat

This command allows to wait for an incoming call on the specified GSM port, to connect it and then to record voice to a specified WAV file (sample rate 8kHz, mono, 8 bits per sample, block-align 1, A-LAW coding).

An optional timeout (in seconds) can be specified.

Optional flag PCM16 can be added to record 16 bits per sample.

Command returns as soon as call is connected and the Robot starts to record.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|WaitAcceptCallAndRecord
|PortIndex, WavFilePath, [Timeout], [PCM16 flag]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

GSM port command status in the following format:

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">
~# WaitAcceptCallAndRecord 1 /mnt/sdcard/usr/wav/record.wav
CONNECTED 0612345678

~# WaitAndAcceptCall 0 /mnt/sdcard/usr/wav/record.wav 120
TIMEOUT EXPIRED

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

StopRecording

2025-03-27T11:29:50Z

Administrator: added Category:R2D2 using HotCat

This command stops recording voice on the specified GSM port.

Command returns as soon as the voice recording is stopped.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|StopRecording
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT''' Command status:

"%s\n", status (CONNECTED or NO INCOMING CALL)

'''EXAMPLE'''<syntaxhighlight lang="text">

~# StopRecording 0
RECORDING STOPPED

~# StopRecording 1
NO CALL

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

SendDtmf

2025-03-27T11:29:43Z

Administrator: added Category:R2D2 using HotCat

This command plays a DTMF sequence in the existing call on the specified GSM port.

Command returns as soon as the DTFM sequence is played.

Maximum length for the DTMF sequence is 32.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|SendDtmf
|PortIndex,DTMFSequence
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

Command status:

"%s\n", command_status (OK | ERROR)

'''EXAMPLE'''<syntaxhighlight lang="text">
~# SendDtmf 0 "12389612"
OK
</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

RecordVoice

2025-03-27T11:29:35Z

Administrator: added Category:R2D2 using HotCat

This command records voice to a WAV file (sample rate 8kHz, Mono, 8 bits per sample, block-align 1, A-LAW coding) in the existing call on the specified GSM port. Optional flag PCM16 can be added to record 16 bits per sample.

Command returns as soon as the recording starts

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|RecordVoice
|PortIndex, DestinationVoiceFile, [PCM16 flag]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

GSM port command status in the following format:

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">

~# RecordVoice 0 /mnt/sdcard/usr/wav/myrecord.wav PCM16
OK

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

PlayVoice

2025-03-27T11:29:27Z

Administrator: added Category:R2D2 using HotCat

This command injects audio file (sample rate 8kHz, Mono, 8 bits per sample, block-align 1, A-LAW coding) in the existing call on the specified GSM port.

Command returns as soon as the voice starts to play.

Voice file will be played in loop is the flag is set to 1

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|PlayVoice
|PortIndex,WavFilePath, [FlagForLoopPlay]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

GSM port command status in the following format:

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">
~# PlayVoice 0 /mnt/sdcard/usr/wav/play.wav 1
STARTED

~# PlayVoice 0 /mnt/sdcard/usr/wav/play.wav 1
CALL IS NOT CONNECTED
</syntaxhighlight>

[[Category:VOICE]]
[[Category:R2D2]]

PlayVoice

2025-03-27T11:29:23Z

Administrator: added Category:VOICE using HotCat

PlaceShortCall

2025-03-27T11:29:15Z

Administrator: added Category:R2D2 using HotCat

This command places a call from the specified GSM port and releases it after a given short time (between 1-999 milliseconds)

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|PlaceShortCall
|PortIndex, DestinationNumber, Duration(ms)
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT''' "OK" or GSM port call status in the following format:

"%s\n", call_status

'''EXAMPLE''' <syntaxhighlight lang="text">

~# PlaceShortCall 0 0612345678 500
OK

~# PlaceShortCall 0 0612345678 100
BUSY

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

PlaceCallAndWaitConnect

2025-03-27T11:29:07Z

Administrator: added Category:R2D2 using HotCat

Call This command places a call from the specified GSM port and waits until the call is connected, or if optional timeout (in seconds) expired.

Command returns Post Dial Delay (PDD) and Total calling time, all in milliseconds.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|PlaceCallAndWaitConnect
|PortIndex, Destination Number, [Timeout]
|Call Status
|}

'''OUTPUT''' GSM port call status in the following format:

"STATUS (%d)\n%s (%d)\n", pdd, call_status, total_calling_time

"%s (%d)\n", call_status, total_calling_time

'''EXAMPLE''' <syntaxhighlight lang="text">
~# PlaceCallAndWaitConnect 0 0612345678 45
NUMBER BUSY (1254)

~# PlaceCallAndWaitConnect 0 0612345678
ALERTING (2895)
CONNECTED (6587)

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

PlaceCallAndPlay

2025-03-27T11:28:54Z

Administrator: added Category:R2D2 using HotCat

This command places a new call from the specified GSM port and plays a voice WAV file (sample rate 8kHz, mono, 8 bits per sample, block-align 1, A-LAW coding).

The PlaceCallAndPlay command return once the call is connected and voice starts to play.

Voice Wav file is played continuously until specified call duration or optional timeout expire.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|PlaceCallAndPlay
|PortIndex, Destination number, Voice file path, Call Duration, [Timeout]
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

GSM port command status in the following format:

"%s\n", command_status

'''EXAMPLE'''<syntaxhighlight lang="text">

~# PlaceCallAndPlay 0 0612345678 /mnt/sdcard/usr/wav/voicequality.wav 15 15
CONNECTED
~# PlaceCallAndPlay 1 0612345678 /mnt/sdcard/usr/wav/voicequality.wav 30
NUMBER BUSY

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

PlaceCall

2025-03-27T11:28:43Z

Administrator: added Category:R2D2 using HotCat

This command allows to accept an incoming call once presented on the specified port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|PlaceCall
|PortIndex, Destination number
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

None 

'''EXAMPLE''' <syntaxhighlight lang="text">

~# PlaceCall 0 0612345678

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

HangupCall

2025-03-27T11:28:35Z

Administrator: added Category:R2D2 using HotCat

This command hangs up the call on the specified GSM port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|HangupCall
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error.
|}
'''OUTPUT'''

None

'''EXAMPLE'''<syntaxhighlight lang="text">

~# HangupCall 1

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

GetGsmAudioMode

2025-03-27T11:28:26Z

Administrator: added Category:R2D2 using HotCat

This command allows to get the audio mode configuration on a given port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|GetGsmAudioMode
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

Audio mode currently configured on the specified port.

'''EXAMPLE''' <syntaxhighlight lang="text">

~ # GetGsmAudioMode 1
USB

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

AcceptCall

2025-03-27T11:28:15Z

Administrator: added Category:R2D2 using HotCat

This command allows to accept an incoming call once presented on the specified port.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|AcceptCall
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''
Command status: 
"%s\n", status (CONNECTED or NO INCOMING CALL)

'''EXAMPLE''' <syntaxhighlight lang="text">

~# AcceptCall 0 
CONNECTED 

~# AcceptCall 2 
NO INCOMING CALL

</syntaxhighlight>
[[Category:Voice]]
[[Category:R2D2]]

DisconnectData

2025-03-27T11:28:03Z

Administrator: added Category:R2D2 using HotCat

This command disconnect the data session on the specified port.

'''COMMAND:'''
{| class="wikitable"
!Command
!Input Arguments
!Returns
|-
|DisconnectData
|Port index
|In case of Error, returns [[R2D2 Error Codes|Error Codes]]
|}
'''OUTPUT:'''

None.

'''EXAMPLE:'''<syntaxhighlight lang="text">
~# DisconnectData 0
DATA DOWN
</syntaxhighlight>
[[Category:DATA]]
[[Category:R2D2]]

GetDataParameters

2025-03-27T11:27:54Z

Administrator: added Category:DATA using HotCat

This command return the data parameters of GSM port.

'''COMMAND:'''
{| class="wikitable"
!Command
!Input Arguments
!Returns
|-
|GetDataParameters
|PortIndex
|In case of Error, returns [[R2D2 Error Codes|Error Codes]]
|}
'''OUTPUT:'''

None.

'''EXAMPLE:'''<syntaxhighlight lang="text">
~# GetDataParameters 0
APN : free
LOG : free
PWD : free

~# GetDataParameters 0
Data parameters not set

</syntaxhighlight>

[[Category:R2D2]]
[[Category:DATA]]

GetDataParameters

2025-03-27T11:27:50Z

Administrator: added Category:R2D2 using HotCat

SetDataParameters

2025-03-27T11:27:42Z

Administrator: added Category:R2D2 using HotCat

This command configures PDP parameters for data session on the specified GSM port; APN Name, PDP User Name, PDP password, connection timeout (seconds), PDP Header Compression flag, PDP Data Compression flag, IP Address, IP Network Mask, Primary DNS and Secondary DNS. These parameters are used in all further Data sessions.

'''COMMAND:'''
{| class="wikitable"
!Command
!Input Arguments
!Returns
|-
|SetDataParameters
|Port index APN, UserName Password [Timeout PDP_Header_Compression PDP_Data_Compression IP_Address IP_Mask Primary_DNS Secondary_DNS Authentication_type]
'''Authentication Type values''': NONE, CHAP or PAP,
P'''DP_Header_Compression:''' TRUE or FALSE,
'''PDP_Data_Compression:''' TRUE or FALSE
|In case of Error, returns [[R2D2 Error Codes|Error Codes]]
|}

'''OUTPUT:'''

None.

'''EXAMPLES:'''<syntaxhighlight lang="text">
~# SetDataParameters 0 free free free 1200
SUCCESS

~# SetDataParameters 0 free free free 1200 TRUE TRUE
SUCCESS

~# SetDataParameters 1 “internet” “gprs” “telenor” 30 TRUE FALSE 10.10.145.33
</syntaxhighlight>
[[Category:DATA]]
[[Category:R2D2]]

GetDataStatus

2025-03-27T11:27:30Z

Administrator: added Category:R2D2 using HotCat

This command return the status of the data session of the specified GSM port.

If GSM port is not registered to the mobile network, the command return the status of the GSM port.

'''COMMAND:'''
{| class="wikitable"
!Command
!Input Arguments
!Returns
|-
|GetDataStatus
|Port index
|Data Status
|}
'''OUTPUT:'''

None.

'''EXAMPLE:'''<syntaxhighlight lang="text">
~# GetDataStatus 0
CONNECTED
Address: 10.157.160.161
Dns1: 212.27.40.240
Dns2: 212.27.40.241
Interface: wwan0
Upload: 2428
Download: 0
StartTime: 22:11:41

~# GetDataStatus 0
DATA LINK IS DOWN

~# GetDataStatus 0
PORT NOT STARTED
</syntaxhighlight>
[[Category:DATA]]
[[Category:R2D2]]