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

RangedBeacon

Ranging된 Beacon의 트래킹 정보를 관리한다.

Static Method Summary

Static Public Methods
public static

현재 사용중인 Rssi 필터의 expirationTime을 반환한다.
public static

현재 비콘 트래킹 기한을 반환한다.
public static

현재 사용중인 Rssi 필터를 반환한다.
public static

트래킹 캐쉬 사용 여부를 반환한다.
public static

현재 사용중인 Rssi 필터의 expirationTime을 설정한다.(기본값 : 5000)
public static

setMaxTrackingAge(maxTrackingAge: number)

Ranging시 비콘 트래킹 기한을 설정한다.(기본값 : 20000)
public static

setRssiFilter(RssiFilter: RssiFilter)

Ranging시 사용할 Rssi 필터를 지정한다.
public static

setTrackingCache(isTrackingCache: boolean)

트래킹 캐쉬 사용 여부를 설정한다.

Constructor Summary

Public Constructor
public

constructor(beacon: Beacon)

Member Summary

Public Members
public

트래킹 정보를 관리할 비콘 객체
public

Rssi 필터
public

마지막으로 트래킹된 시간, Date 객체의 getTime()값
public

트래킹된 횟수
public

트래킹 정보

Method Summary

Public Methods
public

측정된 Rssi값을 저장한다.
public

비콘의 측정값(Rssi, 거리)를 계산한다.
public

현재 Ranging 중인 비콘을 반환한다.
public

마지막으로 트래킹 된 이후 경과된 시간을 반환한다.
public

트래킹 시간 초과 여부를 반환한다.
public

필터에서 측정된 값에 대하여 사용 가능 여부를 반환한다.
public

트래킹 여부를 반환한다.
public

setTracked(isTracked: boolean)

트래킹 여부를 설정한다.
public

updateBeacon(beacon: Beacon)

비콘의 정보와 트래킹 횟수, Rssi 값을 갱신한다.

Static Public Methods

public static getExpirationTime(): number source

현재 사용중인 Rssi 필터의 expirationTime을 반환한다.

Return:

number

expirationTime(단위 : ms)

public static getMaxTrackingAge(): number source

현재 비콘 트래킹 기한을 반환한다.

Return:

number

최대 트래킹 시간(단위 : ms)

public static getRssiFilter(): RssiFilter source

현재 사용중인 Rssi 필터를 반환한다.

Return:

RssiFilter

현재 설정된 RssiFilter 객체

public static getTrackingCache(): boolean source

트래킹 캐쉬 사용 여부를 반환한다.

Return:

boolean

트래킹 사용 여부

public static setExpirationTime(time: number) source

현재 사용중인 Rssi 필터의 expirationTime을 설정한다.(기본값 : 5000)

Params:

NameTypeAttributeDescription
time number

expirationTime(단위 : ms)

public static setMaxTrackingAge(maxTrackingAge: number) source

Ranging시 비콘 트래킹 기한을 설정한다.(기본값 : 20000)

Params:

NameTypeAttributeDescription
maxTrackingAge number

최대 트래킹 시간(단위 : ms)

public static setRssiFilter(RssiFilter: RssiFilter) source

Ranging시 사용할 Rssi 필터를 지정한다.

Params:

NameTypeAttributeDescription
RssiFilter RssiFilter

RssiFilter를 구현한 필터 객체

public static setTrackingCache(isTrackingCache: boolean) source

트래킹 캐쉬 사용 여부를 설정한다.

Params:

NameTypeAttributeDescription
isTrackingCache boolean

트래킹 사용 여부(true시 사용)

Public Constructors

public constructor(beacon: Beacon) source

Params:

NameTypeAttributeDescription
beacon Beacon
  • nullable: false

트래킹 정보를 관리할 비콘 객체

Public Members

public beacon: Beacon source

트래킹 정보를 관리할 비콘 객체

public filter: RssiFilter source

Rssi 필터

public lastTrackedTime: number source

마지막으로 트래킹된 시간, Date 객체의 getTime()값

public packetCount: number source

트래킹된 횟수

public tracked: boolean source

트래킹 정보

Public Methods

public addMeasurement(rssi: number) source

측정된 Rssi값을 저장한다.

Params:

NameTypeAttributeDescription
rssi number

측정된 Rssi값

public commitMeasurements() source

비콘의 측정값(Rssi, 거리)를 계산한다.

public getBeacon(): Beacon source

현재 Ranging 중인 비콘을 반환한다.

Return:

Beacon

현재 Ranging 중인 비콘

public getTrackingAge(): number source

마지막으로 트래킹 된 이후 경과된 시간을 반환한다.

Return:

number

Date객체의 getTime() 값

public isExpired(): boolean source

트래킹 시간 초과 여부를 반환한다.

Return:

boolean

트래킹 시간 초과 여부

public isMeasurementAvailable(): boolean source

필터에서 측정된 값에 대하여 사용 가능 여부를 반환한다.

Return:

boolean

필터에서 측정값 사용 가능 여부

public isTracked(): boolean source

트래킹 여부를 반환한다.

Return:

boolean

현재 비콘의 트래킹 여부

public setTracked(isTracked: boolean) source

트래킹 여부를 설정한다.

Params:

NameTypeAttributeDescription
isTracked boolean

트래킹 여부

public updateBeacon(beacon: Beacon) source

비콘의 정보와 트래킹 횟수, Rssi 값을 갱신한다.

Params:

NameTypeAttributeDescription
beacon Beacon

갱신할 비콘 객체