快速上手

安装

数字空间 SDK 支持通过npm、yarn等方式引入集成至项目中。

npm

npm install @tslfe/tacos-sdk --save

yarn(推荐使用)

yarn add @tslfe/tacos-sdk -S

导入

SDK 支持两种模块加载方式（esm、commonJS）。如果项目中使用了 webpack 或 vite 现代化的打包工具，推荐使用 import（esm模块规范） 的方式进行包的导入。

• ES-Module加载

import Tacos from "@tslfe/tacos-sdk"

• CommonJS加载

var Tacos = require("@tslfe/tacos-sdk")

使用

一般通过@tslfe/tacos-sdk接入 tacos 平台需要三个步骤

建立连接

通过connect与tacos建立连接，通过 tacos 实例 ID 和对应的 signature 签名与平台建立互信连接（完成请求的 token 签名）。 connect 的更多详情请点击 connect api 查看

import Tacos from "@tslfe/tacos-sdk";

Tacos.connect({
    appCode: "<应用id>"；
    request: {
      baseURL: "<应用接口根路径域名>"
    },
    socket:{
      url: "<空间与设备通讯连接地址>" // 指定websoket地址
    }
})

初始化 Root SDK 实例

通过建立连接后返回的Core创建 根节点SDK实例对象 , 后续具体相关的SDK实例对象均需要根据 Root SDK对象来获取

import Tacos, { Root } from "@tslfe/tacos-sdk";
Tacos.connect({
    ...
}).then(core => {
   // RootSDK实例
   const root = core.createInstance(Root);
})

查询空间要素对象

通过查询资源定位符来获取相对应的空间要素资源SDK对象：空间（Space）、设备（Device）、模式（Mode）、计划（Plan）、规则（Rule）、布局（Layout）等。

import Tacos, { Root } from "@tslfe/tacos-sdk";
import type { Space, Device, Mode, Rule } from "@tslfe/tacos-sdk";
...
...
const space = root.search<S>(xpath: "<资源定位符>");

// eg：查询office空间下的所有资源(空间内又包括设备、模式、计划、规则、布局、指标等资源)
const space = root.search<Space>("/Office/*");
// eg: 查询office空间下的所有设备
const device = root.search<Device>("/Office/devices/*");
//eg： 查询office空间下的所有模式
const mode = root.search<Mode>("/Office/modes/*");
//eg: 查询office空间下的所有规则
const rule = root.search<Rule>("/Office/rules/*");
...

现在，你就可以根据查询得到的相关要素资源进行相关具体操作了。详情参见基础篇章

#