288 lines
19 KiB
Markdown
288 lines
19 KiB
Markdown
# MyEMS
|
||
|
||
[中文](./README.md) | [EN](./README_EN.md) | [DE](./README_DE.md)
|
||
|
||
[](https://myems.readthedocs.io/en/latest/?badge=latest)
|
||
[](https://codeclimate.com/github/MyEMS/myems/maintainability)
|
||
[](https://codeclimate.com/github/MyEMS/myems/test_coverage)
|
||
[](https://lgtm.com/projects/g/MyEMS/myems/alerts/)
|
||
[](https://lgtm.com/projects/g/MyEMS/myems/context:python)
|
||
[](https://lgtm.com/projects/g/MyEMS/myems/context:javascript)
|
||
[](https://scrutinizer-ci.com/g/MyEMS/myems/?branch=master)
|
||
[](https://scrutinizer-ci.com/g/MyEMS/myems/build-status/master)
|
||
[](https://www.codacy.com/gh/MyEMS/myems/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MyEMS/myems&utm_campaign=Badge_Grade)
|
||
|
||
## MyEMS Introduction
|
||
|
||
MyEMS is an industry-leading open source Energy Management System.
|
||
MyEMS can be used for device management, data collection, processing, analysis, visualization and reporting for your EMS projects.
|
||
MyEMS is being developed and maintained by an experienced development team, and the system's source code is published under MIT license.
|
||
|
||
## MyEMS Architecture
|
||
|
||
|
||
|
||
|
||
|
||
## MyEMS Mirrors
|
||
|
||
[1]. [Github](https://github.com/myems/myems) https://github.com/myems/myems
|
||
|
||
[2]. [Gitee](https://gitee.com/myems/myems) https://gitee.com/myems/myems
|
||
|
||
[3]. [Bitbucket](https://bitbucket.org/myems/myems) https://bitbucket.org/myems/myems
|
||
|
||
[4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems
|
||
|
||
## MyEMS Components (Community Edition)
|
||
|
||
This project is compose of following components:
|
||
|
||
### MyEMS Database (SQL)
|
||
|
||
[Install database](./database/README.md)
|
||
|
||
### MyEMS API (Python)
|
||
|
||
[Install myems-api](./myems-api/README.md)
|
||
|
||
### MyEMS Admin UI (ReactJS)
|
||
|
||
[Install admin UI](./admin/README.md)
|
||
|
||
### MyEMS Modbus TCP Acquisition Service (Python)
|
||
|
||
[Install myems-modbus-tcp](./myems-modbus-tcp/README.md)
|
||
|
||
### MyEMS Cleaning Service (Python)
|
||
|
||
[Install myems-cleaning](./myems-cleaning/README.md)
|
||
|
||
### MyEMS Normalization Service (Python)
|
||
|
||
[Install myems-normalization](./myems-normalization/README.md)
|
||
|
||
### MyEMS Aggregation Service (Python)
|
||
|
||
[Install myems-aggregation](./myems-aggregation/README.md)
|
||
|
||
### MyEMS Web UI (AngularJS)
|
||
|
||
[Install web UI](./web/README.md)
|
||
|
||
### Default Ports
|
||
|
||
MyEMS API: 8000
|
||
|
||
MyEMS Web UI: 80
|
||
|
||
MyEMS Admin UI: 8001
|
||
|
||
### Default Passwords
|
||
<details>
|
||
<summary>Admin UI</summary>
|
||
|
||
```
|
||
administrator
|
||
|
||
!MyEMS1
|
||
```
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Web UI</summary>
|
||
|
||
```
|
||
administrator@myems.io
|
||
|
||
!MyEMS1
|
||
```
|
||
</details>
|
||
|
||
### Docker-compose Installation
|
||
|
||
```
|
||
git clone https://gitee.com/myems/myems.git
|
||
```
|
||
|
||
Modify Database IP in the following files
|
||
Assume the Database IP is 192.168.2.2
|
||
```
|
||
sudo nano myems-api/config.py
|
||
sudo nano myems-aggregation/config.py
|
||
sudo nano myems-cleaning/config.py
|
||
sudo nano myems-modbus-tcp/config.py
|
||
sudo nano myems-normalization/config.py
|
||
|
||
# host: '127.0.0.1' => 'host': '192.168.2.2'
|
||
```
|
||
Modify location '/api' in nginx.conf of web and admin
|
||
Assume the Host IP is 192.168.2.3
|
||
```
|
||
sudo nano admin/nginx.conf
|
||
sudo nano web/nginx.conf
|
||
# proxy_pass http://127.0.0.1:8000/; => proxy_pass http://192.168.2.3:8000/;
|
||
```
|
||
|
||
Build web for production
|
||
```
|
||
cd myems/web
|
||
npm install
|
||
npm run build
|
||
```
|
||
Install with docker-compose
|
||
```
|
||
cd myems
|
||
docker-compose up -d
|
||
```
|
||
|
||
## Compare Editions
|
||
|
||
| Features | Community Edition | Enterprise Edition | Explanation |
|
||
| :--- | :----: | :----: | :----: |
|
||
| Open Source | ✔️ | ❌ | |
|
||
| Pricing | Free | Pay for Projects | |
|
||
| Change Name and Logo | ❌️ | ✔️ | |
|
||
| Modbus TCP | ✔️ | ✔️ | |
|
||
| Data Points Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Meters Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Spaces Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Equipments Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Tenants Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Stores Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Shopfloors Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Combined Equipments Number | Unlimited | Unlimited | The actual number is limited by the upper limit of server resources |
|
||
| Docker | ✔️ | ✔️ | https://www.docker.com/ |
|
||
| Kubernetes | ❌ | ✔️ | https://kubernetes.io/ |
|
||
| MySQL | ✔️ | ✔️ | http://mysql.com/ |
|
||
| MariaDB | ✔️ | ✔️ | https://mariadb.org/ |
|
||
| SingleStore | ❌ | ✔️ | https://www.singlestore.com/ |
|
||
| AWS Cloud | ✔️ | ✔️ | https://aws.amazon.com/ |
|
||
| AZure Cloud | ✔️ | ✔️ | https://azure.microsoft.com/ |
|
||
| Alibaba Cloud | ✔️ | ✔️ | https://aliyun.com/ |
|
||
| Private Cloud | ✔️ | ✔️ | |
|
||
| Data Comparison | ✔️ | ✔️ | Year-on-Year, Month-on-Month, Free Comparison, None Comparison |
|
||
| Excel Exporter | ✔️ | ✔️ | Tables, Line Charts, Column Charts, Pie Charts |
|
||
| Meter/Energy Data | ✔️ | ✔️ | |
|
||
| Meter/Cost Data | ✔️ | ✔️ | |
|
||
| Meter/Trend Data | ✔️ | ✔️ | |
|
||
| Meter/Realtime Data | ✔️ | ✔️ | |
|
||
| Meter/Master Meter Submeters Balance | ✔️ | ✔️ | |
|
||
| Meter/Offline Meter Energy Data | ✔️ | ✔️ | |
|
||
| Meter/Offline Meter Cost Data | ✔️ | ✔️ | |
|
||
| Meter/Virtual Meter Energy Data | ✔️ | ✔️ | |
|
||
| Meter/Virtual Meter Cost Data | ✔️ | ✔️ | |
|
||
| Meter/Meter Tracking | ✔️ | ✔️ | |
|
||
| Space/Energy Category Data | ✔️ | ✔️ | |
|
||
| Space/Energy Item Data | ✔️ | ✔️ | |
|
||
| Space/Cost Data | ✔️ | ✔️ | |
|
||
| Space/Output Data | ✔️ | ✔️ | |
|
||
| Space/Income Data | ✔️ | ✔️ | |
|
||
| Space/Efficiency Data | ✔️ | ✔️ | |
|
||
| Space/Load Data | ✔️ | ✔️ | |
|
||
| Space/Statistics | ✔️ | ✔️ | |
|
||
| Space/Saving Data | ❌ | ✔️ | Requires Energy consumption prediction component |
|
||
| Equipment/Energy Category Data | ✔️ | ✔️ | |
|
||
| Equipment/Energy Item Data | ✔️ | ✔️ | |
|
||
| Equipment/Cost Data | ✔️ | ✔️ | |
|
||
| Equipment/Output Data | ✔️ | ✔️ | |
|
||
| Equipment/Income Data | ✔️ | ✔️ | |
|
||
| Equipment/Efficiency Data | ✔️ | ✔️ | |
|
||
| Equipment/Load Data | ✔️ | ✔️ | |
|
||
| Equipment/Statistics | ✔️ | ✔️ | |
|
||
| Equipment/Saving Data | ❌ | ✔️ | Requires Energy consumption prediction component |
|
||
| Equipment/Batch Analysis | ✔️ | ✔️ | |
|
||
| Equipment/Equipment Tracking | ✔️ | ✔️ | |
|
||
| Tenant/Energy Category Data | ✔️ | ✔️ | |
|
||
| Tenant/Energy Item Data | ✔️ | ✔️ | |
|
||
| Tenant/Cost Data | ✔️ | ✔️ | |
|
||
| Tenant/Load Data | ✔️ | ✔️ | |
|
||
| Tenant/Statistics | ✔️ | ✔️ | |
|
||
| Tenant/Saving Data | ❌ | ✔️ | Requires Energy consumption prediction component |
|
||
| Tenant/Tenant Bill | ✔️ | ✔️ | |
|
||
| Tenant/Batch Analysis | ✔️ | ✔️ | |
|
||
| Store/Energy Category Data | ✔️ | ✔️ | |
|
||
| Store/Energy Item Data | ✔️ | ✔️ | |
|
||
| Store/Cost Data | ✔️ | ✔️ | |
|
||
| Store/Load Data | ✔️ | ✔️ | |
|
||
| Store/Statistics | ✔️ | ✔️ | |
|
||
| Store/Saving Data | ❌ | ✔️ | Requires Energy consumption prediction component |
|
||
| Store/Batch Analysis | ✔️ | ✔️ | |
|
||
| Shopfloor/Energy Category Data | ✔️ | ✔️ | |
|
||
| Shopfloor/Energy Item Data | ✔️ | ✔️ | |
|
||
| Shopfloor/Cost Data | ✔️ | ✔️ | |
|
||
| Shopfloor/Load Data | ✔️ | ✔️ | |
|
||
| Shopfloor/Statistics | ✔️ | ✔️ | |
|
||
| Shopfloor/Saving Data | ❌ | ✔️ | Requires Energy consumption prediction component |
|
||
| Shopfloor/Batch Analysis | ✔️ | ✔️ | |
|
||
| Combined Equipment/Energy Category Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Energy Item Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Cost Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Output Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Income Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Efficiency Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Load Data | ✔️ | ✔️ | |
|
||
| Combined Equipment/Statistics | ✔️ | ✔️ | |
|
||
| Combined Equipment/Saving Data | ❌ | ✔️ | Requires Energy consumption prediction component |
|
||
| Combined Equipment/Batch Analysis | ✔️ | ✔️ | |
|
||
| Energy Dashboard | ✔️ | ✔️ | |
|
||
| Energy Flow Diagram | ✔️ | ✔️ | |
|
||
| Distribution System | ✔️ | ✔️ | |
|
||
| REST API | ✔️ | ✔️ | |
|
||
| Web UI | ✔️ | ✔️ | |
|
||
| Admin UI | ✔️ | ✔️ | |
|
||
| BACnet/IP | ❌ | ✔️ | http://www.bacnet.org/ |
|
||
| MQTT Subscriber | ❌ | ✔️ | https://mqtt.org/ |
|
||
| Modbus RTU | ❌ | ✔️ | https://modbus.org/ |
|
||
| OPC UA | ❌ | ✔️ | https://opcfoundation.org/ |
|
||
| OPC DA | ❌ | ✔️ | https://opcfoundation.org/ |
|
||
| Siemens S7 | ❌ | ✔️ | https://siemens.com/ |
|
||
| IEC 104 | ❌ | ✔️ | IEC 60870-5-104 https://en.wikipedia.org/wiki/IEC_60870-5 |
|
||
| Johnson Controls Metasys API | ❌ | ✔️ | https://www.johnsoncontrols.com/ |
|
||
| Honeywell EBI | ❌ | ✔️ | https://www.honeywell.com/ |
|
||
| SIEMENS Desigo CC | ❌ | ✔️ | https://siemens.com/ |
|
||
| QWeather API | ❌ | ✔️ | https://www.qweather.com/ |
|
||
| Ingest from MySQL | ❌ | ✔️ | https://www.mysql.com/ |
|
||
| Ingest from Microsoft SQL Server | ❌ | ✔️ | https://www.microsoft.com/en-us/sql-server/ |
|
||
| Ingest from PostgreSQL | ❌ | ✔️ | https://www.postgresql.org/ |
|
||
| Ingest from Oracle | ❌ | ✔️ | https://www.oracle.com/database/ |
|
||
| Ingest from MongoDB | ❌ | ✔️ | https://www.mongodb.com/ |
|
||
| FDD Rule Engine | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| Alarm via Alibaba Cloud SMS Service| ❌ | ✔️ | https://www.aliyun.com/product/sms?userCode=8jwn6m8c |
|
||
| Advanced Reporting Engine | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| Prognose des Energieverbrauchs | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| Graphics Drawing Tool | ❌ | ✔️ | |
|
||
| Equipments Remote Control | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| BACnet Server | ❌ | ✔️ | http://www.bacnet.org/ |
|
||
| Modbus TCP Server | ❌ | ✔️ | https://modbus.org/ |
|
||
| OPC UA Server | ❌ | ✔️ | https://opcfoundation.org/ |
|
||
| MQTT Publisher | ❌️ | ✔️ | https://mqtt.org/ |
|
||
| iOS APP | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| Android APP | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| WeChat Mini Program | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| Alipay Mini Program | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| IPC Hardware Gateway (Data Acquisition and Remote Control）| ❌ | ✔️ | MyEMS certified industrial computer hardware |
|
||
| LoRa Radio Module (Data Acquisition and Remote Control）| ❌ | ✔️ | MyEMS certified LoRa hardware device |
|
||
| Protocol for Uploading to Provincial Platform of On-line monitoring system for Key Energy-Consuming Unit | ❌ | ✔️ | Requires standard component license or custom development |
|
||
| 3rd Party Systems Integration Service | ❌ | ✔️ | Custom development |
|
||
| Online software training | ❌ | ✔️ | |
|
||
| Face to face software training | ❌ | ✔️ | |
|
||
| Online Community Customer Support| ✔️ | ✔️ | |
|
||
| Email Customer Support | ❌ | ✔️ | |
|
||
| Telephone Customer Support | ❌ | ✔️ | |
|
||
| WeChat Customer Support | ❌ | ✔️ | |
|
||
| Remote Desktop Customer Support | ❌ | ✔️ | |
|
||
| Onsite Customer Support | ❌ | ✔️ | |
|
||
| Bidding Support Service | ❌ | ✔️ | |
|
||
| Customize Support Service | ❌ | ✔️ | |
|
||
|
||
## MyEMS Screenshot
|
||
|
||
|
||
|
||
|
||
|
||
## MyEMS Roadmap
|
||
|
||
[Community Edition Roadmap](https://github.com/orgs/MyEMS/projects)
|