TP-Link Cloud API 项目教程

TP-Link Cloud API 项目教程

tplink-cloud-apiA node.js npm module to remotely control TP-Link smartplugs (HS100, HS110) and smartbulbs (LB100, LB110, LB120, LB130) using their cloud web service (no need to be on the same wifi/lan)项目地址:https://gitcode.com/gh_mirrors/tp/tplink-cloud-api

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

tplink-cloud-api/
├── README.md
├── requirements.txt
├── setup.py
├── tplinkcloud/
│   ├── __init__.py
│   ├── device.py
│   ├── device_manager.py
│   └── exceptions.py
├── tests/
│   ├── __init__.py
│   ├── test_device.py
│   └── test_device_manager.py
└── examples/
    └── example.py

• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。
• tplinkcloud/: 核心代码目录，包含设备管理、设备操作等模块。
  • init.py: 模块初始化文件。
  • device.py: 设备操作相关代码。
  • device_manager.py: 设备管理相关代码。
  • exceptions.py: 自定义异常类。
• tests/: 测试代码目录，包含设备和设备管理的测试用例。
• examples/: 示例代码目录，包含使用示例。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/example.py，该文件展示了如何使用 tplink-cloud-api 库来控制 TP-Link 智能设备。

from tplinkcloud import TPLinkDeviceManager

# 初始化设备管理器
device_manager = TPLinkDeviceManager(username='your_email@example.com', password='your_password')

# 获取设备列表
devices = device_manager.get_devices()

# 控制设备
for device in devices:
    if device.get_alias() == 'Living Room Plug':
        device.power_on()

3. 项目的配置文件介绍

项目没有显式的配置文件，但可以通过环境变量或直接在代码中设置参数来配置。

环境变量配置

export TPLINK_KASA_TERM_ID=2a8ced52-f200-4b79-a1fe-2f6b58193c4c
export TPLINK_KASA_API_URL=http://127.0.0.1:8080

代码中配置

from tplinkcloud import TPLinkDeviceManager

device_manager = TPLinkDeviceManager(
    username='your_email@example.com',
    password='your_password',
    term_id='2a8ced52-f200-4b79-a1fe-2f6b58193c4c',
    api_url='http://127.0.0.1:8080'
)

通过以上配置，可以灵活地控制 TP-Link 智能设备。

tplink-cloud-apiA node.js npm module to remotely control TP-Link smartplugs (HS100, HS110) and smartbulbs (LB100, LB110, LB120, LB130) using their cloud web service (no need to be on the same wifi/lan)项目地址:https://gitcode.com/gh_mirrors/tp/tplink-cloud-api