      import { Beacon } from 'buildthing-ble-sdk'

public class | source

Beacon

Extends:

Device → Beacon

Direct Subclass:

BuildThingBeacon, EddyStone, iBeacon

Indirect Subclass:

EddyStoneTLM, EddyStoneUID, EddyStoneURL

Beacon 공통 정보를 가지는 비콘 클래스

Static Method Summary

Static Public Methods
public static	getDistanceCalculator(): DistanceCalculator 사용하고 있는 distanceCalculator 인스턴스 가져오는 함수
public static	setDistanceCalculator(distanceCalculator: DistanceCalculator) 실제 사용할 distanceCalculator 설정 하는 함수

Constructor Summary

Public Constructor
public	constructor(data: Object) 기본 비콘 생성자

Member Summary

Public Members
public	distance: number 비콘의 거리 계산 값
public	mode: string 현재 비콘 모드 (BuildThing, iBeacon, EddyStoneTLM, EddyStoneUID, EddyStoneURL)
public	packetCount: number ranging 할때에, 비콘 패킷 수신 횟수
public	rssiMeasurementCount: number ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수
public	txPower: Object 비콘 txPower 값

Method Summary

Public Methods
public	calculateDistance(txPower: Object, rssi: number): number 비콘과의 대략적인 거리를 계산하는 함수
public	getDistance(): string 비콘과의 대략적인 거리를 가져오는 함수
public	getMeasurementCount(): number ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수 를 가져오는 하는 함수
public	getMode(): string 현재 비콘 모드를 가져오는 함수
public	getPacketCount(): number ranging 할때에, 비콘 패킷 수신 횟수 정보를 가져오는 함수
public	getTxPower(): Object 비콘 txPower 값을 가져오는 함수
public	setMode(mode: string) 현재 비콘 모드를 설정하는 함수
public	setPacketCount(packetCount: number) ranging 할때에, 비콘 패킷 수신 횟수 정보를 설정하는 함수
public	setRssiMeasurementCount(rssiMeasurementCount: number) ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수 를 설정 하는 함수
public	setTxPower(txPower: Object) 비콘 txPower 값을 설정하는 함수

Inherited Summary

From class Device
public	address: string 디바이스 맥 어드레스
public	distance: *
public	firmwareVersion: number 디바이스 펌웨어 버전 값
public	id: string 디바이스 식별 id
public	name: string 디바이스 이름
public	rssi: number 디바이스 수신 세기를 나태내는 rssi 값
public	type: string 디바이스 타입
public	getAddress(): string 디바이스 맥 어드레스 가져오는 함수
public	getId(): string 디바이스 id 가져오는 함수
public	getName(): string 디바이스 이름 가져오는 함수
public	getPeripheral(): Object 수신한 본래의 디바이스 정보를 담은 객체를 가져오는 함수
public	getRssi(): number 디바이스 rssi 값을 가져오는 함수
public	getType(): number 디바이스 타입을 가져오는 함수
public	setAddress(address: string) 디바이스 맥 어드레스 설정하는 함수
public	setId(id: string) 디바이스 id 설정하는 함수
public	setName(name: string) 디바이스 이름 설정하는 함수
public	setPeripheral(peripheral: Object) 수신한 본래의 디바이스 정보를 담은 객체를 설정하는 함수
public	setRssi(rssi: number) 디바이스 rssi 값을 설정하는 함수
public	setType(type: number) 디바이스 타입을 설정하는 함수
public	toString(): string 디바이스 기본 정보를 리턴하는 함수

Static Public Methods

public static getDistanceCalculator(): DistanceCalculator source

사용하고 있는 distanceCalculator 인스턴스 가져오는 함수

Return:

DistanceCalculator

비콘과의 거리를 구할때 사용하는 distanceCalculator 구현 클래스 인스턴스

public static setDistanceCalculator(distanceCalculator: DistanceCalculator) source

실제 사용할 distanceCalculator 설정 하는 함수

Params:

Name	Type	Attribute	Description
distanceCalculator	DistanceCalculator		비콘과의 거리를 구할때 사용하는 distanceCalculator 구현 클래스 인스턴스.

Public Constructors

public constructor(data: Object) source

기본 비콘 생성자

Override:

Device#constructor

Params:

Name	Type	Attribute	Description
data	Object		초기화 정보 객체
data.id	string		비콘 식별 id
data.mode	string		비콘 모드 (BuildThing, iBeacon, EddyStoneTLM, EddyStoneUID, EddyStoneURL)
data.name	string		비콘 이름
data.address	string		비콘 맥 어드레스
data.rssi	number		비콘 수신 세기를 나태내는 rssi 값
data.firmwareVersion	number		비콘 펌웨어 버전 값

Public Members

public distance: number source

비콘의 거리 계산 값

Override:

Device#distance

public mode: string source

현재 비콘 모드 (BuildThing, iBeacon, EddyStoneTLM, EddyStoneUID, EddyStoneURL)

public packetCount: number source

ranging 할때에, 비콘 패킷 수신 횟수

public rssiMeasurementCount: number source

ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수

public txPower: Object source

비콘 txPower 값

Properties:

Name	Type	Attribute	Description
value	number		실제 값
unit	string		단위

Public Methods

public calculateDistance(txPower: Object, rssi: number): number source

비콘과의 대략적인 거리를 계산하는 함수

Params:

Name	Type	Attribute	Description
txPower	Object		비콘으로부터 받은 txPower
txPower.value	number		실제 값
txPower.unit	string		단위
rssi	number		비콘으로부터 받은 데이터 수신 세기

Return:

number

비콘과의 대략적인 거리

public getDistance(): string source

비콘과의 대략적인 거리를 가져오는 함수

Return:

string

비콘과의 대략적인 거리

public getMeasurementCount(): number source

ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수 를 가져오는 하는 함수

Return:

number

ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수

public getMode(): string source

현재 비콘 모드를 가져오는 함수

Return:

string

현재 비콘 모드 (BuildThing, iBeacon, EddyStoneTLM, EddyStoneUID, EddyStoneURL)

public getPacketCount(): number source

ranging 할때에, 비콘 패킷 수신 횟수 정보를 가져오는 함수

Return:

number

ranging 할때에, 비콘 패킷 수신 횟수

public getTxPower(): Object source

비콘 txPower 값을 가져오는 함수

Return:

Object

비콘 txPower 값

Return Properties:

Name	Type	Attribute	Description
value	number		실제 값
unit	string		단위

public setMode(mode: string) source

현재 비콘 모드를 설정하는 함수

Params:

Name	Type	Attribute	Description
mode	string		현재 비콘 모드 (BuildThing, iBeacon, EddyStoneTLM, EddyStoneUID, EddyStoneURL)

public setPacketCount(packetCount: number) source

ranging 할때에, 비콘 패킷 수신 횟수 정보를 설정하는 함수

Params:

Name	Type	Attribute	Description
packetCount	number		ranging 할때에, 비콘 패킷 수신 횟수

public setRssiMeasurementCount(rssiMeasurementCount: number) source

ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수 를 설정 하는 함수

Params:

Name	Type	Attribute	Description
rssiMeasurementCount	number		ranging 할때에, filter 을 통해 rssi 값을 재측정 한 횟수

public setTxPower(txPower: Object) source

비콘 txPower 값을 설정하는 함수

Params:

Name	Type	Attribute	Description
txPower	Object		비콘 txPower 값
txPower.value	number		실제 값
txPower.unit	string		단위