Skip to main content

EnergyWeb DER Modbus Simulator

Project description

EnergyWeb

EnergyWeb DER Modbus Simulator

Introduction

This repository hosts the EnergyWeb's Decentralized-Energy-Resouce Modbus Simulator.

Primary features

  • TCP/RTU modbus support.
  • Sunspec interface support.
  • Supply custom DER model.
  • Model-map library available.

Prerequisites

  • pip>=20.3.4
  • pipenv>=2020.8.13

Quick start

Installation steps

# Clone demo repository
git clone https://github.com/energywebfoundation/ew_der_modbus_sim_py.git

# Acces project folder
cd ew_der_modbus_sim_py

# Installs pipenv
pip install pipenv --upgrade

# Creates a python3 virtual environment
pipenv --three

# Installs all demo dependencies
pipenv install '.[all]'

Preset environment variables

# Modbus Mode [TCP or RTU]
SLAVE_MODE=TCP
# A slave unique ID [int]
SLAVE_ID=1

# Slave TCP address and port. Defaults to 'localhost:8502'
SLAVE_TCP_ADDRESS=localhost
SLAVE_TCP_PORT=8502

# Slave RTU port 
SLAVE_RTU_PORT=/dev/ptyp5

# DER model-map name 
MODEL_MAP_NAME=STP8-10-3AV-40

Virtual environment

# Access pipenv's virtual environment in order to run the examples below
pipenv shell

Documentation

DER Simulator

# Running Simulator
python3 ./src/ew_der_modbus_sim_py/der_simulator.py

Available model-map list

  • SMA
    • STP8-10-3AV-40 - PV Inverter
    • SUNNY-ISLAND-4.4-M-13 - Battery Inverter

Active Contributors

  • Ioannis Vlachos (@iovlachos)
  • Mahir Şentürk (@mhrsntrk)
  • Bacem Ben Achour (@Aresguerre)
  • Pablo Buitrago (@ChangoBuitrago)

License

This project is licensed under GNU General Public License Version 3 (GPLv3)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ew_der_modbus_sim_py-0.1.0a7.tar.gz (15.0 kB view hashes)

Uploaded Source

Built Distribution

ew_der_modbus_sim_py-0.1.0a7-py3-none-any.whl (14.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page