사용자 정의 함수 클라이언트 라이브러리 참조

아티클
01/17/2020

중요

새 버전의 Azure Digital Twins 서비스가 릴리스되었습니다. 새 서비스의 확장된 기능에 비추어 원래 Azure Digital Twins 서비스(이 설명서 집합에 설명됨)가 사용 중지되었습니다.

새 서비스에 대한 설명서를 보려면 활성 Azure Digital Twins 설명서를 방문하세요.

이 문서에서는 Azure Digital Twins 사용자 정의 함수 클라이언트 라이브러리에 대한 참조 정보를 제공합니다.

도우미 메서드

클라이언트 라이브러리는 일반적으로 사용되는 작업에 대한 도우미 메서드를 정의합니다.

getSpaceMetadata(id) ⇒ `space`

공간 식별자를 지정하면 이 함수는 그래프에서 공간을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	Description
id	`guid`	공간 식별자

getSensorMetadata(id) ⇒ `sensor`

센서 식별자를 지정하면 이 함수는 그래프에서 센서를 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	Description
id	`guid`	센서 식별자

getDeviceMetadata(id) ⇒ `device`

디바이스 식별자를 지정하면 이 함수는 그래프에서 디바이스를 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	Description
id	`guid`	디바이스 식별자

getSensorValue(sensorId, dataType) ⇒ `value`

센서 식별자 및 해당 데이터 형식을 지정하면 이 함수는 센서의 현재 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
sensorId	`guid`	센서 식별자
dataType	`string`	센서 데이터 형식

getSpaceValue(spaceId, valueName) ⇒ `value`

공간 식별자 및 값 이름을 지정하면 이 함수는 해당 공간 속성의 현재 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자
valueName	`string`	공간 속성 이름

getSensorHistoryValues(sensorId, dataType) ⇒ `value[]`

센서 식별자 및 해당 데이터 형식을 지정하면 이 함수는 해당 센서의 기록 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
sensorId	`guid`	센서 식별자
dataType	`string`	센서 데이터 형식

getSpaceHistoryValues(spaceId, dataType) ⇒ `value[]`

공간 식별자 및 값 이름을 지정하면 이 함수는 공간에 있는 해당 속성의 기록 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자
valueName	`string`	공간 속성 이름

getSpaceChildSpaces(spaceId) ⇒ `space[]`

공간 식별자를 지정하면 이 함수는 해당 부모 공간에 대한 자식 공간을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

공간 식별자를 지정하면 이 함수는 해당 부모 공간에 대한 자식 센서를 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자

getSpaceChildDevices(spaceId) ⇒ `device[]`

공간 식별자를 지정하면 이 함수는 해당 부모 공간에 대한 자식 디바이스를 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

디바이스 식별자를 지정하면 이 함수는 해당 부모 디바이스에 대한 자식 센서를 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
deviceId	`guid`	디바이스 식별자

getSpaceParentSpace(childSpaceId) ⇒ `space`

공간 식별자를 지정하면 이 함수는 해당 부모 공간을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
childSpaceId	`guid`	공간 식별자

getSensorParentSpace(childSensorId) ⇒ `space`

센서 식별자를 지정하면 이 함수는 해당 부모 공간을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
childSensorId	`guid`	센서 식별자

getDeviceParentSpace(childDeviceId) ⇒ `space`

디바이스 식별자를 지정하면 이 함수는 해당 부모 공간을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
childDeviceId	`guid`	디바이스 식별자

getSensorParentDevice(childSensorId) ⇒ `space`

센서 식별자를 지정하면 이 함수는 해당 부모 디바이스를 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
childSensorId	`guid`	센서 식별자

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

공간 식별자를 지정하면 이 함수는 공간에서 속성 및 해당 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자
propertyName	`string`	공간 속성 이름

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

센서 식별자를 지정하면 이 함수는 센서에서 속성 및 해당 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
sensorId	`guid`	센서 식별자
propertyName	`string`	센서 속성 이름

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

디바이스 식별자를 지정하면 이 함수는 디바이스에서 속성 및 해당 값을 검색합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
deviceId	`guid`	디바이스 식별자
propertyName	`string`	디바이스 속성 이름

setSensorValue(sensorId, dataType, value)

이 함수는 지정된 데이터 형식을 사용하여 센서 개체의 값을 설정합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
sensorId	`guid`	센서 식별자
dataType	`string`	센서 데이터 형식
value	`string`	값

setSpaceValue(spaceId, dataType, value)

이 함수는 지정된 데이터 형식을 사용하여 공간 개체의 값을 설정합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
spaceId	`guid`	공간 식별자
dataType	`string`	데이터 형식
value	`string`	값

log(message)

이 함수는 사용자 정의 함수 내에서 다음 메시지를 기록합니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	Description
message	`string`	기록할 메시지

sendNotification(topologyObjectId, topologyObjectType, payload)

이 함수는 디스패치할 사용자 지정 알림을 보냅니다.

Kind: 글로벌 함수입니다.

매개 변수	Type	설명
topologyObjectId	`guid`	그래프 개체 식별자. 예제는 공간, 센서 및 디바이스 ID입니다.
topologyObjectType	`string`	예제는 센서 및 디바이스입니다.
페이로드	`string`	알림을 사용하여 보낼 JSON 페이로드입니다.

반환 형식

클라이언트 참조 도우미 메서드에서 반환된 응답 모델에 대한 설명은 다음과 같습니다.

Space

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Space",
  "friendlyName": "Conference Room",
  "typeId": 0,
  "parentSpaceId": "00000000-0000-0000-0000-000000000001",
  "subtypeId": 0
}

공간 메서드

Parent() ⇒ `space`

이 함수는 현재 공간의 부모 공간을 반환합니다.

ChildSensors() ⇒ `sensor[]`

이 함수는 현재 공간의 자식 센서를 반환합니다.

ChildDevices() ⇒ `device[]`

이 함수는 현재 공간의 자식 디바이스를 반환합니다.

ExtendedProperty(propertyName) ⇒ `extendedProperty`

이 함수는 현재 공간에 대한 확장 속성 및 해당 값을 반환합니다.

매개 변수	Type	설명
propertyName	`string`	확장 속성의 이름

Value(valueName) ⇒ `value`

이 함수는 현재 공간의 값을 반환합니다.

매개 변수	Type	설명
valueName	`string`	값의 이름

History(valueName) ⇒ `value[]`

이 함수는 현재 공간의 기록 값을 반환합니다.

매개 변수	Type	설명
valueName	`string`	값의 이름

Notify(payload)

이 함수는 지정된 페이로드를 사용하여 알림을 보냅니다.

매개 변수	Type	설명
payload	`string`	알림에 포함할 JSON 페이로드입니다.

디바이스

{
  "id": "00000000-0000-0000-0000-000000000002",
  "name": "Device",
  "friendlyName": "Temperature Sensing Device",
  "description": "This device contains a sensor that captures temperature readings.",
  "type": "None",
  "subtype": "None",
  "typeId": 0,
  "subtypeId": 0,
  "hardwareId": "ABC123",
  "gatewayId": "ABC",
  "spaceId": "00000000-0000-0000-0000-000000000000"
}

디바이스 메서드

Parent() ⇒ `space`

이 함수는 현재 디바이스의 부모 공간을 반환합니다.

ChildSensors() ⇒ `sensor[]`

이 함수는 현재 디바이스의 자식 센서를 반환합니다.

ExtendedProperty(propertyName) ⇒ `extendedProperty`

이 함수는 현재 디바이스에 대한 확장 속성 및 해당 값을 반환합니다.

매개 변수	Type	설명
propertyName	`string`	확장 속성의 이름

Notify(payload)

이 함수는 지정된 페이로드를 사용하여 알림을 보냅니다.

매개 변수	Type	설명
payload	`string`	알림에 포함할 JSON 페이로드입니다.

센서

{
  "id": "00000000-0000-0000-0000-000000000003",
  "port": "30",
  "pollRate": 3600,
  "dataType": "Temperature",
  "dataSubtype": "None",
  "type": "Classic",
  "portType": "None",
  "dataUnitType": "FahrenheitTemperature",
  "spaceId": "00000000-0000-0000-0000-000000000000",
  "deviceId": "00000000-0000-0000-0000-000000000001",
  "portTypeId": 0,
  "dataUnitTypeId": 0,
  "dataTypeId": 0,
  "dataSubtypeId": 0,
  "typeId": 0  
}

센서 메서드

Space() ⇒ `space`

이 함수는 현재 센서의 부모 공간을 반환합니다.

Device() ⇒ `device`

이 함수는 현재 센서의 부모 디바이스를 반환합니다.

ExtendedProperty(propertyName) ⇒ `extendedProperty`

이 함수는 현재 센서에 대한 확장 속성 및 해당 값을 반환합니다.

매개 변수	Type	설명
propertyName	`string`	확장 속성의 이름

Value() ⇒ `value`

이 함수는 현재 센서의 값을 반환합니다.

History() ⇒ `value[]`

이 함수는 현재 센서의 기록 값을 반환합니다.

Notify(payload)

이 함수는 지정된 페이로드를 사용하여 알림을 보냅니다.

매개 변수	Type	설명
payload	`string`	알림에 포함할 JSON 페이로드입니다.

값

{
  "dataType": "Temperature",
  "value": "70",
  "createdTime": ""
}

확장 속성

{
  "name": "OccupancyStatus",
  "value": "Occupied"
}

다음 단계

Azure Digital Twins 사용자 정의 함수에 대해 알아봅니다.
사용자 정의 함수를 만드는 방법에 대해 알아봅니다.
사용자 정의 함수를 디버그하는 방법에 대해 알아봅니다.

다음을 통해 공유

사용자 정의 함수 클라이언트 라이브러리 참조

도우미 메서드

getSpaceMetadata(id) ⇒ space

getSensorMetadata(id) ⇒ sensor

getDeviceMetadata(id) ⇒ device

getSensorValue(sensorId, dataType) ⇒ value

getSpaceValue(spaceId, valueName) ⇒ value

getSensorHistoryValues(sensorId, dataType) ⇒ value[]

getSpaceHistoryValues(spaceId, dataType) ⇒ value[]

getSpaceChildSpaces(spaceId) ⇒ space[]

getSpaceChildSensors(spaceId) ⇒ sensor[]

getSpaceChildDevices(spaceId) ⇒ device[]

getDeviceChildSensors(deviceId) ⇒ sensor[]

getSpaceParentSpace(childSpaceId) ⇒ space

getSensorParentSpace(childSensorId) ⇒ space

getDeviceParentSpace(childDeviceId) ⇒ space

getSensorParentDevice(childSensorId) ⇒ space

getSpaceExtendedProperty(spaceId, propertyName) ⇒ extendedProperty

getSensorExtendedProperty(sensorId, propertyName) ⇒ extendedProperty

getDeviceExtendedProperty(deviceId, propertyName) ⇒ extendedProperty

setSensorValue(sensorId, dataType, value)

setSpaceValue(spaceId, dataType, value)

log(message)

sendNotification(topologyObjectId, topologyObjectType, payload)

반환 형식

Space

공간 메서드

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ChildDevices() ⇒ device[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Value(valueName) ⇒ value

History(valueName) ⇒ value[]

Notify(payload)

디바이스

디바이스 메서드

Parent() ⇒ space

ChildSensors() ⇒ sensor[]

ExtendedProperty(propertyName) ⇒ extendedProperty

Notify(payload)

센서

센서 메서드

Space() ⇒ space

Device() ⇒ device

ExtendedProperty(propertyName) ⇒ extendedProperty

Value() ⇒ value

History() ⇒ value[]

Notify(payload)

값

확장 속성

다음 단계

추가 리소스

getSpaceMetadata(id) ⇒ `space`

getSensorMetadata(id) ⇒ `sensor`

getDeviceMetadata(id) ⇒ `device`

getSensorValue(sensorId, dataType) ⇒ `value`

getSpaceValue(spaceId, valueName) ⇒ `value`

getSensorHistoryValues(sensorId, dataType) ⇒ `value[]`

getSpaceHistoryValues(spaceId, dataType) ⇒ `value[]`

getSpaceChildSpaces(spaceId) ⇒ `space[]`

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

getSpaceChildDevices(spaceId) ⇒ `device[]`

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

getSpaceParentSpace(childSpaceId) ⇒ `space`

getSensorParentSpace(childSensorId) ⇒ `space`

getDeviceParentSpace(childDeviceId) ⇒ `space`

getSensorParentDevice(childSensorId) ⇒ `space`

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

Parent() ⇒ `space`

ChildSensors() ⇒ `sensor[]`

ChildDevices() ⇒ `device[]`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Value(valueName) ⇒ `value`

History(valueName) ⇒ `value[]`

Parent() ⇒ `space`

ChildSensors() ⇒ `sensor[]`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Space() ⇒ `space`

Device() ⇒ `device`

ExtendedProperty(propertyName) ⇒ `extendedProperty`

Value() ⇒ `value`

History() ⇒ `value[]`