Skip to content

Home Assistant intergration to get statictics from China Southern Power Grid (CSG) 南方电网HA集成

License

Notifications You must be signed in to change notification settings

CubicPill/china_southern_power_grid_stat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

China Southern Power Grid Statistics

南方电网电费数据HA集成

hacs_badge GitHub release (latest by date) License: GPL v3

支持功能

  • ✅支持南方电网覆盖范围内的电费数据查询(广东、广西、云南、贵州、海南)
  • ✅支持使用手机号、短信验证码和密码(可选)登录,支持南网在线APP、微信、支付宝扫码登录
  • ✅支持多个南网账户(每个账户一个集成),支持单个账户下的多个缴费号
  • ✅数据自动抓取和更新(默认间隔4小时,可配置)
  • ✅全程GUI配置,无需编辑yaml进行配置(暂不支持yaml配置)

可接入如下数据:

  • 当前余额和欠费
  • 当前阶梯电量数据(档位、阶梯剩余电量、阶梯电价)
  • 昨日用电量
  • 最新一日用电量、电费(取有数据的最近一日)
  • 本年度总用电量、总电费(非实时,更新到上个月)
  • 本年度每月用电量、电费(非实时,更新到上个月)
  • 上年度总用电量、总电费
  • 上年度每月用电量、电费
  • 当月累计用电量、电费(非实时,有2天左右的延迟)
  • 当月每日用电量、电费(非实时,有2天左右的延迟)
  • 上月累计用电量、电费
  • 上月每日用电量、电费

不支持阶梯电费设置(仅能获取当前所在阶梯)、峰谷电价设置和电费计算(本插件只进行数据抓取和转换,不进行任何计算), 暂时也没有支持计划(南网暂时没有统一的API),如有需求,建议单独创建对应的电价实体。

❌因为南网登录API调整,不再支持登录态失效之后自动重新登录,需要手动重新登录。

使用方法

使用HACS手动下载安装

注意:本集成需求Home Assistant最低版本为2022.11

配置界面

支持的登录方式

配置界面

添加缴费号

传感器列表

  • 余额
  • 欠费
  • 当前阶梯档位
  • 当前阶梯剩余电量
  • 当前阶梯电价
  • 上月电费
  • 上月用电量
  • 当月用电量
  • 当月电费
  • 本年度电费
  • 本年度用电量
  • 上年度电费
  • 上年度用电量
  • 最近日用电量
  • 最近日电费
  • 昨日用电量

传感器额外参数(每月用量、每日用量)

参数设置

数据更新策略

由于上月数据和去年数据在生成之后一般不会发生变化,因此对于上月累计用电量、上月每日用电量、上年度累计用电量、上年度每月用电量,数据更新间隔将会与一般更新间隔有所不同。 具体更新策略如下:

对于上月数据,在每月前3天(1~3日)将会跟随一般更新间隔更新(默认为4小时),其余时间将会停止更新,但数据依然可用。

对于去年数据,在每年一月的前7天(1月1日~1月7日)将会每天更新(在每天第一次触发更新时更新),其余时间将会停止更新,但数据依然可用。

如果需要强制刷新数据,重载集成即可。

一些技术细节

登录接口加密原理

登录接口的请求数据和返回数据都经过加密,其中请求数据经过两层加密:整个请求数据的AES加密和密码字段的RSA 公钥加密(密钥、公钥具体值见代码)。

加密前的请求数据结构如下:

{
  "areaCode": "xxx",
  "acctId": "xxx",
  "logonChan": "xxx",
  "credType": "xxx",
  "credentials": "xxx"  // <- encrypted with RSA
}

返回数据同样经过AES加密,密钥与请求数据相同。但返回值其中暂时不包含有用信息,验证状态码正常后可以直接忽略内容。

Web端接口和App端接口

对于南网API相关信息的提取主要通过Web端的抓包和JS代码获取。 之后因为登录态有效期问题,对App端抓包进行比对后切换到App端API。 经过验证,Web端(网上营业厅)和App端(南网在线)的API接口基本相同,差别主要在于:

Web App
API路径 ucs/ma/wt/ ucs/ma/zt/
支持登录方式 手机号+验证码(+密码),南网在线/微信/支付宝扫码 手机号+验证码(+密码),微信/支付宝跳转登录
token有效期 几小时(有待进一步确认) 较长(有待进一步确认)
Cookies token包含在cookies中 无cookies
敏感信息(姓名、地址等) 部分信息用“*”隐去 有明文全文

另外在HTTP请求头上有细微的差别(如:UA),但实际上对于请求的返回结果没有影响。

API 实现库

本项目代码中的csg_client/__init__.py 是对南网在线 App API 的实现,可以独立于此项目单独使用。 详细使用方法见csg_client_demo.py

Thank you

感谢瀚思彼岸论坛以下帖子作者的辛苦付出,排名不分先后

自定义集成教程参考:Building a Home Assistant Custom Component Part 1: Project Structure and Basics

About

Home Assistant intergration to get statictics from China Southern Power Grid (CSG) 南方电网HA集成

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages