npm 包 @c8y/client 使用教程

简介

The Cumulocity IoT platform 是一款针对物联网解决方案的平台，开发者可以使用它来构建、部署和管理物联网设备。

c8y-client 是一个由 cumulocity 开发的 Node.js 客户端包。它可以帮助开发者使用 Cumulocity IoT platform 的 API，并提供高层抽象和方便的方法来处理 Cumulocity IoT platform 返回的数据。

本文将介绍 @c8y/client 的使用教程，帮助开发者更轻松地使用 Cumulocity IoT platform。

安装

要使用 @c8y/client，您需要使用以下命令将其安装到您的项目中：

npm install @c8y/client

使用

要使用 @c8y/client，您需要先获取 Cumulocity IoT platform 的 tenant（租户）和应用程序的凭证。请按照以下步骤获取您的凭证：

1. 登录 Cumulocity IoT 网站.

2. 在控制台页面上点击左侧菜单中的“管理”。

3. 在“应用程序”选项卡中，单击“新建”。

   

4. 选择“管理员应用程序”权限，然后单击“创建”。

   

5. 在新创建的应用程序的详情页面中，您可以找到获取 HTTP Credentials 的选项。

   

6. 将从 Cumulocity IoT platform 获取的租户和密码作为参数提供给您的应用程序：

   const { Client } = require('@c8y/client');
   
   const client = new Client({
     tenant: 'your-tenant',
     username: 'your-username',
     password: 'your-password'
   });

使用 @c8y/client，您可以很方便地使用 Cumulocity IoT platform 的 API。以下是一些示例：

示例

获取设备列表

async function getDevices() {
  const { data } = await client.inventory.list();
  const devices = data.filter(item => item.type === 'c8y_Device');
  return devices;
}

创建设备

async function createDevice(name) {
  const { data } = await client.inventory.create({
    name,
    type: 'c8y_Device'
  });
  const { id } = data;
  return id;
}

获取设备的全部事件

async function getDeviceEvents(deviceId) {
  const { data } = await client.event.list({
    source: deviceId
  });
  return data;
}

结论

@c8y/client 是一个非常方便的工具，可以帮助开发者使用 Cumulocity IoT platform 的 API。本文介绍了如何使用 @c8y/client，以及该工具如何帮助我们开发 IoT 解决方案。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/141947