cesarbr/knot-fog-connector

KNoT Fog 连接器服务

概述和主要用途

这是一个KNoT网关服务，用于将雾计算连接到云服务，实现设备数据在雾与云之间的传输、管理及设备注册、认证等功能。

核心功能和特性

• 支持多种云服务提供商（KNoT Cloud、FIWARE）
• 设备生命周期管理（添加、移除、认证、列表）
• 数据发布与更新（传感器数据上报、执行器控制）
• 配置管理（设备传感器配置更新）
• 连接状态监控（断开、重连事件处理）

支持的服务

• https://github.com/CESARBR/knot-fog-connector-knot-cloud
• https://github.com/CESARBR/knot-fog-connector-fiware

快速启动

bash
$ npm install
$ npm run build
$ npm start

开发环境设置

为测试对支持的服务的更改，需设置开发环境并本地运行所需服务。注意，更改也应在KNoT网关上直接测试。

先决条件

knot-fog-connector 需要 RabbitMQ 运行，默认访问地址为 localhost:5672。

配置

配置通过 knot-fog-connector/config/ 文件夹中的JSON文件实现（详见 config 包文档）。配置参数说明如下：

• fog 对象 雾服务参数
• cloudType 字符串 云服务提供商名称，目前支持 KNOT_CLOUD 或 FIWARE
• cloud 对象 特定云服务的参数（见下文）

Fog 配置

• fog 对象 雾服务参数：
  • token 字符串 用户访问令牌
  • hostname 字符串 AMQP代理主机名
  • port 数字 AMQP代理端口
  • username 字符串 AMQP代理用户名
  • password 字符串 AMQP代理密码

json
{
  "fog": {
    "token": "<knot-fog-user-token>",
    "hostname": "localhost",
    "port": 5672,
    "username": "knot",
    "password": "knot"
  }
}

KNoT-Cloud 配置

注意：KNoT Cloud是雾解决方案的扩展版本，配置类似，但需使用独立的消息代理实例。

• cloud 对象 云服务参数：
  • amqp 对象 AMQP代理参数：
    • token 字符串 用户访问令牌
    • hostname 字符串 代理主机名
    • port 数字 代理端口
    • username 字符串 代理用户名
    • password 字符串 代理密码
  • http 对象 HTTP服务器参数：
    • hostname 字符串 服务器主机名
    • port 数字 服务器端口
    • protocol 字符串 服务器协议（HTTP|HTTPS）

json
{
  "cloudType": "KNOT_CLOUD",
  "cloud": {
    "amqp": {
      "token": "<knot-cloud-user-token>",
      "hostname": "broker.knot.cloud",
      "port": 5672,
      "username": "knot",
      "password": "knot"
    },
    "http": {
      "hostname": "api.knot.cloud",
      "port": "443",
      "protocol": "https"
    }
  }
}

FIWARE 配置

• cloud 对象 云服务参数：
  • iota 对象 IOTA服务器参数：
    • hostname 字符串 主机名
    • port 数字 端口
  • orion 对象 Orion服务器参数：
    • hostname 字符串 主机名
    • port 数字 端口

json
{
  "cloudType": "FIWARE",
  "cloud": {
    "iota": {
      "hostname": "localhost",
      "port": 4041
    },
    "orion": {
      "hostname": "localhost",
      "port": 1026
    }
  }
}

创建自定义连接器

连接器是默认导出 Connector 类的库，服务使用方式如下：

javascript
import CustomCloudConnector from '@cesarbr/knot-fog-connector-customcloud';

// 初始化连接器
const connector = new CustomCloudConnector(config);
// 启动连接器
await connector.start();

核心方法

constructor(config)

创建连接器实例，接收配置对象（从JSON文件加载）。构造函数中不执行连接等初始化操作。

参数：

• config 对象 连接器定义的配置参数

示例：

javascript
import CustomCloudConnector from '@cesarbr/knot-fog-connector-customcloud';

const connector = new CustomCloudConnector({
  hostname: 'localhost',
  port: 3000
});

start(): Promise

启动连接器，执行初始化操作（如连接外部服务）。

示例：

javascript
await connector.start();

addDevice(device): Promise

添加设备到云，雾中新增设备时调用。

参数：

• device 对象 设备信息：
  • id 字符串 设备ID（KNoT ID）
  • name 字符串 设备名称

返回值：

• device 对象 云注册设备信息：
  • id 字符串 设备ID
  • token 字符串 设备令牌

示例：

javascript
await connector.addDevice({
  id: '918f2e0f4e19f990',
  name: '前门'
});
// 返回: { id: '918f2e0f4e19f990', token: '5b67ce6bef21701331152d6297e1bd2b22f91787' }

removeDevice(id): Promise

从云移除设备，雾中移除设备时调用。

参数：

• id 字符串 设备ID（KNoT ID）

示例：

javascript
await connector.removeDevice('918f2e0f4e19f990');

authDevice(id, token): Promise

设备云认证，验证设备在云服务中的有效性。

参数：

• id 字符串 设备ID
• token 字符串 设备令牌

返回值：

• status 布尔值 认证状态（true/false）

示例：

javascript
const status = await connector.authDevice(
  '918f2e0f4e19f990',
  '0c20c12e2ac058d0513d81dc58e33b2f9ff8c83d'
);
console.log(status); // true

listDevices(): Promise