oesinc/openfmb.adapters

OpenFMB Adapter 镜像文档

概述

OpenFMB Adapter 是一个强大的适配器，允许多个电网设备通过OpenFMB消息标准进行通信。它作为协议转换桥梁，支持将多种工业协议转换为OpenFMB标准消息格式，促进智能电网设备间的标准化数据交换。

快速参考

• 维护者：https://github.com/openenergysolutions/openfmb.adapters
• 获取帮助：https://stackoverflow.com/questions/tagged/openfmb
• 提交问题：https://github.com/openenergysolutions/openfmb.adapters/issues
• 支持架构：amd64、arm32v7、arm64v8
• 官方文档：[***]

核心功能与特性

• 协议转换：支持将多种工业协议（如DNP3、Modbus、GOOSE等）转换为OpenFMB标准消息格式
• 多插件架构：提供丰富的插件系统，包括数据捕获、重放、MQTT/NATS通信、时序数据库存储等功能模块
• 灵活配置：通过YAML配置文件自定义适配器行为，支持日志管理、安全设置等
• 跨平台支持：兼容amd64、arm32v7、arm64v8多种硬件架构
• 开源免费：基于开源许可发布，支持二次开发与定制化需求

使用场景

• 智能电网设备数据采集与标准化转换
• 电网监控系统中不同协议设备的互联互通
• 分布式能源资源（DER）与电网控制系统的集成
• 电力系统数据记录、分析与回放
• 基于OpenFMB标准的电网自动化解决方案

使用方法

示例用法

运行OpenFMB Adapter

sh
# 运行OpenFMB适配器（挂载本地配置目录）
docker run -d --name openfmb_adapter -v $PWD/cfg:/cfg oesinc/openfmb.adapters -c /cfg/adapter.yaml

运行NATS服务器（消息传输所需）

sh
# 运行NATS服务器（默认端口4222用于消息通信，8222用于监控）
docker run -d --name nats_main -p 4222:4222 -p 8222:8222 nats

命令行选项

sh
服务器选项:
  -l, --list              列出可用插件
  -c, --config <file>     使用指定的配置文件运行
  -g, --generate          生成指定的配置文件
  -s, --schema            生成JSON模式
  -p, --plugin <plugin>   为指定插件生成配置
  -f, --profile <profile> 生成指定的配置文件
  --pretty-print          格式化输出生成的JSON

命令选项:
  -h, --help              显示此帮助消息
  -v, --version           显示版本信息

配置说明

配置文件结构

适配器通过YAML配置文件进行管理，主要包含以下核心部分：

• file：适配器基本信息（ID、版本等）
• logging：日志配置（控制台输出、文件轮转等）
• plugins：插件配置（数据捕获、重放、协议转换、消息传输等）

示例配置文件

https://github.com/openenergysolutions/openfmb.demo/blob/develop/replay/adapter.yaml

yaml
file:
  id: openfmb-adapter-main
  edition: 2.0
  version: 1.0.0.0
  plugin: ''
logging:
  logger-name: application
  console:
    enabled: true
  rotating-file:
    enabled: true
    path: adapter.log
    max-size: 1048576
    max-files: 3
plugins:
  capture:
    enabled: false
    file: /cfg/capture.txt
  replay:
    enabled: true
    file: /cfg/replay.txt
  dnp3-master:
    enabled: false
    thread-pool-size: 1
    masters: []
  dnp3-outstation:
    enabled: false
    thread-pool-size: 1
    outstations: []
  modbus-master:
    enabled: false
    thread-pool-size: 1
    sessions: []
  modbus-outstation:
    enabled: false
    thread-pool-size: 1
    sessions: []
  goose-pub:
    enabled: false
    thread-pool-size: 1
    goCb: []
  goose-sub:
    enabled: false
    thread-pool-size: 1
    goCb: []
  mqtt:
    enabled: false
    max-queued-messages: 100
    server-address: 127.0.0.1
    client-id: client1
    connect-retry-delay-ms: 5000
    security:
      security-type: tls_mutual_auth
      ca-trusted-cert-file: cert.pem
      client-private-key-file: client_key.pem
      client-cert-chain-file: client_cert.pem
      username: ''
      password: ''
    publish: []
    subscribe: []
  nats:
    enabled: true
    max-queued-messages: 100
    connect-url: nats://host.docker.internal:4222
    connect-retry-seconds: 5
    security:
      security-type: none
      ca-trusted-cert-file: cert.pem
      client-private-key-file: client_key.pem
      client-cert-chain-file: client_cert.pem
    publish:
    - profile: ESSReadingProfile
      subject: '*'
    - profile: ESSStatusProfile
      subject: '*'
    - profile: SolarReadingProfile
      subject: '*'
    - profile: SolarStatusProfile
      subject: '*'
    - profile: SwitchReadingProfile
      subject: '*'
    - profile: SwitchStatusProfile
      subject: '*'
    - profile: LoadReadingProfile
      subject: '*'
    - profile: LoadStatusProfile
      subject: '*'
    - profile: MeterReadingProfile
      subject: '*'
    subscribe: []
  timescaledb:
    enabled: false
    database-url: postgresql://user:password@localhost:5432/dbname
    store-measurement: true
    table-name: data
    store-raw-message: false
    raw-table-name: raw_data
    raw-data-format: 0
    max-queued-messages: 100
    connect-retry-seconds: 5

关键配置项说明

• logging：配置日志输出方式（控制台/文件）、日志文件大小和数量限制
• plugins：各功能插件的启用状态及参数配置
  • nats/mqtt：消息传输插件，配置连接地址、安全认证方式及发布/订阅主题
  • replay/capture：数据重放与捕获插件，用于测试和数据记录
  • dnp3/modbus：工业协议转换插件，实现与传统电网设备的通信
  • timescaledb：时序数据库插件，用于长期存储电网运行数据

许可证

查看https://github.com/openenergysolutions/openfmb.adapters/blob/develop/LICENSE%E3%80%82

与所有Docker镜像一样，本镜像可能包含其他软件（如Bash等基础系统组件及直接或间接依赖的软件），这些软件可能具有其他许可证。使用本镜像时，用户有责任确保对本镜像的任何使用都符合其中包含的所有软件的相关许可证要求。