OpenFMB Adapter Extensions

This repo consists of a Dockerfile that is used to build an "Extension" for OpenFMB Adapter framework.

Objectives:

The objective is to enhance an existing OpenFMB Adapter Framework by extending its capabilities to support multiple protocols, regardless of the programming language used. This expansion will allow seamless integration with various systems and enable communication using different protocols.

One key aspect of this extension is the ability to leverage the existing OpenFMB Adapter Framework's functionalities, such as MQTT, NATS, DNP3, MODBUS, and more. These features provide robust communication channels and protocol-specific implementations that can be utilized by the newly added plugins or extensions.

By incorporating this extension mechanism, developers can write custom plugins or extensions in their preferred programming languages. This flexibility enables them to leverage their existing knowledge and expertise while expanding the framework's protocol support. Whether it's implementing a custom UDP datagram speaker, integrating with OCPP1.6, or storing telemetry data in databases, the extended framework provides the necessary tools and infrastructure.

The extended framework also promotes interoperability and compatibility across different systems and protocols. It allows seamless communication between components written in different programming languages, facilitating integration with a wide range of devices and platforms.

Zenoh Bus

Zenoh bus is used as an internal/inside-container communication channel between the extension app and the OpenFMB Adapter written by OES.

How to Write UDP OpenFMB Adapter, an Extension for OpenFMB Adapter Framework

The goal here is to utilize the extension framework we have developed to establish communication with a fictitious smart plug device that speaks UDP. The extension framework allows for integration of UDP protocol adapter written in any programming languages, enabling efficient and flexible communication with the devices.

For sample code, refer to this repo. This sample code (UDP OpenFMB Adapter) is written in RUST programming language and takes advantage of an inside-container communication bus. Upon receiving data from the fictitious smart plug device, the UDP OpenFMB Adapter shall publish SwitchStatusProfile with the plug's On/Off indication, and SwitchReadingProfile for voltage, current, and power measurement. The UDP OpenFMB Adapter also subscribes to SwitchDiscreteControlProfile and turn On/Off the smart plug accordingly.

Build the Docker Image

Run the build script to build the Docker image:

./build.sh

Launcher Configuration

Launcher is an app that acts as the entry point of the Docker image. The following configuration is used by the Launcher:

---
launcher:
  log_level: Debug
adapters: 
  - name: oes-plug
    type: oes-plug
    config: /adapters/udp-adapter.yaml
  - name: bridge-master
    type: pub-sub-bridge    
    config: /adapters/bridge-adapter.yaml 
...

The following adapter types (adapters.type) are supported by the launcher:

• dnp3-master (DNP3)
• dnp3-outstation (DNP3)
• modbus-master (MODBUS)
• modbus-outstation (MODBUS)
• pub-sub-bridge (bridging between pub/sub protocols such as NATS, MQTT, ZENOH, DDS**)
• oes-plug (the OES fictitious smart plug speaking UDP)*
• ocpp-adapter (OCPP 1.6)**
• iccp-client (IEC60870-6)**
• iccp-server (IEC60870-6)**
• IEC61850-client (IEC61850)**
• IEC61850-server (IEC61850)**
• openadr (OpenADR)**
• ieee2030.5 (IEEE 2030.5)**

(*) This sample plug-in/extension (**) Required appropriate licensing

Examples

These examples are intented to be run on Linux OS.

Before running the examples, run replace-ip-address.sh script. Replace <MY_COMPUTER_IP_ADDRESS> with your computer's IP address.

HOST_IP_ADDRESS=<MY_COMPUTER_IP_ADDRESS> ./replace-ip-address.sh

To demonstrate, consider these two scenarios:

Scenario 1

To be able to monitor the OES fictitious smart plug data, and turn it on/off using OpenFMB via NATS pub/sub protocol:

• Note that the UDP OpenFMB Adapter doesn't support NATS. We are utilizing the protocol-bridge functionality of the OpenFMB Adapter Framework extension

To run the adapters, run:

cd examples/scenario-1
docker-compose up -d

The docker-compose command shall start:

• an UDP Plug simulator (software simulator of the OES fictitious smart plug)
• a NATS broker
• an UDP extension adapter

Now, to monitor the smart plug as well as turn it ON/OFF, we can stand up an OES' Human Machine Interface (HMI) tool by running:

cd ../hmi
docker-compose up -d

The HMI can then be opened at:

http://127.0.0.1:32771

Username: admin
Password: hm1admin

Scenario 2

To be able to monitor the OES fictitious smart plug data and turn it on/off using DNP3 protocol

• We are internally translating UDP datagram into DNP3
• The OpenFMB adapter acts as a DNP3 outstation to serve data to a connected DNP3 master program

To run the adapters, run:

cd examples/scenario-2
docker-compose up -d

The docker-compose command shall start:

• an UDP Plug simulator (software simulator of the OES fictitious smart plug)
• an UDP extension adapter exposes its data as a DNP3 outstation

The DNP3 outstation data points:

• Binary Input 0 for the plug status ON/OFF
• Binary Output 0 to turn the plug ON/OFF
• Analog Inputs: Current = 0; Voltage: 1; Power: 2

To interrogate data, use a DNP3 master software to connect to the outstation:

• IP address: same as <MY_COMPUTER_IP_ADDRESS> above
• Port: 20000
• Master Address: 1
• Outstation Address: 10

Now, to monitor the smart plug as well as turn it ON/OFF, we can stand up an OES' Human Machine Interface (HMI) tool, we can stand up an DNP3 Master OpenFMB Adapter that connects to the outstation and publish data on NATS:

cd ../dnp-master
docker-compose up -d
cd ../hmi
docker-compose up -d

The HMI can then be opened at:

http://127.0.0.1:32771

Username: admin
Password: hm1admin

HMI Screen