Skip to content
OpenFMB Device Simulator is a simple simulator that publishes information using NATS messaging about simulated devices and accepts control requests for those devices.
Python JavaScript HTML Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deps
docs OFMBDS-21 Futher improvements to the documentation Sep 4, 2019
env/nats Simple OpenFMB message simulator to aid in developing other OpenFMB-b… Jul 19, 2019
openfmbsim OFMBDS-21 Add support for recently added OpenFMB models Aug 29, 2019
tests OFMBDS-21 Add support for recently added OpenFMB models Aug 29, 2019
.codacy.yml
.dockerignore
.editorconfig
.gitattributes
.gitignore Simple OpenFMB message simulator to aid in developing other OpenFMB-b… Jul 19, 2019
.gitmodules Simple OpenFMB message simulator to aid in developing other OpenFMB-b… Jul 19, 2019
.travis.yml
CONTRIBUTING.md
Dockerfile
LICENSE
NOTICE Simple OpenFMB message simulator to aid in developing other OpenFMB-b… Jul 19, 2019
README.md
docker-compose.yml Simple OpenFMB message simulator to aid in developing other OpenFMB-b… Jul 19, 2019
requirements-dev.txt
requirements.txt
setup.py
tox.ini

README.md

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.

You can’t perform that action at this time.