README_EN.md

# MyEMS

 [简体中文](./README.md) | [ENGLISH](./README_EN.md) | [DEUTSCH](./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-en.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

See [https://myems.io/docs/intro#myems-features](https://myems.io/docs/intro#myems-features)


## Features of MyEMS Enterprise Edition

See [https://myems.io/docs/enterprise](https://myems.io/docs/enterprise)


## MyEMS Downloads (Community Edition)

[1]. [https://github.com/myems/myems](https://github.com/myems/myems)

[2]. [https://gitee.com/myems/myems](https://gitee.com/myems/myems)

[3]. [https://bitbucket.org/myems/myems](https://bitbucket.org/myems/myems)

[4]. [https://gitlab.com/myems/myems](https://gitlab.com/myems/myems)

[5]. [https://gitcode.net/myems/myems](https://gitcode.net/myems/myems)

## MyEMS Installation (Community Edition)

See [https://myems.io/docs/category/installation](https://myems.io/docs/category/installation)

## MyEMS Compose of Components:

### MyEMS Database (SQL)

See [database](./database/README.md) Introduction

### MyEMS API (Python)

See [myems-api](./myems-api/README.md) Introduction

### MyEMS Admin UI (ReactJS)

See [myems-admin](myems-admin/README.md) Introduction

### MyEMS Modbus TCP Acquisition Service (Python)

See [myems-modbus-tcp](./myems-modbus-tcp/README.md) Introduction

### MyEMS Cleaning Service (Python)

See [myems-cleaning](./myems-cleaning/README.md) Introduction

### MyEMS Normalization Service (Python)

See [myems-normalization](./myems-normalization/README.md) Introduction

### MyEMS Aggregation Service (Python)

See [myems-aggregation](./myems-aggregation/README.md) Introduction

### MyEMS Web UI (AngularJS)

See [myems-web](myems-web/README.md) Introduction

### 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 [https://myems.io/docs/installation/docker-compose)](https://myems.io/docs/installation/docker-compose)

## Integration Testing Cooperation Plan

See [https://myems.io/docs/cooperation](https://myems.io/docs/cooperation)

## QQ Group

Group Number: 792528967

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

## Videos

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