[docs]defget_bc_role(self)->enums.BtoCtrlRol:"""SCPI: [SOURce<HW>]:BB:BTOoth:BCRole \n Snippet: value: enums.BtoCtrlRol = driver.source.bb.btooth.get_bc_role() \n Sets the Bluetooth controller role. Depending on the selected channel type different roles are assigned to the controller. For channel type 'Data', you can assign Central or Peripheral. If the channel type is 'Advertising', the parameter is read only and displayed directly above the graph. \n :return: bc_role: CENTral| PERipheral| ADVertiser| SCANner| INITiator CENTral Selects Central as controller role. PERipheral Selects Peripheral as controller role. ADVertiser|SCANner|INITiator Assigned roles depending on the selected packet type of the respective channel type. """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:BCRole?')returnConversions.str_to_scalar_enum(response,enums.BtoCtrlRol)
[docs]defset_bc_role(self,bc_role:enums.BtoCtrlRol)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:BCRole \n Snippet: driver.source.bb.btooth.set_bc_role(bc_role = enums.BtoCtrlRol.ADVertiser) \n Sets the Bluetooth controller role. Depending on the selected channel type different roles are assigned to the controller. For channel type 'Data', you can assign Central or Peripheral. If the channel type is 'Advertising', the parameter is read only and displayed directly above the graph. \n :param bc_role: CENTral| PERipheral| ADVertiser| SCANner| INITiator CENTral Selects Central as controller role. PERipheral Selects Peripheral as controller role. ADVertiser|SCANner|INITiator Assigned roles depending on the selected packet type of the respective channel type. """param=Conversions.enum_scalar_to_str(bc_role,enums.BtoCtrlRol)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:BCRole {param}')
[docs]defget_bc_text(self)->str:"""SCPI: [SOURce<HW>]:BB:BTOoth:BCText \n Snippet: value: str = driver.source.bb.btooth.get_bc_text() \n Queries the state and controller role. \n :return: bc_text: string Connected (only data channel type) Advertiser (only advertising channel type) ADV_IND, ADV_DIRECT_IND, ADV_NONCONN_IND, ADV_SCAN_IND Within R&S SMW-K117 also ADV_EXT_IND, AUX_ADV_IND, AUX_SYNC_IND, AUX_CHAIN_IND Scanner (only advertising channel type) SCAN_REQ, SCAN_RSP Within R&S SMW-K117 also AUX_SCAN_REQ, AUX_SCAN_RSP Initiator (only advertising channel type) CONNECT_IND Within R&S SMW-K117 also AUX_CONNECT_REQ, AUX_CONNECT_RSP """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:BCText?')returntrim_str_response(response)
# noinspection PyTypeChecker
[docs]defget_bmode(self)->enums.BtoMode:"""SCPI: [SOURce<HW>]:BB:BTOoth:BMODe \n Snippet: value: enums.BtoMode = driver.source.bb.btooth.get_bmode() \n Sets the Bluetooth mode. \n :return: bmode: BASic| BLENergy BASic Sets basic rate (BR) or enhanced data rate (EDR) Bluetooth mode. BLENergy Sets low energy (LE) Bluetooth mode. """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:BMODe?')returnConversions.str_to_scalar_enum(response,enums.BtoMode)
[docs]defset_bmode(self,bmode:enums.BtoMode)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:BMODe \n Snippet: driver.source.bb.btooth.set_bmode(bmode = enums.BtoMode.BASic) \n Sets the Bluetooth mode. \n :param bmode: BASic| BLENergy BASic Sets basic rate (BR) or enhanced data rate (EDR) Bluetooth mode. BLENergy Sets low energy (LE) Bluetooth mode. """param=Conversions.enum_scalar_to_str(bmode,enums.BtoMode)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:BMODe {param}')
# noinspection PyTypeChecker
[docs]defget_ctype(self)->enums.BtoChnnelType:"""SCPI: [SOURce<HW>]:BB:BTOoth:CTYPe \n Snippet: value: enums.BtoChnnelType = driver.source.bb.btooth.get_ctype() \n Determines the channel type. Advertising and data are available. \n :return: ctype: ADVertising| DATA | | CS ADVertising Selects channel type advertising. DATA Selects channel type data. Devices in a connected state transmit data channel packets in connection events with a start point and an interval. CS Requires R&S SMW-K178. Selects channel type channel sounding. """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:CTYPe?')returnConversions.str_to_scalar_enum(response,enums.BtoChnnelType)
[docs]defset_ctype(self,ctype:enums.BtoChnnelType)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:CTYPe \n Snippet: driver.source.bb.btooth.set_ctype(ctype = enums.BtoChnnelType.ADVertising) \n Determines the channel type. Advertising and data are available. \n :param ctype: ADVertising| DATA | | CS ADVertising Selects channel type advertising. DATA Selects channel type data. Devices in a connected state transmit data channel packets in connection events with a start point and an interval. CS Requires R&S SMW-K178. Selects channel type channel sounding. """param=Conversions.enum_scalar_to_str(ctype,enums.BtoChnnelType)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:CTYPe {param}')
# noinspection PyTypeChecker
[docs]defget_dcycle(self)->enums.LowHigh:"""SCPI: [SOURce<HW>]:BB:BTOoth:DCYCle \n Snippet: value: enums.LowHigh = driver.source.bb.btooth.get_dcycle() \n Specifies duty cycle for directed advertising (packet type ADV_DIRECT_IND) . \n :return: dcycle: LOW| HIGH """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:DCYCle?')returnConversions.str_to_scalar_enum(response,enums.LowHigh)
[docs]defset_dcycle(self,dcycle:enums.LowHigh)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:DCYCle \n Snippet: driver.source.bb.btooth.set_dcycle(dcycle = enums.LowHigh.HIGH) \n Specifies duty cycle for directed advertising (packet type ADV_DIRECT_IND) . \n :param dcycle: LOW| HIGH """param=Conversions.enum_scalar_to_str(dcycle,enums.LowHigh)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:DCYCle {param}')
[docs]defget_duration(self)->float:"""SCPI: [SOURce<HW>]:BB:BTOoth:DURation \n Snippet: value: float = driver.source.bb.btooth.get_duration() \n Sets the transmission duration for continuous payload transmission. This transmission requires a CONTINUOUS packet: SOURce1:BB:BTOoth:UPTYpe CONT Command sets the values in ms. Query returns values in s. The duration range, increment and default value depend on the modulation format, symbols per a bit and payload type. For more information, refer to the specifications document. \n :return: duration: float Range: depends on settings , Unit: ms """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:DURation?')returnConversions.str_to_float(response)
[docs]defset_duration(self,duration:float)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:DURation \n Snippet: driver.source.bb.btooth.set_duration(duration = 1.0) \n Sets the transmission duration for continuous payload transmission. This transmission requires a CONTINUOUS packet: SOURce1:BB:BTOoth:UPTYpe CONT Command sets the values in ms. Query returns values in s. The duration range, increment and default value depend on the modulation format, symbols per a bit and payload type. For more information, refer to the specifications document. \n :param duration: float Range: depends on settings , Unit: ms """param=Conversions.decimal_value_to_str(duration)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:DURation {param}')
# noinspection PyTypeChecker
[docs]defget_hdrp_phy(self)->enums.BtoHdrpPhy:"""SCPI: [SOURce<HW>]:BB:BTOoth:HDRPphy \n Snippet: value: enums.BtoHdrpPhy = driver.source.bb.btooth.get_hdrp_phy() \n No command help available \n :return: hdrp_phy: No help available """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:HDRPphy?')returnConversions.str_to_scalar_enum(response,enums.BtoHdrpPhy)
[docs]defset_hdrp_phy(self,hdrp_phy:enums.BtoHdrpPhy)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:HDRPphy \n Snippet: driver.source.bb.btooth.set_hdrp_phy(hdrp_phy = enums.BtoHdrpPhy.HDRP4) \n No command help available \n :param hdrp_phy: No help available """param=Conversions.enum_scalar_to_str(hdrp_phy,enums.BtoHdrpPhy)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:HDRPphy {param}')
# noinspection PyTypeChecker
[docs]defget_mformat(self)->enums.PackFormat:"""SCPI: [SOURce<HW>]:BB:BTOoth:MFORmat \n Snippet: value: enums.PackFormat = driver.source.bb.btooth.get_mformat() \n Sets the LE PHY for continuous payload transmission. This transmission requires a CONTINUOUS packet: SOURce1:BB:BTOoth:UPTYpe CONT \n :return: mod_fmt: L1M| L2M| LCOD L1M: LE 1M L2M: LE 2M LCOD: LE coded See also [:SOURcehw]:BB:BTOoth:PFORmat. """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:MFORmat?')returnConversions.str_to_scalar_enum(response,enums.PackFormat)
[docs]defset_mformat(self,mod_fmt:enums.PackFormat)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:MFORmat \n Snippet: driver.source.bb.btooth.set_mformat(mod_fmt = enums.PackFormat.L1M) \n Sets the LE PHY for continuous payload transmission. This transmission requires a CONTINUOUS packet: SOURce1:BB:BTOoth:UPTYpe CONT \n :param mod_fmt: L1M| L2M| LCOD L1M: LE 1M L2M: LE 2M LCOD: LE coded See also [:SOURcehw]:BB:BTOoth:PFORmat. """param=Conversions.enum_scalar_to_str(mod_fmt,enums.PackFormat)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:MFORmat {param}')
# noinspection PyTypeChecker
[docs]defget_pformat(self)->enums.BtoPackFormat:"""SCPI: [SOURce<HW>]:BB:BTOoth:PFORmat \n Snippet: value: enums.BtoPackFormat = driver.source.bb.btooth.get_pformat() \n Selects the packet format that is the format according to the physical layer (PHY) that supports the packet type or PDU type. \n :return: pformat: L1M| L2M| LCOD| L2M2B L1M LE uncoded PHY with 1 Msymbol/s modulation. L2M LE uncoded PHY with 2 Msymbol/s modulation and bandwidth time product BT = 0.5. LCOD LE coded PHY with 1 Msymbol/s modulation. L2M2B LE uncoded PHY with 2 Msymbol/s modulation and bandwidth time product BT = 2. """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PFORmat?')returnConversions.str_to_scalar_enum(response,enums.BtoPackFormat)
[docs]defset_pformat(self,pformat:enums.BtoPackFormat)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:PFORmat \n Snippet: driver.source.bb.btooth.set_pformat(pformat = enums.BtoPackFormat.BLE4M) \n Selects the packet format that is the format according to the physical layer (PHY) that supports the packet type or PDU type. \n :param pformat: L1M| L2M| LCOD| L2M2B L1M LE uncoded PHY with 1 Msymbol/s modulation. L2M LE uncoded PHY with 2 Msymbol/s modulation and bandwidth time product BT = 0.5. LCOD LE coded PHY with 1 Msymbol/s modulation. L2M2B LE uncoded PHY with 2 Msymbol/s modulation and bandwidth time product BT = 2. """param=Conversions.enum_scalar_to_str(pformat,enums.BtoPackFormat)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:PFORmat {param}')
[docs]defpreset(self)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:PRESet \n Snippet: driver.source.bb.btooth.preset() \n Sets the parameters of the digital standard to their default values (*RST values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:BTOoth:STATe. \n """self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:PRESet')
[docs]defpreset_with_opc(self,opc_timeout_ms:int=-1)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:PRESet \n Snippet: driver.source.bb.btooth.preset_with_opc() \n Sets the parameters of the digital standard to their default values (*RST values specified for the commands) . Not affected is the state set with the command SOURce<hw>:BB:BTOoth:STATe. \n Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value. \n :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:BTOoth:PRESet',opc_timeout_ms)
# noinspection PyTypeChecker
[docs]defget_ptype(self)->enums.BtoPckType:"""SCPI: [SOURce<HW>]:BB:BTOoth:PTYPe \n Snippet: value: enums.BtoPckType = driver.source.bb.btooth.get_ptype() \n The available packets depend on the selected transport mode. All packet types as defined in the Bluetooth specifications are supported. \n :return: ptype: ID| NULL| POLL| FHS| DM1| DH1| DM3| DH3| DM5| DH5| AUX1| ADH1| ADH3| ADH5| AEDH1| AEDH3| AEDH5| HV1| HV2| HV3| DV| EV3| EV4| EV5| EEV3| EEV5| EEEV3| EEEV5 """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:PTYPe?')returnConversions.str_to_scalar_enum(response,enums.BtoPckType)
[docs]defset_ptype(self,ptype:enums.BtoPckType)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:PTYPe \n Snippet: driver.source.bb.btooth.set_ptype(ptype = enums.BtoPckType.ADH1) \n The available packets depend on the selected transport mode. All packet types as defined in the Bluetooth specifications are supported. \n :param ptype: ID| NULL| POLL| FHS| DM1| DH1| DM3| DH3| DM5| DH5| AUX1| ADH1| ADH3| ADH5| AEDH1| AEDH3| AEDH5| HV1| HV2| HV3| DV| EV3| EV4| EV5| EEV3| EEV5| EEEV3| EEEV5 """param=Conversions.enum_scalar_to_str(ptype,enums.BtoPckType)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:PTYPe {param}')
[docs]defget_slength(self)->int:"""SCPI: [SOURce<HW>]:BB:BTOoth:SLENgth \n Snippet: value: int = driver.source.bb.btooth.get_slength() \n Sets the sequence length of the Bluetooth signal in number of frames. This signal is calculated in advance and output in the arbitrary waveform generator. \n :return: slength: integer Range: depends on the number of states in dirty transmitter test to dynamic """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:SLENgth?')returnConversions.str_to_int(response)
[docs]defset_slength(self,slength:int)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:SLENgth \n Snippet: driver.source.bb.btooth.set_slength(slength = 1) \n Sets the sequence length of the Bluetooth signal in number of frames. This signal is calculated in advance and output in the arbitrary waveform generator. \n :param slength: integer Range: depends on the number of states in dirty transmitter test to dynamic """param=Conversions.decimal_value_to_str(slength)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:SLENgth {param}')
[docs]defget_state(self)->bool:"""SCPI: [SOURce<HW>]:BB:BTOoth:STATe \n Snippet: value: bool = driver.source.bb.btooth.get_state() \n Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n :return: state: 1| ON| 0| OFF """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:STATe?')returnConversions.str_to_bool(response)
[docs]defset_state(self,state:bool)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:STATe \n Snippet: driver.source.bb.btooth.set_state(state = False) \n Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n :param state: 1| ON| 0| OFF """param=Conversions.bool_to_str(state)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:STATe {param}')
[docs]defget_tmode(self)->enums.BtoTranMode:"""SCPI: [SOURce<HW>]:BB:BTOoth:TMODe \n Snippet: value: enums.BtoTranMode = driver.source.bb.btooth.get_tmode() \n Selects the transport mode. \n :return: tmode: ACL| SCO| ESCO ACL Asynchronous connection-less (ACL) mode used for a point-to-point multipoint link between a Central and all Peripherals. SCO Synchronous connection-oriented (SCO) mode used for a point-to-point link between a Central and a specific Peripheral. ESCO Enhanced SCO mode used for a symmetric or asymmetric point-to-point link between a Central and a specific Peripheral. """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:TMODe?')returnConversions.str_to_scalar_enum(response,enums.BtoTranMode)
[docs]defset_tmode(self,tmode:enums.BtoTranMode)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:TMODe \n Snippet: driver.source.bb.btooth.set_tmode(tmode = enums.BtoTranMode.ACL) \n Selects the transport mode. \n :param tmode: ACL| SCO| ESCO ACL Asynchronous connection-less (ACL) mode used for a point-to-point multipoint link between a Central and all Peripherals. SCO Synchronous connection-oriented (SCO) mode used for a point-to-point link between a Central and a specific Peripheral. ESCO Enhanced SCO mode used for a symmetric or asymmetric point-to-point link between a Central and a specific Peripheral. """param=Conversions.enum_scalar_to_str(tmode,enums.BtoTranMode)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:TMODe {param}')
[docs]defget_us_length(self)->int:"""SCPI: [SOURce<HW>]:BB:BTOoth:USLength \n Snippet: value: int = driver.source.bb.btooth.get_us_length() \n Selects the number of frames or events depending on the packet type. The signal repeats after the specified number of frames/events. For SCAN_REQ and CONNECT_IND packet, the sequence length is expressed in 'Frames'. For AUX_SCAN_REQ and AUX_CONNECT_REQ packet, the sequence length is expressed in 'Frames'. For LL_TERMINATE_IND packets, a default value according to the specification is given: Central: PeripheralLatency + 6 Peripheral: 6 For all other packet types the sequence length is expressed in 'Events'. \n :return: us_length: integer Range: depends on the number of states in dirty transmitter test to dynamic """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:USLength?')returnConversions.str_to_int(response)
[docs]defset_us_length(self,us_length:int)->None:"""SCPI: [SOURce<HW>]:BB:BTOoth:USLength \n Snippet: driver.source.bb.btooth.set_us_length(us_length = 1) \n Selects the number of frames or events depending on the packet type. The signal repeats after the specified number of frames/events. For SCAN_REQ and CONNECT_IND packet, the sequence length is expressed in 'Frames'. For AUX_SCAN_REQ and AUX_CONNECT_REQ packet, the sequence length is expressed in 'Frames'. For LL_TERMINATE_IND packets, a default value according to the specification is given: Central: PeripheralLatency + 6 Peripheral: 6 For all other packet types the sequence length is expressed in 'Events'. \n :param us_length: integer Range: depends on the number of states in dirty transmitter test to dynamic """param=Conversions.decimal_value_to_str(us_length)self._core.io.write(f'SOURce<HwInstance>:BB:BTOoth:USLength {param}')
[docs]defget_version(self)->str:"""SCPI: [SOURce<HW>]:BB:BTOoth:VERSion \n Snippet: value: str = driver.source.bb.btooth.get_version() \n Queries the version of the specification for Bluetooth wireless technology underlying the definitions. \n :return: version: string """response=self._core.io.query_str('SOURce<HwInstance>:BB:BTOoth:VERSion?')returntrim_str_response(response)
defclone(self)->'BtoothCls':"""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=BtoothCls(self._core,self._cmd_group.parent)self._cmd_group.synchronize_repcaps(new_group)returnnew_group