def execute_hard_handover(self):
"""
This function performs a hard handover.
:raise TestEquipmentException: call to ExecuteHardHandover3G driver function failed
"""
(err, msg) = W.ExecuteHardHandover(self.get_root())
self._error_check(err, msg)
def set_scrambling_code(self, code):
"""
Sets the scrambling code
:type code: integer
:param code: the scrambling code to set
"""
(err, msg) = W.SetScramblingCode(self.get_root(), code)
self._error_check(err, msg)
def set_gsm_neighbor_cell_states(self, states):
"""
Sets GSM neighbor cell states
:type states: array
:param states: contains the states of the 8 cells to set (see doc1)
"""
(err, msg) = W.SetGsmNeighborCellStates(self.get_root(), states)
self._error_check(err, msg)
def set_ms_power(self, mspower):
"""
Sets the mobile station power
:type mspower: integer
:param mspower: the expected power level from the UE to set
"""
(err, msg) = W.SetMsPower(self.get_root(), mspower)
self._error_check(err, msg)
def set_downlink_arfcn(self, arfcn):
"""
Sets the downlink ARFCN
:type arfcn: integer
:param arfcn: the downlink ARFCN to set
"""
(err, msg) = W.SetDownlinkArfcn(self.get_root(), arfcn)
self._error_check(err, msg)
def set_cell_power(self, bch_power):
"""
Sets the cell power
:type bchPower: double
:param bchPower: cell power to set
"""
(err, msg) = W.SetCellPower(self.get_root(), bch_power)
self._error_check(err, msg)
def set_lac(self, lac):
"""
Sets the local area code.
:type lac: long
:param lac: local area code to set.
"""
(err, msg) = W.SetLAC(self.get_root(), lac)
self._error_check(err, msg)
def set_dpch_level(self, level):
"""
Sets DPCH level
:type level: double
:param level: the DPCH level to set
"""
(err, msg) = W.SetDpchLevel(self.get_root(), level)
self._error_check(err, msg)
def set_periodic_location_update_timer(self, period):
"""
Sets periodic location update timer
:type period: integer
:param period: T312 link establishment timer to set
(in decihours 0 to 255)
"""
(err, msg) = W.SetPeriodicLocationUpdateTimer(self.get_root(), period)
self._error_check(err, msg)
def set_mcc(self, code):
"""
Sets the mobile country code
:type code: integer
:param code: the Mobile Country Code to set.
An integer from 0 to 999.
"""
(err, msg) = W.SetMCCode(self.get_root(), code)
self._error_check(err, msg)
def set_intra_freq_neighbor_cell_states(self, states):
"""
Sets intra frequency neighbor cell states
:type states: array
:param states: contains intra frequency neighbor states
of the 8 cells to set
"""
(err, msg) = W.SetIntraFreqNeighborCellStates(self.get_root(), states)
self._error_check(err, msg)
def set_mnc(self, code):
"""
Sets the mobile network code
:type code: integer
:param code: the Mobile Network Code to set.
An integer from 0 to 99 for other bands.
"""
(err, msg) = W.SetMNCode(self.get_root(), code)
self._error_check(err, msg)
def get_lac(self):
"""
Gets the local area code.
:rtype: long
:return: the local area code.
"""
(err, lac, msg) = W.GetLAC(self.get_root())
self._error_check(err, msg)
return lac
def set_srb_config_control(self, state):
"""
Sets SRB configuration control state
:type state: str
:param state: the desired state:
- "ON"
- "OFF"
"""
(err, msg) = W.SetSrbConfigControl(self.get_root(), state)
self._error_check(err, msg)
def set_ps_domain_information(self, domain):
"""
Sets the PS domain information present or not
:type domain: str
:param domain: the PS domain information to set. Possible values:
- "ABSENT"
- "PRESENT"
"""
(err, msg) = W.SetPSDomainInformation(self.get_root(), domain)
self._error_check(err, msg)
def set_dpch_state(self, state):
"""
Sets DPCH state
:type state: str
:param state: str representation of the desired state:
- "ON"
- "OFF"
"""
(err, msg) = W.SetDpchState(self.get_root(), state)
self._error_check(err, msg)
def set_uplink_channel_mode(self, state):
"""
Sets the uplnik channel mode
:type state: str
:param state: the state to set:
- "ON"
- "OFF"
"""
(err, msg) = W.SetUplinkChannelMode(self.get_root(), state)
self._error_check(err, msg)
def get_pcr_downlink_arfcn(self):
"""
Gets the PCR downlink ARFCN
:raise TestEquipmentException: call to GetPcrDownlinkArfcn3G driver function failed
:rtype: integer
:return: The actual PCR downlink ARFCN
"""
(err, pcr_arfcn, msg) = W.GetPcrDownlinkArfcn(self.get_root())
self._error_check(err, msg)
return int(pcr_arfcn)
def get_channel_power(self):
"""
Gets the channel power
:rtype: str
:return: the str representation of channel power or "NA" if the value
wasn't available when queried
"""
(err, power, msg) = W.GetChannelPower(self.get_root())
self._error_check(err, msg)
return power
def set_paging_service(self, service):
"""
Sets the paging service
:type service: str
:param service: the paging service to set. Possible values:
- "AMR"
- "GPRS"
- "RBT"
"""
(err, msg) = W.SetPagingService(self.get_root(), service)
self._error_check(err, msg)
def set_band_and_dl_arfcn(self, band, arfcn):
"""
Sets the band and the ARFCN. Checks if the ARFCN is valid for the specified band.
:type band: str
:param band: the band to set.
:type arfcn: integer
:param arfcn: the downlink ARFCN to set
"""
self.set_downlink_arfcn(arfcn)
if str(band).isdigit():
band = "BAND" + str(band)
if band in ["BAND5", "BAND6"]:
(err, msg) = W.SetBchBandIndicatorState(self.get_root(), "ON")
self._error_check(err, msg)
(err, msg) = W.SetBandArbitrator(self.get_root(), band)
self._error_check(err, msg)
elif band == "BAND4":
(err, msg) = W.SetTransmitSIB5bis(self.get_root(), band)
self._error_check(err, msg)
def set_uplink_arfcn(self, arfcn):
"""
Sets the uplink ARFCN
:type arfcn: integer
:param arfcn: the uplink ARFCN
:raise TestEquipmentException: failed to call SetUplinkArfcn
driver function
:rtype: integer
:return: the error code of the driver function
"""
(err, msg) = W.SetUplinkArfcn(self.get_root(), arfcn)
self._error_check(err, msg)
def set_drx_cycle(self, drx_cycle_length):
"""
Sets DRX cycle
:type drx_cycle_length: str
:param drx_cycle_length: DRX cycle length to set. Possible values:
- "FRAM64"
- "FRAM128"
- "FRAM256"
- "FRAM512"
"""
(err, msg) = W.SetDrxCycle(self.get_root(), drx_cycle_length)
self._error_check(err, msg)
def get_bch_update_page_state(self):
"""
This function gets the BCCH Update Page state
:rtype: str
:return: The BCCH Update Page state
- AUTO
- INHIBIT
"""
(err, state, msg) = W.GetBchUpdatePageState(self.get_root())
if state == "INH":
state = "INHIBIT"
self._error_check(err, msg)
return state
def set_bch_update_page_state(self, state):
"""
This function sets the BCCH Update Page state
:return: the str representation of channel power or "NA" if the value
:type state: str
:param state: The BCCH Update Page state:
- AUTO
- INHIBIT
wasn't available when queried
"""
if state == "INHIBIT":
state = "INH"
(err, msg) = W.SetBchUpdatePageState(self.get_root(), state)
self._error_check(err, msg)
def is_dut_registered(self, dut_imsi):
"""
Test if DUT is synchronized with equipment
:type dut_imsi: str
:param dut_imsi: IMSI retrieved from CDK.
:rtype: boolean
:return: true if the DUT is synchronized with the equipment, false otherwise
"""
dut_imsi = dut_imsi.replace('\n', '')
dut_imsi = dut_imsi.replace('"', '')
(err, imsi, msg) = W.GetReportedIMSI(self.get_root())
self._error_check(err, msg)
imsi = imsi.replace('"', '') # pylint: disable=E1101
return imsi == dut_imsi
def set_rbt_channel_type(self, channel_type):
"""
Sets the RBT channel type
:type channel_type: str
:param channel_type: the RBT channel type to set:
- "HSDParmc12" : (12.2k RMC + HSDPA)
- "HSParmc12" : (12.2k RMC + HSPA
- "HSPA"
- "RMC12" : (12.2k RMC)
- "RMC64" : (64k RMC)
- "RMC144" : (144k RMC)
- "RMC384" : (384k RMC)
- "RMC33NC" : (33k No Coding RMC)
- "RMCAM1264" : (12.2k UL/64k DL AM RMC) (active cell operating mode only)
- "RMCAM12144" : (12.2k UL/144k DL AM RMC) (active cell operating mode only)
- "RMCAM12384" : (12.2k UL/384k DL AM RMC) (active cell operating mode only)
- "RMCAM64384" : (64k UL/384k DL AM RMC) (active cell operating mode only)
"""
(err, msg) = W.SetRbtChannelType(self.get_root(), channel_type)
self._error_check(err, msg)
def set_cell_on(self, mimo=None):
"""
Turns on the cell.
"""
(err, msg) = W.SetCellActive(self.get_root())
self._error_check(err, msg)
def init_wcp_measurement(self):
"""
Initializes WCP measurements
"""
(err, msg) = W.InitWCPMeasurement(self.get_root())
self._error_check(err, msg)
def clear_ue_info(self):
"""
Clears UE information
"""
(err, msg) = W.ClearUeInfo(self.get_root())
self._error_check(err, msg)