简介
Npm 包 unifi-hotspot 是一个用于管理 UniFi 热点的 JavaScript 库，它可以通过代码调用 UniFi 控制器 API 来实现创建、修改和删除热点等操作。本文将详细介绍 unifi-hotspot 的使用方法，包括安装、配置、创建热点等，帮助读者快速上手并学会使用该库。
安装
使用 unifi-hotspot 首先需要在 Node.js 环境中安装该 npm 包。可以通过以下命令完成安装：
npm install unifi-hotspot
配置
在使用 unifi-hotspot 之前，需要通过 config 对象配置 UniFi 控制器的 IP、用户名、密码等信息。配置示例代码如下：
-- -------------------- ---- ------- ----- ----- - ------------------------- ----- ------ - - -------- -------------------------------------------- --------- -------- --------- ----------- ----- ---------- -- ------------------------
其中，baseUrl 指定 UniFi 控制器的地址和端口号，username 和 password 指定登录控制器的用户名和密码，site 指定站点名称，默认为 default。
创建热点
创建热点是 unifi-hotspot 的核心功能之一，可以通过以下示例代码创建一个名为 guest-wifi 的热点：
-- -------------------- ---- -------
----- ---- - --------------------
----- ------- - -
----- -------------
------------ -----
---------- --------
-------------------- -----
------------- --------------------- -----------------------
--
----------------------------- --------
--------------- -- -
-------------------- -------- ------------------
--
-------------- -- -
------------------ -------- -------- -------------------
---上面的代码中，unifi.getSites()[0] 获取到了第一个站点的信息，options 对象定义了热点的配置信息，包括 SSID、VLAN、用户组、围栏等。unifi.createHotspot(site._id, options) 调用了 unifi-hotspot 的创建热点 API，并返回了一个 Promise 对象，可以通过 then() 和 catch() 方法处理创建热点的结果。
更新热点
更新热点是 unifi-hotspot 的另一个重要功能，可以通过以下示例代码修改名为 guest-wifi 的热点的配置信息：
-- -------------------- ---- -------
----- ---- - --------------------
----- --------- - ---------------------------
----- ------- - -
------------ ------
---------- ---------
--
----------------------------- ---------- --------
--------------- -- -
-------------------- -------- ------------------
--
-------------- -- -
------------------ -------- -------- -------------------
---上面的代码中，hotspotId 指定要更新的热点的 ID，options 对象定义了要修改的配置信息，包括 VLAN 和用户组。unifi.updateHotspot(site._id, hotspotId, options) 调用了 unifi-hotspot 的更新热点 API，并返回了一个 Promise 对象，可以通过 then() 和 catch() 方法处理更新热点的结果。
删除热点
删除热点也是 unifi-hotspot 的一个重要功能，可以通过以下示例代码删除名为 guest-wifi 的热点：
-- -------------------- ---- -------
----- ---- - --------------------
----- --------- - ---------------------------
----------------------------- ----------
-------- -- -
-------------------- -------- ---------------
--
-------------- -- -
------------------ -------- -------- -------------------
---上面的代码中，hotspotId 指定要删除的热点的 ID。unifi.deleteHotspot(site._id, hotspotId) 调用了 unifi-hotspot 的删除热点 API，并返回了一个 Promise 对象，可以通过 then() 和 catch() 方法处理删除热点的结果。
总结
本文简要介绍了 npm 包 unifi-hotspot 的使用方法，包括安装、配置、创建热点、更新热点和删除热点等。通过阅读本文，读者可以快速上手 unifi-hotspot，并在实际项目中使用该库实现 UniFi 热点管理的相关功能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600572ca81e8991b448e8f8b