bacnet_server.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. from __future__ import annotations
  2. from typing import Any, NotRequired, TypedDict
  3. from pydantic import BaseModel
  4. from .collector_api import (
  5. create_bacnet_devices as api_create_bacnet_devices,
  6. create_bacnet_points as api_create_bacnet_points,
  7. edit_bacnet_device as api_edit_bacnet_device,
  8. edit_bacnet_point as api_edit_bacnet_point,
  9. )
  10. from .gateway_api import (
  11. bacnet_bbmd_whois as api_bacnet_bbmd_whois,
  12. bacnet_point_collect_test as api_bacnet_point_collect_test,
  13. bacnet_point_search as api_bacnet_point_search,
  14. )
  15. from .mcp_app import mcp
  16. class BacnetDeviceCreateItem(BaseModel):
  17. name: str
  18. ip: str
  19. bacnet_device_id: int
  20. port: int = 47808
  21. bacnet_net: int = 0
  22. asp_ip: str = ""
  23. timeout: int = 3
  24. is_persistent: bool = False
  25. group_id: int = 0
  26. alarm_interval: int = 90
  27. collect_interval: int = 5
  28. class BacnetPointSpec(TypedDict):
  29. object_type: str
  30. object_id: int
  31. name: NotRequired[str]
  32. description: NotRequired[str]
  33. class BacnetPointCreateItem(TypedDict):
  34. device_id: int
  35. object_type: str
  36. object_id: int
  37. name: NotRequired[str]
  38. object_name: NotRequired[str]
  39. point_id: NotRequired[str]
  40. priority: NotRequired[int | None]
  41. units: NotRequired[str]
  42. value_type: NotRequired[int]
  43. group_id: NotRequired[int]
  44. scale_ratio: NotRequired[float]
  45. value_offset: NotRequired[float]
  46. describe: NotRequired[str]
  47. @mcp.tool(
  48. name="bacnet.point_collect_test",
  49. description=(
  50. "通过采集网关读取 BACnet/IP 点位 present-value。调用 "
  51. "{base_url}/api/dc-gateway/bacnet/read_points。ip 为 BACnet/IP 设备地址,"
  52. "bacnet_device_id 为 BACnet 设备对象实例号,也叫设备号,范围 0..4194303;port 默认 47808。"
  53. "points 每项必须包含 object_type 和 object_id;object_type 支持 AnalogInput 这类格式。"
  54. "如果传入 analogInput、analog-input 等常见写法,需要先转换为 AnalogInput 这类格式;"
  55. "网关响应也会规范为 AnalogInput 形式。"
  56. "响应 data.points[].present_value 为当前值;响应透传上游 JSON,code=0 表示业务成功。"
  57. ),
  58. )
  59. def bacnet_point_collect_test(
  60. project_key: str,
  61. ip: str,
  62. bacnet_device_id: int,
  63. points: list[BacnetPointSpec],
  64. port: int = 47808,
  65. ) -> dict[str, Any]:
  66. return api_bacnet_point_collect_test(
  67. project_key,
  68. ip=ip,
  69. bacnet_device_id=bacnet_device_id,
  70. port=port,
  71. points=points,
  72. )
  73. @mcp.tool(
  74. name="bacnet.point_search",
  75. description=(
  76. "通过采集网关搜索 BACnet/IP 设备点位。调用 "
  77. "{base_url}/api/dc-gateway/bacnet/search_points。ip 为 BACnet/IP 设备地址,"
  78. "bacnet_device_id 为 BACnet 设备对象实例号,也叫设备号,范围 0..4194303;port 默认 47808。"
  79. "网关读取设备对象的 object-list,并过滤常见点位对象类型:AnalogInput、AnalogOutput、"
  80. "AnalogValue、BinaryInput、BinaryOutput、BinaryValue、MultiStateInput、MultiStateOutput、"
  81. "MultiStateValue。响应 data.points[] 包含 name、description、object_type、object_id、"
  82. "present_value;单点 description 或 present_value 读取失败时字段为 null。"
  83. "响应透传上游 JSON,code=0 表示业务成功。"
  84. ),
  85. )
  86. def bacnet_point_search(
  87. project_key: str,
  88. ip: str,
  89. bacnet_device_id: int,
  90. port: int = 47808,
  91. ) -> dict[str, Any]:
  92. return api_bacnet_point_search(
  93. project_key,
  94. ip=ip,
  95. bacnet_device_id=bacnet_device_id,
  96. port=port,
  97. )
  98. @mcp.tool(
  99. name="bacnet.bbmd_whois",
  100. description=(
  101. "通过采集网关执行 BACnet/IP BBMD Who-Is 设备发现。调用 "
  102. "{base_url}/api/dc-gateway/bacnet/bbmd/whois,MCP 不发送请求体;"
  103. "BBMD 地址、端口、TTL、Who-Is 等待超时、设备号范围、本机绑定地址等参数由采集网关环境变量配置,"
  104. "包括 BACNET_BBMD_IP、BACNET_BBMD_PORT、BACNET_BBMD_TTL、"
  105. "BACNET_BBMD_WHOIS_TIMEOUT、BACNET_BBMD_LOW_LIMIT、BACNET_BBMD_HIGH_LIMIT、"
  106. "BACNET_BBMD_LOCAL_DEVICE_ID、BACNET_LOCAL_IP、BACNET_LOCAL_PORT。"
  107. "网关会注册 BBMD Foreign Device,分发 Who-Is,收集 I-Am 响应并在结束前注销;"
  108. "响应 data.bbmd 为本次 BBMD 请求配置,data.devices[] 为发现的 BACnet 设备,"
  109. "常见字段包括 bacnet_device_id、ip、port、max_apdu、segmentation、vendor_id;"
  110. "响应透传上游 JSON,code=0 表示业务成功。"
  111. ),
  112. )
  113. def bacnet_bbmd_whois(project_key: str) -> dict[str, Any]:
  114. return api_bacnet_bbmd_whois(project_key)
  115. @mcp.tool(
  116. name="collector.bacnet_device_create",
  117. description=(
  118. "汇采-批量创建 BACnet 设备。依次调用 {data_collector_base_url}/api/collector/device,"
  119. "请求体固定 type=bacnet 且 device_type=1(ASP 设备)。全部设备创建调用完成后会内部调用"
  120. "设备列表并匹配每个设备 id;如果匹配到多个设备,选择 id 最大的。devices 每项必须传 "
  121. "name、ip、bacnet_device_id(设备号);port 默认 47808,bacnet_net 默认 0,asp_ip 默认空字符串。"
  122. "默认参数: timeout=3, is_persistent=false, group_id=0, alarm_interval=90, collect_interval=5。"
  123. "响应返回批量结果,state=0 表示全部创建并匹配成功。"
  124. ),
  125. )
  126. def collector_bacnet_device_create(
  127. project_key: str,
  128. devices: list[BacnetDeviceCreateItem],
  129. ) -> dict[str, Any]:
  130. return api_create_bacnet_devices(project_key, [_dump_model_or_dict(item) for item in devices])
  131. @mcp.tool(
  132. name="collector.bacnet_device_edit",
  133. description=(
  134. "汇采-编辑 BACnet 设备。调用 {data_collector_base_url}/api/collector/bacnet/device/edit。"
  135. "必须传 ori_id 原设备 id、name、ip、bacnet_device_id(设备号);MCP 会把 bacnet_device_id 映射为"
  136. "汇采旧接口的 device_id 字符串,并固定 type=1(ASP 设备)。编辑前设备不能处于已连接状态;"
  137. "若已连接,请先调用 collector.device_disconnect,并传 device_type=bacnet。该接口是全量更新语义。"
  138. "默认参数: port=47808, net=0, asp_ip='', timeout=3, is_persistent=false, "
  139. "device_group_id=0, alarm_interval=90, collect_interval=5。响应透传上游 JSON,state=0 表示业务成功。"
  140. ),
  141. )
  142. def collector_bacnet_device_edit(
  143. project_key: str,
  144. ori_id: int,
  145. name: str,
  146. ip: str,
  147. bacnet_device_id: int,
  148. port: int = 47808,
  149. bacnet_net: int = 0,
  150. asp_ip: str = "",
  151. is_persistent: bool = False,
  152. device_group_id: int = 0,
  153. timeout: int = 3,
  154. alarm_interval: int = 90,
  155. collect_interval: int = 5,
  156. ) -> dict[str, Any]:
  157. return api_edit_bacnet_device(
  158. project_key,
  159. {
  160. "ori_id": ori_id,
  161. "name": name,
  162. "ip": ip,
  163. "bacnet_device_id": bacnet_device_id,
  164. "port": port,
  165. "bacnet_net": bacnet_net,
  166. "asp_ip": asp_ip,
  167. "is_persistent": is_persistent,
  168. "device_group_id": device_group_id,
  169. "timeout": timeout,
  170. "alarm_interval": alarm_interval,
  171. "collect_interval": collect_interval,
  172. },
  173. )
  174. @mcp.tool(
  175. name="collector.bacnet_point_create",
  176. description=(
  177. "汇采-批量创建 BACnet 采集点位。依次调用 "
  178. "{data_collector_base_url}/api/collector/bacnet/point/add_collect_point。"
  179. "points 每项必须传 device_id、object_type、object_id,并传 name 或 object_name;"
  180. "object_type 支持 AnalogInput 这类格式;如果传入 analogInput、analog-input 等常见写法,"
  181. "需要先转换为 AnalogInput 这类格式;"
  182. "MCP 会将单个点位包装成汇采接口要求的 {device_id, points:[...]}。"
  183. "每个点位会补齐默认值: point_id='', priority=null, units='', value_type=0, "
  184. "group_id=0, scale_ratio=1, value_offset=0, describe=''。"
  185. "常见 value_type: 1=Boolean, 2=Unsigned, 3=Signed, 4=Real, 5=Double, 6=Enumerated。"
  186. "响应返回批量结果,state=0 表示全部创建成功。"
  187. ),
  188. )
  189. def collector_bacnet_point_create(
  190. project_key: str,
  191. points: list[BacnetPointCreateItem],
  192. ) -> dict[str, Any]:
  193. return api_create_bacnet_points(project_key, points)
  194. @mcp.tool(
  195. name="collector.bacnet_point_edit",
  196. description=(
  197. "汇采-编辑 BACnet 采集点位。调用 {data_collector_base_url}/api/collector/bacnet/point/edit。"
  198. "必须传 ori_id 原点位 id、object_type、object_id,并传 name 或 object_name;ori_id 对应 "
  199. "collector.device_points 返回的 data.point[].id,MCP 会映射为汇采接口字段 id。"
  200. "object_type 支持 AnalogInput 这类格式;如果传入 analogInput、analog-input 等常见写法,"
  201. "MCP 会先转换为 AnalogInput 这类格式再调用汇采接口。"
  202. "该接口是全量更新语义,未传字段可能被默认值覆盖。默认参数: point_id='', priority=null, "
  203. "units='', value_type=0, group_id=0, scale_ratio=1, value_offset=0, describe='', "
  204. "invalid_values='', valid_range_start=null, valid_range_end=null。"
  205. "响应透传上游 JSON,state=0 表示业务成功。"
  206. ),
  207. )
  208. def collector_bacnet_point_edit(
  209. project_key: str,
  210. ori_id: int,
  211. object_type: str,
  212. object_id: int,
  213. name: str = "",
  214. object_name: str = "",
  215. point_id: str = "",
  216. priority: int | None = None,
  217. units: str = "",
  218. value_type: int = 0,
  219. group_id: int = 0,
  220. scale_ratio: float = 1,
  221. value_offset: float = 0,
  222. describe: str = "",
  223. invalid_values: str = "",
  224. valid_range_start: float | None = None,
  225. valid_range_end: float | None = None,
  226. ) -> dict[str, Any]:
  227. return api_edit_bacnet_point(
  228. project_key,
  229. {
  230. "ori_id": ori_id,
  231. "name": name,
  232. "object_type": object_type,
  233. "object_id": object_id,
  234. "object_name": object_name,
  235. "point_id": point_id,
  236. "priority": priority,
  237. "units": units,
  238. "value_type": value_type,
  239. "group_id": group_id,
  240. "scale_ratio": scale_ratio,
  241. "value_offset": value_offset,
  242. "describe": describe,
  243. "invalid_values": invalid_values,
  244. "valid_range_start": valid_range_start,
  245. "valid_range_end": valid_range_end,
  246. },
  247. )
  248. def _dump_model_or_dict(item: Any) -> dict[str, Any]:
  249. if isinstance(item, BaseModel):
  250. return item.model_dump(exclude_none=True)
  251. return dict(item)