简介
unifi-detect 是一个基于 Node.js 的 npm 包，主要用于检测设备是否连接到 UniFi 控制器的网络中。
在前端开发中，我们常常需要了解设备的连接状态，以方便开发和调试。然而，常规的网络连接状态检测方式通常需要使用到复杂的 API，而且有些还需要特别的权限。unifi-detect 包则是为了解决这个问题而推出的，它提供了一种简便、高效、安全的设备连接状态检测方式。
在本篇文章中，我们将会给出 unifi-detect 的使用教程，包括安装、配置、使用等方面的详细步骤和说明，以便读者们可以快速而准确地上手使用该 npm 包。
安装
unifi-detect 是一个基于 Node.js 的 npm 包，所以在使用前，你需要先安装 Node.js。Node.js 的安装方法在此不再赘述，读者可以前往其官网了解详细信息。
在 Node.js 安装成功后，你可以使用 npm 包管理器来安装 unifi-detect 包。具体的安装方式如下：
npm install unifi-detect
安装完成后，你就可以使用 unifi-detect 包了。
配置
unifi-detect 包的配置非常简单，你只需要在代码中引入它，并调用相应的方法即可。在使用前，你需要确保你已经有了 UniFi 控制器的账号和密码，并能够访问 UniFi 控制器的相关 API。
在引入 unifi-detect 包后，你需要设置 UniFi 控制器的相关信息：IP 地址、账号、密码、端口以及 SSL 证书路径（可选）。具体的代码如下：
const unifiDetect = require('unifi-detect');
unifiDetect.setup({
controllerUrl: 'https://192.168.1.1:8443',
username: 'user',
password: 'password',
port: 8443,
sslCertPath: '/path/to/cert.pem'
});需要注意的是，其中的 controllerUrl、username 和 password 是必填的参数；而 port 和 sslCertPath 则是可选的参数，一般的情况下，你可以不填写它们。
使用
在配置完成之后，你就可以开始使用 unifi-detect 包了。unifi-detect 提供了以下两种函数：isDeviceConnected 和 getDevicesConnected。
isDeviceConnected
该函数接受两个参数：mac 和 cb，其中 mac 表示设备的 MAC 地址，cb 是一个回调函数。isDeviceConnected 函数的主要作用是检测指定的设备是否连接到 UniFi 控制器的网络中。
unifiDetect.isDeviceConnected('00:11:22:33:44:55', (err, connected) => {
if (err) {
console.error(err);
} else {
console.log(connected);
}
});在上面的代码中，isDeviceConnected 函数会检测 MAC 地址为 00:11:22:33:44:55 的设备是否连接到 UniFi 控制器的网络中。如果设备已经连接，函数会返回 true；如果未连接，则返回 false。
getDevicesConnected
该函数接受一个 cb 参数，该参数是一个回调函数。getDevicesConnected 函数的主要作用是获取当前连接到 UniFi 控制器网络中的所有设备的 MAC 地址列表。
unifiDetect.getDevicesConnected((err, devices) => {
if (err) {
console.error(err);
} else {
console.log(devices);
}
});在上面的代码中，getDevicesConnected 函数会获取当前连接到 UniFi 控制器网络中的所有设备的 MAC 地址列表，并返回该列表到回调函数的 devices 参数中。如果没有设备连接到网络中，该函数会返回一个空列表。
示例代码
下面是一段完整的使用示例代码：
-- -------------------- ---- -------
----- ----------- - ------------------------
-------------------
-------------- ---------------------------
--------- -------
--------- ----------
---
-------------------------------------------------- ----- ---------- -- -
-- ----- -
-------------------
- ---- -
-----------------------
-
---
------------------------------------- -------- -- -
-- ----- -
-------------------
- ---- -
---------------------
-
---在上面的代码中，我们首先引入了 unifi-detect 包，并设置了 UniFi 控制器的相关信息。然后，我们分别调用了 isDeviceConnected 和 getDevicesConnected 两个函数，从而检测指定设备的连接状态，并获取当前连接到网络中的所有设备的 MAC 地址列表。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066b5851ab1864dac66dd5