@clearblade/iot

中文文档
1.4.4发布于 2026/05/29Apache-2.0TypeScriptCommonJS近 30 天下载 1767

Cloud IoT API 节点客户端

中文使用文档
文档目录11 节
  1. 快速启动
  2. 在你开始之前
  3. 安装客户端库
  4. 建立服务账户证书
  5. BINARYDATA AND TIME GOGLE FORMAT env 变量(可选)
  6. 使用客户端库
  7. 样本
  8. 支持的 Node.js 版本
  9. 版本
  10. 捐款
  11. 许可证

ClearBlade IoT 核心:节点.js 客户端

npm version

节点.js 平庸客户端 清除Blade IoT 核心。 。 。 .

清除Blade IoT 核心 这是一种完全管理的服务,用于安全连接和管理IOT设备,从几到数百万。 从相接设备获取信息,并构建与ClearBlade平台或Google Cloud平台的其他大数据服务相融合的丰富应用程序.

目录 :

快速启动

在你开始之前

  1. 选择或创建云平台项目。 。 。 .
  2. 启用您的工程计费。 。 。 .
  3. 启用 ClearBlade IoT 核心 API。 。 。 .
  4. 用服务账户设置认证 您可从本地工作站获取 API.

安装客户端库

npm install @clearblade/iot

建立服务账户证书

本节使用其中之一文件 :

在您的项目中创建一个服务账户并下载证书.json文件 。 定义命名的环境变量 CLEARBLADE_CONFIGURATION,它代表证书.json文件的路径。 示例

export CLEARBLADE_CONFIGURATION=/path/to/file.json

作为使用文件路径获取服务账户证书的替代办法,您可以使用 project, (中文(简体) ), systemKey, (中文(简体) ), token,以及 url 从您的服务账户的.json文件中获取的值,并直接提供给构建者:

const client = new DeviceManagerClient({
  credentials: {
    project: '<project>',
    systemKey: '<systemKey>',
    token: '<token>',
    url: '<url>',
  },
});

使用您的服务账户证书而不是来自注册 API 密钥页的证书。 您可以使用一套服务账户证书来瞄准您项目的所有注册.

BINARYDATA AND TIME GOGLE FORMAT env 变量(可选)

如果您想要收到二进制数据以及和Google IoT节点SDK提供格式相同的时间戳,您可以定义一个环境变量,命名为 BINARYDATA_AND_TIME_GOOGLE_FORMAT。如果此嵌入变量被设定为 true,然后它将给二进制数据对象的反应,以字节阵列形式和时间为时标格式,其中会包含秒和纳米,遵循Google的结构. 它适用于获取设备状态列表,修改配置,以及设备配置版本方法. 默认情况下,这面旗帜的值会是虚假的.

export BINARYDATA_AND_TIME_GOOGLE_FORMAT=true

使用客户端库

const iot = require('@clearblade/iot');
const client = new iot.v1.DeviceManagerClient();

async function quickstart() {
  const projectId = await client.getProjectId();
  const parent = client.locationPath(projectId, 'us-central1');
  const [resources] = await client.listDeviceRegistries({parent});
  console.log(`${resources.length} resource(s) found.`);
  for (const resource of resources) {
    console.log(resource);
  }
}
quickstart();

样本

样本在 samples/ 目录。 每个样本 README.md 有运行样本的指示.

样本源代码试试看
快速启动源代码Open in Cloud Shell

这个 ClearBlade IoT 核心节点.js客户端 API 参考 文件还载有样本.

支持的 Node.js 版本

我们的客户端图书馆跟着 节点.js发布时间表。图书馆兼容所有当前 活动 财务报告和审定财务报表 维修 (原始内容存档于2018-10-21). Executive of Node.js. 如果你正在使用一个报废版本的Node.js,我们建议你尽快更新到一个积极支持的LTS版本.

ClearBlade的客户端库在最佳效果的基础上支持了Node.js runtimes的遗留版本,并给出了以下警告:

  • 后遗症版本不进行连续整合测试.
  • 一些安全补丁和特性不能被后移植.
  • 依赖关系不能不断更新.

客户端库针对一些已报废的 Node.js 版本,可以通过 npm 安装 秒数。 。 。 . 立面遵循命名惯例 legacy-(version)。例如, npm install @google-cloud/iot@legacy-8 为与Node.js 8.相容的版本安装客户端库.

版本

这个图书馆跟随 语义版本。 。 。 .

这个图书馆被认为是 稳定。除非有必要(例如,由于重大安全问题)或与下列情况相适应,否则代码表面不会改变后向兼容方式 大量贬值期。 问题和要求 稳定 以最高优先处理图书馆问题.

捐款

欢迎捐款! 见 贡献指南。 。 。 .

许可证

Apache 版本 2.0

见 自由主义

版本与发布记录

@clearblade/iot 共发布 30 个版本,首次发布于 2022/10/25;过去 12 个月发布了 2 个版本。

版本发布日期距今
1.4.4latest2026/05/295 个月前
1.4.32026/05/295 个月前
1.4.22024/06/212 年前
1.4.12024/04/162 年前
1.4.02024/02/012 年前
1.3.12023/09/303 年前

关于 @clearblade/iot 的常见问题

@clearblade/iot 是什么?

Cloud IoT API 节点客户端

如何安装 @clearblade/iot?

在项目目录运行 npm install @clearblade/iot,或使用 pnpm add / yarn add / bun add。

@clearblade/iot 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@clearblade/iot 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@clearblade/iot 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=12.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@clearblade/iot 可以商用吗?

@clearblade/iot 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@clearblade/iot 的下载量有多少?

根据 npm 官方下载统计,@clearblade/iot 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,767 次,日均约 59 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@clearblade/iot 还在维护吗?

最新版本 1.4.4 发布于 2026/05/29(5 个月前);至今共发布 30 个版本,其中过去 12 个月发布了 2 个;首次发布于 2022/10/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。