openharmony 鸿蒙 js-apis-awareness-spatialAwareness-sys

2026-08-25 浏览 (1)

@ohos.multimodalAwareness.spatialAwareness (空间感知)(系统接口)

本模块提供对测距的感知能力。

说明:

本模块首批接口从API version 23开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import { spatialAwareness } from '@kit.MultimodalAwarenessKit';

spatialAwareness.TechnologyType

提供输入信号的类型。接口根据输入信号类型,执行对应算法。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称说明
BLE_RSSI0表示蓝牙强度。
WIFI_RSSI1表示WIFI强度。
ULTRASOUND2表示超声强度。
NEAR_LINK3表示星闪强度。
WIFI_BLE_RSSI4表示WIFI和蓝牙强度。

spatialAwareness.ReportingMode

测距接口执行完成后结果的上报模式。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称说明
REPORT_MODE_PERIODIC_REPORTING0表示周期性上报。
REPORT_MODE_TRIGGERED_REPORTING1表示触发式上报。

spatialAwareness.DistanceRank

测距结果的距离挡位,不同的挡位对应不同的距离范围。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称说明
RANK_ULTRA_SHORT_RANGErankUltraShort表示超短距。单位:cm,范围:[0:5]
RANK_SHORT_RANGErankShort表示短距。单位:cm,范围:(5:100]
RANK_SHORT_MEDIUM_RANGErankMediumShort表示中短距。单位:cm,范围:(100:500]
RANK_MEDIUM_RANGErankMedium表示中距。单位:cm,范围:(500:1000]

spatialAwareness.DistanceMeasurementResponse

测距接口执行完成后的回调结果。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称类型只读可选说明
rankDistanceRank表示距离档位。
distancefloat表示距离。
confidencefloat表示置信度。
deviceIdstring表示设备Id号。

spatialAwareness.PositionRelativeToDoor

门内外识别接口返回结果中表示门内或门外位置的枚举。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称说明
OUTDOOR0表示门外。
INDOOR1表示门内。

spatialAwareness.DoorPositionResponse

门内外识别接口执行完成后的回调结果。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称类型只读可选说明
doorLockCodeint表示门锁校验码。
positionPositionRelativeToDoor表示门内外位置信息。
deviceIdstring表示设备Id号。

spatialAwareness.DistanceMeasurementConfigParams

测距接口的输入参数配置。根据不同的参数配置,执行对应的算法。

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

名称类型只读可选说明
deviceListstring[]表示设备列表。
techTypeTechnologyType表示信号类型。
reportModeReportingMode表示结果上报模式。
reportFrequencyint表示结果上报频率。

spatialAwareness.onDistanceMeasure23+

onDistanceMeasure(configParams: DistanceMeasurementConfigParams, callback: Callback<DistanceMeasurementResponse>): void;

订阅测距接口。触发测距算法执行,并返回测距结果。

需要权限:ohos.permission.ACCESS_SENSING_WITH_ULTRASOUND

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

参数

参数名类型必填说明
configParamsDistanceMeasurementConfigParams测距接口配置参数
callbackCallback<DistanceMeasurementResponse>回调函数,返回测距结果。

错误码

以下错误码的详细介绍请参见空间感知错误码通用错误码

错误码ID错误信息
201Permission denied.
801Capability not supported. Function can not work correctly due to limited device capabilities.
35100001Service exception.
35100002Subscription failed.
35100004Parameter invalid.

示例

import { spatialAwareness } from '@kit.MultimodalAwarenessKit';
   console.info('call onDistanceMeasure before');
   let configParams: spatialAwareness.DistanceMeasurementConfigParams = {
      deviceList: ["123456"],
      techType: 2,
      reportMode: 0,
      reportFrequency: 340
   };
   console.info('call onDistanceMeasure start');
   try {
      spatialAwareness.onDistanceMeasure(configParams, (data:spatialAwareness.DistanceMeasurementResponse) => {
         console.info('result = ${data.distance}');
      });
   } catch (err) {
      console.error('call onDistanceMeasure failed, errCode = ' + err.code);
   }

spatialAwareness.offDistanceMeasure23+

offDistanceMeasure(configParams: DistanceMeasurementConfigParams, callback?: Callback<DistanceMeasurementResponse>): void;

取消订阅测距接口。停止运行已订阅的测距算法。

需要权限:ohos.permission.ACCESS_SENSING_WITH_ULTRASOUND

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

参数

参数名类型必填说明
configParamsDistanceMeasurementConfigParams测距接口配置参数
callbackCallback<DistanceMeasurementResponse>表示取消指定的callback通知。如果输入空、undefined或null,则取消configParams订阅的所有测距通知事件。

错误码

以下错误码的详细介绍请参见空间感知错误码通用错误码

错误码ID错误信息
201Permission denied.
801Capability not supported. Function can not work correctly due to limited device capabilities.
35100001Service exception.
35100003Unsubscription failed.
35100004Parameter invalid.

示例

import { spatialAwareness } from '@kit.MultimodalAwarenessKit';
   console.info('call offDistanceMeasure before');
   let configParams: spatialAwareness.DistanceMeasurementConfigParams = {
      deviceList: ["123456"],
      techType: 2,
      reportMode: 0,
      reportFrequency: 340
   };
   console.info('call offDistanceMeasure start');
   try {
      spatialAwareness.offDistanceMeasure(configParams, (data:spatialAwareness.DistanceMeasurementResponse) => {
         console.info('result = ${data.distance}');
      });
   } catch (err) {
      console.error('call offDistanceMeasure failed, errCode = ' + err.code);
   }

spatialAwareness.onIndoorOrOutdoorIdentify23+

onIndoorOrOutdoorIdentify(configParams: DistanceMeasurementConfigParams, callback: Callback<DoorPositionResponse>): void;

订阅门内外识别接口。触发门内外识别算法执行,并返回设备在门内还是门外的信息。

需要权限:ohos.permission.ACCESS_SENSING_WITH_ULTRASOUND

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

参数

参数名类型必填说明
configParamsDistanceMeasurementConfigParams测距接口配置参数
callbackCallback<DoorPositionResponse>回调函数,返回门内外信息。

错误码

以下错误码的详细介绍请参见空间感知错误码通用错误码

错误码ID错误信息
201Permission denied.
801Capability not supported. Function can not work correctly due to limited device capabilities.
35100001Service exception.
35100002Subscription failed.
35100004Parameter invalid.

示例

import { spatialAwareness } from '@kit.MultimodalAwarenessKit';
   console.info('call onIndoorOrOutdoorIdentify before');
   let configParams: spatialAwareness.DistanceMeasurementConfigParams = {
      deviceList: ["123456"],
      techType: 2,
      reportMode: 0,
      reportFrequency: 340
   };
   console.info('call onIndoorOrOutdoorIdentify start');
   try {
      spatialAwareness.onIndoorOrOutdoorIdentify(configParams, (data:spatialAwareness.DoorPositionResponse) => {
         console.info('result = ${data.position}');
      });
   } catch (err) {
      console.error('call onIndoorOrOutdoorIdentify failed, errCode = ' + err.code);
   }

spatialAwareness.offIndoorOrOutdoorIdentify23+

offIndoorOrOutdoorIdentify(configParams: DistanceMeasurementConfigParams, callback?: Callback<DoorPositionResponse>): void;

取消订阅门内外识别接口。停止运行已订阅的门内外识别算法。

需要权限:ohos.permission.ACCESS_SENSING_WITH_ULTRASOUND

系统能力:SystemCapability.MultimodalAwareness.DistanceMeasurement

参数

参数名类型必填说明
configParamsDistanceMeasurementConfigParams测距接口配置参数
callbackCallback<DoorPositionResponse>表示取消指定的callback通知。如果输入空、undefined或null,则取消configParams订阅的所有门内外识别通知事件。

错误码

以下错误码的详细介绍请参见空间感知错误码通用错误码

错误码ID错误信息
201Permission denied.
801Capability not supported. Function can not work correctly due to limited device capabilities.
35100001Service exception.
35100003Unsubscription failed.
35100004Parameter invalid.

示例

import { spatialAwareness } from '@kit.MultimodalAwarenessKit';
   console.info('call offIndoorOrOutdoorIdentify before');
   let configParams: spatialAwareness.DistanceMeasurementConfigParams = {
      deviceList: ["123456"],
      techType: 2,
      reportMode: 0,
      reportFrequency: 340
   };
   console.info('call offIndoorOrOutdoorIdentify start');
   try {
      spatialAwareness.offIndoorOrOutdoorIdentify(configParams, (data:spatialAwareness.DoorPositionResponse) => {
         console.info('result = ${data.position}');
      });
   } catch (err) {
      console.error('call offIndoorOrOutdoorIdentify failed, errCode = ' + err.code);
   }

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 errorcode-onScreen

openharmony 鸿蒙 js-apis-awareness-metadataBinding-sys

openharmony 鸿蒙 errorcode-metadataBinding

openharmony 鸿蒙 js-apis-awareness-deviceStatus-sys

openharmony 鸿蒙 js-apis-awareness-motion

openharmony 鸿蒙 js-apis-awareness-metadataBinding

openharmony 鸿蒙 Readme-CN

openharmony 鸿蒙 errorcode-userStatus

openharmony 鸿蒙 errorcode-deviceStatus

openharmony 鸿蒙 js-apis-awareness-onScreen-sys

  • 所属分类: 后端技术
  • 本文标签: 鸿蒙 软件
  • 版权声明: 本文链接 https://seaxiang.com/blog/OksemHmJ