from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class BitrateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("bitrate", core, parent)
[docs]
def get(self, bus=repcap.Bus.Default) -> int:
"""
``BUS<*>:CXPI:RESult:BITRate`` \n
Snippet: ``value: int = driver.bus.cxpi.result.bitrate.get(bus = repcap.Bus.Default)`` \n
Queries the measured average bit rate, which is calculated if method ``RsRtx.bus.cxpi.bitrate.enable.set()`` is set to
OFF.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:return: average_bitrate: 1000 to 100E+3
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:CXPI:RESult:BITRate?')
return Conversions.str_to_int(response)