# @clearblade/iot 中文文档

规范地址：https://npmcn.com/package/%40clearblade/iot/

版本：1\.4\.4
npm 元数据更新时间：2026-05-28T21:35:22.577Z
中文译文更新时间：2026-11-10T01:03:28.475Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40clearblade/iot
原文对照：https://npmcn.com/package/%40clearblade/iot/?lang=original
项目主页：https://github.com/ClearBlade/nodejs-iot#readme
源码仓库：https://github.com/ClearBlade/nodejs-iot

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.4 MB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12\.0\.0
- 运行依赖：2 个
- 首次发布：2022-10-24T16:46:55.238Z
- 最新版本发布：2026-05-28T21:35:22.410Z
- 近 30 天下载量：1767（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 2 个）

## 中文简介

Cloud IoT API 节点客户端

## 安装

```sh
npm install @clearblade/iot
```

也可以使用：`pnpm add @clearblade/iot`、`yarn add @clearblade/iot`、`bun add @clearblade/iot`

## README

# [ClearBlade IoT 核心:节点.js 客户端](https://github.com/clearblade/nodejs-iot)

[![npm version](https://img.shields.io/npm/v/@clearblade/iot.svg)](https://www.npmjs.org/package/@clearblade/iot)

> 节点.js 平庸客户端 [清除Blade IoT 核心](https://docs.clearblade.com/iotcore/all-concepts)。 。 。 .

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

-   [ClearBlade IoT 核心节点.js客户端 API 参考](https://cloud.google.com/nodejs/docs/reference/iot/latest)
-   [清除 IoT 核心文件](https://docs.clearblade.com/iotcore/all-concepts)
-   [github.com/ clearblade/nodejs-iot 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/clearblade/nodejs-iot)

**目录 :**

-   [快速启动](https://npmcn.com/package/%40clearblade/iot/#readme-quickstart)
    -   [在你开始之前](https://npmcn.com/package/%40clearblade/iot/#readme-before-you-begin)
    -   [安装客户端库](https://npmcn.com/package/%40clearblade/iot/#readme-installing-the-client-library)
    -   [使用客户端库](https://npmcn.com/package/%40clearblade/iot/#readme-using-the-client-library)
-   [样本](https://npmcn.com/package/%40clearblade/iot/#readme-samples)
-   [版本](https://npmcn.com/package/%40clearblade/iot/#readme-versioning)
-   [捐款](https://npmcn.com/package/%40clearblade/iot/#readme-contributing)
-   [许可证](https://npmcn.com/package/%40clearblade/iot/#readme-license)

## 快速启动

### 在你开始之前

1.  [选择或创建云平台项目](https://console.cloud.google.com/project)。 。 。 .
2.  [启用您的工程计费](https://support.google.com/cloud/answer/6293499#enable-billing)。 。 。 .
3.  [启用 ClearBlade IoT 核心 API](https://docs.clearblade.com/iotcore/google-cloud-marketplace-activation)。 。 。 .
4.  [用服务账户设置认证](https://cloud.google.com/docs/authentication/getting-started) 您可从本地工作站获取 API.

### 安装客户端库

```bash
npm install @clearblade/iot
```

### 建立服务账户证书

本节使用其中之一文件 :

-   [IOT 核心标准](https://docs.clearblade.com/iotcore/manage-service-accounts-in-a-project-standard)
-   [IOT 核心企业](https://docs.clearblade.com/iotcore/manage-service-accounts-in-a-project-enterprise)

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

```
export CLEARBLADE_CONFIGURATION=/path/to/file.json
```

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

```javascript
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
```

### 使用客户端库

```javascript
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/`](https://github.com/clearblade/nodejs-iot/tree/main/samples) 目录。 每个样本 `README.md` 有运行样本的指示.

| 样本 | 源代码 | 试试看 |
| --- | --- | --- |
| 快速启动 | [源代码](https://github.com/clearblade/nodejs-iot/blob/main/samples/quickstart.js) | [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/clearblade/nodejs-iot&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |

这个 [ClearBlade IoT 核心节点.js客户端 API 参考](https://cloud.google.com/nodejs/docs/reference/iot/latest) 文件还载有样本.

## 支持的 Node.js 版本

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

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

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

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

## 版本

这个图书馆跟随 [语义版本](http://semver.org/)。 。 。 .

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

## 捐款

欢迎捐款! 见 [贡献指南](https://github.com/clearblade/nodejs-iot/blob/main/CONTRIBUTING.md)。 。 。 .

## 许可证

Apache 版本 2.0

见 [自由主义](https://github.com/googleapis/nodejs-iot/blob/main/LICENSE)

## 常见问题

### @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 和提交记录判断。