Source code for RsSmw.Implementations.Source.Bb.LrWpan.Sens.MacHeader
from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class MacHeaderCls:
"""
| Commands in total: 31
| Subgroups: 0
| Direct child commands: 31
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("macHeader", core, parent)
[docs]
def get_ar(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:AR`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_ar()`` \n
Sets the bit in the AR field. The bit specifies if an acknowledgment is required from the recipient device on receipt of
a data frame or MAC command.
:return: ar: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:AR?')
return Conversions.str_to_int(response)
[docs]
def set_ar(self, ar: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:AR`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_ar(ar = 1)`` \n
Sets the bit in the AR field. The bit specifies if an acknowledgment is required from the recipient device on receipt of
a data frame or MAC command.
:param ar: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(ar)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:AR {param}')
[docs]
def get_ctrl(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:CTRL`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_ctrl()`` \n
Sets the input value of the frame control field. The value is an 8-bit or 16-bit value in hexadecimal representation.
:return: frame_control: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:CTRL?')
return Conversions.str_to_int(response)
[docs]
def set_ctrl(self, frame_control: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:CTRL`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_ctrl(frame_control = 1)`` \n
Sets the input value of the frame control field. The value is an 8-bit or 16-bit value in hexadecimal representation.
:param frame_control: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(frame_control)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:CTRL {param}')
[docs]
def get_dad_2(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DAD2`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_dad_2()`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DAD2?')
return Conversions.str_to_int(response)
[docs]
def set_dad_2(self, dest_addr_2: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DAD2`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_dad_2(dest_addr_2 = 1)`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
:param dest_addr_2: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(dest_addr_2)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DAD2 {param}')
[docs]
def get_dad_3(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DAD3`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_dad_3()`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DAD3?')
return Conversions.str_to_int(response)
[docs]
def set_dad_3(self, dest_addr_3: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DAD3`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_dad_3(dest_addr_3 = 1)`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
:param dest_addr_3: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(dest_addr_3)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DAD3 {param}')
[docs]
def get_dad_4(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DAD4`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_dad_4()`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DAD4?')
return Conversions.str_to_int(response)
[docs]
def set_dad_4(self, dest_addr_4: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DAD4`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_dad_4(dest_addr_4 = 1)`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
:param dest_addr_4: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(dest_addr_4)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DAD4 {param}')
[docs]
def get_dadd(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DADD`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_dadd()`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
:return: destination_addr: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DADD?')
return Conversions.str_to_int(response)
[docs]
def set_dadd(self, destination_addr: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DADD`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_dadd(destination_addr = 1)`` \n
DADD requires destination address length of two or eight octets. DAD2, DAD3 and DAD4 require destination address length
of eight octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LDADdress. Sets the first, second,
third and fourth input value of the destination address field.
:param destination_addr: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(destination_addr)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DADD {param}')
[docs]
def get_dad_mode(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DADMode`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_dad_mode()`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets bits of the destination addressing mode.
:return: dest_addr_mode: integer Range: 0 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DADMode?')
return Conversions.str_to_int(response)
[docs]
def set_dad_mode(self, dest_addr_mode: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DADMode`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_dad_mode(dest_addr_mode = 1)`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets bits of the destination addressing mode.
:param dest_addr_mode: integer Range: 0 to 3
"""
param = Conversions.decimal_value_to_str(dest_addr_mode)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DADMode {param}')
[docs]
def get_dpan_id(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DPANid`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_dpan_id()`` \n
Sets the length and the input value of the destination PAN ID field.
:return: destination_pan_id: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DPANid?')
return Conversions.str_to_int(response)
[docs]
def set_dpan_id(self, destination_pan_id: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:DPANid`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_dpan_id(destination_pan_id = 1)`` \n
Sets the length and the input value of the destination PAN ID field.
:param destination_pan_id: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(destination_pan_id)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:DPANid {param}')
[docs]
def get_fpending(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:FPENding`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_fpending()`` \n
Sets the bit in the frame pending field.
:return: frame_pending: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:FPENding?')
return Conversions.str_to_int(response)
[docs]
def set_fpending(self, frame_pending: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:FPENding`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_fpending(frame_pending = 1)`` \n
Sets the bit in the frame pending field.
:param frame_pending: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(frame_pending)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:FPENding {param}')
[docs]
def get_ftype(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:FTYPe`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_ftype()`` \n
Sets the bits in the frame type field. The value is a 3-bit value.
:return: frame_type: integer Range: 0 to 7
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:FTYPe?')
return Conversions.str_to_int(response)
[docs]
def set_ftype(self, frame_type: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:FTYPe`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_ftype(frame_type = 1)`` \n
Sets the bits in the frame type field. The value is a 3-bit value.
:param frame_type: integer Range: 0 to 7
"""
param = Conversions.decimal_value_to_str(frame_type)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:FTYPe {param}')
[docs]
def get_fversion(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:FVERsion`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_fversion()`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bits in the frame version field. The value is a 2-bit value.
:return: frame_version: integer Range: 0 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:FVERsion?')
return Conversions.str_to_int(response)
[docs]
def set_fversion(self, frame_version: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:FVERsion`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_fversion(frame_version = 1)`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bits in the frame version field. The value is a 2-bit value.
:param frame_version: integer Range: 0 to 3
"""
param = Conversions.decimal_value_to_str(frame_version)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:FVERsion {param}')
[docs]
def get_ie_present(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:IEPResent`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_ie_present()`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bit in the information element (IE) present field.
:return: ie_present: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:IEPResent?')
return Conversions.str_to_int(response)
[docs]
def set_ie_present(self, ie_present: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:IEPResent`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_ie_present(ie_present = 1)`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bit in the information element (IE) present field.
:param ie_present: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(ie_present)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:IEPResent {param}')
# noinspection PyTypeChecker
[docs]
def get_ld_address(self) -> enums.HrpUwbMacLenAddress:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LDADdress`` \n
Snippet: ``value: enums.HrpUwbMacLenAddress = driver.source.bb.lrWpan.sens.macHeader.get_ld_address()`` \n
Sets the length of the destination address field. You can set lengths of zero octets, two octets or eight octets.
:return: len_dest_addr: L0 | L2 | L8 L0 Sets destination address length to zero octets. L2 Sets destination address length to two octets. L8 Sets destination address length to eight octets.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LDADdress?')
return Conversions.str_to_scalar_enum(response, enums.HrpUwbMacLenAddress)
[docs]
def set_ld_address(self, len_dest_addr: enums.HrpUwbMacLenAddress) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LDADdress`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_ld_address(len_dest_addr = enums.HrpUwbMacLenAddress.L0)`` \n
Sets the length of the destination address field. You can set lengths of zero octets, two octets or eight octets.
:param len_dest_addr: L0 | L2 | L8 L0 Sets destination address length to zero octets. L2 Sets destination address length to two octets. L8 Sets destination address length to eight octets.
"""
param = Conversions.enum_scalar_to_str(len_dest_addr, enums.HrpUwbMacLenAddress)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LDADdress {param}')
# noinspection PyTypeChecker
[docs]
def get_lde_pan_id(self) -> enums.HrpUwbMacLenPanId:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LDEPanid`` \n
Snippet: ``value: enums.HrpUwbMacLenPanId = driver.source.bb.lrWpan.sens.macHeader.get_lde_pan_id()`` \n
Sets the length of the destination PAN ID field. You can set lengths of zero octets or two octets.
:return: len_dest_pan_id: L0 | L2 L0 Sets destination PAN ID length to zero octets. L2 Sets destination PAN ID length to two octets.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LDEPanid?')
return Conversions.str_to_scalar_enum(response, enums.HrpUwbMacLenPanId)
[docs]
def set_lde_pan_id(self, len_dest_pan_id: enums.HrpUwbMacLenPanId) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LDEPanid`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_lde_pan_id(len_dest_pan_id = enums.HrpUwbMacLenPanId.L0)`` \n
Sets the length of the destination PAN ID field. You can set lengths of zero octets or two octets.
:param len_dest_pan_id: L0 | L2 L0 Sets destination PAN ID length to zero octets. L2 Sets destination PAN ID length to two octets.
"""
param = Conversions.enum_scalar_to_str(len_dest_pan_id, enums.HrpUwbMacLenPanId)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LDEPanid {param}')
# noinspection PyTypeChecker
[docs]
def get_lfr_control(self) -> enums.HrpUwbMacLenFrameControl:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LFRControl`` \n
Snippet: ``value: enums.HrpUwbMacLenFrameControl = driver.source.bb.lrWpan.sens.macHeader.get_lfr_control()`` \n
Sets the length of the frame control field. You can set lengths of one octet or two octets.
:return: len_frame_control: L1 | L2 L1 Sets frame control length to one octet. L2 Sets frame control length to two octets.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LFRControl?')
return Conversions.str_to_scalar_enum(response, enums.HrpUwbMacLenFrameControl)
[docs]
def set_lfr_control(self, len_frame_control: enums.HrpUwbMacLenFrameControl) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LFRControl`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_lfr_control(len_frame_control = enums.HrpUwbMacLenFrameControl.L1)`` \n
Sets the length of the frame control field. You can set lengths of one octet or two octets.
:param len_frame_control: L1 | L2 L1 Sets frame control length to one octet. L2 Sets frame control length to two octets.
"""
param = Conversions.enum_scalar_to_str(len_frame_control, enums.HrpUwbMacLenFrameControl)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LFRControl {param}')
# noinspection PyTypeChecker
[docs]
def get_ls_address(self) -> enums.HrpUwbMacLenAddress:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LSADdress`` \n
Snippet: ``value: enums.HrpUwbMacLenAddress = driver.source.bb.lrWpan.sens.macHeader.get_ls_address()`` \n
Sets the length of the source address field. You can set lengths of zero octets, two octets or eight octets.
:return: len_src_address: L0 | L2 | L8 L0 Sets source address length to zero octets. L2 Sets source address length to two octets. L8 Sets source address length to eight octets.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LSADdress?')
return Conversions.str_to_scalar_enum(response, enums.HrpUwbMacLenAddress)
[docs]
def set_ls_address(self, len_src_address: enums.HrpUwbMacLenAddress) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LSADdress`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_ls_address(len_src_address = enums.HrpUwbMacLenAddress.L0)`` \n
Sets the length of the source address field. You can set lengths of zero octets, two octets or eight octets.
:param len_src_address: L0 | L2 | L8 L0 Sets source address length to zero octets. L2 Sets source address length to two octets. L8 Sets source address length to eight octets.
"""
param = Conversions.enum_scalar_to_str(len_src_address, enums.HrpUwbMacLenAddress)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LSADdress {param}')
# noinspection PyTypeChecker
[docs]
def get_lseq_number(self) -> enums.HrpUwbMacLenSeqNumber:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LSEQnumber`` \n
Snippet: ``value: enums.HrpUwbMacLenSeqNumber = driver.source.bb.lrWpan.sens.macHeader.get_lseq_number()`` \n
Sets the length of the sequence number field. You can set zero octets or one octet.
:return: len_seq_number: L0 | L1 L0 Sets the sequence number length to zero octets. L1 Sets the sequence number length to one octet.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LSEQnumber?')
return Conversions.str_to_scalar_enum(response, enums.HrpUwbMacLenSeqNumber)
[docs]
def set_lseq_number(self, len_seq_number: enums.HrpUwbMacLenSeqNumber) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LSEQnumber`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_lseq_number(len_seq_number = enums.HrpUwbMacLenSeqNumber.L0)`` \n
Sets the length of the sequence number field. You can set zero octets or one octet.
:param len_seq_number: L0 | L1 L0 Sets the sequence number length to zero octets. L1 Sets the sequence number length to one octet.
"""
param = Conversions.enum_scalar_to_str(len_seq_number, enums.HrpUwbMacLenSeqNumber)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LSEQnumber {param}')
# noinspection PyTypeChecker
[docs]
def get_lso_pan_id(self) -> enums.HrpUwbMacLenPanId:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LSOPanid`` \n
Snippet: ``value: enums.HrpUwbMacLenPanId = driver.source.bb.lrWpan.sens.macHeader.get_lso_pan_id()`` \n
Sets the length of the source PAN ID field. You can set lengths of zero octets or two octets.
:return: len_source_pan_id: L0 | L2 L0 Sets source PAN ID length to zero octets. L2 Sets source PAN ID length to two octets.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LSOPanid?')
return Conversions.str_to_scalar_enum(response, enums.HrpUwbMacLenPanId)
[docs]
def set_lso_pan_id(self, len_source_pan_id: enums.HrpUwbMacLenPanId) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:LSOPanid`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_lso_pan_id(len_source_pan_id = enums.HrpUwbMacLenPanId.L0)`` \n
Sets the length of the source PAN ID field. You can set lengths of zero octets or two octets.
:param len_source_pan_id: L0 | L2 L0 Sets source PAN ID length to zero octets. L2 Sets source PAN ID length to two octets.
"""
param = Conversions.enum_scalar_to_str(len_source_pan_id, enums.HrpUwbMacLenPanId)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:LSOPanid {param}')
[docs]
def get_pid_comp(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:PIDComp`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_pid_comp()`` \n
Sets the bit in the PAN ID compression field.
:return: pan_id_compress: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:PIDComp?')
return Conversions.str_to_int(response)
[docs]
def set_pid_comp(self, pan_id_compress: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:PIDComp`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_pid_comp(pan_id_compress = 1)`` \n
Sets the bit in the PAN ID compression field.
:param pan_id_compress: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(pan_id_compress)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:PIDComp {param}')
[docs]
def get_reserved(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:REServed`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_reserved()`` \n
Sets a reserved bit for future use.
:return: reserved: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:REServed?')
return Conversions.str_to_int(response)
[docs]
def set_reserved(self, reserved: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:REServed`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_reserved(reserved = 1)`` \n
Sets a reserved bit for future use.
:param reserved: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(reserved)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:REServed {param}')
[docs]
def get_sad_2(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SAD2`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_sad_2()`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SAD2?')
return Conversions.str_to_int(response)
[docs]
def set_sad_2(self, source_address_2: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SAD2`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_sad_2(source_address_2 = 1)`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
:param source_address_2: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(source_address_2)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SAD2 {param}')
[docs]
def get_sad_3(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SAD3`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_sad_3()`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SAD3?')
return Conversions.str_to_int(response)
[docs]
def set_sad_3(self, source_address_3: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SAD3`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_sad_3(source_address_3 = 1)`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
:param source_address_3: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(source_address_3)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SAD3 {param}')
[docs]
def get_sad_4(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SAD4`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_sad_4()`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SAD4?')
return Conversions.str_to_int(response)
[docs]
def set_sad_4(self, source_address_4: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SAD4`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_sad_4(source_address_4 = 1)`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
:param source_address_4: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(source_address_4)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SAD4 {param}')
[docs]
def get_sadd(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SADD`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_sadd()`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
:return: source_address: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SADD?')
return Conversions.str_to_int(response)
[docs]
def set_sadd(self, source_address: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SADD`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_sadd(source_address = 1)`` \n
SADD requires source address length of two or eight octets. SAD2, SAD3 and SAD4 require source address lengths of eight
octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd | SENS:MACHeader:LSADdress. Sets the first, second, third and
fourth input value of the source address field.
:param source_address: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(source_address)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SADD {param}')
[docs]
def get_sad_mode(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SADMode`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_sad_mode()`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bits in the source addressing mode field. The value is a 2-bit value.
:return: src_addr_mode: integer Range: 0 to 3
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SADMode?')
return Conversions.str_to_int(response)
[docs]
def set_sad_mode(self, src_addr_mode: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SADMode`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_sad_mode(src_addr_mode = 1)`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bits in the source addressing mode field. The value is a 2-bit value.
:param src_addr_mode: integer Range: 0 to 3
"""
param = Conversions.decimal_value_to_str(src_addr_mode)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SADMode {param}')
[docs]
def get_se_enabled(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SEENabled`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_se_enabled()`` \n
Sets the bit in the security enabled field.
:return: security_enabled: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SEENabled?')
return Conversions.str_to_int(response)
[docs]
def set_se_enabled(self, security_enabled: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SEENabled`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_se_enabled(security_enabled = 1)`` \n
Sets the bit in the security enabled field.
:param security_enabled: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(security_enabled)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SEENabled {param}')
[docs]
def get_sen_supp(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SENSupp`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_sen_supp()`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bit in the sequence number suppression field.
:return: seq_numb_suppr: integer Range: 0 to 1
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SENSupp?')
return Conversions.str_to_int(response)
[docs]
def set_sen_supp(self, seq_numb_suppr: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SENSupp`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_sen_supp(seq_numb_suppr = 1)`` \n
Requires frame control length of two octets. See [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk | EMLLd |
SENS:MACHeader:LFRControl. Sets the bit in the sequence number suppression field.
:param seq_numb_suppr: integer Range: 0 to 1
"""
param = Conversions.decimal_value_to_str(seq_numb_suppr)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SENSupp {param}')
[docs]
def get_seq_number(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SEQNumber`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_seq_number()`` \n
Sets the input value of the sequence number field. The value is in hexadecimal representation.
:return: sequence_number: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SEQNumber?')
return Conversions.str_to_int(response)
[docs]
def set_seq_number(self, sequence_number: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SEQNumber`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_seq_number(sequence_number = 1)`` \n
Sets the input value of the sequence number field. The value is in hexadecimal representation.
:param sequence_number: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(sequence_number)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SEQNumber {param}')
[docs]
def get_span_id(self) -> int:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SPANid`` \n
Snippet: ``value: int = driver.source.bb.lrWpan.sens.macHeader.get_span_id()`` \n
Sets the input value of the source PAN ID field. The value is a 16-bit value in hexadecimal representation.
:return: source_pan_id: integer Range: 0 to 65535
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SPANid?')
return Conversions.str_to_int(response)
[docs]
def set_span_id(self, source_pan_id: int) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:SPANid`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_span_id(source_pan_id = 1)`` \n
Sets the input value of the source PAN ID field. The value is a 16-bit value in hexadecimal representation.
:param source_pan_id: integer Range: 0 to 65535
"""
param = Conversions.decimal_value_to_str(source_pan_id)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:SPANid {param}')
[docs]
def get_state(self) -> bool:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:STATe`` \n
Snippet: ``value: bool = driver.source.bb.lrWpan.sens.macHeader.get_state()`` \n
Activates or deactivates MAC header information.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:STATe`` \n
Snippet: ``driver.source.bb.lrWpan.sens.macHeader.set_state(state = False)`` \n
Activates or deactivates MAC header information.
:param state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:STATe {param}')
[docs]
def get_string(self) -> str:
"""
``[SOURce<HW>]:BB:[LRWPan]:SENS:MACHeader:STRing`` \n
Snippet: ``value: str = driver.source.bb.lrWpan.sens.macHeader.get_string()`` \n
Queries the length of the MAC header and the MAC address in hexadecimal format.
:return: string: string
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:SENS:MACHeader:STRing?')
return trim_str_response(response)