Sign inSign up

oesinc/openfmb.adapters

By oesinc

•Updated about 2 months ago

An open-source adapter that translates various protocols to the OpenFMB standard message format.

Image
1

10K+

oesinc/openfmb.adapters repository overview

⁠Quick Reference

⁠OpenFMB Adapter: Robust adapter that allows multiple electrical grid devices to communicate via the OpenFMB message standard⁠.

⁠Example usage

# Run an OpenFMB Adapter
docker run -d --name openfmb_adapter -v $PWD/cfg:/cfg oesinc/openfmb.adapters -c /cfg/adapter.yaml

# Run a Nats server
docker run -d --name nats_main -p 4222:4222 -p 8222:8222 nats

⁠Example Configuration File

adapter.yml⁠

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
...

⁠Commandline Options

Server Options:
  -l, --list              Lists available plug-ins
  -c, --config <file>     Run with the specified config file
  -g, --generate          Generate the specified config file
  -s, --schema            Generate a JSON schema
  -p, --plugin <plugin>   The plugin for which to generate a configuration
  -f, --profile <profile> Profile to generate
  --pretty-print          Pretty-print the generated JSON

Command Options:
  -h, --help              Show this help message
  -v, --version           Display version information


⁠License

View license information⁠ for the software container in the images.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

Tag summary

Content type

Image

Digest

sha256:8cd6828da…

Size

168.2 MB

Last updated

about 2 months ago

docker pull oesinc/openfmb.adapters:v2.2.0-7ad4411c