Home Reference Source
      import { Scanner } from 'buildthing-ble-sdk'
    
public class | source

Scanner

Extends:

EventEmitter → Scanner

'특정 주기' 로 비콘을 스캔한다. (주기 그리고 주기 간격에 따라 스캔한다.)

빌드잇 비콘을 찾기 위해 특정 서비스 UUID로 필터링하여 스캔한다.

서비스 UUID로 필터링 된 비콘을 core/beacon-parser를 이용하여 파싱하고 core/beacon 인스턴스로 생성한다.

비콘 스캔 시 Callback 제공 (emit으로 trigger, 비콘 데이터를 파싱해서 파라미터로 넘긴다.)

비콘 스캔 주기 1 Cycle 완료 시 Callback 제공 (emit로 trigger)

Constructor Summary

Public Constructor
public

constructor(manager: Manager)

스캐너가 사용하는 manager, ble 라이브러리, beaconParser 등을 설정하고, 스캐너 관련 초기 설정값을 설정한다.

Member Summary

Public Members
public

스캐너에서 비콘 정보를 파싱 할때 사용하는 비콘 파서

public

스캐너에서 빌드씽 IAQ 정보를 파싱 할때 사용하는 빌드씽 IAQ 파서

public

스캐너에서 게이트웨이 정보를 파싱 할때 사용하는 게이트웨이 파서

public

스캐너가 스캐닝 작업 중 인지 여부

public

스캐너의 스캔 타입 (all: 0, beacon: 1, gateway: 2 ...)

Method Summary

Public Methods
public

setScanPeriod(period: number, betweenPeriod: number)

스캔 사이클 지속 시간, 스캔 사이클 간 간격 시간 설정하는 함수

public

setScanType(scanType: number)

스캐너의 디바이스 스캔 타입을 설정 하는 함수

public

일정 주기마다 반복되는 스캔을 시작하는 함수

public

동작하고 있는 스캔을 멈추는 함수

Inherited Summary

From class EventEmitter
public

등록된 이벤트 Set 을 저장 할 객체

public

emit(eventName: string, args: Object)

이벤트를 발생시켜 해당 이벤트에 등록된 이벤트 콜백 함수를 호출 하는 함수

public

off(eventName: string, fn: function)

전달받은 이벤트 명 과 이벤트 콜백함수 통해서 이벤트 Set 에서 이벤트 콜백 함수를 제거하는 함수

public

on(eventName: string, fn: function)

전달받은 이벤트 명으로, 전달받은 이벤트 콜백 함수를 등록하는 함수

public

once(eventName: string, fn: function)

이벤트가 발생한 경우 한번만 호출되는 이벤트 콜백 함수를 등록 하는 함수

Public Constructors

public constructor(manager: Manager) source

스캐너가 사용하는 manager, ble 라이브러리, beaconParser 등을 설정하고, 스캐너 관련 초기 설정값을 설정한다.

Override:

EventEmitter#constructor

Params:

NameTypeAttributeDescription
manager Manager

스캐너에서 사용하는 Manager 인스턴스

Public Members

public beaconParser: BeaconParser source

스캐너에서 비콘 정보를 파싱 할때 사용하는 비콘 파서

public buildThingIAQParser: BuildThingIAQParser source

스캐너에서 빌드씽 IAQ 정보를 파싱 할때 사용하는 빌드씽 IAQ 파서

public gatewayParser: GatewayParser source

스캐너에서 게이트웨이 정보를 파싱 할때 사용하는 게이트웨이 파서

public isScanning: boolean source

스캐너가 스캐닝 작업 중 인지 여부

public scanType: number source

스캐너의 스캔 타입 (all: 0, beacon: 1, gateway: 2 ...)

Public Methods

public setScanPeriod(period: number, betweenPeriod: number) source

스캔 사이클 지속 시간, 스캔 사이클 간 간격 시간 설정하는 함수

Params:

NameTypeAttributeDescription
period number

한 스캔 사이클 지속 시간 (단위: 1ms)

betweenPeriod number

스캔 사이클 간 간격 시간 (단위: 1ms)

public setScanType(scanType: number) source

스캐너의 디바이스 스캔 타입을 설정 하는 함수

Params:

NameTypeAttributeDescription
scanType number

스캐너의 스캔 타입 (all: 0, beacon: 1, gateway: 2 ...)

public startScan() source

일정 주기마다 반복되는 스캔을 시작하는 함수

Emit:

scanStart

이벤트를 스캔을 시작 할때 emit 한다.

public stopScan() source

동작하고 있는 스캔을 멈추는 함수

Emit:

scanStop

이벤트를 스캔이 중지 될때 emit 한다.