UniFi API 项目使用教程

UniFi API 项目使用教程

unifi-api[UNMAINTAINED] An API towards the Ubiquity Networks UniFi controller项目地址:https://gitcode.com/gh_mirrors/un/unifi-api

1. 项目的目录结构及介绍

UniFi API 项目的目录结构如下：

unifi-api/
├── examples/
│   ├── example.py
│   └── ...
├── unifi/
│   ├── __init__.py
│   ├── controller.py
│   └── ...
├── README.md
├── LICENSE
└── setup.py

目录介绍

• examples/: 包含一些示例代码，展示如何使用 UniFi API。
• unifi/: 核心代码目录，包含 API 的主要实现。
  • __init__.py: 模块初始化文件。
  • controller.py: 控制器类，用于与 UniFi 控制器进行交互。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。
• setup.py: 用于安装项目的脚本。

2. 项目的启动文件介绍

项目的启动文件位于 examples/ 目录下，例如 example.py。这个文件展示了如何初始化 UniFi API 并执行一些基本操作。

示例代码

from unifi.controller import Controller

# 初始化控制器
c = Controller('192.168.1.1', 'admin', 'password', '8443', 'v5.12.32')

# 获取站点列表
sites = c.get_sites()
for site in sites:
    print(site['name'])

代码说明

• from unifi.controller import Controller: 导入控制器类。
• Controller 类的初始化参数包括控制器的 IP 地址、用户名、密码、端口和版本。
• c.get_sites(): 获取 UniFi 控制器管理的站点列表。

3. 项目的配置文件介绍

UniFi API 项目本身没有独立的配置文件，配置信息通常在代码中直接指定，如上述示例代码中的 Controller 初始化参数。

配置参数

• ip: UniFi 控制器的 IP 地址。
• username: 登录用户名。
• password: 登录密码。
• port: 控制器的端口。
• version: 控制器的版本。

通过这些参数，可以连接到 UniFi 控制器并进行相应的操作。

---

以上是 UniFi API 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

unifi-api[UNMAINTAINED] An API towards the Ubiquity Networks UniFi controller项目地址:https://gitcode.com/gh_mirrors/un/unifi-api