esptest.iperf_utility.iperf_results module

class esptest.iperf_utility.iperf_results.FixRateReportOptions(init_rssi=0, ap_name='', target='', throughput_value='max')[source]

Bases: object

Formatting options shared by the fix-rate report generators.

Parameters:

  • init_rssi (int)

  • ap_name (str)

  • target (str)

  • throughput_value (str)

init_rssi: int = 0
ap_name: str = ''
target: str = ''
throughput_value: str = 'max'
esptest.iperf_utility.iperf_results.parse_rate_label(label)[source]

Parse config/rate labels like perf_rate_11n_MCS0 or 11n_MCS0.

Parameters:

label (str)

Return type:

tuple

class esptest.iperf_utility.iperf_results.IperfResult(avg, max=-1, min=-1, throughput_list=None, unit='Mbits/sec', min_heap=0, bandwidth=0, channel=0, rssi=-128, type='iperf', target='', errors=None, att=0, config_name='unknown', ap_name='unknown', version='unknown')[source]

Bases: object

One point iperf result, including type, att, rssi, max, avg, min, heap, etc.

Parameters:
avg: float
max: float = -1
min: float = -1
throughput_list: List[float] | None = None
unit: str = 'Mbits/sec'
min_heap: int = 0
bandwidth: int = 0
channel: int = 0
rssi: float = -128
type: str = 'iperf'
target: str = ''
errors: List[str] | None = None
att: int = 0
config_name: str = 'unknown'
ap_name: str = 'unknown'
version: str = 'unknown'
to_dict(with_keys=None)[source]

_summary_

Parameters:

with_keys (Optional[List[str]], optional) – dict keys. default [avg,max,min,min_heap,rssi].

Return type:

Dict[str, float]

class esptest.iperf_utility.iperf_results.IperfResultsRecord[source]

Bases: object

record, analysis iperf test results for different configs

append_result(result)[source]
Parameters:

result (IperfResult)

Return type:

None

part(filter_fn)[source]
Parameters:

filter_fn (Callable[[IperfResult], bool])

Return type:

Self

dict_by_att(filter_fn=None)[source]
Parameters:

filter_fn (Callable[[IperfResult], bool] | None)

Return type:

Dict[int | float | str, List[IperfResult]]

dict_by_ap(filter_fn=None)[source]
Parameters:

filter_fn (Callable[[IperfResult], bool] | None)

Return type:

Dict[int | float | str, List[IperfResult]]

draw_rssi_vs_att_chart(file_name, title='RSSI vs ATT')[source]
Parameters:
Return type:

None

draw_rate_vs_rssi_chart(file_name, title='Rate vs RSSI', throughput_type='max')[source]
Parameters:

  • file_name (str)

  • title (str)

  • throughput_type (str)

Return type:

None

generate_fix_rate_raw_data_markdown(throughput_types=None, options=None)[source]

Generate fix-rate raw-data markdown aligned with QACT report format.

Parameters:
Return type:

str

save_fix_rate_raw_data_markdown(file_name, throughput_types=None, options=None)[source]
Parameters:
Return type:

None

save_fix_rate_raw_data_excel(file_name, throughput_types=None, options=None)[source]

Save fix-rate raw data as Excel. Requires optional openpyxl.

Parameters:
Return type:

None