diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 00000000..59b2e106 --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,3 @@ +Architecture +============== +.. image:: ../images/architecture.png diff --git a/docs/compare-editions.rst b/docs/compare-editions.rst new file mode 100644 index 00000000..50f104dc --- /dev/null +++ b/docs/compare-editions.rst @@ -0,0 +1,2 @@ +Compre Editions +================ \ No newline at end of file diff --git a/docs/components.rst b/docs/components.rst new file mode 100644 index 00000000..8359d324 --- /dev/null +++ b/docs/components.rst @@ -0,0 +1,3 @@ +Components +================ +.. image:: ../images/myems-conponets.svg \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 77437b87..5d5b4f7f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,8 +19,8 @@ import sphinx_rtd_theme # -- Project information ----------------------------------------------------- project = 'MyEMS' -copyright = '2020, MyEMS' -author = 'MyEMS' +copyright = '2019, 2020, MyEMS' +author = 'MyEMS Team' # -- General configuration --------------------------------------------------- diff --git a/docs/images/architecture.png b/docs/images/architecture.png new file mode 100644 index 00000000..d0b59350 Binary files /dev/null and b/docs/images/architecture.png differ diff --git a/docs/images/myem-conponets.svg b/docs/images/myem-conponets.svg new file mode 100644 index 00000000..34139208 --- /dev/null +++ b/docs/images/myem-conponets.svg @@ -0,0 +1,4672 @@ + +image/svg+xml1EMS UsersMQTTBrokerPREST APISpacesAdvancedReportsWEB APPiOS APPAndroid APPLinux Virtual ServersOn-Premises or Cloud 4Subscribe Alarms & Real-Time DataFDDDatabaseMetersSystemDatabaseEnergyDatabaseHistorianDatabaseUserDatabaseReal-Time Data WarehouseEnergyEfficiencyServiceEnergyBillingServicePublish Real-Time DataFaultDetectionDiagnosisServicePublish AlarmsMRequestResponseBASMESOfflineDataEngineUsers3rd PartyIntegrattionEngine9VM5SMS ServiceEmailServiceVM3SAPBillingDatabaseDataCleaningServiceDataNormalizationServiceDataAggregationServiceProductionEfficiencyServiceSSSSSSSHigh Performance ComputingERPPLCsGatewaysBACnetEngineModbusEngineEthernet/IPEngineOPCEngineAPSSensorsPROFINETEngineWeChatService10Copyright © 2020 MyEMS.All rights reserved.MyEMS Architecture v1.0.0 diff --git a/docs/images/screenshot-2020.12.01-16_53_12.png b/docs/images/screenshot-2020.12.01-16_53_12.png new file mode 100644 index 00000000..4035d44a Binary files /dev/null and b/docs/images/screenshot-2020.12.01-16_53_12.png differ diff --git a/docs/index.rst b/docs/index.rst index 117104bf..74612418 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,12 +11,9 @@ Welcome to MyEMS's documentation! .. toctree:: :maxdepth: 2 :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + + introduction + architecture + components + screenshots + compare-editions diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 00000000..ef637d1e --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,15 @@ +Introduction to MyEMS +======================= + +MyEMS is an industry leading open source Energy Management System that is built on cloud computing, IOT, +Big Data and AI technologies. MyEMS can be used for a standard and powerful integrated energy management +service platform. MyEMS is being developed and maintained by an experienced development team, +and the system's source code is published under MIT license. + +Target audience +--------------- + + +Reasons to use MyEMS +---------------------- + diff --git a/docs/screenshots.rst b/docs/screenshots.rst new file mode 100644 index 00000000..8223e9c2 --- /dev/null +++ b/docs/screenshots.rst @@ -0,0 +1,3 @@ +Screen Shoots +================ +.. image:: ../images/screenshot-2020.12.01-16_53_12.png \ No newline at end of file