用户定义函数客户端库参考

项目
01/17/2020

重要

Azure 数字孪生服务的新版本已发布。鉴于新服务的扩展功能，本文档集中介绍的原始 Azure 数字孪生服务 (已停用) 。

若要查看新服务的文档，请访问活动的 Azure 数字孪生文档。

本文档提供 Azure 数字孪生用户定义函数客户端库的参考信息。

帮助器方法

客户端库为常用操作定义帮助器方法。

getSpaceMetadata(id) ⇒ `space`

给定空间标识符后，此函数将从图形中检索空间。

类型：全局函数

参数	类型	说明
id	`guid`	空间标识符

getSensorMetadata(id) ⇒ `sensor`

给定传感器标识符后，此函数将从图形中检索传感器。

类型：全局函数

参数	类型	说明
id	`guid`	传感器标识符

getDeviceMetadata(id) ⇒ `device`

给定设备标识符后，此函数将从图形中检索设备。

类型：全局函数

参数	类型	说明
id	`guid`	设备标识符

getSensorValue(sensorId, dataType) ⇒ `value`

给定传感器标识符及其数据类型后，此函数将检索该传感器的当前值。

类型：全局函数

参数	类型	说明
sensorId	`guid`	传感器标识符
dataType	`string`	传感器数据类型

getSpaceValue(spaceId, valueName) ⇒ `value`

给定空间标识符及其值名称后，此函数将检索该空间属性的当前值。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符
值名称	`string`	空间属性名称

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

给定传感器标识符及其数据类型后，此函数将检索该传感器的历史值。

类型：全局函数

参数	类型	说明
sensorId	`guid`	传感器标识符
dataType	`string`	传感器数据类型

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

给定空间标识符和值名称后，此函数将检索空间上该属性的历史值。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符
值名称	`string`	空间属性名称

getSpaceChildSpaces(spaceId) ⇒ `space[]`

给定空间标识符后，此函数将检索该父空间的子空间。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符

getSpaceChildSensors(spaceId) ⇒ `sensor[]`

给定空间标识符后，此函数将检索该父空间的子传感器。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符

getSpaceChildDevices(spaceId) ⇒ `device[]`

给定空间标识符后，此函数将检索该父空间的子设备。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符

getDeviceChildSensors(deviceId) ⇒ `sensor[]`

给定设备标识符后，此函数将检索该父设备的子传感器。

类型：全局函数

参数	类型	说明
deviceId	`guid`	设备标识符

getSpaceParentSpace(childSpaceId) ⇒ `space`

给定空间标识符后，此函数将检索其父空间。

类型：全局函数

参数	类型	说明
childSpaceId	`guid`	空间标识符

getSensorParentSpace(childSensorId) ⇒ `space`

给定传感器标识符后，此函数将检索其父空间。

类型：全局函数

参数	类型	说明
childSensorId	`guid`	传感器标识符

getDeviceParentSpace(childDeviceId) ⇒ `space`

给定设备标识符后，此函数将检索其父空间。

类型：全局函数

参数	类型	说明
childDeviceId	`guid`	设备标识符

getSensorParentDevice(childSensorId) ⇒ `space`

给定传感器标识符后，此函数将检索其父设备。

类型：全局函数

参数	类型	说明
childSensorId	`guid`	传感器标识符

getSpaceExtendedProperty(spaceId, propertyName) ⇒ `extendedProperty`

给定空间标识符后，此函数将从空间中检索属性及其值。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符
propertyName	`string`	空间属性名称

getSensorExtendedProperty(sensorId, propertyName) ⇒ `extendedProperty`

给定传感器标识符后，此函数将从传感器中检索属性及其值。

类型：全局函数

参数	类型	说明
sensorId	`guid`	传感器标识符
propertyName	`string`	传感器属性名称

getDeviceExtendedProperty(deviceId, propertyName) ⇒ `extendedProperty`

给定设备标识符后，此函数将从设备中检索属性及其值。

类型：全局函数

参数	类型	说明
deviceId	`guid`	设备标识符
propertyName	`string`	设备属性名称

setSensorValue(sensorId, dataType, value)

此函数将在具有给定数据类型的传感器对象上设置值。

类型：全局函数

参数	类型	说明
sensorId	`guid`	传感器标识符
dataType	`string`	传感器数据类型
value	`string`	值

setSpaceValue(spaceId, dataType, value)

此函数将在具有给定数据类型的空间对象上设置值。

类型：全局函数

参数	类型	说明
spaceId	`guid`	空间标识符
dataType	`string`	数据类型
value	`string`	值

log(message)

此函数记录用户定义函数中的以下消息。

类型：全局函数

参数	类型	说明
message	`string`	要记录的消息

sendNotification(topologyObjectId, topologyObjectType, payload)

此函数发出要分派的自定义通知。

类型：全局函数

参数	类型	说明
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`

此函数将返回当前空间的扩展属性及其值。

参数	类型	说明
propertyName	`string`	扩展属性的名称

Value(valueName) ⇒ `value`

此函数将返回当前空间的值。

参数	类型	说明
值名称	`string`	值的名称

History(valueName) ⇒ `value[]`

此函数将返回当前空间的历史值。

参数	类型	说明
值名称	`string`	值的名称

Notify(payload)

此函数发送具有指定有效负载的通知。

参数	类型	说明
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`

此函数返回当前设备的扩展属性及其值。

参数	类型	说明
propertyName	`string`	扩展属性的名称

Notify(payload)

此函数发送具有指定有效负载的通知。

参数	类型	说明
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`

此函数返回当前传感器的扩展属性及其值。

参数	类型	说明
propertyName	`string`	扩展属性的名称

Value() ⇒ `value`

此函数返回当前传感器的值。

History() ⇒ `value[]`

此函数返回当前传感器的历史值。

Notify(payload)

此函数发送具有指定有效负载的通知。

参数	类型	说明
payload	`string`	要包含在通知中的 JSON 有效负载

值

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

扩展属性

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

通过

用户定义函数客户端库参考

帮助器方法

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[]`