@awarns/geofencing

此模块允许根据在@awarns/geolocation包中声明的任务获取的位置执行基于基本地理围栏分析的。它还兼容任何其他符合GeolocationLike接口的定制实体（例如，由定制室内定位系统产生的实体）。

此包内部的地理围栏机制允许检测对已注册兴趣区域的多个接近程度。

使用以下命令行指令安装插件

ns plugin add @awarns/geofencing

用法

安装并配置此插件后，您将获得两种交互机制来与之交互

1. 插件 API。通过它，您将能够配置和更新与应用程序相关的相关兴趣区域。
2. 地理围栏任务，允许检测刚刚获取的位置是否接近一个或多个已注册的兴趣区域。当检测到接近度变化时，此任务将发出以下描述的AoIProximityChange记录。

API

areasOfInterest

areasOfInterest单例对象是主要插件入口点。通过它，您可以设置和管理兴趣区域。这是完整的 API

AreaOfInterest

任务

检查兴趣区域邻近度

要注册此任务以供使用，您只需将其导入并在应用程序的任务列表中调用其生成器函数即可

import { Task } from '@awarns/core/tasks';
import { checkAreaOfInterestProximityTask } from '@awarns/geofencing';

export const demoTasks: Array<Task> = [
    checkAreaOfInterestProximityTask(),
];

任务生成器参数

任务生成器不接收任何参数。

任务输出事件

• checkAreaOfInterestProximityFinished (默认，无内容)
• movedCloseToAreaOfInterest
• movedInsideAreaOfInterest
• movedOutsideAreaOfInterest
• movedAwayFromAreaOfInterest

在应用程序任务图中示例使用

on(
  'startEvent',
  run('acquirePhoneGeolocation')
    .every(1, 'minutes')
    .cancelOn('stopEvent')
);

on(
  'geolocationAcquired',
  run('checkAreaOfInterestProximity', {
    nearbyRange: 100, // Area approximation radius, in meters (defaults to 100)
    offset: 15, // Optional distance calculation offset, in meters. Can help mitigating location error (defaults to 0)
  })
);

on('movedCloseToAreaOfInterest', run('writeRecords'));
on('movedInsideAreaOfInterest', run('writeRecords'));
on('movedOutsideAreaOfInterest', run('writeRecords'));
on('movedAwayFromAreaOfInterest', run('writeRecords'));

注意：要使用 acquirePhoneGeolocation 和 writeRecords 任务，必须安装并配置地理位置和持久化包。请参阅 地理位置包 和 持久化包 文档。

基于兴趣区域邻近度过滤地理位置

要注册此任务以供使用，您只需将其导入并在应用程序的任务列表中调用其生成器函数即可

import { Task } from '@awarns/core/tasks';
import { filterGeolocationByAoIProximityTask } from '@awarns/geofencing';

export const demoTasks: Array<Task> = [
  filterGeolocationByAoIProximityTask(),
];

任务生成器参数

任务生成器不接收任何参数。

任务输出事件

• filterGeolocationByAoIProximityFinished (默认，无内容)
• geolocationCloseToAoIAcquired

在应用程序任务图中示例使用

on(
  'startEvent',
  run('acquirePhoneGeolocation')
    .every(1, 'minutes')
    .cancelOn('stopEvent')
);

on(
  'geolocationAcquired',
  run('filterGeolocationByAoIProximity', {
    nearbyRange: 100, // Area approximation radius, in meters (defaults to 100)
    offset: 15, // Optional distance calculation offset, in meters. Can help mitigating location error (defaults to 0)
    includeNearby: true // Optional indicate if points nearby an area should be taken into consideration (defaults to false)
  })
);

on('geolocationCloseToAoIAcquired', run('writeRecords')); // Just write the locations captured nearby an area of interest

注意：要使用 acquirePhoneGeolocation 和 writeRecords 任务，必须安装并配置地理位置和持久化包。请参阅 地理位置包 和 持久化包 文档。

事件

记录

AoIProximityChange

GeofencingProximity

许可证

Apache License Version 2.0