Metadata-Version: 2.4
Name: dlt645
Version: 1.2.0
Summary: DLT645协议Python实现库
Home-page: https://gitee.com/chen-dongyu123/dlt645
Author: Chen Dongyu
Author-email: Chen Dongyu <1755696012@qq.com>
Maintainer-email: Chen Dongyu <1755696012@qq.com>
License: Apache License 2.0
Project-URL: Homepage, https://gitee.com/chen-dongyu123/dlt645
Project-URL: Repository, https://gitee.com/chen-dongyu123/dlt645
Project-URL: Issues, https://gitee.com/chen-dongyu123/dlt645/issues
Project-URL: Changelog, https://gitee.com/chen-dongyu123/dlt645/tree/master/python/CHANGELOG.md
Project-URL: Documentation, https://gitee.com/chen-dongyu123/dlt645/wiki
Keywords: dlt645,protocol,communication,energy,meter
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: loguru>=0.7.0
Requires-Dist: pyserial>=3.5
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=2.0; extra == "dev"
Requires-Dist: black>=21.0; extra == "dev"
Requires-Dist: flake8>=3.8; extra == "dev"
Requires-Dist: mypy>=0.800; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

# DLT645协议多语言实现库

一个功能完整的DLT645电能表通信协议的多语言实现项目，同时支持C++、Python和Go三种编程语言，提供了统一的接口和功能。

## 🌴通讯支持

| 功能                            | 状态 |
| ------------------------------- | ---- |
| **TCP客户端（方便通讯测试）** 🐾 | ✅    |
| **TCP服务端（方便通讯测试）** 🐾 | ✅    |
| **RTU主站** 🐾                   | ✅    |
| **RTU从站** 🐾                   | ✅    |

## 🌴 功能完成情况

| 功能                                           | 状态 |
| ---------------------------------------------- | -- |
| **读、写通讯地址** 🐾  | ✅  |
| **广播校时** 🐾  | ✅  |
| **电能量** 🐾  | ✅  |
| **最大需量及发生时间** 🐾         | ✅ |
| **变量** 🐾                | ✅ |
| **参变量** 🐾            | ✅ |
| **事件记录** 🐾                 | ❌ |
| **冻结量** 🐾               | ❌ |
| **负荷纪录** 🐾           | ❌ |

因为本人使用DLT645协议需求大多是读取电能表上的电能、需量、变量等数据，后续的功能暂无开发计划，如果需要可以联系我

## 选择语言版本

请选择您感兴趣的语言版本查看详细文档：

- [C++版本](../cpp/README.md)
- Python版本
- [Go版本](../go/README.md)

## DLT645协议Python实现库

一个功能完整的DLT645电能表通信协议Python实现库，支持TCP和RTU两种通信方式，可用于电能表数据读写和通信测试。

## 功能特性

- 🌐 **多种通信方式**：支持TCP和RTU（串口）通信
- 📊 **完整协议支持**：实现DLT645协议的主要功能
- 🔌 **客户端/服务端**：同时提供客户端和服务端功能
- 📈 **多种数据类型**：支持电能量、最大需量、变量数据读写
- 🛡️ **设备认证**：支持设备地址验证和密码保护
- 📝 **完善日志**：内置日志系统，便于调试
- 🎯 **易于使用**：简洁的API设计，快速上手

## 支持的数据类型

- **电能量数据**（00类）：正向有功电能、反向有功电能等
- **最大需量数据**（01类）：最大需量及发生时间
- **变量数据**（02类）：实时电压、电流、功率等
- **参变量数据**（04类）：设备参数、配置信息等

## 安装

```bash
pip install dlt645
```

## 快速开始

### 创建TCP服务器

```python
from dlt645 import MeterServerService

# 创建TCP服务器
server_svc = MeterServerService.new_tcp_server("127.0.0.1", 8021, 3000)

# 设置设备地址
server_svc.set_address(b'\x01\x02\x03\x04\x05\x06')

# 写电能
server_svc.set_00(0x00000000, 50.5)
    
# 写最大需量
server_svc.set_01(0x01010000, Demand(78.0, datetime.strptime("2023-01-01 12:00:00", "%Y-%m-%d %H:%M:%S")))
        
# 写参变量
server_svc.set_04(0x04000101, "25110201")   # 2025年11月2日星期一
server_svc.set_04(0x04000204, "10") 		# 设置费率数为10

# 启动服务器
server_svc.server.start()
```

![](../resource/python/1.png)

### 创建RTU服务器

```python
from dlt645 import MeterServerService

# 创建RTU服务器
server_svc = MeterServerService.new_rtu_server(port="COM11",data_bits=8,stop_bits=1,baud_rate=9600,parity="N",timeout=1.0)

# 设置设备地址
server_svc.set_address(b'\x01\x02\x03\x04\x05\x06')

# 写电能
server_svc.set_00(0x00000000, 50.5)
    
# 写最大需量
server_svc.set_01(0x01010000, Demand(78.0, datetime.strptime("2023-01-01 12:00:00", "%Y-%m-%d %H:%M:%S")))

# 启动服务器
server_svc.server.start()
```

![](../resource/python/2.png)

### 创建TCP客户端

```python
from dlt645 import MeterClientService

client_svc = MeterClientService.new_tcp_client("127.0.0.1", 10521, timeout=1)

# 读取通讯地址
address_data = client_svc.read_address()

# 设置通讯地址
client_svc.set_address(address_data.value)

# 读取电能数据
data_item = client_svc.read_00(0x00000000)

# 读取最大需量及发生时间
data_item2 = client_svc.read_01(0x01010000)

# 读取变量数据
data_item3 = client_svc.read_02(0x02010100)

# 读取参变量
data_item4 = client_svc.read_04(0x04000101)
print(f"日期及星期: {data_item4}")

data_item5 = client_svc.read_04(0x04000204)
print(f"费率数: {data_item5}")
```

![](../resource/python/3.png)

### 创建RTU客户端

```python
from dlt645 import MeterClientService

# 创建RTU客户端
client = MeterClientService.new_rtu_client(
    port="COM10",
    baudrate=9600,
    databits=8,
    stopbits=1,
    parity="N",
    timeout=0.5
)

# 读取通讯地址
address_data = client_svc.read_address()

# 设置通讯地址
client_svc.set_address(address_data.value)

# 读取电能数据
data_item = client_svc.read_00(0x00000000)

# 读取最大需量及发生时间
data_item2 = client_svc.read_01(0x01010000)

# 读取变量数据
data_item3 = client_svc.read_02(0x02010100)

# 读取参变量
data_item4 = client_svc.read_04(0x04000101)
print(f"日期及星期: {data_item4}")

data_item5 = client_svc.read_04(0x04000204)
print(f"费率数: {data_item5}")
```
![](../resource/python/4.png)

### 使用第三方工具测试

测试效果

![](../resource/python/5.gif)

## API参考

### 服务器端API

#### MeterServerService

主要的服务器服务类，提供以下方法：
- `new_tcp_server(ip: str, port: int, timeout: float)` - 创建TCP服务器（类方法）
- `new_rtu_server(port: str, data_bits: int, stop_bits: int, baud_rate: int, parity: str, timeout: float)` - 创建RTU服务器（类方法）
- `set_00(di: int, value: float)` - 设置电能量数据
- `set_01(di: int, demand: Demand)` - 设置最大需量数据
- `set_02(di: int, value: float)` - 设置变量数据
- `set_04(di: int, value: float)` - 设置参变量数据
- `set_address(address: bytearray)` - 设置设备地址
- `set_password(password: bytearray)` - 设置密码

### 客户端API

#### MeterClientService

主要的客户端服务类，提供以下方法：

- `new_tcp_client(ip: str, port: int, timeout: float)` - 创建TCP客户端（类方法）
- `new_rtu_client(port: str, baudrate: int, databits: int, stopbits: int, parity: str, timeout: float)` - 创建RTU客户端（类方法）
- `read_00(di: int)` - 读取电能量数据
- `read_01(di: int)` - 读取最大需量数据
- `read_02(di: int)` - 读取变量数据
- `read_04(di: int)` - 读取参变量数据
- `read_address()` - 读取设备地址
- `write_address(new_address: bytes)` - 写入设备地址
- `set_address(address: bytes)` - 设置本地设备地址
- `set_password(password: bytes)` - 设置密码

## 数据标识说明

DLT645协议使用4字节的数据标识来标识不同的数据项：

### 电能量数据（00类）
- `0x00000000` - 总有功电能
- `0x00010000` - 正向有功电能
- `0x00020000` - 反向有功电能

### 最大需量数据（01类）  
- `0x01000000` - 总最大需量
- `0x01010000` - 正向最大需量

### 变量数据（02类）
- `0x02010100` - A相电压
- `0x02010200` - B相电压
- `0x02010300` - C相电压
- `0x02020100` - A相电流
- `0x02020200` - B相电流
- `0x02020300` - C相电流

### 参变量数据（04类）
- `0x04000101` - 日期及星期(0代表星期天)
- `0x04000102` - 时间

## 配置文件

库包含了丰富的配置文件，定义了各种数据类型：

- `config/energy_types.json` - 电能量数据类型配置
- `config/demand_types.json` - 最大需量数据类型配置  
- `config/variable_types.json` - 变量数据类型配置
- `config/parameter_types.json` - 参变量数据类型配置

## 开发指南

### 环境要求

- Python >= 3.7
- loguru >= 0.5.0
- pyserial >= 3.4

### 运行测试

```bash
# 安装开发依赖
pip install -e .[dev]

# 运行测试
pytest
```

### 调试日志

库使用loguru进行日志记录，可以通过以下方式启用详细日志：

```python
from loguru import logger
logger.add("dlt645.log", level="DEBUG")
```

## 常见问题

### Q: 如何处理通信超时？
A: 可以在创建客户端时设置timeout参数，或者使用try-catch捕获超时异常。

### Q: 支持哪些串口参数？
A: 支持标准的串口参数：波特率（1200-115200）、数据位（7-8）、停止位（1-2）、校验位（N/E/O）。

### Q: 如何添加自定义数据类型？
A: 可以修改config目录下的JSON配置文件，添加新的数据标识和格式定义。

## 许可证

Apache License 2.0

## 贡献

欢迎提交Issue和Pull Request！

## 联系方式

- 作者：Chen Dongyu
- 邮箱：1755696012@qq.com
- 项目地址：https://gitee.com/chen-dongyu123/dlt645
