README_EN.md 4.8 KB
Newer Older
nengyuangzhang's avatar
nengyuangzhang 已提交
1 2 3
<p align="center">
   <img alt="logo" src="https://myems.io/img/myems.png" width="150" height="150">
</p>
nengyuangzhang's avatar
nengyuangzhang 已提交
4
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">MyEMS v4.4.0</h1>
nengyuangzhang's avatar
nengyuangzhang 已提交
5
<h4 align="center">Industry Leading Open Source Energy Management System</h4>
nengyuangzhang's avatar
nengyuangzhang 已提交
6
<h4 align="center">Recommended by Gitee</h4>
nengyuangzhang's avatar
nengyuangzhang 已提交
7 8 9 10 11

 [![Maintainability](https://api.codeclimate.com/v1/badges/e01a2ca1e833d66040d0/maintainability)](https://codeclimate.com/github/MyEMS/myems/maintainability)
 [![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)
nengyuangzhang's avatar
nengyuangzhang 已提交
12
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/b2cd6049727240e2aaeb8fc7b4086166)](https://app.codacy.com/gh/MyEMS/myems/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
nengyuangzhang's avatar
nengyuangzhang 已提交
13

nengyuangzhang's avatar
nengyuangzhang 已提交
14 15
 [简体中文](./README.md) | [ENGLISH](./README_EN.md) | [DEUTSCH](./README_DE.md)

nengyuangzhang's avatar
nengyuangzhang 已提交
16 17 18 19
## 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.
nengyuangzhang's avatar
nengyuangzhang 已提交
20
MyEMS can be used for device management, data collection, processing, analysis, visualization and reporting for your EMS projects.
nengyuangzhang's avatar
nengyuangzhang 已提交
21 22 23 24 25
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

26
![MyEMS Architecture Function View](/docs/images/architecture-function-view-en.png)
nengyuangzhang's avatar
nengyuangzhang 已提交
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

![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

nengyuangzhang's avatar
nengyuangzhang 已提交
45
See [https://myems.io/en/docs/intro#myems-features](https://myems.io/en/docs/intro#myems-features)
nengyuangzhang's avatar
nengyuangzhang 已提交
46 47 48 49


## Features of MyEMS Enterprise Edition

nengyuangzhang's avatar
nengyuangzhang 已提交
50
See [https://myems.io/en/docs/enterprise](https://myems.io/en/docs/enterprise)
nengyuangzhang's avatar
nengyuangzhang 已提交
51 52 53 54


## MyEMS Downloads (Community Edition)

nengyuangzhang's avatar
nengyuangzhang 已提交
55
[1]. [https://github.com/myems/myems](https://github.com/myems/myems)
nengyuangzhang's avatar
nengyuangzhang 已提交
56

nengyuangzhang's avatar
nengyuangzhang 已提交
57
[2]. [https://gitee.com/myems/myems](https://gitee.com/myems/myems)
nengyuangzhang's avatar
nengyuangzhang 已提交
58

nengyuangzhang's avatar
nengyuangzhang 已提交
59
[3]. [https://bitbucket.org/myems/myems](https://bitbucket.org/myems/myems)
nengyuangzhang's avatar
nengyuangzhang 已提交
60

nengyuangzhang's avatar
nengyuangzhang 已提交
61
[4]. [https://gitlab.com/myems/myems](https://gitlab.com/myems/myems)
nengyuangzhang's avatar
nengyuangzhang 已提交
62

nengyuangzhang's avatar
nengyuangzhang 已提交
63
[5]. [https://gitcode.net/myems/myems](https://gitcode.net/myems/myems)
nengyuangzhang's avatar
nengyuangzhang 已提交
64 65 66

## MyEMS Installation (Community Edition)

nengyuangzhang's avatar
nengyuangzhang 已提交
67
See [https://myems.io/en/docs/category/installation](https://myems.io/en/docs/category/installation)
nengyuangzhang's avatar
nengyuangzhang 已提交
68 69

## MyEMS Compose of Components:
nengyuangzhang's avatar
nengyuangzhang 已提交
70 71 72

### MyEMS Database (SQL)

nengyuangzhang's avatar
nengyuangzhang 已提交
73
See [database](./database/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
74 75 76

### MyEMS API (Python)

nengyuangzhang's avatar
nengyuangzhang 已提交
77
See [myems-api](./myems-api/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
78 79 80

### MyEMS Admin UI (ReactJS)

nengyuangzhang's avatar
nengyuangzhang 已提交
81
See [myems-admin](myems-admin/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
82 83 84

### MyEMS Modbus TCP Acquisition Service (Python)

nengyuangzhang's avatar
nengyuangzhang 已提交
85
See [myems-modbus-tcp](./myems-modbus-tcp/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
86 87 88

### MyEMS Cleaning Service (Python)

nengyuangzhang's avatar
nengyuangzhang 已提交
89
See [myems-cleaning](./myems-cleaning/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
90 91 92

### MyEMS Normalization Service (Python)

nengyuangzhang's avatar
nengyuangzhang 已提交
93
See [myems-normalization](./myems-normalization/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
94 95 96

### MyEMS Aggregation Service (Python)

nengyuangzhang's avatar
nengyuangzhang 已提交
97
See [myems-aggregation](./myems-aggregation/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
98 99 100

### MyEMS Web UI (AngularJS)

nengyuangzhang's avatar
nengyuangzhang 已提交
101
See [myems-web](myems-web/README.md) Introduction
nengyuangzhang's avatar
nengyuangzhang 已提交
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133

### 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

nengyuangzhang's avatar
nengyuangzhang 已提交
134
See [https://myems.io/en/docs/installation/docker-compose)](https://myems.io/en/docs/installation/docker-compose)
nengyuangzhang's avatar
nengyuangzhang 已提交
135 136 137

## Integration Testing Cooperation Plan

nengyuangzhang's avatar
nengyuangzhang 已提交
138
See [https://myems.io/en/docs/cooperation](https://myems.io/en/docs/cooperation)
nengyuangzhang's avatar
nengyuangzhang 已提交
139

nengyuangzhang's avatar
nengyuangzhang 已提交
140 141 142 143
## Weixin Official Subscription Account

![Open Source Energy Management System](/docs/images/qrcode_for_mp_weixin.jpg)

nengyuangzhang's avatar
nengyuangzhang 已提交
144 145 146 147
## QQ Group

Group Number: 792528967

nengyuangzhang's avatar
nengyuangzhang 已提交
148
![QQ Group 1](/docs/images/qq-group.png)
nengyuangzhang's avatar
nengyuangzhang 已提交
149 150 151 152

## Videos

[BiliBili](https://space.bilibili.com/539108162)
nengyuangzhang's avatar
nengyuangzhang 已提交
153 154

[YouTube](https://www.youtube.com/@myems)