Class default

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

Hierarchy

default<Logtta_CO2_Data, Logtta_CO2_Connected_Data>
- default

Constructors

constructor

new default(peripheral, mode): default
Parameters
- peripheral: BleRemotePeripheral
- mode: "Beacon" | "Connectable" | "Pairing"
Returns default
Inherited from default.constructor
- Defined in src/parts/Ble/utils/abstracts/Logtta.ts:54

Properties

`Readonly` address

address: string

`Optional` batteryService

batteryService?: BleBatteryService

`Readonly` beaconData

beaconData: null | number[]

`Readonly` beaconDataInScanResponse

beaconDataInScanResponse: null | number[]

`Optional` genericAccess

genericAccess?: BleGenericAccess

`Optional` onNotify

onNotify?: ((data) => void)

Type declaration

- (data): void
- Parameters
  - data: Logtta_CO2_Connected_Data
  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` `Readonly` BeaconDataLength

BeaconDataLength: ObnizPartsBleCompare<number> = ...

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: ObnizPartsBleCompare<ObnizBleBeaconStruct<Logtta_CO2_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: {
Beacon: RegExp;
Connectable: undefined;
} = ...

Used as a condition of isDevice() by default.

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

Type declaration

Beacon: RegExp
Connectable: undefined

`Static` `Readonly` PartsName

PartsName: "Logtta_CO2" = 'Logtta_CO2'

`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` `Readonly` ServiceUuids

ServiceUuids: {
Beacon: null;
Connectable: string;
} = ...

Used as a condition of isDevice() by default.

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

Type declaration

Beacon: null
Connectable: string

Accessors

mode

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

Methods

authPinCodeWait

authPinCodeWait(code): Promise<boolean>
Authorize PIN code

ピンコードを認証
Parameters
- code: string | number
  
  PIN code ピンコード
Returns Promise<boolean>
Whether authentication was/is passed 認証が通った/通っているかどうか
Inherited from default.authPinCodeWait
- Defined in src/parts/Ble/utils/abstracts/Logtta.ts:144

checkMode

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

connectWait

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

デバイスのサービスに接続
Parameters
- Optional keys: string
  
  Key acquired when pairing previously 以前にペアリングしたときに取得されたキー
Returns Promise<void>
Inherited from default.connectWait
- Defined in src/parts/Ble/utils/abstracts/Logtta.ts:65

disconnectWait

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

ペリフェラルから切断

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

getData

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

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

Form advertising data into an associative array

Available modes: Beacon, Connectable(only part)

Returns Logtta_CO2_Data
Inherited from default.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:689

getDataWait

getDataWait(): Promise<Logtta_CO2_Connected_Data>
Get data with connected state

接続状態でデータを取得

Returns Promise<Logtta_CO2_Connected_Data>
received value from each sensor それぞれのセンサから取得した値
Inherited from default.getDataWait
- Defined in src/parts/Ble/utils/abstracts/Logtta.ts:94

getWait

getWait(): Promise<null | number>
Returns Promise<null | number>
CO2 concentration data from the Logtta_CO2

Logtta_CO2から受け取ったCO2濃度データ

Deprecated
Get CO2 concentration data with connected state

接続している状態でCO2濃度データを取得
- Defined in src/parts/Ble/LogttaCO2/index.ts:200

setBeaconMode

setBeaconMode(enable): Promise<boolean>
Parameters
- enable: boolean
  
  enable the beacon mode or not ビーコンモードを有効にするかどうか
Returns Promise<boolean>

Deprecated
Set enable / disable for beacon mode (periodic beacon transmission)

Call this function after authenticating with the sensor

After setting, disconnect once to enable it

To stop beacon mode, you need to hold the button on the sensor for more than 2 seconds

(For more detail, please see http://www.uni-elec.co.jp/logtta_page.html )

ビーコンモード(定期的なビーコン発信)の有効/無効の設定

センサとの認証を済ませた状態で実行してください

設定後に切断した後から有効になります

ビーコンモードの終了は、デバイスのボタンを2秒以上長押しする操作が必要です(詳しくは http://www.uni-elec.co.jp/logtta_page.html )
- Defined in src/parts/Ble/LogttaCO2/index.ts:233

setBeaconModeWait

setBeaconModeWait(enable): Promise<boolean>
Set / unset to Beacon Mode

ビーコンモードに設定/解除
Parameters
- enable: boolean
  
  enable / disable 有効 / 無効
Returns Promise<boolean>
data write result
Inherited from default.setBeaconModeWait
- Defined in src/parts/Ble/utils/abstracts/Logtta.ts:191

startNotifyWait

startNotifyWait(callback): Promise<void>
Notify when the CO2 concentration data have got from the Logtta_CO2 with connected state

接続している状態でLogtta_CO2からCO2濃度データを取得したとき通知
Parameters
- callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: Logtta_CO2_Connected_Data
      
      Returns void
Returns Promise<void>
Overrides default.startNotifyWait
- Defined in src/parts/Ble/LogttaCO2/index.ts:158

`Static` getAvailableBleMode

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

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

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

`Static` getData

getData(peripheral): unknown
Form advertising data into an associative array.

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

Deprecated
Inherited from default.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:627

`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 default.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 default.getServiceUuids
- Defined in src/obniz/ObnizPartsBleAbstract.ts:265

`Static` info

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

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

`Static` isAdvDevice

isAdvDevice(peripheral): boolean
Parameters
- peripheral: BleRemotePeripheral
  
  instance of BleRemotePeripheral BleRemotePeripheralのインスタンス
Returns boolean
Whether it is the Logtta_CO2

Logtta_CO2かどうか

Deprecated
Verify that the received advertisement is from the Logtta_CO2 (in Beacon Mode)

受け取ったAdvertisementがLogtta_CO2のものかどうか確認する(ビーコンモード中)
- Defined in src/parts/Ble/LogttaCO2/index.ts:141

`Static` isDevice

isDevice(peripheral): boolean
Parameters
- peripheral: BleRemotePeripheral
  
  instance of BleRemotePeripheral BleRemotePeripheralのインスタンス
Returns boolean
Whether it is the Logtta_CO2

Logtta_CO2かどうか

Deprecated
Verify that the received peripheral is from the Logtta_CO2

受け取ったPeripheralがLogtta_CO2のものかどうかを確認する
Overrides default.isDevice
- Defined in src/parts/Ble/LogttaCO2/index.ts:124

`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 default.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

Optional batteryService

Readonly beaconData

Readonly beaconDataInScanResponse

Optional genericAccess

Optional onNotify

Type declaration

Parameters

data: Logtta_CO2_Connected_Data

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 Readonly BeaconDataLength

Static Optional Readonly BeaconDataLength_ScanResponse

Static Readonly BeaconDataStruct

Static Readonly CompanyID

Static Optional Readonly CompanyID_ScanResponse

Static Readonly LocalName

Type declaration

Beacon: RegExp

Connectable: undefined

Static Readonly PartsName

Static Optional Readonly ServiceDataLength

Static Optional Readonly ServiceDataStruct

Static Optional Readonly ServiceDataUUID

Static Readonly ServiceUuids

Type declaration

Beacon: null

Connectable: string

Accessors

mode

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

Methods

authPinCodeWait

Parameters

code: string | number

Returns Promise<boolean>

checkMode

Parameters

force: boolean = false

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

connectWait

Parameters

Optional keys: string

Returns Promise<void>

disconnectWait

Returns Promise<void>

getData

Returns Logtta_CO2_Data

getDataWait

Returns Promise<Logtta_CO2_Connected_Data>

getWait

Returns Promise<null | number>

Deprecated

setBeaconMode

Parameters

enable: boolean

Returns Promise<boolean>

Deprecated

`Readonly` address

`Optional` batteryService

`Readonly` beaconData

`Readonly` beaconDataInScanResponse

`Optional` genericAccess

`Optional` onNotify

`Optional` ondisconnect

`Readonly` peripheral

`Readonly` serviceData

`Static` `Optional` `Readonly` Address

`Static` `Readonly` AvailableBleMode

`Static` `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` `Readonly` ServiceUuids

`Optional` keys: string

`Static` getAvailableBleMode

`Static` getData

`Static` getDeviceMode

`Static` getServiceUuids

`Static` info

`Static` isAdvDevice

`Static` isDevice

`Static` isDeviceWithMode