Class default

RS_BTEVS1 management class RS_BTEVS1を管理するクラス

Hierarchy

ObnizPartsBleConnectable<RS_BTEVS1_Data, RS_BTEVS1_Data>
- default

Constructors

constructor

new default(peripheral, mode): default
Parameters
- peripheral: BleRemotePeripheral
- mode: "Beacon" | "Connectable" | "Pairing"
Returns default
Inherited from ObnizPartsBleConnectable.constructor
- Defined in src/obniz/ObnizPartsBleAbstract.ts:794

Properties

`Readonly` address

address: string

`Readonly` beaconData

beaconData: null | number[]

`Readonly` beaconDataInScanResponse

beaconDataInScanResponse: null | number[]

firmwareRevision

firmwareRevision: string = ''

onButtonPressed

onButtonPressed: null | ((pressed) => void) = null

Event handler for button ボタンのイベントハンドラー

Type declaration

- (pressed): void
- Parameters
  - pressed: boolean
  Returns void

onCo2Measured

onCo2Measured: null | ((co2) => void) = null

Event handler for co2 sensor CO2センサーのイベントハンドラー

Type declaration

- (co2): void
- Parameters
  - co2: number
  Returns void

onPm2_5Measured

onPm2_5Measured: null | ((pm2_5) => void) = null

Event handler for PM2.5 sensor PM2.5センサーのイベントハンドラー

Type declaration

- (pm2_5): void
- Parameters
  - pm2_5: RS_BTEVS1_Pm2_5
  Returns void

onTempMeasured

onTempMeasured: null | ((temp, humidity) => void) = null

Event handler for temperature sensor 温度センサーのイベントハンドラー

Type declaration

- (temp, humidity): void
- Parameters
  - temp: number
  - humidity: number
  Returns void

`Optional` ondisconnect

ondisconnect?: ((reason) => void | Promise<void>)

Type declaration

- (reason): void | Promise<void>
- onDisconnect callback function.
  
  切断された時に呼ばれるコールバック関数
  Parameters
  - reason: unknown
    
    Reason for being disconnected 切断された理由
  Returns void | Promise<void>

`Readonly` peripheral

peripheral: BleRemotePeripheral

`Readonly` serviceData

serviceData: null | number[]

`Static` `Optional` `Readonly` Address

Address?: ObnizPartsBleCompareWithNonNull<RegExp> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Readonly` AvailableBleMode

`Static` `Optional` `Readonly` BeaconDataLength

BeaconDataLength?: ObnizPartsBleCompare<number> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` BeaconDataLength_ScanResponse

BeaconDataLength_ScanResponse?: ObnizPartsBleCompare<number> = undefined

Overall length of manufacturer-specific data. Used as a condition of isDevice() by default.

製造者固有データ全体の長さ標準でisDevice()の条件として使用

`Static` `Readonly` BeaconDataStruct

BeaconDataStruct: ObnizBleBeaconStruct<RS_BTEVS1_Data> = ...

Used as a condition of isDevice() by default. Compare with data after Company ID.

標準でisDevice()の条件として使用 CompanyID以降のデータと比較

`Static` `Readonly` CompanyID

CompanyID: ObnizPartsBleCompare<number[]> = ...

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` CompanyID_ScanResponse

CompanyID_ScanResponse?: ObnizPartsBleCompare<number[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Readonly` LocalName

LocalName: RegExp = ...

BTEVS-1234: ~~1.0.2 EVS-1234: 1.1.2~~ EVS_1234 1.2~

`Static` `Readonly` PartsName

PartsName: "RS_BTEVS1" = 'RS_BTEVS1'

`Static` `Optional` `Readonly` ServiceDataLength

ServiceDataLength?: ObnizPartsBleCompare<number> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` ServiceDataStruct

ServiceDataStruct?: ObnizPartsBleCompare<ObnizBleBeaconStruct<unknown>>

Used as a condition of isDevice() by default. Compare with data after Service UUID.

標準でisDevice()の条件として使用 ServiceUUID以降のデータと比較

`Static` `Optional` `Readonly` ServiceDataUUID

ServiceDataUUID?: ObnizPartsBleCompare<number[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` ServiceUuids

ServiceUuids?: ObnizPartsBleCompare<string | string[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

Accessors

mode

get mode(): "Beacon" | "Connectable" | "Pairing"
Returns "Beacon" | "Connectable" | "Pairing"
Inherited from ObnizPartsBleConnectable.mode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:651

Methods

buttonChangeStartWait

buttonChangeStartWait(): Promise<void>
Start reading the button state

ボタンの状態読み取りを開始

Returns Promise<void>
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:450

checkMode

checkMode(force?): "Beacon" | "Connectable" | "Pairing"
Parameters
- force: boolean = false
Returns "Beacon" | "Connectable" | "Pairing"
Inherited from ObnizPartsBleConnectable.checkMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:673

co2MeasureStartWait

co2MeasureStartWait(): Promise<void>
Returns Promise<void>

Deprecated
Start reading the co2 sensor

CO2センサーの読み取りを開始
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:492

connectWait

connectWait(): Promise<void>
Connect to the services of a device

デバイスのサービスに接続

Returns Promise<void>
Overrides ObnizPartsBleConnectable.connectWait
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:234

disconnectWait

disconnectWait(): Promise<void>
Disconnect from peripheral.

ペリフェラルから切断

Returns Promise<void>
Inherited from ObnizPartsBleConnectable.disconnectWait
- Defined in src/obniz/ObnizPartsBleAbstract.ts:860

getConfigWait

getConfigWait(): Promise<RS_BTEVS1_Config>
Get device settings デバイスの設定を取得

Returns Promise<RS_BTEVS1_Config>
Instance of RS_BTEVS1_Config RS_BTEVS1_Configのインスタンス
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:348

getData

getData(): RS_BTEVS1_Data
アドバタイジングデータを連想配列に成形

利用可能なモード: Beacon, Connectable(一部のみ)

Form advertising data into an associative array

Available modes: Beacon, Connectable(only part)

Returns RS_BTEVS1_Data
Inherited from ObnizPartsBleConnectable.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:689

getDataWait

getDataWait(): Promise<RS_BTEVS1_Data>
Get device all data Version 1.0.x is not supported デバイスの全てのデータの取得バージョン1.0.xはサポートされません

Returns Promise<RS_BTEVS1_Data>
Overrides ObnizPartsBleConnectable.getDataWait
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:303

pm2_5MeasureStartWait

pm2_5MeasureStartWait(): Promise<void>
Returns Promise<void>

Deprecated
Start reading the PM2.5 sensor Version 1.1 is not supported PM2.5センサーの読み取りを開始バージョン1.1より上のバージョンはサポートされません
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:513

setConfigWait

setConfigWait(config): Promise<boolean>
Write device settings, blanks write initial values

デバイス設定の書き込み、空欄は初期値を書き込み
Parameters
- config: Partial<RS_BTEVS1_Config>
  
  Instance of RS_BTEVS1_Config RS_BTEVS1_Configのインスタンス
Returns Promise<boolean>
Write result 書き込み結果
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:379

setModeLEDWait

setModeLEDWait(blink): Promise<boolean>
Change pairing LED flashing status Version 1.0.x is not supported ペアリングLEDの点滅状態の変更バージョン1.0.xはサポートされません
Parameters
- blink: boolean
  
  Whether it blinks 点滅するかどうか
Returns Promise<boolean>
Write result 書き込み結果
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:434

tempMeasureStartWait

tempMeasureStartWait(): Promise<void>
Returns Promise<void>

Deprecated
Start reading the temperature sensor Version 1.0.x is not supported 温度センサーの読み取りを開始バージョン1.0.xはサポートされません
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:471

`Static` getAvailableBleMode

getAvailableBleMode(): ("Beacon" | "Connectable" | "Pairing")[]
Available BLE modes (Beacon | Connectable | Pairing)

利用可能なBLEのモード (Beacon | Connectable | Pairing)

Returns ("Beacon" | "Connectable" | "Pairing")[]
Inherited from ObnizPartsBleConnectable.getAvailableBleMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:234

`Static` getData

getData(peripheral): null | RS_BTEVS1_Data
Form advertising data into an associative array.

アドバタイジングデータを連想配列に成形
Parameters
- peripheral: BleRemotePeripheral
Returns null | RS_BTEVS1_Data

Deprecated
Overrides ObnizPartsBleConnectable.getData
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:255

`Static` getDeviceMode

getDeviceMode(peripheral): null | "Beacon" | "Connectable" | "Pairing"
Get Peripheral Mode.

ペリフェラルのモードを取得
Parameters
- peripheral: BleRemotePeripheral
  
  BleRemotePeripheral
Returns null | "Beacon" | "Connectable" | "Pairing"
If the corresponding device is that mode, it must be null if not applicable 該当するデバイスならばそのモード、該当しなければnull
Inherited from ObnizPartsBleConnectable.getDeviceMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:363

`Static` getServiceUuids

getServiceUuids(mode): undefined | null | string[]
Parameters
- mode: "Beacon" | "Connectable" | "Pairing"
Returns undefined | null | string[]
Inherited from ObnizPartsBleConnectable.getServiceUuids
- Defined in src/obniz/ObnizPartsBleAbstract.ts:265

`Static` info

info(): ObnizPartsInfo
Information of parts. name: PartsName

Returns ObnizPartsInfo
Inherited from ObnizPartsBleConnectable.info
- Defined in src/obniz/ObnizPartsBleAbstract.ts:225

`Static` isDevice

isDevice(peripheral): boolean
Parameters
- peripheral: BleRemotePeripheral
Returns boolean

Deprecated
Overrides ObnizPartsBleConnectable.isDevice
- Defined in src/parts/Ble/RS_BTEVS1/index.ts:222

`Static` isDeviceWithMode

isDeviceWithMode(peripheral, mode): boolean
Check if peripherals and modes match the library.

ペリフェラルとモードがライブラリと合致するかチェック
Parameters
- peripheral: BleRemotePeripheral
  
  BleRemotePeripheral
- mode: "Beacon" | "Connectable" | "Pairing"
  
  Beacon | Connectable | Pairing
Returns boolean
Whether to match 合致するかどうか
Inherited from ObnizPartsBleConnectable.isDeviceWithMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:387

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

peripheral: BleRemotePeripheral

mode: "Beacon" | "Connectable" | "Pairing"

Returns default

Properties

Readonly address

Readonly beaconData

Readonly beaconDataInScanResponse

firmwareRevision

onButtonPressed

Type declaration

Parameters

pressed: boolean

Returns void

onCo2Measured

Type declaration

Parameters

co2: number

Returns void

onPm2_5Measured

Type declaration

Parameters

pm2_5: RS_BTEVS1_Pm2_5

Returns void

onTempMeasured

Type declaration

Parameters

temp: number

humidity: number

Returns void

Optional ondisconnect

Type declaration

Parameters

reason: unknown

Returns void | Promise<void>

Readonly peripheral

Readonly serviceData

Static Optional Readonly Address

Static Readonly AvailableBleMode

Static Optional Readonly BeaconDataLength

Static Optional Readonly BeaconDataLength_ScanResponse

Static Readonly BeaconDataStruct

Static Readonly CompanyID

Static Optional Readonly CompanyID_ScanResponse

Static Readonly LocalName

Static Readonly PartsName

Static Optional Readonly ServiceDataLength

Static Optional Readonly ServiceDataStruct

Static Optional Readonly ServiceDataUUID

Static Optional Readonly ServiceUuids

Accessors

mode

Returns "Beacon" | "Connectable" | "Pairing"

Methods

buttonChangeStartWait

Returns Promise<void>

checkMode

Parameters

force: boolean = false

Returns "Beacon" | "Connectable" | "Pairing"

co2MeasureStartWait

Returns Promise<void>

Deprecated

connectWait

Returns Promise<void>

disconnectWait

Returns Promise<void>

getConfigWait

Returns Promise<RS_BTEVS1_Config>

getData

Returns RS_BTEVS1_Data

`Readonly` address

`Readonly` beaconData

`Readonly` beaconDataInScanResponse

`Optional` ondisconnect

`Readonly` peripheral

`Readonly` serviceData

`Static` `Optional` `Readonly` Address

`Static` `Readonly` AvailableBleMode

`Static` `Optional` `Readonly` BeaconDataLength

`Static` `Optional` `Readonly` BeaconDataLength_ScanResponse

`Static` `Readonly` BeaconDataStruct

`Static` `Readonly` CompanyID

`Static` `Optional` `Readonly` CompanyID_ScanResponse

`Static` `Readonly` LocalName

`Static` `Readonly` PartsName

`Static` `Optional` `Readonly` ServiceDataLength

`Static` `Optional` `Readonly` ServiceDataStruct

`Static` `Optional` `Readonly` ServiceDataUUID

`Static` `Optional` `Readonly` ServiceUuids

`Static` getAvailableBleMode

`Static` getData

`Static` getDeviceMode

`Static` getServiceUuids

`Static` info

`Static` isDevice

`Static` isDeviceWithMode