nativescript-wearos-sensors

nativescript-wearos-sensors 是使用 NativeScript 框架开发的插件。它允许开发智能手机应用程序，用于从配对的Android WearOS智能手表（如果设备中存在相应的传感器）收集IMU传感器（例如加速度计和陀螺仪）、磁力计、心率以及GPS数据。

Android WearOS智能手表必须运行使用本地 WearOS Sensors 库构建的对应应用程序。然后，智能手机应用程序可以请求智能手表开始/停止指定传感器的数据收集，智能手表将收集到的样本发送到智能手机应用程序。

[!WARNING] 如果配对的智能手表中没有使用 WearOS Sensors 库构建的对应应用程序，使用此插件的应用程序将完全无用。换句话说，智能手机不能独立工作。它需要一个智能手表才能工作。

数据收集可以从智能手机和配对的智能手表启动。此外，该插件提供了一种通过发送消息与智能手表通信的方式。

安装

在您的项目根目录中运行以下命令。

ns plugin add nativescript-wearos-sensors

要求

此插件仅由 Android 智能手机支持。要使用它构建应用程序，必须满足以下要求

• 运行 Android 6（API 级别 23）或更高版本的 Android 智能手机。

[!CAUTION] 构建的应用程序的 targetSdkVersion 必须小于或等于 31（Android 12）。针对 >=31 的应用程序将无法工作，因为 Dynamic File Loading 存在问题。

• 此外，智能手机必须与安装有对应应用程序的智能手表配对。要将智能手表连接到智能手机，您还必须安装 Google Smartwatch WearOS 或智能手表制造商提供的特定应用程序（例如，Mobvoi Health、Samsung Wearable 等），并按照连接两个设备的说明进行操作。

[!IMPORTANT] 两个应用程序（智能手机和智能手表应用程序）必须具有相同的应用程序 id。如果不是这样，应用程序将无法交互。您可以在 nativescript.config.ts 中更改 NativeScript 应用程序的应用程序 id。

使用方法

该插件提供以下功能

• 从配对的智能手表收集传感器数据：可以从智能手机和智能手表启动/停止。智能手表可以通过 WearCommands 功能启动和停止数据收集。
• 纯文本消息：允许在两个设备之间发送和接收简单消息。

首先，您需要使用 WearosSensorsConfig 在您的 app.ts（TypeScript 应用程序）或 main.ts（Angular 应用程序）文件中初始化插件

// TypeScript App:
import { Application } from "@nativescript/core";
// or Angular App:
import { platformNativeScriptDynamic } from "nativescript-angular/platform";
import { AppModule } from "./app/app.module";

// WearOSSensors import
import { wearosSensors, allSensors } from "nativescript-wearos-sensors";

wearosSensors.init({
    sensors: allSensors,
    disablePlainMessaging: false,
    disableWearCommands: false
});

// TypeScript App:
Application.run({ moduleName: "app-root" });
// Angular App:
platformNativeScriptDynamic().bootstrapModule(AppModule);

初始化参数是可选的，允许指定哪些传感器已启用（sensors），以及是否启用 PlainMessaging（《disablePlainMessaging》）和 WearCommands（《disableWearCommands》）功能。默认配置是上面示例中显示的配置：所有传感器和功能都启用。

[!注意] 此配置允许根据条件将本地组件与插件核心连接。这可以减少应用程序在未使用某些功能时使用的内存。

传感器数据收集

如上所述，数据收集可以由两个设备启动/停止，但只有智能手机可以访问收集到的数据。

要接收收集到的数据，智能手机必须通过 CollectorManager 注册监听器（至少一个）。可以为特定的节点/（例如，智能手表）和特定的传感器/设置监听器。这意味着可以有多个注册的监听器，它们都监听不同的节点或传感器。可以使用 ListenerFilters 实现此行为。以下是如何注册不同监听器的示例

import { getCollectorManager } from "nativescript-wearos-sensors/collection";
import { SensorRecord } from "nativescript-wearos-sensors/sensors/records";
import { Node } from "nativescript-wearos-sensors/node";
import { ListenerFilter } from "nativescript-wearos-sensors/listeners";
import { SensorType } from "nativescript-wearos-sensors/sensors";


function registerGlobalListener() {
    // Register a listener witout filters --> receives records from all sources
    getCollectorManager().addSensorListener((sensorRecord: SensorRecord<any>) => {
        console.log(deviceId, JSON.stringify(sensorRecord));
    });
}

function registerListenerForNode(node: Node) {
    // Register a listener filtering per node --> receives all kind of records from that node
    const filter: ListenerFilter = {
        nodes: [node]
    }
    getCollectorManager().addSensorListener((sensorRecord: SensorRecord<any>) => {
        console.log(deviceId, JSON.stringify(sensorRecord));
    }, filter);
}

function registerListenerForSensor(sensor: SensorType) {
    // Register a listener filtering per sensor --> receives records of that sensor from any node
    const filter: ListenerFilter = {
        sensors: [sensor]
    }
    getCollectorManager().addSensorListener((sensorRecord: SensorRecord<any>) => {
        console.log(deviceId, JSON.stringify(sensorRecord));
    }, filter);
}

function registerListenerForNodeAndSensors(node: Node, sensors: SensorType[]) {
    // Register a listener filtering per node and sensor --> receives records of that sensors from that node
    const filter: ListenerFilter = {
        nodes: [node],
        sensors: sensors
    }
    getCollectorManager().addSensorListener((sensorRecord: SensorRecord<any>) => {
        console.log(deviceId, JSON.stringify(sensorRecord));
    }, filter);
}

从智能手机开始/停止数据收集

为了开始节点的数据收集，首先您必须使用 NodeDiscoverer 获取连接的节点。一旦您获得连接的节点，您就必须遵循一些步骤来开始数据收集

1. 检查节点上的特定传感器是否已准备好进行收集。
2. 如果它没有准备好
   1. 这是因为传感器未在设备中。
   2. 传感器在设备中，但智能手表应用程序没有收集该传感器的权限。
3. 如果我们缺乏权限，我们可以只是要求用户授予它们。
   1. 如果权限被拒绝，那就到此为止了...
   2. 如果权限被授予，我们可以开始收集!!

要开始数据收集，我们还应该指定一个 CollectionConfiguration，其中我们可以指定连续样本之间的所需时间（sensorDelay）以及每次交付的样本数量（batchSize）。配置是可选的，如果未提供配置，则应用默认值。

[!注意] 由于智能手表必须通过蓝牙发送收集到的数据，因此在与高采样率一起工作时，我们无法发送单个样本。这样会饱和连接。为了解决这个问题，我们以批量的方式发送样本。

以下是此收集程序的示例

import { getNodeDiscoverer } from "nativescript-wearos-sensors/node";
import { getCollectorManager, PrepareError, CollectionConfiguration } from "nativescript-wearos-sensors/collection";
import { Node } from "nativescript-wearos-sensors/node";
import { SensorType } from "nativescript-wearos-sensors/sensors";

async function getNodes(): Promise<Node[]> {
    await nodesDiscovered = nodeDiscoverer.getConnectedNodes();
    const nodes = []
    nodesDiscovered.forEach((nodeDiscovered) => {
        if (nodeDiscovered.error) {
            this.logger.logResult(nodeDiscovered.error);
            return;
        }
        nodes.push(nodeDiscovered.node);
    });
    return nodes;
}

async function collectFrom(node: Node, sensor: SensorType, config: CollectionConfiguration) {
    const collectorManager = getCollectorManager();
    
    const isReady = await collectorManager.isReady(node, sensor);
    if (!isReady) {
        const prepareError: PrepareError = await collectorManager.prepare(node, sensor);
        if (prepareError) {
            console.log(prepareError.message);
            return;
        }
    }
    
    await collectorManager.startCollecting(node, sensor, config);
}

async function stopCollecingFrom(node: Node, sensor: SensorType) {
    await collectorManager.stopCollecting(node, sensor);
}

从智能手表开始/停止数据收集

插件为您完全处理此问题。您只需确保至少注册一个监听器以接收收集到的数据。

[!重要] WearCommands功能必须在插件初始化时启用。

普通消息传递

在一个由多个设备组成的系统中，有一种方法来进行通信很重要。我们提供了 PlainMessageClient，它允许发送和接收基于字符串的消息。有两种类型接收到的消息：需要响应的消息和不需要响应的消息。以下是如何使用消息功能的示例

import { getPlainMessageClient } from "src/internal/communication/plain-message";

function registerListener(): void {
    // Register a listener to receive messages from the smartwatch
    getPlainMessageClient().registerListener((receivedMessage) => {
        console.log(`received single message ${JSON.stringify(receivedMessage)}`);
    });
}

async function sendMessage(node: Node, message: string): void {
    // Send a message to the smartwatch
    const plainMessage = {message: "You don't have to reply :)"};
    await getPlainMessageClient().send(node, plainMessage);
}

async function sendMessageAndWaitResponse(node: Node, message: string): void {
    // Send a message to the smartwatch and wait for a response
    const plainMessage = {message: "PING!"};
    const receivedMessage = await getPlainMessageClient().sendExpectingResponse(node, plainMessage);
    console.log(`response received: ${JSON.stringify(receivedMessage)}`);
}

[!重要] 平凡消息传递功能必须在插件初始化时启用。

API

wearosSensors - 方法

WearosSensorsConfig

defaultConfig

export const defaultConfig = {
    sensors: allSensors, // Constant containing all the sensors
    disablePlainMessaging: false,
    disableWearCommands: false
};

NodeDiscoverer

Node

NodeDiscovered

SensorType

CollectorManager

PrepareError

CollectionConfiguration

SensorListener

(sensorRecord: SensorRecord) => void

ListenerFilter

[!TIP] 过滤器的工作方式如下

{ 
  nodes: [node1, /* OR */ node2]
  // AND
  sensors: [SensorType.ACCELEROMETER, /* OR */ SensorType.GYROSCOPE]
}

SensorRecord

TriAxialSensorSample

HeartRateSensorSample

LocationSensorSample

PlainMessageClient

普通消息

接收到的消息

普通消息监听器

(receivedMessage: 接收到的消息) => void

许可证

Apache许可证2.0

见 LICENSE。

作者

致谢

本库的开发得益于西班牙大学部（资助FPU19/05352）。