intdashクライアント

intdashサーバーに対するアクセス API を提供します。

class Client(...)[ソース]

intdash REST サーバーに対するアクセスクライアントです。

パラメータ

  • url (str) -- intdash REST API サーバーの URL

  • username (str) --

    ユーザー名

    バージョン 2.1.0 で非推奨.

  • password (str) --

    パスワード

    バージョン 2.1.0 で非推奨.

  • edge_token (str) -- エッジトークン

  • verify (bool) -- サーバ証明書の検証を行うかどうか（デフォルトは True ）

  • session (requests.Session) -- セッション

注釈

認証情報として、 エッジトークン もしくは requests-oauthlib の session が必要です。 ユーザー名／パスワード は非推奨です。

property captures

キャプチャリソースへのアクセスオブジェクト

Type

intdash.Captures

async connect_iscp(flush_interval=0.01, on_close=None, token_source: Optional[intdash._client.TokenSource] = None)[ソース]

リアルタイム通信用のエンドポイントへ接続します。

パラメータ

  • flush_interval (float) -- 秒単位のフラッシュ間隔

  • on_close (func) -- close時に呼び出されるコールバック関数

戻り値

iSCPコネクション

戻り値の型

intdash.ISCPConn

connect_websocket(flush_interval=0.01, auto_reconnect=False, token_source: Optional[intdash._client.TokenSource] = None)[ソース]

リアルタイム通信用のエンドポイントへ接続します。

パラメータ

  • flush_interval (float) -- 秒単位のフラッシュ間隔

  • auto_reconnect (bool) -- 自動再接続フラグ

戻り値

WebSocketコネクション

戻り値の型

intdash.WebSocketConn

property data_points

時系列データ(データポイント形式)へのアクセスオブジェクト

Type

intdash.DataPoints

property edges

エッジリソースへのアクセスオブジェクト

Type

intdash.Edges

property measurement_basetimes

基準時刻リソースへのアクセスオブジェクト

Type

intdash.MeasurementBasetimes

property measurement_markers

計測マーカーリソースへのアクセスオブジェクト

Type

intdash.MeasurementMarkers

property measurements

計測リソースへのアクセスオブジェクト

Type

intdash.Measurements

property signals

信号定義リソースへのアクセスオブジェクト

Type

intdash.Signals

property units

時系列データ(ユニット形式)へのアクセスオブジェクト

Type

intdash.Units