seg_yinzy
/
myems
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixed code style warnings in README

pull/63/MERGE
13621160019@163.com 2021-08-26 14:57:44 +08:00
parent 1b07a2147d
commit c350ddd808
11 changed files with 341 additions and 364 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -272,11 +272,11 @@ docker-compose up -d
## MyEMS镜像 ## MyEMS镜像
[1]. [https://github.com/MyEMS/myems](https://github.com/MyEMS/myems) [1]. [Github](https://github.com/MyEMS/myems) https://github.com/MyEMS/myems
[2]. [https://gitee.com/myems/myems](https://gitee.com/myems/myems) [2]. [Gitee](https://gitee.com/myems/myems) https://gitee.com/myems/myems
[3]. [https://bitbucket.org/myems/myems](https://bitbucket.org/myems/myems) [3]. [Bitbucket](https://bitbucket.org/myems/myems) https://bitbucket.org/myems/myems
[4]. [https://gitlab.com/myems/myems](https://gitlab.com/myems/myems) [4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems

8
README_DE.md
View File

@ -274,11 +274,11 @@ docker-compose up -d
## MyEMS Spiegel ## MyEMS Spiegel
[1]. [https://github.com/MyEMS/myems](https://github.com/MyEMS/myems) [1]. [Github](https://github.com/MyEMS/myems) https://github.com/MyEMS/myems
[2]. [https://gitee.com/myems/myems](https://gitee.com/myems/myems) [2]. [Gitee](https://gitee.com/myems/myems) https://gitee.com/myems/myems
[3]. [https://bitbucket.org/myems/myems](https://bitbucket.org/myems/myems) [3]. [Bitbucket](https://bitbucket.org/myems/myems) https://bitbucket.org/myems/myems
[4]. [https://gitlab.com/myems/myems](https://gitlab.com/myems/myems) [4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems

9
README_EN.md
View File

@ -274,12 +274,11 @@ docker-compose up -d
## MyEMS Mirrors ## MyEMS Mirrors
[1]. [https://github.com/MyEMS/myems](https://github.com/MyEMS/myems) [1]. [Github](https://github.com/MyEMS/myems) https://github.com/MyEMS/myems
[2]. [https://gitee.com/myems/myems](https://gitee.com/myems/myems) [2]. [Gitee](https://gitee.com/myems/myems) https://gitee.com/myems/myems
[3]. [https://bitbucket.org/myems/myems](https://bitbucket.org/myems/myems) [3]. [Bitbucket](https://bitbucket.org/myems/myems) https://bitbucket.org/myems/myems
[4]. [https://gitlab.com/myems/myems](https://gitlab.com/myems/myems)
[4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems

45
admin/README.md vendored
View File

@ -7,7 +7,6 @@ Providing admin panel for MyEMS system administration and configuration
## Prerequisites ## Prerequisites
nginx-1.18.0 or later nginx-1.18.0 or later
## Option 1: Install on NGINX Server ## Option 1: Install on NGINX Server
* Install NGINX Server * Install NGINX Server
@ -15,8 +14,8 @@ nginx-1.18.0 or later
refer to http://nginx.org/en/docs/install.html refer to http://nginx.org/en/docs/install.html
* Configure NGINX * Configure NGINX
``` ```bash
$ sudo nano /etc/nginx/nginx.conf sudo nano /etc/nginx/nginx.conf
``` ```
In the 'http' section, add some directives: In the 'http' section, add some directives:
``` ```
@ -54,20 +53,20 @@ Add a new 'server' section with direstives as below:
``` ```
* Download myems * Download myems
``` ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
``` ```
* Install myems-admin : * Install myems-admin :
If the server can not connect to the internet, please compress the myems/admin folder and upload it to the server and extract it to ~/myems/admin If the server can not connect to the internet, please compress the myems/admin folder and upload it to the server and extract it to ~/myems/admin
``` ```bash
$ sudo cp -r ~/myems/admin /var/www/html/admin sudo cp -r ~/myems/admin /var/www/html/admin
$ sudo chmod 0755 -R /var/www/html/admin sudo chmod 0755 -R /var/www/html/admin
``` ```
Check the config file and change it if necessary: Check the config file and change it if necessary:
``` ```bash
$ sudo nano /var/www/html/admin/app/api.js sudo nano /var/www/html/admin/app/api.js
``` ```
## NOTE: ## NOTE:
@ -83,15 +82,15 @@ The 'upload' folder is for user uploaded files. DO NOT delete/move/overwrite the
refer to https://httpd.apache.org/docs/2.4/install.html refer to https://httpd.apache.org/docs/2.4/install.html
* Configure Apache2 * Configure Apache2
``` ```bash
$ sudo vi /etc/apache2/ports.conf sudo vi /etc/apache2/ports.conf
``` ```
Add a Listen Add a Listen
``` ```
Listen 8001 Listen 8001
``` ```
``` ```bash
$ sudo vi /etc/apache2/sites-available/000-default.conf sudo vi /etc/apache2/sites-available/000-default.conf
``` ```
Add a new 'VirtualHost' as below Add a new 'VirtualHost' as below
``` ```
@ -110,18 +109,18 @@ Add a new 'VirtualHost' as below
``` ```
* Download myems-admin * Download myems-admin
``` ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
``` ```
* Install myems-admin : * Install myems-admin :
If the server can not connect to the internet, please compress the myems/admin folder and upload it to the server and extract it to ~/myems/admin If the server can not connect to the internet, please compress the myems/admin folder and upload it to the server and extract it to ~/myems/admin
``` ```bash
$ sudo cp -r ~/myems/admin /var/www/html/admin sudo cp -r ~/myems/admin /var/www/html/admin
$ sudo chmod 0755 -R /var/www/html/admin sudo chmod 0755 -R /var/www/html/admin
``` ```
Check the config file and change it if necessary: Check the config file and change it if necessary:
``` ```bash
$ sudo nano /var/www/html/admin/app/api.js sudo nano /var/www/html/admin/app/api.js
``` ```

6
database/README.md
View File

@ -14,7 +14,7 @@ Providing database schema and scripts for MyEMS.
### Installation ### Installation
Execute the following scripts in MySQL commandline, or execute in other MySQL client tools such as MySQL Workbench, Navicat, DBaver, phpMyAdmin, etc. Execute the following scripts in MySQL commandline, or execute in other MySQL client tools such as MySQL Workbench, Navicat, DBaver, phpMyAdmin, etc.
``` ```bash
mysql -u root -p < myems_billing_baseline_db.sql mysql -u root -p < myems_billing_baseline_db.sql
mysql -u root -p < myems_billing_db.sql mysql -u root -p < myems_billing_db.sql
mysql -u root -p < myems_energy_baseline_db.sql mysql -u root -p < myems_energy_baseline_db.sql
@ -26,11 +26,11 @@ mysql -u root -p < myems_system_db.sql
mysql -u root -p < myems_user_db.sql mysql -u root -p < myems_user_db.sql
``` ```
To insert demo data execute the following scripts, To insert demo data execute the following scripts,
``` ```bash
mysql -u root -p < demo/myems_system_db.sql mysql -u root -p < demo/myems_system_db.sql
``` ```
#### Change COLLATE for MySQL server before version 8.0 #### Change COLLATE for MySQL server before version 8.0
``` ```bash
sudo nano /etc/mysql/my.cnf sudo nano /etc/mysql/my.cnf
``` ```
``` ```

48
myems-aggregation/README.md
View File

@ -1,7 +1,5 @@
## MyEMS Aggregation Service 数据汇总服务 ## MyEMS Aggregation Service 数据汇总服务
### Introduction ### Introduction
This service is a component of MyEMS and it aggregates normalized data up to multiple dimensions. This service is a component of MyEMS and it aggregates normalized data up to multiple dimensions.
@ -10,50 +8,48 @@ This service is a component of MyEMS and it aggregates normalized data up to mul
mysql.connector mysql.connector
### Installation ### Installation
Download and install MySQL Connector: Download and install MySQL Connector:
``` ```bash
$ cd ~/tools cd ~/tools
$ wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz
$ tar xzf mysql-connector-python-8.0.20.tar.gz tar xzf mysql-connector-python-8.0.20.tar.gz
$ cd ~/tools/mysql-connector-python-8.0.20 cd ~/tools/mysql-connector-python-8.0.20
$ sudo python3 setup.py install sudo python3 setup.py install
``` ```
Install myems-aggregation service: Install myems-aggregation service:
``` ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
$ cd myems cd myems
$ sudo git checkout master (or the latest release tag) sudo git checkout master (or the latest release tag)
$ sudo cp -R ~/myems/myems-aggregation /myems-aggregation sudo cp -R ~/myems/myems-aggregation /myems-aggregation
``` ```
Edit config.py Edit config.py
``` ```bash
$ sudo nano /myems-aggregation/config.py sudo nano /myems-aggregation/config.py
``` ```
Setup systemd service: Setup systemd service:
``` ```bash
$ sudo cp myems-aggregation.service /lib/systemd/system/ sudo cp myems-aggregation.service /lib/systemd/system/
``` ```
Enable the service: Enable the service:
``` ```bash
$ sudo systemctl enable myems-aggregation.service sudo systemctl enable myems-aggregation.service
``` ```
Start the service: Start the service:
``` ```bash
$ sudo systemctl start myems-aggregation.service sudo systemctl start myems-aggregation.service
``` ```
Monitor the service: Monitor the service:
```bash ```bash
$ sudo systemctl status myems-aggregation.service sudo systemctl status myems-aggregation.service
``` ```
View the log: View the log:
```bash ```bash
$ cat /myems-aggregation.log cat /myems-aggregation.log
``` ```
### References ### References

290
myems-api/README.md
View File

@ -185,7 +185,6 @@ View in Postman: import the file MyEMS.postman_collection.json with Postman
[Reports](#Reports) [Reports](#Reports)
### Contact ### Contact
* GET Contact by ID * GET Contact by ID
```bash ```bash
@ -443,7 +442,6 @@ $ curl -i -X GET {{base_url}}/emailmessages/from/{startdate}/to/{enddate}
$ curl -i -X DELETE {{base_url}}/emailmessages/{id} $ curl -i -X DELETE {{base_url}}/emailmessages/{id}
``` ```
### Email Server ### Email Server
* GET an Email Server by ID * GET an Email Server by ID
@ -479,7 +477,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"host":"smtp.
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"host":"smtp.myems.io","port":25, "requires_authentication":true, "user_name":"myems" , "password":"!MyEMS1" , "from_addr":"myems@myems.io"}}' {{base_url}}/emailservers/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"host":"smtp.myems.io","port":25, "requires_authentication":true, "user_name":"myems" , "password":"!MyEMS1" , "from_addr":"myems@myems.io"}}' {{base_url}}/emailservers/{id}
``` ```
### Energy Category ### Energy Category
* GET an Energy Category by ID * GET an Energy Category by ID
@ -515,7 +512,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"电",
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"电","unit_of_measure":"kWh", "kgce":0.1329 , "kgco2e":0.9825}}' {{base_url}}/energycategories/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"电","unit_of_measure":"kWh", "kgce":0.1329 , "kgco2e":0.9825}}' {{base_url}}/energycategories/{id}
``` ```
### Energy Flow Diagram ### Energy Flow Diagram
* GET an Energy Flow Diagram by ID * GET an Energy Flow Diagram by ID
```bash ```bash
@ -578,7 +574,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"source_node_
$ curl -i -X DELETE {{base_url}}/energyflowdiagrams/{id}/links/{lid} $ curl -i -X DELETE {{base_url}}/energyflowdiagrams/{id}/links/{lid}
``` ```
### Energy Item ### Energy Item
* GET an Energy Item by ID * GET an Energy Item by ID
@ -612,7 +607,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"空
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"动力用电","energy_category_id":1}}' {{base_url}}/energyitems/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"动力用电","energy_category_id":1}}' {{base_url}}/energyitems/{id}
``` ```
### Equipment ### Equipment
* GET Equipment by ID * GET Equipment by ID
```bash ```bash
@ -849,7 +843,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"virtual_mete
$ curl -i -X DELETE {{base_url}}/combinedequipments/{id}/virtualmeters/{mid} $ curl -i -X DELETE {{base_url}}/combinedequipments/{id}/virtualmeters/{mid}
``` ```
### Gateway ### Gateway
* GET Gateway by ID * GET Gateway by ID
@ -919,7 +912,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"serial_port"
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"serial_port":"/dev/ttyS0","baud_rate":115200}}' {{base_url}}/gsmmodems/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"serial_port":"/dev/ttyS0","baud_rate":115200}}' {{base_url}}/gsmmodems/{id}
``` ```
### Knowledge File ### Knowledge File
* GET Knowledge File by ID * GET Knowledge File by ID
@ -987,7 +979,6 @@ $ curl -i -X GET {{base_url}}/menus/web
$ curl -i -X GET {{base_url}}/menus/{id}/children $ curl -i -X GET {{base_url}}/menus/{id}/children
``` ```
### Meter ### Meter
* GET Meter by ID * GET Meter by ID
@ -1043,7 +1034,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"point_id":"3
$ curl -i -X DELETE {{base_url}}/meters/{id}/points/{pid} $ curl -i -X DELETE {{base_url}}/meters/{id}/points/{pid}
``` ```
### Notification ### Notification
NOTE: Login before call these APIs, and then update User-UUID and Token in Headers NOTE: Login before call these APIs, and then update User-UUID and Token in Headers
@ -1208,7 +1198,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"Modbu
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"ModbusPoint1", "data_source_id":1, "object_type": "ENERGY_VALUE", "units":"kWh", "low_limit":0, "high_limit":999999999, "is_trend":true, "is_virtual":false, "address":"{\"slave_id\":1, \"function_code\":3, \"offset\":1, \"number_of_registers\":2, \"data_format\":\"float\"}", "description":null}}' {{base_url}}/points/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"ModbusPoint1", "data_source_id":1, "object_type": "ENERGY_VALUE", "units":"kWh", "low_limit":0, "high_limit":999999999, "is_trend":true, "is_virtual":false, "address":"{\"slave_id\":1, \"function_code\":3, \"offset\":1, \"number_of_registers\":2, \"data_format\":\"float\"}", "description":null}}' {{base_url}}/points/{id}
``` ```
### Privilege ### Privilege
* GET Privilege by ID * GET Privilege by ID
```bash ```bash
@ -1231,7 +1220,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"super
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"superusers", "data":"{\"spaces\":[1, 3]}"}}' {{base_url}}/privileges/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"superusers", "data":"{\"spaces\":[1, 3]}"}}' {{base_url}}/privileges/{id}
``` ```
### Rule ### Rule
* GET Rule by ID * GET Rule by ID
@ -1252,7 +1240,6 @@ Result in JSON
| last_run_datetime | float | null, or the number of milliseconds since January 1, 1970, 00:00:00, universal time | | last_run_datetime | float | null, or the number of milliseconds since January 1, 1970, 00:00:00, universal time |
| next_run_datetime | float | null, or the number of milliseconds since January 1, 1970, 00:00:00, universal time | | next_run_datetime | float | null, or the number of milliseconds since January 1, 1970, 00:00:00, universal time |
```bash ```bash
$ curl -i -X GET {{base_url}}/rules/{id} $ curl -i -X GET {{base_url}}/rules/{id}
``` ```
@ -1273,7 +1260,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"Space
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"Space Energy Consumption Over Limit", "fdd_code":"SPACE01", "category":"SPACE", "priority":"HIGH", "channel":"WEB", "expression":"{\"space_id\":1, \"high_limit\":1000.000}", "message_template":"%s截止到目前电耗%s，超标%s。", "is_enabled":true}}' {{base_url}}/rules/{id} $ curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"Space Energy Consumption Over Limit", "fdd_code":"SPACE01", "category":"SPACE", "priority":"HIGH", "channel":"WEB", "expression":"{\"space_id\":1, \"high_limit\":1000.000}", "message_template":"%s截止到目前电耗%s，超标%s。", "is_enabled":true}}' {{base_url}}/rules/{id}
``` ```
### Sensor ### Sensor
* GET a Sensor by ID * GET a Sensor by ID
@ -1579,7 +1565,6 @@ $ curl -i -X DELETE {{base_url}}/spaces/{id}/virtualmeters/{mid}
$ curl -i -H "User-UUID: 793f1bb4-6e25-4242-8cdc-2f662b25484f" -H "Token: a6e52af82e5b4168ae03b1c5fd8fa31b2ab3a338" -X GET {{base_url}}/spaces/tree $ curl -i -H "User-UUID: 793f1bb4-6e25-4242-8cdc-2f662b25484f" -H "Token: a6e52af82e5b4168ae03b1c5fd8fa31b2ab3a338" -X GET {{base_url}}/spaces/tree
``` ```
### Store ### Store
* GET Store by ID * GET Store by ID
```bash ```bash
@ -1876,7 +1861,6 @@ $ curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"virtual_mete
$ curl -i -X DELETE {{base_url}}/tenants/{id}/virtualmeters/{mid} $ curl -i -X DELETE {{base_url}}/tenants/{id}/virtualmeters/{mid}
``` ```
### Tenant Type ### Tenant Type
* GET a Tenant Type by ID * GET a Tenant Type by ID
@ -1938,7 +1922,6 @@ $ curl -i -X GET {{base_url}}/textmessages/from/{startdate}/to/{enddate}
$ curl -i -X DELETE {{base_url}}/textmessages/{id} $ curl -i -X DELETE {{base_url}}/textmessages/{id}
``` ```
### Timezone ### Timezone
* GET a Timezone by ID * GET a Timezone by ID
```bash ```bash
@ -1995,7 +1978,6 @@ $ curl -i -H "Content-Type: application/json" -H "User-UUID: 793f1bb4-6e25-4242-
$ curl -i -H "Content-Type: application/json" -H "User-UUID: 793f1bb4-6e25-4242-8cdc-2f662b25484f" -H "Token: a6e52af82e5b4168ae03b1c5fd8fa31b2ab3a338" -X PUT -d '{"data":{"name":"johnson","password":"NewPassword1"}}' {{base_url}}/users/resetpassword $ curl -i -H "Content-Type: application/json" -H "User-UUID: 793f1bb4-6e25-4242-8cdc-2f662b25484f" -H "Token: a6e52af82e5b4168ae03b1c5fd8fa31b2ab3a338" -X PUT -d '{"data":{"name":"johnson","password":"NewPassword1"}}' {{base_url}}/users/resetpassword
``` ```
### Virtual Meter ### Virtual Meter
* GET a Virtual Meter by ID * GET a Virtual Meter by ID
@ -2103,274 +2085,274 @@ $ curl -i -X DELETE {{base_url}}/wechatmessages/{id}
### Reports ### Reports
* GET AdvancedReports * GET AdvancedReports
``` ```bash
$ curl -i -X GET {{base_url}}/reports/advancedreports?reportingperiodstartdatetime={reportingperiodstartdatetime}&reportingperiodenddatetime={reportingperiodenddatetime} curl -i -X GET {{base_url}}/reports/advancedreports?reportingperiodstartdatetime={reportingperiodstartdatetime}&reportingperiodenddatetime={reportingperiodenddatetime}
``` ```
* GET AdvancedReport by ID * GET AdvancedReport by ID
``` ```bash
$ curl -i -X GET {{base_url}}/reports/advancedreports/{id} curl -i -X GET {{base_url}}/reports/advancedreports/{id}
``` ```
* DELETE AdvancedReport by ID * DELETE AdvancedReport by ID
``` ```bash
$ curl -i -X GET {{base_url}}/reports/advancedreports/{id} curl -i -X GET {{base_url}}/reports/advancedreports/{id}
``` ```
* GET Combined Equipment Batch Analysis Report * GET Combined Equipment Batch Analysis Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09 curl -i -X GET {{base_url}}/reports/combinedequipmentbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09
``` ```
* GET Combined Equipment Cost Report * GET Combined Equipment Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentcost?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentcost?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Efficiency Report * GET Combined Equipment Efficiency Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentefficiency?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentefficiency?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Energy Category Report * GET Combined Equipment Energy Category Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentenergycategory?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentenergycategory?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Energy Item Report * GET Combined Equipment Energy Item Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentenergyitem?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentenergyitem?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Income Report * GET Combined Equipment Income Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentincome?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentincome?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Load Report * GET Combined Equipment Load Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentload?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentload?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Output Report * GET Combined Equipment Output Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentoutput?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentoutput?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Saving Report * GET Combined Equipment Saving Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/combinedequipmentsaving?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/combinedequipmentsaving?combinedequipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Combined Equipment Statistics Report * GET Combined Equipment Statistics Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentstatistics?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentstatistics?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Dashboard * GET Dashboard
``` ```bash
$ curl -i -X GET {{base_url}}/reports/dashboard?useruuid={useruuid}&periodtype={periodtype}&baseperiodstartdatetime={baseperiodstartdatetime}&baseperiodenddatetime={baseperiodenddatetime}&reportingperiodstartdatetime={reportingperiodstartdatetime}&reportingperiodenddatetime={reportingperiodenddatetime} curl -i -X GET {{base_url}}/reports/dashboard?useruuid={useruuid}&periodtype={periodtype}&baseperiodstartdatetime={baseperiodstartdatetime}&baseperiodenddatetime={baseperiodenddatetime}&reportingperiodstartdatetime={reportingperiodstartdatetime}&reportingperiodenddatetime={reportingperiodenddatetime}
``` ```
* GET Distribution System Report * GET Distribution System Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/distributionsystem?distributionsystemid=1 curl -i -X GET {{base_url}}/reports/distributionsystem?distributionsystemid=1
``` ```
* GET Energy Flow Diagram Report * GET Energy Flow Diagram Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/energyflowdiagram?energyflowdiagramid=1&reportingperiodstartdatetime={reportingperiodstartdatetime}&reportingperiodenddatetime={reportingperiodenddatetime} curl -i -X GET {{base_url}}/reports/energyflowdiagram?energyflowdiagramid=1&reportingperiodstartdatetime={reportingperiodstartdatetime}&reportingperiodenddatetime={reportingperiodenddatetime}
``` ```
* GET Equipment Batch Analysis Report * GET Equipment Batch Analysis Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09 curl -i -X GET {{base_url}}/reports/equipmentbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09
``` ```
* GET Equipment Cost Report * GET Equipment Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentcost?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentcost?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Efficiency Report * GET Equipment Efficiency Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentefficiency?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentefficiency?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Energy Category Report * GET Equipment Energy Category Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentenergycategory?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentenergycategory?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Energy Item Report * GET Equipment Energy Item Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentenergyitem?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentenergyitem?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Income Report * GET Equipment Income Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentincome?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentincome?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Load Report * GET Equipment Load Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentload?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentload?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Output Report * GET Equipment Output Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentoutput?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentoutput?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Saving Report * GET Equipment Saving Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentsaving?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentsaving?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Equipment Statistics Report * GET Equipment Statistics Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/equipmentstatistics?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/equipmentstatistics?equipmentid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Meter Batch Analysis Report * GET Meter Batch Analysis Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/meterbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09 curl -i -X GET {{base_url}}/reports/meterbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09
``` ```
* GET Meter Cost Report * GET Meter Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/metercost?meterid=6&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/metercost?meterid=6&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Meter Energy Report * GET Meter Energy Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/meterenergy?meterid=6&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/meterenergy?meterid=6&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Meter Realtime Report * GET Meter Realtime Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/meterrealtime?meterid=1 curl -i -X GET {{base_url}}/reports/meterrealtime?meterid=1
``` ```
* GET Meter Submeters Balance Report * GET Meter Submeters Balance Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/metersubmetersbalance?meterid=1&periodtype=daily&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/metersubmetersbalance?meterid=1&periodtype=daily&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Meter Trend Report * GET Meter Trend Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/metertrend?meterid=6&reportingperiodstartdatetime=2020-09-10T00:00:00&reportingperiodenddatetime=2020-09-11T00:00:00 curl -i -X GET {{base_url}}/reports/metertrend?meterid=6&reportingperiodstartdatetime=2020-09-10T00:00:00&reportingperiodenddatetime=2020-09-11T00:00:00
``` ```
* GET Meter Tracking Report * GET Meter Tracking Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/metertracking?spaceid=1 curl -i -X GET {{base_url}}/reports/metertracking?spaceid=1
``` ```
* GET Offline Meter Energy Report * GET Offline Meter Energy Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/offlinemeterenergy?offlinemeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/offlinemeterenergy?offlinemeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Offline Meter Cost Report * GET Offline Meter Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/offlinemetercost?offlinemeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/offlinemetercost?offlinemeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Shopfloor Batch Analysis Report * GET Shopfloor Batch Analysis Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09 curl -i -X GET {{base_url}}/reports/shopfloorbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09
``` ```
* GET Shopfloor Cost Report * GET Shopfloor Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorcost?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/shopfloorcost?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Shopfloor Energy Category Report * GET Shopfloor Energy Category Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorenergycategory?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/shopfloorenergycategory?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Shopfloor Energy Item Report * GET Shopfloor Energy Item Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorenergyitem?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/shopfloorenergyitem?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Shopfloor Load Report * GET Shopfloor Load Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorload?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/shopfloorload?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Shopfloor Saving Report * GET Shopfloor Saving Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorsaving?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/shopfloorsaving?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Shopfloor Statistics Report * GET Shopfloor Statistics Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/shopfloorstatistics?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/shopfloorstatistics?shopfloorid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Cost Report * GET Space Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spacecost?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spacecost?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Efficiency Report * GET Space Efficiency Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spaceefficiency?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spaceefficiency?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Energy Category Report * GET Space Energy Category Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spaceenergycategory?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spaceenergycategory?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Energy Item Report * GET Space Energy Item Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spaceenergyitem?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spaceenergyitem?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Income Report * GET Space Income Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spaceincome?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spaceincome?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Load Report * GET Space Load Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spaceload?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spaceload?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Output Report * GET Space Output Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spaceoutput?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spaceoutput?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Saving Report * GET Space Saving Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spacesaving?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spacesaving?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Space Statistics Report * GET Space Statistics Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/spacestatistics?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/spacestatistics?spaceid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Store Batch Analysis Report * GET Store Batch Analysis Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storebatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09 curl -i -X GET {{base_url}}/reports/storebatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09
``` ```
* GET Store Cost Report * GET Store Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storetcost?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/storetcost?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Store Energy Category Report * GET Store Energy Category Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storeenergycategory?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/storeenergycategory?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Store Energy Item Report * GET Store Energy Item Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storeenergyitem?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/storeenergyitem?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Store Load Report * GET Store Load Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storeload?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/storeload?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Store Saving Report * GET Store Saving Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storesaving?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/storesaving?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Store Statistics Report * GET Store Statistics Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/storestatistics?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/storestatistics?storeid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Tenant Batch Analysis Report * GET Tenant Batch Analysis Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09 curl -i -X GET {{base_url}}/reports/tenantbatch?spaceid=1&reportingperiodstartdatetime=2021-05-01T00:00:00&reportingperiodenddatetime=2021-05-20T11:41:09
``` ```
* GET Tenant Bill Report * GET Tenant Bill Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantbill?tenantid=1&reportingperiodstartdatetime=2020-10-01T00:00:00&reportingperiodenddatetime=2020-11-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantbill?tenantid=1&reportingperiodstartdatetime=2020-10-01T00:00:00&reportingperiodenddatetime=2020-11-01T00:00:00
``` ```
* GET Tenant Cost Report * GET Tenant Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantcost?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantcost?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Tenant Energy Category Report * GET Tenant Energy Category Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantenergycategory?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantenergycategory?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Tenant Energy Item Report * GET Tenant Energy Item Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantenergyitem?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantenergyitem?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Tenant Load Report * GET Tenant Load Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantload?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantload?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Tenant Saving Report * GET Tenant Saving Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantsaving?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantsaving?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Tenant Statistics Report * GET Tenant Statistics Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/tenantstatistics?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/tenantstatistics?tenantid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Virtual Meter Energy Report * GET Virtual Meter Energy Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/virtualmeterenergy?virtualmeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/virtualmeterenergy?virtualmeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```
* GET Virtual Meter Cost Report * GET Virtual Meter Cost Report
``` ```bash
$ curl -i -X GET {{base_url}}/reports/virtualmetercost?virtualmeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00 curl -i -X GET {{base_url}}/reports/virtualmetercost?virtualmeterid=1&periodtype=daily&baseperiodstartdatetime=2020-08-01T00:00:00&baseperiodenddatetime=2020-09-01T00:00:00&reportingperiodstartdatetime=2020-09-01T00:00:00&reportingperiodenddatetime=2020-10-01T00:00:00
``` ```

37
myems-cleaning/README.md
View File

@ -3,59 +3,56 @@ MyEMS Cleaning Service
MyEMS 数据清洗服务 MyEMS 数据清洗服务
### Introduction ### Introduction
This service is a component of MyEMS and it cleans the historical data. This service is a component of MyEMS and it cleans the historical data.
### Prerequisites ### Prerequisites
mysql.connector mysql.connector
### Installation ### Installation
Download and install MySQL Connector: Download and install MySQL Connector:
``` ```bash
$ cd ~/tools cd ~/tools
$ wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz
$ tar xzf mysql-connector-python-8.0.20.tar.gz tar xzf mysql-connector-python-8.0.20.tar.gz
$ cd ~/tools/mysql-connector-python-8.0.20 cd ~/tools/mysql-connector-python-8.0.20
$ sudo python3 setup.py install sudo python3 setup.py install
``` ```
Install myems-cleaning service Install myems-cleaning service
```bash ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
$ cd myems cd myems
$ sudo git checkout master (or the latest release tag) sudo git checkout master (or the latest release tag)
$ sudo cp -R ~/myems/myems-cleaning /myems-cleaning sudo cp -R ~/myems/myems-cleaning /myems-cleaning
``` ```
Open config file and edit database configuration Open config file and edit database configuration
```bash ```bash
$ sudo nano /myems-cleaning/config.py sudo nano /myems-cleaning/config.py
``` ```
Setup systemd service: Setup systemd service:
```bash ```bash
$ sudo cp myems-cleaning.service /lib/systemd/system/ sudo cp myems-cleaning.service /lib/systemd/system/
``` ```
Enable the service: Enable the service:
```bash ```bash
$ sudo systemctl enable myems-cleaning.service sudo systemctl enable myems-cleaning.service
``` ```
Start the service: Start the service:
```bash ```bash
$ sudo systemctl start myems-cleaning.service sudo systemctl start myems-cleaning.service
``` ```
Monitor the service: Monitor the service:
```bash ```bash
$ sudo systemctl status myems-cleaning.service sudo systemctl status myems-cleaning.service
``` ```
View the log: View the log:
```bash ```bash
$ cat /myems-cleaning.log cat /myems-cleaning.log
``` ```
### References ### References

75
myems-modbus-tcp/README.md
View File

@ -3,7 +3,6 @@
### Introduction ### Introduction
This service is a component of MyEMS to acquire data from Modbus TCP devices. This service is a component of MyEMS to acquire data from Modbus TCP devices.
### Prerequisites ### Prerequisites
pyserial pyserial
@ -16,74 +15,71 @@ Schedule
### Installation ### Installation
Download and install MySQL Connector: Download and install MySQL Connector:
``` ```bash
$ cd ~/tools cd ~/tools
$ wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz
$ tar xzf mysql-connector-python-8.0.20.tar.gz tar xzf mysql-connector-python-8.0.20.tar.gz
$ cd ~/tools/mysql-connector-python-8.0.20 cd ~/tools/mysql-connector-python-8.0.20
$ sudo python3 setup.py install python3 setup.py install
``` ```
Download and install Schedule Download and install Schedule
``` ```bash
$ cd ~/tools cd ~/tools
$ git clone https://github.com/dbader/schedule.git git clone https://github.com/dbader/schedule.git
$ cd ~/tools/schedule cd ~/tools/schedule
$ sudo python3 setup.py install python3 setup.py install
``` ```
Download and install modbus-tk Download and install modbus-tk
``` ```bash
$ cd ~/tools cd ~/tools
$ git clone https://github.com/pyserial/pyserial.git git clone https://github.com/pyserial/pyserial.git
$ cd ~/tools/pyserial cd ~/tools/pyserial
$ sudo python3 setup.py install python3 setup.py install
$ git clone https://github.com/ljean/modbus-tk.git git clone https://github.com/ljean/modbus-tk.git
$ cd ~/tools/modbus-tk cd ~/tools/modbus-tk
$ sudo python3 setup.py install python3 setup.py install
``` ```
Install myems-modbus-tcp service Install myems-modbus-tcp service
``` ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
$ cd myems cd myems
$ sudo git checkout master (or the latest release tag) git checkout master (or the latest release tag)
$ sudo cp -R ~/myems/myems-modbus-tcp /myems-modbus-tcp cp -R ~/myems/myems-modbus-tcp /myems-modbus-tcp
``` ```
Edit the config Edit the config
``` ```bash
$ sudo nano /myems-modbus-tcp/config.py nano /myems-modbus-tcp/config.py
``` ```
Setup systemd service: Setup systemd service:
```bash ```bash
$ sudo cp myems-modbus-tcp.service /lib/systemd/system/ cp myems-modbus-tcp.service /lib/systemd/system/
``` ```
Enable the service: Enable the service:
```bash ```bash
$ sudo systemctl enable myems-modbus-tcp.service systemctl enable myems-modbus-tcp.service
``` ```
Start the service: Start the service:
```bash ```bash
$ sudo systemctl start myems-modbus-tcp.service systemctl start myems-modbus-tcp.service
``` ```
Monitor the service: Monitor the service:
```bash ```bash
$ sudo systemctl status myems-modbus-tcp.service systemctl status myems-modbus-tcp.service
``` ```
View the log: View the log:
```bash ```bash
$ cat /myems-modbus-tcp.log cat /myems-modbus-tcp.log
``` ```
### Add Data Sources and Points in MyEMS Admin ### Add Data Sources and Points in MyEMS Admin
NOTE: If you modified Modbus TCP datasources and points, please restart this service: NOTE: If you modified Modbus TCP datasources and points, please restart this service:
``` ```bash
$ sudo systemctl restart myems-modbus-tcp.service systemctl restart myems-modbus-tcp.service
``` ```
Input Data source protocol: Input Data source protocol:
@ -106,11 +102,13 @@ Point address example:
The slave ID The slave ID
#### function_code #### function_code
```
01 (0x01) Read Coils 01 (0x01) Read Coils
02 (0x02) Read Discrete Inputs 02 (0x02) Read Discrete Inputs
03 (0x03) Read Holding Registers 03 (0x03) Read Holding Registers
04 (0x04) Read Input Registers 04 (0x04) Read Input Registers
23 (0x17) Read/Write Multiple registers 23 (0x17) Read/Write Multiple registers
```
#### offset #### offset
The starting register address specified in the Request PDU The starting register address specified in the Request PDU
@ -155,7 +153,6 @@ This is not for little-endian and big-endian swapping, and use format for that.
The option is effective when number_of_registers is ether 2(32bits) or 4(64bits), The option is effective when number_of_registers is ether 2(32bits) or 4(64bits),
else it will be ignored. else it will be ignored.
### References ### References
[1]. http://myems.io [1]. http://myems.io

89
myems-normalization/README.md
View File

@ -17,84 +17,91 @@ openpyxl
### Installation ### Installation
Download and install MySQL Connector: Download and install MySQL Connector:
``` ```bash
$ cd ~/tools cd ~/tools
$ wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz
$ tar xzf mysql-connector-python-8.0.20.tar.gz tar xzf mysql-connector-python-8.0.20.tar.gz
$ cd ~/tools/mysql-connector-python-8.0.20 cd ~/tools/mysql-connector-python-8.0.20
$ sudo python3 setup.py install sudo python3 setup.py install
``` ```
Download and install mpmath Download and install mpmath
``` ```bash
$ cd ~/tools cd ~/tools
$ git clone https://github.com/fredrik-johansson/mpmath.git git clone https://github.com/fredrik-johansson/mpmath.git
$ cd ~/tools/mpmath cd ~/tools/mpmath
$ sudo python3 setup.py install sudo python3 setup.py install
``` ```
Download and install SymPy Download and install SymPy
``` ```bash
$ cd ~/tools cd ~/tools
$ git clone https://github.com/sympy/sympy.git git clone https://github.com/sympy/sympy.git
$ cd ~/tools/sympy cd ~/tools/sympy
$ sudo python3 setupegg.py develop sudo python3 setupegg.py develop
``` ```
Download and install openpyxl Download and install openpyxl
```bash
cd ~/tools
``` ```
$ cd ~/tools
Get the latest version of et_xmlfile from https://bitbucket.org/openpyxl/et_xmlfile/downloads/ Get the latest version of et_xmlfile from https://bitbucket.org/openpyxl/et_xmlfile/downloads/
$ wget https://bitbucket.org/openpyxl/et_xmlfile/get/50973a6de49c.zip ```bash
$ 7z x 50973a6de49c.zip && mv openpyxl-et_xmlfile-50973a6de49c et_xmlfile wget https://bitbucket.org/openpyxl/et_xmlfile/get/50973a6de49c.zip
7z x 50973a6de49c.zip && mv openpyxl-et_xmlfile-50973a6de49c et_xmlfile
$ git clone https://github.com/phn/jdcal.git ```
Get jdcal
```bash
git clone https://github.com/phn/jdcal.git
```
Get the latest version of openpyxl from https://bitbucket.org/openpyxl/openpyxl/downloads/ Get the latest version of openpyxl from https://bitbucket.org/openpyxl/openpyxl/downloads/
$ wget https://bitbucket.org/openpyxl/openpyxl/get/8953233f5af2.zip ```bash
$ 7z x 8953233f5af2.zip && mv openpyxl-openpyxl-8953233f5af2 openpyxl wget https://bitbucket.org/openpyxl/openpyxl/get/8953233f5af2.zip
7z x 8953233f5af2.zip && mv openpyxl-openpyxl-8953233f5af2 openpyxl
```
$ cd ~/tools/et_xmlfile ```bash
$ sudo python3 setup.py install cd ~/tools/et_xmlfile
$ cd ~/tools/jdcal sudo python3 setup.py install
$ sudo python3 setup.py install cd ~/tools/jdcal
$ cd ~/tools/openpyxl sudo python3 setup.py install
$ sudo python3 setup.py install cd ~/tools/openpyxl
sudo python3 setup.py install
``` ```
Install myems-normalization service: Install myems-normalization service:
``` ```
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
$ cd myems cd myems
$ sudo git checkout master (or the latest release tag) sudo git checkout master (or the latest release tag)
$ sudo cp -r ~/myems/myems-normalization /myems-normalization sudo cp -r ~/myems/myems-normalization /myems-normalization
``` ```
Edit config.py Edit config.py
``` ```
$ sudo nano /myems-normalization/config.py sudo nano /myems-normalization/config.py
``` ```
Setup systemd service: Setup systemd service:
``` ```
$ sudo cp myems-normalization.service /lib/systemd/system/ sudo cp myems-normalization.service /lib/systemd/system/
``` ```
Enable the service: Enable the service:
``` ```
$ sudo systemctl enable myems-normalization.service sudo systemctl enable myems-normalization.service
``` ```
Start the service: Start the service:
``` ```
$ sudo systemctl start myems-normalization.service sudo systemctl start myems-normalization.service
``` ```
Monitor the service: Monitor the service:
```bash ```bash
$ sudo systemctl status myems-normalization.service sudo systemctl status myems-normalization.service
``` ```
View the log: View the log:
```bash ```bash
$ cat /myems-normalization.log cat /myems-normalization.log
``` ```
### References ### References

84
web/README.md vendored
View File

@ -16,28 +16,28 @@ This project is scaffolded using Create React App.
Download Current Linux Binaries (x64) from https://nodejs.org/en/download/current/ Download Current Linux Binaries (x64) from https://nodejs.org/en/download/current/
Unzip the binary archive to /usr/local/bin/nodejs, Unzip the binary archive to /usr/local/bin/nodejs,
``` ```bash
sudo mkdir -p /usr/local/lib/nodejs sudo mkdir -p /usr/local/lib/nodejs
sudo tar -xJvf node-v1x.x.x-linux-x64.tar.xz -C /usr/local/lib/nodejs sudo tar -xJvf node-v1x.x.x-linux-x64.tar.xz -C /usr/local/lib/nodejs
``` ```
Using sudo to symlink node, npm, and npx into /usr/bin/: Using sudo to symlink node, npm, and npx into /usr/bin/:
``` ```bash
sudo ln -s /usr/local/lib/nodejs/node-v1x.x.x-linux-x64/bin/node /usr/bin/node sudo ln -s /usr/local/lib/nodejs/node-v1x.x.x-linux-x64/bin/node /usr/bin/node
``` ```
``` ```bash
sudo ln -s /usr/local/lib/nodejs/node-v1x.x.x-linux-x64/bin/npm /usr/bin/npm sudo ln -s /usr/local/lib/nodejs/node-v1x.x.x-linux-x64/bin/npm /usr/bin/npm
``` ```
``` ```bash
sudo ln -s /usr/local/lib/nodejs/node-v1x.x.x-linux-x64/bin/npx /usr/bin/npx sudo ln -s /usr/local/lib/nodejs/node-v1x.x.x-linux-x64/bin/npx /usr/bin/npx
``` ```
Test installation using Test installation using
``` ```bash
node -v node -v
``` ```
``` ```bash
npm version npm version
``` ```
``` ```bash
npx -v npx -v
``` ```
@ -65,8 +65,8 @@ You can run 'node server.js' to run the production build locally at http://local
refer to http://nginx.org/en/docs/install.html refer to http://nginx.org/en/docs/install.html
* Configure NGINX * Configure NGINX
``` ```bash
$ sudo nano /etc/nginx/nginx.conf sudo nano /etc/nginx/nginx.conf
``` ```
In the 'http' section, add some directives: In the 'http' section, add some directives:
``` ```
@ -103,34 +103,34 @@ Add a new 'server' section with direstives as below:
} }
``` ```
Restart NGINX Restart NGINX
``` ```bash
$ sudo systemctl restart nginx sudo systemctl restart nginx
``` ```
* Download myems: * Download myems:
``` ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
``` ```
* Install myems-web : * Install myems-web :
Check and change the config file if necessary: Check and change the config file if necessary:
``` ```bash
$ cd ~/myems/web cd ~/myems/web
$ sudo nano src/config.js sudo nano src/config.js
``` ```
Build and Compress Build and Compress
``` ```bash
$ sudo npm run build sudo npm run build
$ tar czvf myems-web.tar.gz build tar czvf myems-web.tar.gz build
``` ```
Install Install
Upload the file myems-web.tar.gz to you web server. Upload the file myems-web.tar.gz to you web server.
Note that the following path should be same as that was configured in nginx.conf. Note that the following path should be same as that was configured in nginx.conf.
``` ```bash
$ tar xzf myems-web.tar.gz tar xzf myems-web.tar.gz
$ sudo rm -r /var/www/html/web sudo rm -r /var/www/html/web
$ sudo mv build /var/www/html/web sudo mv build /var/www/html/web
``` ```
## Option 2: Install Production Build on Apache2 Server ## Option 2: Install Production Build on Apache2 Server
@ -139,15 +139,15 @@ $ sudo systemctl restart nginx
refer to https://httpd.apache.org/docs/2.4/install.html refer to https://httpd.apache.org/docs/2.4/install.html
* Configure Apache2 * Configure Apache2
``` ```bash
$ sudo vi /etc/apache2/ports.conf sudo vi /etc/apache2/ports.conf
``` ```
Add a Listen Add a Listen
``` ```
Listen 80 Listen 80
``` ```
``` ```bash
$ sudo vi /etc/apache2/sites-available/000-default.conf sudo vi /etc/apache2/sites-available/000-default.conf
``` ```
Add a new 'VirtualHost' as below Add a new 'VirtualHost' as below
``` ```
@ -166,28 +166,28 @@ Add a new 'VirtualHost' as below
``` ```
* Download myems: * Download myems:
``` ```bash
$ cd ~ cd ~
$ git clone https://github.com/MyEMS/myems.git git clone https://github.com/MyEMS/myems.git
``` ```
* Install myems-web : * Install myems-web :
Check and change the config file if necessary: Check and change the config file if necessary:
``` ```bash
$ cd ~/myems/web cd ~/myems/web
$ sudo nano src/config.js sudo nano src/config.js
``` ```
Build and Compress Build and Compress
``` ```bash
$ cd ~/myems/web/ cd ~/myems/web/
$ sudo npm run build sudo npm run build
$ tar czvf myems-web.tar.gz build tar czvf myems-web.tar.gz build
``` ```
Install Install
Upload the file myems-web.tar.gz to you web server. Upload the file myems-web.tar.gz to you web server.
Note that the following path should be same as that was configured in 000-default.conf Note that the following path should be same as that was configured in 000-default.conf
``` ```bash
$ tar xzf myems-web.tar.gz tar xzf myems-web.tar.gz
$ sudo rm -r /var/www/web sudo rm -r /var/www/web
$ sudo mv build /var/www/web sudo mv build /var/www/web
``` ```