Signals - 信号定義へのアクセスオブジェクト¶
信号定義リソースへのアクセスAPIを提供します。 信号定義とは、サーバーからデータを取得する際にバイナリデータを物理値に変換するための変換定義を示します。適切な信号定義を指定することにより、サーバー側で時系列データを物理値に変換することができます。
Request Methods¶
警告
以下のアクセスオブジェクトは、必ず client の signals を使用して生成してください。
client = intdash.Client(...)
client.signals.list()
-
class
Signals
(...)[ソース]¶ 信号定義リソースへのアクセスオブジェクトです。
-
create
(label, data_type, data_id, channel, conversion, display, description='')[ソース]¶ 信号定義をサーバー内に作成します。
- パラメータ
label (str) -- ラベル名
data_type (DataType) -- データタイプ
data_id (str) -- データID
channel (int) -- チャンネル
conversion (Conversion) -- 変換定義
display (Display) -- 表示定義
description (str) -- 説明
-
list
(label=None, sort='label', order='asc', limit=100, page=1, iterator=False)[ソース]¶ 信号定義のリストを取得します。
- パラメータ
label (str) -- ラベル名
sort (str) -- ソートに使用するフィールド名
order (str) -- ソート順 (
asc
ordesc
)limit (int) -- 最大取得件数
page (int) -- ページ番号
iterator (bool) -- Trueの場合、イテレータを生成します
- 戻り値
信号定義オブジェクトのリスト
- 戻り値の型
list[Signal]
-
update
(uuid, label=None, description=None, data_type=None, data_id=None, channel=None, conversion=None, display=None)[ソース]¶ 信号定義を更新します。
- パラメータ
uuid (str) -- 更新対象の信号定義のUUID
label (str) -- ラベル名
description (str) -- 説明
data_type (DataType) -- データタイプ
data_id (str) -- データID
channel (int) -- チャンネル
conversion (Conversion) -- 変換定義
display (Display) -- 表示定義
-
Request Params¶
-
class
ConversionType
(...)[ソース]¶ 変換タイプを表す定数です。
-
csv
= 'csv'¶
-
json
= 'json'¶
-
none
= 'none'¶
-
num_fixed_point
= 'num_fixed_point'¶
-
num_floating_point
= 'num_floating_point'¶
-
sub_bytes
= 'sub_bytes'¶
-
sub_string
= 'sub_string'¶
-
-
class
ConversionJSON
(...)[ソース]¶ JSONからの変換を定義するオブジェクトです。
-
fieldpath
¶ フィールドパス
- Type
str
-
value_type
¶ 出力値タイプ (
str
ornum
)- Type
str
-
-
class
ConversionCSV
(...)[ソース]¶ CSVからの変換を定義するオブジェクトです。
-
delimiters
¶ デリミタのリスト
- Type
list[str]
-
index
¶ インデックス
- Type
int
-
value_type
¶ 出力値タイプ (
str
ornum
)- Type
str
-
-
class
ConversionNumFixedPoint
(...)[ソース]¶ 固定小数点数としての読み出しを表す変換定義オブジェクトです。
-
startbit
¶ 開始ビット位置
- Type
int
-
bitsize
¶ ビットサイズ
- Type
int
-
endian
¶ エンディアン (
little
orbig
)- Type
str
-
sign
¶ 符号有無 (
signed
orunsigned
)- Type
str
-
scale
¶ スケールファクター
- Type
float
-
offset
¶ オフセット
- Type
float
-
-
class
ConversionNumFloatingPoint
(...)[ソース]¶ 浮動小数点数としての読み出しを表す変換定義オブジェクトです。
-
startbyte
¶ 開始バイト位置
- Type
int
-
endian
¶ エンディアン (
little
orbig
)- Type
str
-
precision
¶ 精度 (
64
or32
)- Type
int
-
-
class
ConversionSubBytes
(...)[ソース]¶ バイト列の切り出しを表す変換定義オブジェクトです。
-
startbyte
¶ 開始バイト位置
- Type
int
-
bytesize
¶ バイトサイズ
- Type
int
-