gsmVoLTEEnable (Function)

Top  Previous  Next

Architecture:

NX32L

Device support:

All

Firmware version:

2.30.00


This function attempts to enable or disable Voice over LTE (VoLTE) on the device. VoLTE support varies by network and configuration.

 

Use gsmVoLTEStatus() to verify if the operation was successful.

 

Enabling VoLTE sets it persistently. Therefore, it should typically be configured only once per SIM card and network.

 

Important: On NX devices, this operation may take some time. On LX devices, a system restart may occur, which will also take time. For LX devices, implement a mechanism to prevent repeated calls to gsmVoLTEEnable() on unsupported networks/SIMs to avoid boot loops.

 

 

 

Input:

enable: BOOL (default: TRUE)

Set to true to try to enable VoLTE.

 

Returns: INT

1

Success

0

Not supported.

-1

Not an LTE module.

-2

No SIM card present.

-3

No power to the LTE engine.

-4

Could not enable VoLTE.

 

Declaration:

FUNCTION gsmVoLTEEnable : INT;
VAR_INPUT
  enable : BOOL := TRUE;
END_VAR;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
 
// Turn on power to the GSM module
gsmPower(power := TRUE);
 
BEGIN
  ...
  // Enable VoLTE
  gsmVoLTEEnable(enable := TRUE);
  ...
END;
 
END_PROGRAM;