デバイスマネージャーAPI ¶
モジュール: typhoon.api.デバイスマネージャー
デバイスマネージャーAPIは、現在のHILセットアップの操作（デバイスの追加または削除）、プログラムによる新規デバイスの作成、現在のセットアップの接続/切断を行うための関数/メソッドのセットです。これは、テスト用スクリプトの作成や反復タスクの自動化に最もよく使用されますが、これらのユースケースに限定されるものではありません。
例¶
次の 2 つの例は、デバイス マネージャー API の使用方法を示しています。
例1 ¶
この例では、セットアップへのデバイスの追加/削除と、現在のセットアップの接続/切断方法を示します。
から typhoon.api.デバイスマネージャー import device_manager # HIL デバイスのシリアル番号を指定しますhil_device_1 = "604-01-00001" hil_device_2 = "604-01-00002" devices_to_add = [ hil_device_1 , hil_device_2 ] # セットアップにデバイスを追加しますdevice_manager . add_devices_to_setup ( devices_to_add ) # HIL セットアップを接続しますdevice_manager . connect_setup () # # 接続されている 2 つのデバイスで何かを実行します# device_manager . disconnect_setup () # シリアル番号が "604-01-00002" のデバイスを削除しますdevice_manager . remove_devices ( hil_device_2 ) # 今回はシリアル番号が "604-01-00001" のデバイスのみでセットアップに再度接続しますdevice_manager . connect_setup ()
スクリプト出力:
例2 ¶
この例では、既存のセットアップを読み込んで接続する方法を示します。
から typhoon.api.デバイスマネージャー import device_manager # ネットワーク上で検出されたすべてのデバイスを印刷print ( device_manager . get_detected_devices ()) device_manager . load_setup ( file = "C:/Users/User/Desktop/test_setup.setup" ) # HIL セットアップに接続device_manager . connect_setup () # セットアップからすべてのデバイスを印刷print ( device_manager . get_setup_devices ) # 接続ステータスを確認device_manager . is_setup_connected () # セットアップを切断device_manager . disconnect_setup ()
スクリプト出力:
- クラス デバイスマネージャーAPI ¶
- add_devices_to_setup (デバイス= None ) ¶
アクティブセットアップにデバイスを追加します。
- パラメータ:
デバイス(リスト) – 追加するデバイス。
- 戻り値:
真実デバイスが正常にセットアップに追加された場合は、そうでない場合は間違い.- 戻り値の型:
ステータス（ブール値）
- add_discovery_ip_addresses (アドレス= None ) ¶
何らかの理由で自動検出が失敗した場合に、HIL デバイスが配置されているアドレスを指定します。
- パラメータ:
アドレス（リスト） – HILデバイスが配置されているIPアドレス。
- 戻り値:
真実デバイスのIPがTHCCアドレスストアに正常に追加された場合は、そうでない場合は間違い.- 戻り値の型:
ステータス（ブール値）
- connect_setup ( ) ¶
現在選択されているHILセットアップに接続します。選択したセットアップ内のすべてのデバイスを他のデバイスからアクセスできないようにします。
- 戻り値:
真実セットアップのすべてのデバイスが利用可能な場合は、そうでない場合は間違い.- 戻り値の型:
ステータス（ブール値）
注記
セットアップからのデバイスのいずれかがステータス（ビジー/非オンライン）である場合、この関数の実行はFalseを返します。
- 切断セットアップ( ) ¶
現在選択されているHILセットアップを切断します。選択したセットアップ内のすべてのデバイスを他のユーザーがアクセスできるようにします。
- 戻り値:
真実セットアップ内のすべてのデバイスからの切断が正常に実行された場合、そうでない場合は戻ります間違い.- 戻り値の型:
ステータス（ブール値）
- get_available_devices ( ) ¶
検出された利用可能なデバイスをすべて取得します。
- 戻り値:
利用可能なデバイスを JSON 表現で示します。
- 戻り値の型:
デバイス（リスト）
- get_detected_devices ( ) ¶
検出されたすべてのデバイスを取得します。
- 戻り値:
検出されたデバイスを JSON 表現で表示します。
- 戻り値の型:
デバイス（リスト）
- get_device_settings ( device_serial ) ¶
目的のデバイスからすべての設定を取得します。:param device_serial: デバイスのシリアル番号。:type device_serial: str
- 戻り値:
- {‘device_name’: ‘hil_name’,
- 'ip_address_eth_port_1': ''、'netmask_eth_port_1': ''、
- 'gateway_eth_port_1': ''、'static_ip_address': ''、
- 'ネットマスク': '', 'ゲートウェイ': '',
- 'ハートビートタイムアウト': 'usb_init_タイムアウト': '、
'force_usb': 'False'、'ssh_enable': 'True'}
- 戻り値の型:
設定（辞書）
HIL 構成を保持する 1 つの辞書の形式。¶ 辞書キー
意味
値の型
「デバイス名」
HILデバイス名（デバイス名1、デバイス名2）
整数値
「ip_address_eth_port_1」
HIL 静的 IP (192.168.0.1、192.168.0.2…)
str値
「ネットマスク_eth_port_1」
HIL 静的 IP (192.168.0.1、192.168.0.2…)
str値
「ゲートウェイ_eth_port_1」
HILゲートウェイ
str値
「force_usb」
（真、偽）
ブール値
「ハートビートタイムアウト」
ハートビートタイムアウトの時間を定義する（秒単位）
整数値
「usb_init_timeout」
USB初期化タイムアウトの時間を定義する（秒単位）
整数値
注記
設定の値として空の文字列が返される場合、その設定にはデフォルト値があることを意味します。
注記
パラメータstatic_ip_address、netmask、gatewayはip_address_eth_port_1、netmask_eth_port_1、gateway_eth_port_1に置き換えられ、非推奨となります。
- get_hil_info ( ) ¶
接続されているすべての HIL デバイスに関する情報を返します。
- 戻り値:
辞書を含むリスト。各辞書には、接続された 1 つの HIL デバイスに関する情報が保持されます。
HILデバイスが接続されていない場合
なし返されます。- 戻り値の型:
リスト
HIL情報を保持する1つの辞書のフォーマット。¶ 辞書キー
意味
値の型
「デバイスID」
HILデバイスID（0、1、2…）
整数値
"シリアルナンバー"
HILシリアル番号（00404-00-0001、00402-00-0001…）
文字列値
「構成ID」
HIL構成ID（1、2、3…）
整数値
「製品名」
HIL製品名（HIL402、HIL602…）
文字列値
「ファームウェアリリース日」
HIL ファームウェアのリリース日 (YMD 形式)
文字列値
「校正日」
HIL 校正日 (YMD 形式)。
なしHILがキャリブレーションされていない場合、キャリブレーションデータが間違っている場合、または接続されたHILでキャリブレーションがサポートされていない場合は返されます）文字列値
- get_setup_devices ( ) ¶
現在の HIL セットアップからすべてのデバイスを取得します。
- 戻り値:
- 各デバイスの情報を含む辞書
- {“serial_number”: “some_serial”, “device_name”: “some_device_name”,
”ステータス”: “デバイスステータス”}.
- 戻り値の型:
デバイス（リスト）
- get_setup_devices_serials ( ) ¶
現在の HIL セットアップからすべてのデバイスを取得します。
- 戻り値:
セットアップからの各デバイスのシリアル番号。
- 戻り値の型:
デバイス（リスト）
- is_setup_connected ( ) ¶
アクティブな HIL セットアップの現在のステータスを返します。
- 戻り値:
真実セットアップが現在接続されている場合は、そうでない場合は間違い.- 戻り値の型:
ステータス（ブール値）
- load_setup (ファイル= '' ) ¶
HIL セットアップをファイルからコントロール センターに読み込みます。
- パラメータ:
file ( str ) – セットアップの説明。
- 戻り値:
真実すべてが正常であれば、そうでなければ戻ります間違い.- 戻り値の型:
ステータス（ブール値）
- セットアップからデバイスを削除します( devices = None ) ¶
アクティブセットアップからデバイスを削除します。
- パラメータ:
デバイス(リスト) – 削除するデバイス。
- 戻り値:
真実デバイスがセットアップから正常に削除された場合、そうでない場合は戻ります間違い.- 戻り値の型:
ステータス（ブール値）
- 削除_discovery_ip_addresses (アドレス= None ) ¶
何らかの理由で自動検出が失敗した場合は、HIL デバイスが配置されている以前に追加されたアドレスを削除します。
- パラメータ:
アドレス（リスト） – 削除したいIPアドレス。
- 戻り値:
真実デバイスのIPがTHCCアドレスストアから正常に削除された場合、そうでない場合は戻ります。間違い.- 戻り値の型:
ステータス（ブール値）
- set_device_settings ( device_serial 、設定= None ) ¶
Allows to change all device settings. :param device_serial: serial number of the desired device. :type device_serial: str :param settings: device settings by system key (setting name) :type settings: dict :param and value: :type and value: desired values for the previously specified key :param settings: {‘device_name’: ‘hil_name’, :type settings: dict :param ‘ip_address_eth_port_1’: ‘’, ‘netmask_eth_port_1’: ‘’, :param ‘gateway_eth_port_1’: ‘’, ‘static_ip_address’: ‘’, :param ‘netmask’: ‘’, ‘gateway’: ‘’,’force_usb’: ‘False’, :param ‘heartbeat_timeout’: ‘’, ‘usb_init_timeout’: ‘’, :param ‘ssh_enable’: ‘True’}
- 戻り値:
真実渡された設定がデバイスに正常に書き込まれた場合は、そうでない場合は間違い.- 戻り値の型:
ステータス（ブール値）
注記
設定値として空の文字列が渡されると、その設定はデフォルト値に設定されます。
注記
HILに応じて、他のポートのネットワーク設定を変更できます。
注記
パラメータ static_ip_address、netmask、gateway は、将来のバージョンでは ip_address_eth_port_1、gateway_eth_port_1、netmask_eth_port_1 に置き換えられます。
- sync_firmware ( device_to_update 、 configuration_id = None 、 force = False ) ¶
選択したデバイスのファームウェアを更新またはロールバックします。
- パラメータ:
device_to_update ( str ) – 選択したデバイスのシリアル番号。
configuration_id ( int ) – 構成のシーケンス番号。
force ( boolean ) – 必要なファームウェアがHILデバイスに既に存在するものと同じであっても強制的にアップロードする
- update_firmware ( device_to_update 、 configuration_id = None 、 force = False ) ¶
選択したデバイスのファームウェアを更新します。
- パラメータ:
device_to_update ( str ) – 選択したデバイスのシリアル番号。
configuration_id ( int ) – 構成のシーケンス番号。
force ( boolean ) – 必要なファームウェアがHILデバイスに既に存在するものと同じであっても強制的にアップロードする
