TyphoonTest ライブラリドキュメント

TyphoonTest API と他の Typhoon API の違いは何ですか?

TyphoonTest API は、HIL 固有の詳細を抽象化して使いやすくすることを目的としています。つまり、意図をより効果的に伝える明確なテストとなり、将来的には HIL シミュレーション以外のターゲットにも使用できるようになります。

TyphoonTest APIは、他のTyphoon APIと同一のテストコード内で問題なく併用できます。可能な場合はTyphoonTest API関数を使用し、必要に応じて他のTyphoon APIを使用することをお勧めします。他のAPIについては、Typhoon APIのローカルまたはオンラインのドキュメントを参照してください。

TyphoonTest Framework を使用してテストを順序付けて実行するにはどうすればよいですか?

TyphoonTestフレームワークは、テスト実行に人気のPythonツールpytestを使用します。pytestはTyphoonTest IDEで完全にサポートされており、コマンドラインから直接使用することもできます。詳細については、 TyphoonTest IDEのドキュメントとpytestのドキュメントをご覧ください。Typhoontestは、pytestの起動時に指定できる新しいコマンドライン引数をいくつか定義しています。これらについては、TyphoonTestによって追加されたpytestコマンドライン引数で説明しています。

typhoon.test.capture パッケージ

このパッケージには、すでにリリースされている HIL API 関数のより高レベルでシンプルなバージョンが含まれています。

関数

キャプチャ結果を取得する([wait_capture, time_format])

キャプチャ結果を Pandas DataFrame として返します。

データフレームのマージ（左、右[、...]）

データベース スタイルの結合を使用して 2 つの DataFrame オブジェクトをマージします。

読む(名前[, 平均読み取り数])

信号を非同期的に 1 回読み取ります (1 回限りのポーリング)。

read_cff(ファイルパス)

台風キャプチャからエクスポートされたcffファイルを読み込みます。

読み取りCSV(ファイルパス)

台風キャプチャからエクスポートされたcsvファイルを読み取ります。

読み取りHDF(ファイルパス)

台風キャプチャからエクスポートされたHDFファイルを読み取ります。

読み取りマット(ファイルパス)

台風キャプチャからエクスポートされたmatファイルを読み込みます。

読み取りMDF(ファイルパス)

台風キャプチャからエクスポートされたmdfファイルを読み取ります。

読み取りtdms(ファイルパス)

台風キャプチャからエクスポートされた tdms ファイルを読み取ります。

キャプチャ開始(期間[, offset_absolute, ...])

キャプチャ設定を行い、キャプチャを開始します。

待って（秒）

定義された秒数だけ待機します。

キャプチャ終了待ち（[寝る]）

キャプチャが停止するまでブロックします。

待つまで(名前、地域、値[、...])

信号が指定された条件を満たすまで待機します。

typhoon.test.sources パッケージ

このパッケージには、電源を扱うための高レベルの機能が含まれています。

関数

グリッドの変更(グリッド名[, rms, 周波数, 位相])

グリッドの特性を変更します。

get_phasor_3ph（グリッドシム名）

選択した GridSimulator から Phasor3ph を読み取ります。

get_pv_mpp（パネル）

PV パネルから最大電力点情報を取得します。

グリッド障害(発生源, fault_duration[, ...])

グリッド障害を作成するための一般的な関数。

typhoon.test.signals パッケージ

このパッケージには、時系列信号から必要な特性を分析するための高レベル関数が含まれています。

関数

アサート分析（結果、期待）

AnalysisResult オブジェクトのアサーション ヘルパー。発生した場合は AssertionError に結果メッセージを出力します。

アサートが参照に従う(信号、参照信号、許容誤差)

アサーションヘルパー follows_reference 関数。

アサートが定数である(シグナル, at_value[, ...])

アサーションヘルパー 定数 関数。

アサートが先順位である(信号、time_constant、...)

アサーションヘルパー 第一順位 関数。

アサートはランプです(信号、傾き、許容範囲[、実行中、...])

アサーションヘルパー ランプ 関数。

アサートはステップである(シグナル、from_value、to_value、...)

アサーションヘルパー is_step 関数。

探す(信号、領域、値[、from_region、...])

関数 typhoon.test.signals.find_all と同様に、信号上の目的の特性を見つけます。

すべて検索(信号、領域、値[、...])

信号上の目的の特性を見つけます。

エッジを見つける(信号、値[、上昇、下降、...])

信号内の特定の値の周囲のエッジを見つけます。

follows_reference(シグナル、ref_signal、tol[、...])

信号が指定された許容範囲内で基準信号に従っているかどうかを確認します。

定数(シグナル, at_value[, during, ...])

信号が常に定義された範囲内にあるかどうかを確認します。

第一順位(信号, 時間定数, ...[, ...])

信号が一次応答を表しているかどうかを確認します。

ランプ(信号、傾き、許容範囲[、実行中、...])

信号が目的の傾斜を持つランプであるかどうかを確認します。

is_step(シグナル、from_value、to_value、at_t)

信号が指定された特性を持つステップであるかどうかを確認します。

pandas_3ph_sine（[振幅、周波数、...]）

指定された特性を持つ 3 つのバランスの取れた正弦波のセットを含む pandas DataFrame を生成します。

パンダの順序(タウ、初期値、最終値[、...])

指定された特性を持つ一次応答信号として pandas シリーズを生成します。

パンダサイン（[振幅、周波数、...]）

指定された特性を持つ正弦波を持つ pandas シリーズを生成します。

ステップ情報(信号[, 設定時間しきい値, ...])

特定の信号の重要なステップ特性（立ち上がり時間、安定時間、オーバーシュートなど）を計算します。

typhoon.test.signals.filtering パッケージ

このパッケージには信号フィルタリングに関連する機能が含まれています

関数

バンドパスフィルター(入力信号, N, Wn[, ...])

Wrapper around 'scipy.signal <https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.butter.html>' function that represents Butterworth digital and analog filter design.

バンドストップフィルター(入力信号, N, Wn[, ...])

Wrapper around 'scipy.signal <https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.butter.html>' function that represents Butterworth digital and analog filter design.

ハイパスフィルター(入力信号, N, Wn[, ...])

Wrapper around 'scipy.signal <https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.butter.html>' function that represents Butterworth digital and analog filter design.

ローパスフィルター(入力信号, N, Wn[, ...])

Wrapper around 'scipy.signal <https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.butter.html>' function that represents Butterworth digital and analog filter design.

移動平均(シグナル, window_length[, ...])

'typhoon.test.rms.window_rms' 関数と同様に、移動ウィンドウ技術を使用して、提供された信号の平均値を計算します。

typhoon.test.signals.control パッケージ

このモジュールには基本的な制御ブロックの実装が含まれています

関数

インテグレーター(入力, 初期値[, ...])

提供された入力信号を統合します。

信号周波数_SOGI_pll（入力、...[、...]）

SOGI PLL アルゴリズムを使用して信号の周波数を測定します。

typhoon.test.ranges モジュール

このモジュールには、範囲（値と時間）を定義するための便利なショートカット関数が含まれており、テスト関数の作成時に意図をより明確に伝えることができます。通常、時系列分析関数（is_stepなど）の引数で使用されます。

各機能の使用例をご確認ください。

関数

後（トン）

t から最新の可能な値までの時間範囲を定義します。

その周り(val[, tol, tol_p])

範囲を、その周囲に許容範囲を持つ中心値として定義します。

前に（トン）

最も早い時点から t までの時間範囲を定義します。

typhoon.test.harmonic パッケージ

このパッケージには、周波数領域演算および変換のための関数が含まれています。

関数

頻度コンテンツ(信号, 最大周波数[, ...])

FFT を使用して信号の高調波成分のリストを計算します。

信号周波数ZC（信号[、中、モード]）

信号の周波数を計算します。

thd(信号、基本波、最大高調波[、...])

信号のTHDを計算します

クラス

FFT結果（信号、FFT、周波数）

結果 頻度コンテンツ 分析。

typhoon.test.IEC61000 パッケージ

このパッケージには、IEC 61000 規格に準拠した測定機能が含まれています。

関数

フリッカーメーター(サンプル、基準電圧、...)

これは 61000-4-30 規格に基づいたデジタルフリッカーメーターです。

頻度（サンプル）

この方法は、グリッド電圧の周波数を計算します。

ハーモニックコンテンツ(サンプル、nominal_grid_freq、...)

この方法は、IEC 61000-4-7 に従って高調波、次数間高調波、および全高調波歪みを測定します。

電力量(電圧サンプル、...[、...])

この方法は、IEC 61000-1-7 に従って、非正弦波条件 (一般的なケース) 下の単相システムの電力量を測定します。

三相電力量（…[、…]）

この方法は、IEEE Std 1459-2010 に従って、非正弦波条件 (一般的なケース) 下の 3 相システムの電力量を測定します。

実効値(サンプル、nominal_grid_freq[, ...])

IEC 61000-4-30 規格に従って入力サンプルの二乗平均平方根 (RMS) 値を測定します。

sym_comp_電圧不均衡（サンプル、...[、...]）

IEEE Std 1159-2019 に従って対称コンポーネントと電圧不平衡を測定します。

typhoon.test.rms パッケージ

関数

ウィンドウrms(シグナル[, ウィンドウの長さ, ...])

スライディング ウィンドウ技術を使用して信号の RMS 値を計算します。

typhoon.test.power パッケージ

このパッケージはさまざまな電力計算に使用されます。

関数

三相電力（電圧、電流[、...]）

3 線と 4 線の両方を備えた 3 相システムの 3 相電力を計算します。

typhoon.test.transformations パッケージ

関数

abc_to_alphabetagamma(シグナル[, メソッド, ...])

abc からアルファ-ベータ-ガンマ変換 (クラーク変換とも呼ばれる) を計算します。

abc_to_dq0（信号、シータ[、方法、アライメント]）

Park 変換とも呼ばれる abc_to_dq0 変換を実装します。

abc_to_symmetrical_components（信号[、...]）

対称変換 (Fortescue 変換とも呼ばれる) を実装します。

アルファベットagamma_to_abc(シグナル[, メソッド, ...])

クラークの逆変換とも呼ばれる、アルファ-ベータ-ガンマから abc への変換を計算します。

アルファベットagamma_to_dq0（信号、シータ[、...]）

アルファ-ベータ-ガンマから dq0 への変換 (クラークからパーク角度への変換とも呼ばれます) を実装します。

完全な対称コンポーネント（V0、V1、V2）

対称コンポーネントから 3 つの 3 相「abc」セットを計算します。

dq0_to_abc（信号、シータ[、方法、アライメント]）

逆 Park 変換とも呼ばれる dq0_to_abc 変換を実装します。

dq0_to_alphabetagamma（信号、シータ[、...]）

dq0 からアルファ-ベータ-ガンマ角度変換 (Park から Clarke 角度変換とも呼ばれます) を実装します。

非対称コンポーネント（V0、V1、V2）

対称コンポーネントから a、b、c 位相器を計算します。

対称コンポーネント（Va、Vb、Vc）

対称値 abc 位相器を計算します。

対称コンポーネントからabcへ（シグナル[, メソッド]）

abc 座標への逆対称変換を実装します。

typhoon.types.phasors モジュール

クラス

フェーザー（[数値、大きさ、角度]）

クラスは複素数をサブクラス化する Phasors を実装しますが、次のものを追加します。

フェイザー3ph(phasor1、phasor2、phasor3[, ...])

Phasors3ph タプルを作成します。

typhoon.test.reporting.tables パッケージ

このパッケージには、さまざまなタイプの HTML テーブルを Allure レポートに添付するために使用される関数が含まれています。

関数

アタッチテーブル(df[, allure_title, caption, ...])

シンプルなCSS設定でHTMLテーブルをAllureレポートに追加します。このタイプのテーブルは、以下の情報を表示するために使用できます。

アタッチテーブルカスタムカラーマップ（自由度、閾値）

テーブルの背景に特定のカラーマップを適用した HTML テーブルをアリュール レポートに追加します。

列ごとのカスタムカラーマップテーブルへの添付（DF、…）

同じ方法でHTMLテーブルをアリュールレポートに追加します アタッチテーブルカスタムカラーマップ 唯一の違いは、しきい値が各列に対して一意であることです。ユーザーはしきい値を繰り返すことができますが、しきい値はすべての列に対して必要です。

テキストスタイル（段落[, 太字, 斜体, 色]）

文字列を特定の HTML タグを含む段落に設定します。

typhoon.test.reporting.messages パッケージ

この Python パッケージは、レポートへのレポート メッセージのログ記録と、一般的なレポートの構成を扱います。

関数

レポートメッセージ（メッセージ）

メッセージをアリュールレポートに記録します。

レポートステップ（メッセージ）

魅力レポートにメッセージを追加する、 台風テスト報告メッセージレポートメッセージ 機能ですが、それとは対照的に、この関数は、より多くの関数を整理し、メッセージを 1 つの論理グループに報告するために使用する必要があります。

typhoon.test.reporting.figures パッケージ

このパッケージには、matplotlibの図をAllureレポートに添付するための関数が含まれています。

関数

図を添付する(データフレームリスト、添付ファイル名)

提供されたシグナルの matplotlib 図を .png 画像添付ファイルとして allure レポートに追加します。

typhoon.types.timedelta モジュール

クラス

タイムデルタ(*引数、**kwargs)

期間、つまり 2 つの日付または時刻の差を表します。

TyphoonTest によって追加された Pytest コマンドライン引数

pytest 用の TyphoonTest プラグインは、テスト実行用のいくつかのコマンドライン引数を提供します。

PytestとAllureレポート操作

  1. --alluredir=DIR - 指定されたディレクトリにAllureレポートを生成します ディレクター (存在しない可能性があります)。

  2. --clean-alluredir - クリーン 魅了する フォルダー（存在する場合）。

  3. --オープンアリュール - 指定されている場合、テスト実行後に allure-report が自動的に開きます。

  4. --キャプチャプロットを削除 - typhoon.test.capture.get_capture_results関数からアリュールプロットの添付ファイルを削除します。これはアリュールレポートのサイズを縮小する良い方法です。

  5. --分析プロットタイプ - Typhoontestの解析関数のテスト実行全体について、Allureレポートに追加するプロットを選択します。サポートされている関数：

  1. 台風テストシグナルis_step,

  2. 台風テストシグナルは一定である,

  3. 台風テスト信号is_ramp,

  4. 台風のテストシグナルは最初の順序です,

  5. 台風テストシグナル参照

  • 可能なオプションは 4 つあります。

    1. なし - プロットは添付されません

    2. 静的 - matplotlibプロットを.png画像として保存すると添付されます。このオプションはファイルサイズを節約しますが、画像を操作するオプションはありません。

    3. 相互の作用 - プロットはHTMLファイルとして保存され、プロット上の信号を操作するオプションが追加されます。失敗したテストのデバッグに最適です。

    4. 全て - サポートされているすべてのプロットが添付されています

  • 指定されたオプションはテスト実行全体に適用されますが、関数呼び出しごとに個別にオーバーライドすることもできます。 レポートプロット 辞書とそのキー タイプ.

  1. --分析プロット失敗時のみ - 前の引数で指定したタイプのレポートプロットを常にプロットするか、失敗した場合にのみプロットするかを指定します。指定した場合、テストが失敗した場合にのみプロットが添付されます。指定したオプションはテスト実行全体に適用されますが、関数呼び出しごとに個別にオーバーライドできます。 レポートプロット 辞書とそのキー いつ そのために使われます。

  2. -k式 - 指定された部分文字列に一致するテストのみを実行します 表現例：-k 'test_method or test_other' は、名前に 'test_method' または 'test_other' を含むすべてのテスト関数とクラスに一致しますが、-k 'not test_method' は、名前に 'test_method' を含まないもののみに一致します。一致は大文字と小文字を区別しません。

  3. --マーカー - マーカーを表示します (組み込み、プラグイン、プロジェクトごと)。

  4. -mマークEXPR - 指定されたマーク式に一致するテストのみを実行する マークエクスPRたとえば、-m 'mark1 and not mark2' です。

  5. --収集のみ, --co - テストは収集するだけで、実行しないでください。

  6. --履歴を保持する - 以前のテストセッションの結果履歴を保持し、Allureレポートに結果履歴グラフを追加します。

  7. --env-params - 追加の環境パラメータが格納されているJSONファイルのパスを表します。ファイルは最初のテストの実行前に読み込まれます。

  8. --自動ステップを無効にする - プロットを除くすべてのTyphoon APIで使用される自動Allureステップを無効にします（ --キャプチャプロットを削除 そして --分析プロットタイプ）。

  9. enable_assertion_pass_hook=true - 有効にする pytest_assertion_pass フック。以前に生成された pyc キャッシュ ファイルを必ず削除してください。 初期化ファイル pytest.ini のみ.

コマンドラインリアルタイムログ

  1. log_cli=true - テスト実行中にログの表示を有効にします（「ライブ ログ」とも呼ばれます）。 初期化ファイル pytest.ini のみ.

  2. --log-cli-level - CLIログレベル。テスト手順中に、異なる重大度レベルのログが書き込まれることがあります。通常は次のように設定します。 --log-cli-level=INFOその他の重大度レベル:

  • DEBUG（下）

  • 情報

  • 警告

  • エラー

  • クリティカル（高）

PDFレポート

  1. --generate-pdf - 指定すると、Allure レポートから抽出されたテスト セッションの結果を含む PDF がテスト セッションの終了時に生成されます。

  2. --pdf-path - 生成されるPDFレポートのカスタムパスを指定します。指定しない場合は、作業ディレクトリ内に次の名前でPDFレポートが生成されます。 {タイムスタンプ}_レポート.pdf.

  3. --pdf-タイトル - PDFレポートの表紙に表示するカスタムタイトルを定義します。指定しない場合は、デフォルトのタイトル名が使用されます。 Typhoon HILテストセッションレポート.

  4. --pdf-title-color - PDFレポートの表紙のタイトルカラーを定義します。指定しない場合、デフォルトのタイトルカラーはダークグレー（16進値： #333333）。

  5. --pdf-ロゴ - PDFレポートの表紙にカスタムロゴとして表示される画像のパスを指定します。指定されていない場合は、表紙のデフォルトロゴはTyphoon HILロゴになります。

  6. --pdf-スローガン - PDFレポートの表紙のロゴの横に表示されるカスタムスローガンを指定します。指定されていない場合は、デフォルトのスローガンが使用されます。 テスト。設計。展開。 表紙に掲載されています。

  7. --pdf-skip-trace - 指定すると、失敗または中断したテストのエラー トレースが PDF レポートから省略されます。

  8. --pdf-skip-steps - 指定すると、各テスト ケースの手順が PDF レポートから省略されます。

  9. --pdf-skip-plots - 指定すると、プロットを含む画像は PDF レポートから省略されます。

注意：PDFレポートにHTMLテーブルを添付するには、テストセッションを実行しているデバイスにChrome/Chromiumブラウザがインストールされている必要があります。インストールされていない場合、HTMLテーブルは無視されます。

HILデバイスの選択

  1. --vdev - VHILでテストを実行できます。 --vdev そして --vcfg 指定する必要があります。例： --vdev=HIL402 --vcfg=1.

  2. --vcfg - VHIL構成を定義します。 --vdev そして --vcfg 指定する必要があります。例： --vdev=HIL402 --vcfg=1.

  3. --ethdev - 特定のネットワークでのテストに使用されるHILのシリアル番号を定義できます。例： --ethdev="00604-00-00170, 00604-00-00171".

  4. --discovery-ip - ネットワーク上のHILのIPアドレスを定義できます。例： --discovery-ip="192.168.0.xxx, 192.168.0.xxx".

  5. --fw - HILファームウェア構成番号（CFG_NUMBER）を定義できます。例： --fw=CFG_NUMBER.

CSVレポートリアルタイム

  1. --シンプルレポート - 簡略化されたレポートをCSVファイルとして生成します。サポートされる値は次のとおりです。 全て, 設定, 電話, 取り壊す, なし. 例 --シンプルレポート=すべて.

その他のオプション

  1. --gc-collect - 実行された各テストの後にガベージ コレクターが自動的に呼び出されます。

リリースノート

TyphoonTest APIのリリースノートはこちらをご覧ください:リリースノート

索引と表