Class default

MESH_100GP management class

Hierarchy

MESH<MESH_100GP_Data>
- default

Index

Constructors

constructor

Accessors

mode

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` DigitalPins

DigitalPins: {
    p1: boolean;
    p2: boolean;
    p3: boolean;
} = ...

Type declaration

p1: boolean
p2: boolean
p3: boolean

`Readonly` address

address: string

`Readonly` beaconData

beaconData: null | number[]

`Readonly` beaconDataInScanResponse

beaconDataInScanResponse: null | number[]

onAnalogInputEvent

onAnalogInputEvent: null | ((level) => void) = null

Type declaration

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

onBatteryLevel

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

Type declaration

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

onDigitalInputEvent

onDigitalInputEvent: null | ((pin, state) => void) = null

Type declaration

- (pin, state): void
- Parameters
  - pin: number
  - state: 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` `Readonly` AnalogInputEventCondition

AnalogInputEventCondition: {
    ABOVE_THRESHOLD: 17;
    BELOW_THRESHOLD: 34;
    NOT_NOTIFY: 0;
} = GPIO.AnalogInputEventCondition

Type declaration

Readonly ABOVE_THRESHOLD: 17
Readonly BELOW_THRESHOLD: 34
Readonly NOT_NOTIFY: 0

`Static` `Readonly` AnalogInputNotifyMode

AnalogInputNotifyMode: {
    ALWAYS: 2;
    ONCE: 1;
    STOP: 0;
} = GPIO.AnalogInputNotifyMode

Type declaration

Readonly ALWAYS: 2
Readonly ONCE: 1
Readonly STOP: 0

`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` DigitalInputState

DigitalInputState: {
HIGH: 0;
LOW: 1;
} = GPIO.DigitalInputState

Type declaration

HIGH: 0
LOW: 1

`Static` `Readonly` LocalName

LocalName: RegExp = ...

Used as a condition of isDevice() by default.

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

`Static` `Readonly` PartsName

PartsName: "MESH_100GP" = 'MESH_100GP'

`Static` `Readonly` Pin

Pin: {
    P1: 0;
    P2: 1;
    P3: 2;
} = GPIO.Pin

Type declaration

Readonly P1: 0
Readonly P2: 1
Readonly P3: 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()の条件として使用

`Static` `Readonly` State

State: {
HIGH_2_LOW: 2;
LOW_2_HIGH: 1;
} = GPIO.State

Type declaration

Readonly HIGH_2_LOW: 2
Readonly LOW_2_HIGH: 1

`Static` `Readonly` Vcc

Vcc: {
OFF: 2;
ON: 1;
} = GPIO.Vcc

Type declaration

Readonly OFF: 2
Readonly ON: 1

`Static` `Readonly` VccState

VccState: {
OFF: 0;
ON: 1;
} = GPIO.VccState

Type declaration

Readonly OFF: 0
Readonly ON: 1

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

getAnalogInputDataWait

getAnalogInputDataWait(opt_timeoutMsec?): Promise<number>
getAnalogInputDataWait
Parameters
- opt_timeoutMsec: 5000 = ...
Returns Promise<number>
- Defined in src/parts/Ble/MESH_100GP/index.ts:112

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_100GP/index.ts:82

getDigitalInputDataWait

getDigitalInputDataWait(pin, opt_timeoutMsec?): Promise<number>
getDigitalInputDataWait
Parameters
- pin: number
- opt_timeoutMsec: 5000 = ...
Returns Promise<number>
- Defined in src/parts/Ble/MESH_100GP/index.ts:96

getDigitalOutputDataWait

getDigitalOutputDataWait(pin, opt_timeoutMsec?): Promise<number>
getDigitalOutputDataWait
Parameters
- pin: number
- opt_timeoutMsec: 5000 = ...
Returns Promise<number>
- Defined in src/parts/Ble/MESH_100GP/index.ts:142

getPwmDataWait

getPwmDataWait(opt_timeoutMsec?): Promise<number>
getPwmDataWait
Parameters
- opt_timeoutMsec: 5000 = ...
Returns Promise<number>
- Defined in src/parts/Ble/MESH_100GP/index.ts:158

getVOutputDataWait

getVOutputDataWait(opt_timeoutMsec?): Promise<number>
getVOutputDataWait
Parameters
- opt_timeoutMsec: 5000 = ...
Returns Promise<number>
- Defined in src/parts/Ble/MESH_100GP/index.ts:128

setDigitalOutput

setDigitalOutput(digitalOutput): void
setDigitalOutput
Parameters
- digitalOutput: {
      p1: boolean;
      p2: boolean;
      p3: boolean;
  }
  
  { p1:boolean, p2:boolean, p3:boolean }
  - p1: boolean
  - p2: boolean
  - p3: boolean
Returns void
- Defined in src/parts/Ble/MESH_100GP/index.ts:270

setMode

setMode(digitalInputLow2High, digitalInputHigh2Low, digitalOutput, pwmRatio, vcc, analogInputRangeUpper, analogInputRangeLower, analogInputCondition): void
setMode
Parameters
- digitalInputLow2High: {
      p1: boolean;
      p2: boolean;
      p3: boolean;
  }
  
  {p1:boolean, p2:boolean, p3:boolean}
  - p1: boolean
  - p2: boolean
  - p3: boolean
- digitalInputHigh2Low: {
      p1: boolean;
      p2: boolean;
      p3: boolean;
  }
  
  {p1:boolean, p2:boolean, p3:boolean}
  - p1: boolean
  - p2: boolean
  - p3: boolean
- digitalOutput: {
      p1: boolean;
      p2: boolean;
      p3: boolean;
  }
  
  {p1:boolean, p2:boolean, p3:boolean}
  - p1: boolean
  - p2: boolean
  - p3: boolean
- pwmRatio: number
  
  0-255
- vcc: number
  
  Vcc.ON or Vcc.OFF
- analogInputRangeUpper: number
  
  0-255(0.00-3.00[V])
- analogInputRangeLower: number
  
  0-255(0.00-3.00[V])
- analogInputCondition: number
  
  AnalogInputEventCondition.NOT_NOTIFY or AnalogInputEventCondition.ABOVE_THRESHOLD or AnalogInputEventCondition.BELOW_THRESHOLD
Returns void
- Defined in src/parts/Ble/MESH_100GP/index.ts:178

setModeAnalogInput

setModeAnalogInput(analogInputRangeUpper, analogInputRangeLower, analogInputCondition): void
setModeAnalogInput
Parameters
- analogInputRangeUpper: number
  
  0-255(0.00-3.00[V])
- analogInputRangeLower: number
  
  0-255(0.00-3.00[V])
- analogInputCondition: number
  
  AnalogInputEventCondition.NOT_NOTIFY or AnalogInputEventCondition.ABOVE_THRESHOLD or AnalogInputEventCondition.BELOW_THRESHOLD
Returns void
- Defined in src/parts/Ble/MESH_100GP/index.ts:243

setModeDigitalInput

setModeDigitalInput(digitalInputLow2High, digitalInputHigh2Low): void
setModeDigitalInput
Parameters
- digitalInputLow2High: {
      p1: boolean;
      p2: boolean;
      p3: boolean;
  }
  
  { p1:boolean, p2:boolean, p3:boolean }
  - p1: boolean
  - p2: boolean
  - p3: boolean
- digitalInputHigh2Low: {
      p1: boolean;
      p2: boolean;
      p3: boolean;
  }
  
  { p1:boolean, p2:boolean, p3:boolean }
  - p1: boolean
  - p2: boolean
  - p3: boolean
Returns void
- Defined in src/parts/Ble/MESH_100GP/index.ts:216

setPwmOutput

setPwmOutput(pwmRatio): void
setPwmOutput
Parameters
- pwmRatio: number
  
  0-255
Returns void
- Defined in src/parts/Ble/MESH_100GP/index.ts:291

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

setVOutput

setVOutput(vcc): void
setVOutput
Parameters
- vcc: number
  
  Vcc.ON or Vcc.OFF
Returns void
- Defined in src/parts/Ble/MESH_100GP/index.ts:312

`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_100GP/index.ts:70

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

peripheral: BleRemotePeripheral

Returns default

Properties

Readonly DigitalPins

Type declaration

p1: boolean

p2: boolean

p3: boolean

Readonly address

Readonly beaconData

Readonly beaconDataInScanResponse

onAnalogInputEvent

Type declaration

Parameters

level: number

Returns void

onBatteryLevel

Type declaration

Parameters

battery: number

Returns void

onDigitalInputEvent

Type declaration

Parameters

pin: number

state: 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 Readonly AnalogInputEventCondition

Type declaration

Readonly ABOVE_THRESHOLD: 17

Readonly BELOW_THRESHOLD: 34

Readonly NOT_NOTIFY: 0

Static Readonly AnalogInputNotifyMode

Type declaration

Readonly ALWAYS: 2

Readonly ONCE: 1

Readonly STOP: 0

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 DigitalInputState

Type declaration

HIGH: 0

LOW: 1

Static Readonly LocalName

Static Readonly PartsName

Static Readonly Pin

Type declaration

Readonly P1: 0

Readonly P2: 1

Readonly P3: 2

`Readonly` DigitalPins

`Readonly` address

`Readonly` beaconData

`Readonly` beaconDataInScanResponse

`Optional` ondisconnect

`Readonly` peripheral

`Readonly` serviceData

`Static` `Optional` `Readonly` Address

`Static` `Readonly` AnalogInputEventCondition

`Readonly` ABOVE_THRESHOLD: 17

`Readonly` BELOW_THRESHOLD: 34

`Readonly` NOT_NOTIFY: 0

`Static` `Readonly` AnalogInputNotifyMode

`Readonly` ALWAYS: 2

`Readonly` ONCE: 1

`Readonly` STOP: 0

`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` DigitalInputState

`Static` `Readonly` LocalName

`Static` `Readonly` PartsName

`Static` `Readonly` Pin

`Readonly` P1: 0

`Readonly` P2: 1

`Readonly` P3: 2

`Static` `Optional` `Readonly` ServiceDataLength

`Static` `Optional` `Readonly` ServiceDataStruct

`Static` `Optional` `Readonly` ServiceDataUUID

`Static` `Optional` `Readonly` ServiceUuids

`Static` `Readonly` State

`Readonly` HIGH_2_LOW: 2

`Readonly` LOW_2_HIGH: 1

`Static` `Readonly` Vcc

`Readonly` OFF: 2

`Readonly` ON: 1

`Static` `Readonly` VccState

`Readonly` OFF: 0

`Readonly` ON: 1

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

digitalOutput: {
p1: boolean;
p2: boolean;
p3: boolean;
}

digitalInputLow2High: {
p1: boolean;
p2: boolean;
p3: boolean;
}

digitalInputHigh2Low: {
p1: boolean;
p2: boolean;
p3: boolean;
}