from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.StructBase import StructBase
from ......Internal.ArgStruct import ArgStruct
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PconfigurationCls:
"""
| Commands in total: 25
| Subgroups: 1
| Direct child commands: 20
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pconfiguration", core, parent)
@property
def data(self):
"""
| Commands in total: 5
| Subgroups: 0
| Direct child commands: 5
"""
if not hasattr(self, '_data'):
from .Data import DataCls
self._data = DataCls(self._core, self._cmd_group)
return self._data
# noinspection PyTypeChecker
[docs]
def get_acknowledgement(self) -> enums.BtoAckNldgmt:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:ACKNowledgement`` \n
Snippet: ``value: enums.BtoAckNldgmt = driver.source.bb.btooth.pconfiguration.get_acknowledgement()`` \n
Sets the ARQN bit of the packet header..
:return: acknowledgement: NAK | ACK NAK Request to retransmit the previous payload. ACK Previous payload has been received successfully.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:ACKNowledgement?')
return Conversions.str_to_scalar_enum(response, enums.BtoAckNldgmt)
# noinspection PyTypeChecker
[docs]
class BdaLapStruct(StructBase):
"""
Structure for reading output parameters. Fields: \n
- Bda_Lap: str: numeric Range: #H000000 to #HFFFFFF
- Bitcount: int: integer Range: 8 to 24
"""
__meta_args_list = [
ArgStruct.scalar_raw_str('Bda_Lap'),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Bda_Lap: str=None
self.Bitcount: int=None
[docs]
def get_bda_lap(self) -> BdaLapStruct:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:BDALap`` \n
Snippet: ``value: BdaLapStruct = driver.source.bb.btooth.pconfiguration.get_bda_lap()`` \n
Sets the lower address part of Bluetooth Device Address. The length of LAP is 24 bits or 6 hexadecimal figures.
:return: structure: for return value, see the help for BdaLapStruct structure arguments.
"""
return self._core.io.query_struct('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:BDALap?', self.__class__.BdaLapStruct())
# noinspection PyTypeChecker
[docs]
class BdaNapStruct(StructBase):
"""
Structure for reading output parameters. Fields: \n
- Bda_Nap: str: numeric Range: #H0000 to #HFFFF
- Bitcount: int: integer Range: 16 to 16
"""
__meta_args_list = [
ArgStruct.scalar_raw_str('Bda_Nap'),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Bda_Nap: str=None
self.Bitcount: int=None
[docs]
def get_bda_nap(self) -> BdaNapStruct:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:BDANap`` \n
Snippet: ``value: BdaNapStruct = driver.source.bb.btooth.pconfiguration.get_bda_nap()`` \n
Enters the non-significant address part of Bluetooth Device Address. The length of NAP is 16 bits or 4 hexadecimal
figures.
:return: structure: for return value, see the help for BdaNapStruct structure arguments.
"""
return self._core.io.query_struct('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:BDANap?', self.__class__.BdaNapStruct())
# noinspection PyTypeChecker
[docs]
class BdaUapStruct(StructBase):
"""
Structure for reading output parameters. Fields: \n
- Bda_Uap: str: numeric Range: #H00 to #HFF
- Bitcount: int: integer Range: 8 to 8
"""
__meta_args_list = [
ArgStruct.scalar_raw_str('Bda_Uap'),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Bda_Uap: str=None
self.Bitcount: int=None
[docs]
def get_bda_uap(self) -> BdaUapStruct:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:BDAUap`` \n
Snippet: ``value: BdaUapStruct = driver.source.bb.btooth.pconfiguration.get_bda_uap()`` \n
Enters the upper address part of Bluetooth Device Address. The length of UAP is 8 bits or 2 hexadecimal figures.
:return: structure: for return value, see the help for BdaUapStruct structure arguments.
"""
return self._core.io.query_struct('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:BDAUap?', self.__class__.BdaUapStruct())
[docs]
def get_byte_interleaving(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:BYTEInterleaving`` \n
Snippet: ``value: bool = driver.source.bb.btooth.pconfiguration.get_byte_interleaving()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:BYTEInterleaving?')
return Conversions.str_to_bool(response)
# noinspection PyTypeChecker
[docs]
class CoDeviceStruct(StructBase):
"""
Structure for reading output parameters. Fields: \n
- Co_Device: str: numeric Range: #H000000 to #HFFFFFF
- Bitcount: int: integer Range: 24 to 24
"""
__meta_args_list = [
ArgStruct.scalar_raw_str('Co_Device'),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Co_Device: str=None
self.Bitcount: int=None
[docs]
def get_co_device(self) -> CoDeviceStruct:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:CODevice`` \n
Snippet: ``value: CoDeviceStruct = driver.source.bb.btooth.pconfiguration.get_co_device()`` \n
A parameter received during the device discovery procedure, indicates the type of device and which types of service that
are supported.
:return: structure: for return value, see the help for CoDeviceStruct structure arguments.
"""
return self._core.io.query_struct('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:CODevice?', self.__class__.CoDeviceStruct())
[docs]
def get_dlength(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:DLENgth`` \n
Snippet: ``value: int = driver.source.bb.btooth.pconfiguration.get_dlength()`` \n
Sets the payload data length in bytes.
:return: dlength: integer Range: 0 to depends on packet type
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:DLENgth?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_dsf_packet(self) -> enums.BtoDataSourForPck:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:DSFPacket`` \n
Snippet: ``value: enums.BtoDataSourForPck = driver.source.bb.btooth.pconfiguration.get_dsf_packet()`` \n
Selects the data source for the selected packet type.
:return: dsf_packet: PEDit | ADATa PED Enables the 'Packet Editor'. All packet fields can be configured individually. ADAT Fills the generated packets with the selected data source. Useful if predefined data contents are loaded with a data list file or the data contents of the packet are not of interest.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:DSFPacket?')
return Conversions.str_to_scalar_enum(response, enums.BtoDataSourForPck)
[docs]
def get_dwhitening(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:DWHitening`` \n
Snippet: ``value: bool = driver.source.bb.btooth.pconfiguration.get_dwhitening()`` \n
Activates the 'Data Whitening'.
:return: dwhitening: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:DWHitening?')
return Conversions.str_to_bool(response)
# noinspection PyTypeChecker
[docs]
def get_eir_packet_follows(self) -> enums.YesNoStatus:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:EIRPacketfollows`` \n
Snippet: ``value: enums.YesNoStatus = driver.source.bb.btooth.pconfiguration.get_eir_packet_follows()`` \n
Indicates that an extended inquiry response packet can follow.
:return: eir_packet_follow: YES | NO YES Indicates that EIR packet follows. NO Indicates that EIR packet does not follow.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:EIRPacketfollows?')
return Conversions.str_to_scalar_enum(response, enums.YesNoStatus)
# noinspection PyTypeChecker
[docs]
def get_hf_control(self) -> enums.BtoFlowCtrl:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:HFControl`` \n
Snippet: ``value: enums.BtoFlowCtrl = driver.source.bb.btooth.pconfiguration.get_hf_control()`` \n
The command sets the FLOW bit in the header. This bit indicates start or stop of transmission of packets over the ACL
logical transport.
:return: hf_control: GO | STOP GO Allows the other devices to transmit new data. STOP Stops the other devices from transmitting data temporarily.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:HFControl?')
return Conversions.str_to_scalar_enum(response, enums.BtoFlowCtrl)
[docs]
def get_hr_interleav(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:HRINterleav`` \n
Snippet: ``value: int = driver.source.bb.btooth.pconfiguration.get_hr_interleav()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:HRINterleav?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
class LfsWordStruct(StructBase):
"""
Structure for reading output parameters. Fields: \n
- Lap_For_Sw: str: numeric Range: #H000000 to #HFFFFFF
- Bitcount: int: integer Range: 8 to 24
"""
__meta_args_list = [
ArgStruct.scalar_raw_str('Lap_For_Sw'),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Lap_For_Sw: str=None
self.Bitcount: int=None
[docs]
def get_lfs_word(self) -> LfsWordStruct:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:LFSWord`` \n
Snippet: ``value: LfsWordStruct = driver.source.bb.btooth.pconfiguration.get_lfs_word()`` \n
Sets the lower address part (LAP) of the sync word for FHS packets. The length of LAP is 24 bits or 6 hexadecimal figures.
:return: structure: for return value, see the help for LfsWordStruct structure arguments.
"""
return self._core.io.query_struct('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:LFSWord?', self.__class__.LfsWordStruct())
[docs]
def get_lt_address(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:LTADdress`` \n
Snippet: ``value: int = driver.source.bb.btooth.pconfiguration.get_lt_address()`` \n
The command enters the logical transport address for the header. Each Peripheral active in a piconet is assigned a
primary logical transport address (LT_ADDR) . The all-zero LT_ADDR is reserved for broadcast messages.
:return: lt_address: integer Range: 0 to 7
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:LTADdress?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_pf_control(self) -> enums.BtoFlowCtrl:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:PFControl`` \n
Snippet: ``value: enums.BtoFlowCtrl = driver.source.bb.btooth.pconfiguration.get_pf_control()`` \n
The command sets the FLOW bit in the payload (flow control per logical link) .
:return: pf_control: GO | STOP GO Indicates the start of transmission of ACL packets after a new connection has been established. STOP Indicates the stop of transmission of ACL packets before an additional amount of payload data is sent.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:PFControl?')
return Conversions.str_to_scalar_enum(response, enums.BtoFlowCtrl)
[docs]
def get_plength(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:PLENgth`` \n
Snippet: ``value: int = driver.source.bb.btooth.pconfiguration.get_plength()`` \n
Sets the packet length in symbols.
:return: plength: integer Range: 1 to depends on packet type
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:PLENgth?')
return Conversions.str_to_int(response)
[docs]
def get_slap(self) -> bool:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:SLAP`` \n
Snippet: ``value: bool = driver.source.bb.btooth.pconfiguration.get_slap()`` \n
Activates synchronization of the lower address part (LAP) of the sync word and Bluetooth device address.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:SLAP?')
return Conversions.str_to_bool(response)
[docs]
def get_sns_value(self) -> int:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:SNSValue`` \n
Snippet: ``value: int = driver.source.bb.btooth.pconfiguration.get_sns_value()`` \n
Sets the start value of the header SEQN bit. The SEQN bit is present in the header to filter out retransmissions in the
destination. The signal generator is altering this bit automatically on consecutive frames, if a sequence length of at
least 2 frames is set.
:return: sns_value: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:SNSValue?')
return Conversions.str_to_int(response)
# noinspection PyTypeChecker
[docs]
def get_sr_mode(self) -> enums.BtoScanReMode:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:SRMode`` \n
Snippet: ``value: enums.BtoScanReMode = driver.source.bb.btooth.pconfiguration.get_sr_mode()`` \n
The command indicates the interval between two consecutive page scan windows, determines the behavior of the paging
device.
:return: sr_mode: R0 | R1 | R2 R0 The scan interval is equal to the scan window T w page scan (continuous nscan) and maximal 1.28s. R1 The scan interval is maximal 1.28s. R2 The scan interval is maximal 2.56s.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:SRMode?')
return Conversions.str_to_scalar_enum(response, enums.BtoScanReMode)
# noinspection PyTypeChecker
[docs]
def get_vdata(self) -> enums.DataSourceB:
"""
``[SOURce<HW>]:BB:BTOoth:PCONfiguration:VDATa`` \n
Snippet: ``value: enums.DataSourceB = driver.source.bb.btooth.pconfiguration.get_vdata()`` \n
Selects the data source for the voice field.
:return: vdata: ALL0 | ALL1 | PATTern | PN09 | PN11 | PN15 | PN16 | PN20 | PN21 | PN23 | DLISt
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PCONfiguration:VDATa?')
return Conversions.str_to_scalar_enum(response, enums.DataSourceB)
def clone(self) -> 'PconfigurationCls':
"""
Clones the group by creating new object from it and its whole existing subgroups.
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group.
"""
new_group = PconfigurationCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group