219 lines
12 KiB
Markdown
219 lines
12 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 Screenshot
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Features of MyEMS Community Edition
|
|
|
|
| Features | Community Edition | Explanation |
|
|
| :--- | :----: | :----: |
|
|
| Open Source | ✔️ | |
|
|
| Pricing | Free | |
|
|
| Change Name and Logo | ❌️ | |
|
|
| Modbus TCP | ✔️ | |
|
|
| Data Points Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Meters Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Spaces Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Equipments Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Tenants Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Stores Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Shopfloors Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Combined Equipments Number | Unlimited | The actual number is limited by the upper limit of server resources |
|
|
| Docker | ✔️ | https://hub.docker.com/u/myems |
|
|
| 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 | ✔️ | |
|
|
| 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/Batch Analysis | ✔️ | |
|
|
| Equipment/Equipment Tracking | ✔️ | |
|
|
| Tenant/Energy Category Data | ✔️ | |
|
|
| Tenant/Energy Item Data | ✔️ | |
|
|
| Tenant/Cost Data | ✔️ | |
|
|
| Tenant/Load Data | ✔️ | |
|
|
| Tenant/Statistics | ✔️ | |
|
|
| Tenant/Tenant Bill | ✔️ | |
|
|
| Tenant/Batch Analysis | ✔️ | |
|
|
| Store/Energy Category Data | ✔️ | |
|
|
| Store/Energy Item Data | ✔️ | |
|
|
| Store/Cost Data | ✔️ | |
|
|
| Store/Load Data | ✔️ | |
|
|
| Store/Statistics | ✔️ | |
|
|
| Store/Batch Analysis | ✔️ | |
|
|
| Shopfloor/Energy Category Data | ✔️ | |
|
|
| Shopfloor/Energy Item Data | ✔️ | |
|
|
| Shopfloor/Cost Data | ✔️ | |
|
|
| Shopfloor/Load Data | ✔️ | |
|
|
| Shopfloor/Statistics | ✔️ | |
|
|
| 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/Batch Analysis | ✔️ | |
|
|
| Energy Dashboard | ✔️ | |
|
|
| Energy Flow Diagram | ✔️ | |
|
|
| Distribution System | ✔️ | |
|
|
| RESTful API | ✔️ | Base on Python. Providing interfaces of system configuration, energy report and excel exporter |
|
|
| Web UI | ✔️ | Based on ReactJS. Providing energy data virtualization. |
|
|
| Admin UI | ✔️ | Based on AngularJS. Providing system configuration. |
|
|
| Online Community Customer Support| ✔️ | |
|
|
|
|
|
|
## Features of MyEMS Enterprise Edition
|
|
|
|
See [Features of MyEMS Enterprise Edition](./enterprise-edition-en.md)
|
|
|
|
|
|
## MyEMS Downloads (Community Edition)
|
|
|
|
[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
|
|
|
|
[5]. [CODE CHINA](https://codechina.csdn.net/myems/myems) https://codechina.csdn.net/myems/myems
|
|
|
|
## MyEMS Installation (Community Edition)
|
|
|
|
This project is compose of following components:
|
|
|
|
### MyEMS Database (SQL)
|
|
|
|
See [database Introduction & Installation](./database/README.md)
|
|
|
|
### MyEMS API (Python)
|
|
|
|
See [myems-api Introduction & Installation](./myems-api/README.md)
|
|
|
|
### MyEMS Admin UI (ReactJS)
|
|
|
|
See [myems-admin Introduction & Installation](./admin/README.md)
|
|
|
|
### MyEMS Modbus TCP Acquisition Service (Python)
|
|
|
|
See [myems-modbus-tcp Introduction & Installation](./myems-modbus-tcp/README.md)
|
|
|
|
### MyEMS Cleaning Service (Python)
|
|
|
|
See [myems-cleaning Introduction & Installation](./myems-cleaning/README.md)
|
|
|
|
### MyEMS Normalization Service (Python)
|
|
|
|
See [myems-normalization Introduction & Installation](./myems-normalization/README.md)
|
|
|
|
### MyEMS Aggregation Service (Python)
|
|
|
|
See [myems-aggregation Introduction & Installation](./myems-aggregation/README.md)
|
|
|
|
### MyEMS Web UI (AngularJS)
|
|
|
|
See [myems-web Introduction & Installation](./web/README.md)
|
|
|
|
### Default Ports
|
|
|
|
MyEMS Web UI: 80
|
|
|
|
MyEMS API: 8000
|
|
|
|
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 Repaid Deployment
|
|
|
|
See [Docker Compose Repaid Deployment](docker-compose.md)
|
|
|
|
## MyEMS Roadmap
|
|
|
|
[Community Edition Roadmap](https://github.com/orgs/MyEMS/projects)
|