# MyEMS

**Repository Path**: yusha223_admin/myems

## Basic Information

- **Project Name**: MyEMS
- **Description**: 基于Python, React开发的行业领先的开源能源管理系统，用于建筑、工厂、商场、数据中心、园区等能源数据采集、处理、分析、报表和展示。还有设备管理、故障诊断、工单管理、人工智能优化控制等功能。代码由资深专业团队开发维护，长期支持有保障。用开源助力实现碳达峰碳中和目标!
”技术上游“”源头厂家“"基础软件“”自主可控““架构清晰“”运行稳定“
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://gitee.com/myems
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 886
- **Created**: 2022-12-15
- **Last Updated**: 2022-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MyEMS

 [中文](/README.md) | [EN](/README_EN.md) | [DE](/README_DE.md)

 [![Documentation Status](https://readthedocs.org/projects/myems/badge/?version=latest)](https://myems.readthedocs.io/en/latest/?badge=latest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e01a2ca1e833d66040d0/maintainability)](https://codeclimate.com/github/MyEMS/myems/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/e01a2ca1e833d66040d0/test_coverage)](https://codeclimate.com/github/MyEMS/myems/test_coverage)
 [![CodeQL Scanning](https://github.com/MyEMS/myems/actions/workflows/codeql.yml/badge.svg)](https://github.com/MyEMS/myems/security/code-scanning)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/MyEMS/myems/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/MyEMS/myems/?branch=master)
 [![Build Status](https://scrutinizer-ci.com/g/MyEMS/myems/badges/build.png?b=master)](https://scrutinizer-ci.com/g/MyEMS/myems/build-status/master)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/b2cd6049727240e2aaeb8fc7b4086166)](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 and is based on Python and React.
It is used for collecting, processing, analyzing, reporting and displaying energy data of buildings, factories, shopping malls, data centers and enterprise zones.
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.
Using open source to help achieve carbon peak carbon neutrality goals.

## MyEMS Architecture

![MyEMS Architecture Function View](/docs/images/architecture-function-view.png)

![MyEMS Architecture Site View](/docs/images/architecture-site-view-en.png)

![MyEMS Data Flow](/docs/images/myems-data-flow-en.svg)

## MyEMS UI Presentation

![MyEMS Space EnergyCategory1](/docs/images/myems-space-energycategory1.gif)

![MyEMS Space EnergyCategory2](/docs/images/myems-space-energycategory2.gif)

![MyEMS Space EnergyCategory3](/docs/images/myems-space-energycategory3.gif)

![MyEMS Large Screen Dashboard](/docs/images/myems-large-screen-dashboard.gif)


## Features of MyEMS Community Edition

| Features                         | Community Edition | Explanation    |
| :---                             |      :----:       | :----:         |
| Open Source                      | ✔️            | MIT License        |
| Pricing                          | Free            |               |
| Change Name and Logo             | ❌️            | There are legal risks in case of violation |
| Modbus TCP Protocol              | ✔️            | Data acquisition, https://modbus.org/      |
| 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 |
| Shop Floors 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/    |
| Percona Server for MySQL         | ✔️             | https://www.percona.com/ |
| MariaDB                          | ✔️             | https://mariadb.org/ |
| SingleStore                      | ✔️             | https://www.singlestore.com/ |
| OceanBase                         | ✔️             | https://www.oceanbase.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                   | ✔️             | Real Excel file, not CSV file. Tables, Line Charts, Column Charts, Pie Charts |
| Meter/Meter Energy Report        | ✔️             | Cascade select Space, Multiple Compare Types, Multiple Period Types, Reporting Period Total Consumption, Base Period Total Consumption, Reporting Period Ton of Standard Coal, Reporting Period Ton of Carbon Dioxide Emissions, Reporting Period Trend, Related Parameters Data, Detailed Data, Export to Excel |
| Meter/Carbon Dioxide Emissions Report | ✔️          |                      |
| Meter/Meter Cost Report          | ✔️             |                      |
| Meter/Meter Trend Data           | ✔️             |                      |
| Meter/Meter Realtime Data        | ✔️             |                      |
| Meter/Master Meter Submeters Balance | ✔️         |                      |
| Meter/Meter Tracking             | ✔️             |                      |
| Meter/Meter Batch Analysis       | ✔️             |                      |
| Meter/Virtual Meter Energy Report  | ✔️             |                      |
| Meter/Virtual Meter Carbon Dioxide Emissions Report | ✔ |                    |
| Meter/Virtual Meter Cost Report    | ✔️             |                      |
| Meter/Offline Meter Energy Report  | ✔️             |                      |
| Meter/Offline Meter Carbon Dioxide Emissions Report | ✔ |                    |
| Meter/Offline Meter Cost Report    | ✔️             |                      |
| Meter/Offline Meter Batch Analysis       | ✔️             |                      |
| Space/Energy Category Data       | ✔️             |                      |
| Space/Energy Item Data           | ✔️             |                      |
| Space/Carbon Dioxide Emissions Report | ✔️          |                      |
| 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/Carbon Dioxide Emissions Report | ✔️          |                      |
| 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/Carbon Dioxide Emissions Report | ✔️          |                      |
| Tenant/Cost Data                 | ✔️             |                      |
| Tenant/Load Data                 | ✔️             |                      |
| Tenant/Statistics                | ✔️             |                      |
| Tenant/Tenant Bill               | ✔️             |                      |
| Tenant/Batch Analysis            | ✔️             |                      |
| Store/Energy Category Data       | ✔️             |                      |
| Store/Energy Item Data           | ✔️             |                      |
| Store/Carbon Dioxide Emissions Report | ✔️          |                      |
| Store/Cost Data                  | ✔️             |                      |
| Store/Load Data                  | ✔️             |                      |
| Store/Statistics                 | ✔️             |                      |
| Store/Batch Analysis             | ✔️             |                      |
| Shopfloor/Energy Category Data   | ✔️             |                      |
| Shopfloor/Energy Item Data       | ✔️             |                      |
| Shopfloor/Carbon Dioxide Emissions Report | ✔️          |                      |
| Shopfloor/Cost Data              | ✔️             |                      |
| Shopfloor/Load Data              | ✔️             |                      |
| Shopfloor/Statistics             | ✔️             |                      |
| Shopfloor/Batch Analysis         | ✔️             |                      |
| Combined Equipment/Energy Category Data | ✔️      |                      |
| Combined Equipment/Energy Item Data     | ✔️      |                      |
| Combined Equipment/Carbon Dioxide Emissions Report | ✔️          |                      |
| 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 (version 1.x). 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]. [GitCode](https://gitcode.net/myems/myems) https://gitcode.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](myems-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](myems-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-en.md)

## MyEMS Project Management

[Community Edition Roadmap](https://github.com/orgs/MyEMS/projects?type=beta)

## Integration Testing Cooperation Plan

See [Integration Testing Cooperation Plan](integration-testing-cn.md)


## QQ Group

Group Number: 792528967

![QQ Group 1](/docs/images/qq-group-1.png)


## Videos

[BiliBili](https://space.bilibili.com/539108162)