Class default

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

Hierarchy

BaseiBS<iBS04i_Data>
- default

Constructors

constructor

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

Properties

`Readonly` address

address: string

`Readonly` beaconData

beaconData: null | number[]

`Readonly` beaconDataInScanResponse

beaconDataInScanResponse: null | number[]

`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

AvailableBleMode: "Beacon" = 'Beacon'

`Static` `Readonly` BeaconDataLength

BeaconDataLength: 26 = 0x1a

Used as a condition of isDevice() by default.

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

`Static` `Readonly` BeaconDataLength_ScanResponse

BeaconDataLength_ScanResponse: number = BaseiBS.BeaconDataLength

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

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

`Static` `Readonly` BeaconDataStruct

BeaconDataStruct: ObnizBleBeaconStruct<iBS04i_Data> = ...

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

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

`Static` `Readonly` CompanyID

CompanyID: number[] = iBeaconCompanyID

Used as a condition of isDevice() by default.

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

`Static` `Readonly` CompanyID_ScanResponse

CompanyID_ScanResponse: number[] = BaseiBS.CompanyID

Used as a condition of isDevice() by default.

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

`Static` `Readonly` Config

Config: {
    acceleration: ObnizBleBeaconStructNormal<unknown, never>;
    battery: ObnizBleBeaconStructNormal<unknown, never>;
    button: ObnizBleBeaconStructNormal<unknown, never>;
    count: ObnizBleBeaconStructNormal<unknown, never>;
    current: ObnizBleBeaconStructNormal<unknown, never>;
    event: ObnizBleBeaconStructNormal<unknown, never>;
    fall: ObnizBleBeaconStructNormal<unknown, never>;
    flood: ObnizBleBeaconStructNormal<unknown, never>;
    humidity: ObnizBleBeaconStructNormal<unknown, never>;
    input_trigger: ObnizBleBeaconStructNormal<unknown, never>;
    moving: ObnizBleBeaconStructNormal<unknown, never>;
    pir: ObnizBleBeaconStructNormal<unknown, never>;
    proximity: ObnizBleBeaconStructNormal<unknown, never>;
    temperature: ObnizBleBeaconStructNormal<unknown, never>;
    triggered: ObnizBleBeaconStructNormal<unknown, never>;
    triggered_count: ObnizBleBeaconStructNormal<unknown, never>;
    user: ObnizBleBeaconStructNormal<unknown, never>;
    voltage: ObnizBleBeaconStructNormal<unknown, never>;
} = ...

Type declaration

acceleration: ObnizBleBeaconStructNormal<unknown, never>
battery: ObnizBleBeaconStructNormal<unknown, never>
button: ObnizBleBeaconStructNormal<unknown, never>
count: ObnizBleBeaconStructNormal<unknown, never>
current: ObnizBleBeaconStructNormal<unknown, never>
event: ObnizBleBeaconStructNormal<unknown, never>
fall: ObnizBleBeaconStructNormal<unknown, never>
flood: ObnizBleBeaconStructNormal<unknown, never>
humidity: ObnizBleBeaconStructNormal<unknown, never>
input_trigger: ObnizBleBeaconStructNormal<unknown, never>
moving: ObnizBleBeaconStructNormal<unknown, never>
pir: ObnizBleBeaconStructNormal<unknown, never>
proximity: ObnizBleBeaconStructNormal<unknown, never>
temperature: ObnizBleBeaconStructNormal<unknown, never>
triggered: ObnizBleBeaconStructNormal<unknown, never>
triggered_count: ObnizBleBeaconStructNormal<unknown, never>
user: ObnizBleBeaconStructNormal<unknown, never>
voltage: ObnizBleBeaconStructNormal<unknown, never>

`Static` `Optional` `Readonly` LocalName

LocalName?: ObnizPartsBleCompareWithNonNull<RegExp> = undefined

Used as a condition of isDevice() by default.

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

`Static` `Readonly` PartsName

PartsName: "iBS04i" = 'iBS04i'

`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 BaseiBS.mode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:651

Methods

checkMode

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

getData

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

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

Form advertising data into an associative array

Available modes: Beacon, Connectable(only part)

Returns iBS04i_Data
Inherited from BaseiBS.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:689

`Static` getAvailableBleMode

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

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

Returns ("Beacon" | "Connectable" | "Pairing")[]
Inherited from BaseiBS.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 BaseiBS.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 BaseiBS.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 BaseiBS.getServiceUuids
- Defined in src/obniz/ObnizPartsBleAbstract.ts:265

`Static` info

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

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

`Static` isDevice

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

Deprecated
Inherited from BaseiBS.isDevice
- Defined in src/obniz/ObnizPartsBleAbstract.ts:351

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

Readonly peripheral

Readonly serviceData

Static Optional Readonly Address

Static Readonly AvailableBleMode

Static Readonly BeaconDataLength

Static Readonly BeaconDataLength_ScanResponse

Static Readonly BeaconDataStruct

Static Readonly CompanyID

Static Readonly CompanyID_ScanResponse

Static Readonly Config

Type declaration

acceleration: ObnizBleBeaconStructNormal<unknown, never>

battery: ObnizBleBeaconStructNormal<unknown, never>

button: ObnizBleBeaconStructNormal<unknown, never>

count: ObnizBleBeaconStructNormal<unknown, never>

current: ObnizBleBeaconStructNormal<unknown, never>

event: ObnizBleBeaconStructNormal<unknown, never>

fall: ObnizBleBeaconStructNormal<unknown, never>

flood: ObnizBleBeaconStructNormal<unknown, never>

humidity: ObnizBleBeaconStructNormal<unknown, never>

input_trigger: ObnizBleBeaconStructNormal<unknown, never>

moving: ObnizBleBeaconStructNormal<unknown, never>

pir: ObnizBleBeaconStructNormal<unknown, never>

proximity: ObnizBleBeaconStructNormal<unknown, never>

temperature: ObnizBleBeaconStructNormal<unknown, never>

triggered: ObnizBleBeaconStructNormal<unknown, never>

triggered_count: ObnizBleBeaconStructNormal<unknown, never>

user: ObnizBleBeaconStructNormal<unknown, never>

voltage: ObnizBleBeaconStructNormal<unknown, never>

Static Optional 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

checkMode

Parameters

force: boolean = false

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

getData

Returns iBS04i_Data

Static getAvailableBleMode

Returns ("Beacon" | "Connectable" | "Pairing")[]

Static getData

Parameters

peripheral: BleRemotePeripheral

Returns unknown

Deprecated

Static getDeviceMode

Parameters

peripheral: BleRemotePeripheral

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

Static getServiceUuids

Parameters

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

Returns undefined | null | string[]

Static info

Returns ObnizPartsInfo

Static isDevice

`Readonly` address

`Readonly` beaconData

`Readonly` beaconDataInScanResponse

`Readonly` peripheral

`Readonly` serviceData

`Static` `Optional` `Readonly` Address

`Static` `Readonly` AvailableBleMode

`Static` `Readonly` BeaconDataLength

`Static` `Readonly` BeaconDataLength_ScanResponse

`Static` `Readonly` BeaconDataStruct

`Static` `Readonly` CompanyID

`Static` `Readonly` CompanyID_ScanResponse

`Static` `Readonly` Config

`Static` `Optional` `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