Class default

MESH_100TH management class

Hierarchy

MESH<MESH_100LE_Data>
- default

Constructors

constructor

new default(peripheral): default
Create new instance of MESH
Parameters
- peripheral: BleRemotePeripheral
Returns default
Inherited from MESH.constructor
- Defined in src/parts/Ble/utils/abstracts/MESH.ts:52

Properties

`Readonly` address

address: string

`Readonly` beaconData

beaconData: null | number[]

`Readonly` beaconDataInScanResponse

beaconDataInScanResponse: null | number[]

colors

colors: {
    blue: number;
    green: number;
    red: number;
} = ...

Type declaration

blue: number
green: number
red: number

onBatteryLevel

onBatteryLevel: null | ((battery) => void) = null

Type declaration

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

onStatusButtonPressed

onStatusButtonPressed: null | (() => void) = null

Type declaration

- (): void
- Returns void

onWriteResponse

onWriteResponse: null | ((response) => void) = null

Type declaration

- (response): void
- Parameters
  - response: boolean
  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` AvailableBleMode

AvailableBleMode: "Connectable" = ...

`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` `Optional` `Readonly` BeaconDataStruct

BeaconDataStruct?: ObnizPartsBleCompare<ObnizBleBeaconStruct<unknown>>

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

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

`Static` `Optional` `Readonly` CompanyID

CompanyID?: ObnizPartsBleCompare<number[]> = undefined

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 = ...

Used as a condition of isDevice() by default.

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

`Static` `Readonly` PartsName

PartsName: "MESH_100LE" = 'MESH_100LE'

`Static` Pattern

Pattern: {
BLINK: 1;
FIREFLY: 2;
} = LED.PATTERN

Type declaration

Readonly BLINK: 1
Readonly FIREFLY: 2

`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 MESH.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 MESH.checkMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:673

connectWait

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

Returns Promise<void>
Inherited from MESH.connectWait
- Defined in src/parts/Ble/utils/abstracts/MESH.ts:61

disconnectWait

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

ペリフェラルから切断

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

getData

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

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

Form advertising data into an associative array

Available modes: Beacon, Connectable(only part)

Returns null
Inherited from MESH.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:689

getDataWait

getDataWait(): Promise<{
address: string;
name: string;
}>
getDataWait

Returns Promise<{
address: string;
name: string;
}>
Overrides MESH.getDataWait
- Defined in src/parts/Ble/MESH_100LE/index.ts:47

setLed

setLed(colors, totalTime, cycleOnTime, cycleOffTime, pattern): void
setLed
Parameters
- colors: {
      blue: number;
      green: number;
      red: number;
  }
  
  { red: 0-127, green: 0-127, blue: 0-127 }
  - blue: number
  - green: number
  - red: number
- totalTime: number
  
  0-65,535 [ms]
- cycleOnTime: number
  
  0-65,535 [ms]
- cycleOffTime: number
  
  0-65,535 [ms]
- pattern: number
  
  Pattern.BLINK or Pattern.FIREFLY
Returns void
void
- Defined in src/parts/Ble/MESH_100LE/index.ts:65

setStatusbarLed

setStatusbarLed(power, red, green, blue): void
Control statusbar LED
Parameters
- power: boolean
- red: boolean
- green: boolean
- blue: boolean
Returns void
Inherited from MESH.setStatusbarLed
- Defined in src/parts/Ble/utils/abstracts/MESH.ts:109

`Static` getAvailableBleMode

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

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

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

`Static` info

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

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

`Static` isDevice

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

Deprecated
Inherited from MESH.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 MESH.isDeviceWithMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:387

`Static` isMESHblock

isMESHblock(peripheral, opt_serialnumber?): boolean
Check MESH block
Parameters
- peripheral: BleRemotePeripheral
- opt_serialnumber: string = ''
Returns boolean
Overrides MESH.isMESHblock
- Defined in src/parts/Ble/MESH_100LE/index.ts:35

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

peripheral: BleRemotePeripheral

Returns default

Properties

Readonly address

Readonly beaconData

Readonly beaconDataInScanResponse

colors

Type declaration

blue: number

green: number

red: number

onBatteryLevel

Type declaration

Parameters

battery: number

Returns void

onStatusButtonPressed

Type declaration

Returns void

onWriteResponse

Type declaration

Parameters

response: boolean

Returns void

Optional ondisconnect

Type declaration

Parameters

reason: unknown

Returns void | Promise<void>

Readonly peripheral

Readonly serviceData

Static Optional Readonly Address

Static AvailableBleMode

Static Optional Readonly BeaconDataLength

Static Optional Readonly BeaconDataLength_ScanResponse

Static Optional Readonly BeaconDataStruct

Static Optional Readonly CompanyID

Static Optional Readonly CompanyID_ScanResponse

Static Readonly LocalName

Static Readonly PartsName

Static Pattern

Type declaration

Readonly BLINK: 1

Readonly FIREFLY: 2

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"

connectWait

Returns Promise<void>

disconnectWait

Returns Promise<void>

getData

Returns null

getDataWait

Returns Promise<{ address: string; name: string; }>

setLed

Parameters

colors: { blue: number; green: number; red: number; }

blue: number

green: number

red: number

`Readonly` address

`Readonly` beaconData

`Readonly` beaconDataInScanResponse

`Optional` ondisconnect

`Readonly` peripheral

`Readonly` serviceData

`Static` `Optional` `Readonly` Address

`Static` AvailableBleMode

`Static` `Optional` `Readonly` BeaconDataLength

`Static` `Optional` `Readonly` BeaconDataLength_ScanResponse

`Static` `Optional` `Readonly` BeaconDataStruct

`Static` `Optional` `Readonly` CompanyID

`Static` `Optional` `Readonly` CompanyID_ScanResponse

`Static` `Readonly` LocalName

`Static` `Readonly` PartsName

`Static` Pattern

`Readonly` BLINK: 1

`Readonly` FIREFLY: 2

`Static` `Optional` `Readonly` ServiceDataLength

`Static` `Optional` `Readonly` ServiceDataStruct

`Static` `Optional` `Readonly` ServiceDataUUID

`Static` `Optional` `Readonly` ServiceUuids

Returns Promise<{
address: string;
name: string;
}>

colors: {
blue: number;
green: number;
red: number;
}

`Static` getAvailableBleMode

`Static` getData

`Static` getDeviceMode

`Static` getServiceUuids

`Static` info

`Static` isDevice

`Static` isDeviceWithMode

`Static` isMESHblock