Skip to content

smartergridsolutions/openfmb-device-simulator

Repository files navigation

OpenFMB Device Simulator

View build status on Travis CI View code quality on Codacy Join the chat on Gitter

OpenFMB Device Simulator is a simple simulator that publishes information using NATS messaging about simulated devices and accepts control requests for those devices. The intended purpose of this simulator is to enable testing of other systems. A minimal OpenFMB system contains several components depicted below and this project provides a simple implementation of the highlighted items:

         ┌───────────────────────────────┐
         │ System Under Development/Test │
         └───────────────────────────────┘
                 ⇑             ⇓
    ┌─────────────────────────────────────────┐
    │           NATS.io message bus           │
    └─────────────────────────────────────────┘
                 ⇑             ⇓
    ╔═════════════════════════════════════════╗
    ║            ⇑             ⇓              ║
    ║    ┌───────────────────────────────┐    ║
    ║    │    OpenFMB Device Simulator   │    ║
    ║    └───────────────────────────────┘    ║ OpenFMB Device
    ║            ⇑             ⇓              ║ Simulator Project
    ║    ┌───────────────────────────────┐    ║
    ║    │     Simple Web Interface      │    ║
    ║    └───────────────────────────────┘    ║
    ╚═════════════════════════════════════════╝

This OpenFMB Device Simulator enables you to quickly develop other systems that subscribe to or publish messages without needing physical hardware.

How to Run

See the OpenFMB Device Simulator instructions for details on how to run the simulator.

Contributing

There are several ways in which you can participate in the project. In particular, we are seeking help in:

  • Extending the models that this simulator supports.
  • Adding the ability to specify simulated devices at start-time and run-time.
  • Creating a package that can be installed with pip (ask about why this is a bit of work) and creates the appropriate application entry point.
  • Add support for additional messaging protocols.

If you are not sure, create an issue and we'll respond.

See the contributing guide if you want to contribute code.

About

OpenFMB Device Simulator is a simple simulator that publishes information using NATS messaging about simulated devices and accepts control requests for those devices.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published