omron

Description:

OMRON USB環境センサ (2JCIE-BU) を制御するモジュール

Source:

index.js, line 80

Members

(static) callback :function

Description:

コールバック関数

Source:

index.js, line 90

コールバック関数

Type:

function

(static) debug :boolean

Description:

デバッグモードフラグ

Source:

index.js, line 122

デバッグモードフラグ

Type:

boolean

(static) internalBuffer :Uint8Array

Description:

受信データバッファ (内部用)

Source:

index.js, line 129

受信データバッファ (内部用)

Type:

Uint8Array

(static) port :SerialPort

Description:

シリアルポートオブジェクト

Source:

index.js, line 115

シリアルポートオブジェクト

Type:

SerialPort

(static) portConfig :object

Description:

シリアルポートの設定

Source:

index.js, line 102

Properties:

Name	Type	Description
`path`	string	ポートパス (例: 'COM3')
`baudRate`	number	ボーレート (デフォルト: 115200)
`dataBits`	number	データビット (デフォルト: 8)
`stopBits`	number	ストップビット (デフォルト: 1)
`parity`	string	パリティ (デフォルト: 'none')

シリアルポートの設定

Type:

object

Methods

(static) calcCrc16(typed_array_list) → {number}

Description:

Typed Array のリストから CRC-16 を算出

Source:

index.js, line 251

Parameters:

Name	Type	Description
`typed_array_list`	Array.<TypedArray>	計算対象のTyped Arrayリスト

Returns:

計算されたCRC-16値

Type: number

(static) concatTypedArrays(typed_array_list) → {Uint8Array}

Description:

Typed Array オブジェクトのリストを 1 つの Uint8Array に連結

Source:

index.js, line 234

Parameters:

Name	Type	Description
`typed_array_list`	Array.<TypedArray>	連結したいTyped Arrayのリスト

Returns:

連結されたUint8Array

Type: Uint8Array

(static) createRequestData() → {Uint8Array}

Description:

リクエストデータ生成 (Uint8Array) Read Latest data short (0x5022)

Source:

index.js, line 148

Returns:

生成されたリクエストデータ

Type: Uint8Array

(static) createSettingLED(option) → {Uint8Array}

Description:

LED設定用データ生成 (Uint8Array)

Source:

index.js, line 174

Parameters:

Name Type Description

option

object

LED設定オプション

Properties

Name	Type	Description
`red`	number	赤色の輝度 (0-255)
`green`	number	緑色の輝度 (0-255)
`blue`	number	青色の輝度 (0-255)

Returns:

生成された設定データ

Type: Uint8Array

(async, static) flashMemoryStatus()

Description:

フラッシュメモリの状態を確認する

Source:

index.js, line 406

(async, static) getPortList() → {Promise.<Array>}

Description:

利用可能なシリアルポートのリストを取得

Source:

index.js, line 352

Returns:

シリアルポート情報の配列

Type: Promise.<Array>

(static) isEmpty(obj) → {boolean}

Description:

空オブジェクト判定

Source:

index.js, line 137

Parameters:

Name	Type	Description
`obj`	object	判定するオブジェクト

Returns:

空の場合はtrue

Type: boolean

(static) parseResponse(recvData) → {SensorData|object|undefined}

Description:

レスポンスデータをパースしてオブジェクトに変換 (呼び出し元で完全なパケットフレームであることを保証すること)

Source:

index.js, line 279

Parameters:

Name	Type	Description
`recvData`	Uint8Array	受信データ (1パケット分)

Returns:

パースされたセンサーデータオブジェクト、またはundefined

Type: SensorData | object | undefined

(static) requestData()

Description:

センサーデータのリクエストを送信

Source:

index.js, line 366

(async, static) settingLED(option)

Description:

LEDの設定を行う

Source:

index.js, line 386

Parameters:

Name	Type	Description
`option`	object	LED設定オプション

(async, static) start(callback, optionsopt)

Description:

モジュールの開始処理シリアルポートを探索し、接続を確立してデータ受信の準備を行う

Source:

index.js, line 422

Parameters:

Name Type Attributes Default Description

callback function データ受信時またはエラー発生時に呼ばれるコールバック関数 (data, err)

options

object

{}

オプション設定

Properties

Name	Type	Attributes	Default	Description
`debug`	boolean	<optional>	`false`	デバッグモードの有効化

(static) stop()

Description:

モジュールの停止処理シリアルポートを閉じる

Source:

index.js, line 584