diff --git a/README.md b/README.md index 66f2a9d..306baff 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,6 @@ cd myems.io sudo npm i --unsafe-perm=true --allow-root --legacy-peer-deps ``` -### Running the development server - -To preview your changes as you edit the files, you can run a local development server that will serve your website and reflect the latest changes. -``` -cd myems.io -sudo npm run start -``` -By default, a browser window will open at http://localhost:3000. - ### Build Docusaurus is a modern static website generator so we need to build the website into a directory of static contents and put it on a web server so that it can be viewed. To build the website: @@ -32,6 +23,15 @@ sudo npm run build This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +### Running the development server + +To preview your changes as you edit the files, you can run a local development server that will serve your website and reflect the latest changes. +``` +cd myems.io +sudo npm run serve +``` +By default, a browser window will open at http://localhost:3000. + ### Deployment with Azure Static Web Apps CI/CD A GitHub Actions workflow is triggered when a push to master branch or a pull request on the master branch is: opened, synchronized, reopened, or closed. diff --git a/docs/api.md b/docs/api.md index 0fa924c..65476fd 100644 --- a/docs/api.md +++ b/docs/api.md @@ -373,8 +373,8 @@ Result in JSON | name | string | Data Source name | | gateway | object | Gateway | | uuid | string | Data Source UUID | -| protocol | string | Protocol Type Supported: 'modbus-tcp', 'modbus-rtu', 'bacnet-ip', 's7', 'profibus', 'profinet', 'opc-ua', 'lora', 'simulation', 'controllogix', 'weather', 'mysql', 'sqlserver', 'postgresql', 'oracle', 'mongodb', 'influxdb', 'mqtt' | -| connection | json | Connection data in JSON. BACnet/IP example: {"host":"10.1.2.88"}, Modbus TCP example: {"host":"10.1.2.88", "port":502}, S7 example: {"host":"10.1.2.202", "port":102, "rack": 0, "slot": 2}, ControlLogix example: {"host":"10.1.2.88","port":44818,"processorslot":3} OPC UA example: {"url":"opc.tcp://10.1.2.5:49320/OPCUA/SimulationServer/"} | +| protocol | string | Protocol Type Supported: 'modbus-tcp', 'modbus-rtu', 'bacnet-ip', 's7', 'profibus', 'profinet', 'opc-ua', 'lora', 'simulation', 'controllogix', 'weather', 'mysql', 'sqlserver', 'postgresql', 'oracle', 'mongodb', 'influxdb', 'mqtt' | +| connection | json | Connection data in JSON. | | last_seen_datetime | string | Indicates the last time when the data source was seen in local timezone | | status | string | 'online' or 'offline' determined by last seen datetime | diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index e12c3f3..0000000 --- a/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial/_category_.json similarity index 67% rename from docs/tutorial-extras/_category_.json rename to docs/tutorial/_category_.json index a8ffcc1..060e502 100644 --- a/docs/tutorial-extras/_category_.json +++ b/docs/tutorial/_category_.json @@ -1,5 +1,5 @@ { - "label": "Tutorial - Extras", + "label": "Tutorial", "position": 3, "link": { "type": "generated-index" diff --git a/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/tutorial/img/docsVersionDropdown.png similarity index 100% rename from docs/tutorial-extras/img/docsVersionDropdown.png rename to docs/tutorial/img/docsVersionDropdown.png diff --git a/docs/tutorial-extras/img/localeDropdown.png b/docs/tutorial/img/localeDropdown.png similarity index 100% rename from docs/tutorial-extras/img/localeDropdown.png rename to docs/tutorial/img/localeDropdown.png diff --git a/docs/tutorial-extras/translate-your-site.md b/docs/tutorial/translate-your-site.md similarity index 100% rename from docs/tutorial-extras/translate-your-site.md rename to docs/tutorial/translate-your-site.md diff --git a/docs/tutorial/use-online-demo.md b/docs/tutorial/use-online-demo.md new file mode 100644 index 0000000..ba44710 --- /dev/null +++ b/docs/tutorial/use-online-demo.md @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +--- + +# 使用在线演示 + +## 项目概要 + +建筑面积100万平方米，计量表179个，数据点284个，各种业态子系统18个，部署在阿里云容器服务 +Kubernetes集群，现场安装一台数据采集器用于数据采集和上传 + +## 参考手册 + +| 我想看 |怎么看 | +| :--- | :----- | +| 能源管理平台地址 | https://myems.cloud | +| 能源管理平台数据大屏地址 | 请咨询销售人员 | +| 空间能耗数据 | 空间数据>能耗分类分析 | +| 空间成本数据 | 空间数据>能耗成本分析 | +| 空间数据能耗分项分析 | 空间数据>能耗分项分析，空间选择‘一度城/办公楼’ | +| 各种业态数据演示方法 | 空间数据>能耗分类分析，空间选择‘一度城/ABC’,ABC指各种业态空间名称：市政府、办公楼、商场、酒店、博物馆、工厂、全国连锁门店、住宅小区、医院、大学、机场、火车站、养殖场、公寓、地铁站、体育场、公用动力、数据中心 | +| 租户数据 | 租户数据>能耗分类分析,空间选择‘一度城/商场/租区’
租户数据>租户账单，空间选择‘一度城/商场/租区’，点击‘提交’和‘导出’
租户数据>批量分析，空间选择‘一度城/商场/租区’，点‘提交’和‘导出’ | +| 单个计量表趋势数据 | 计量表数据>计量表趋势分析，空间选择‘一度城/调试空间’ | +| 总分表平衡分析 | 计量表数据>总分表平衡分析，空间选择‘一度城/调试空间’，搜索‘ahb01’ | +| 碳排放数据分析 | 计量表数据>计量表碳排放分析，空间选择‘一度城/调试空间’ | +| 制冷站效率 | 组合设备数据>效率分析，空间选择‘一度城/公用动力/制冷站’ | +| 数据中心效率 | 组合设备数据>效率分析，空间选择‘一度城/数据中心’ | +| 车间能耗数据 | 车间数据>能耗分类分析，空间选择‘一度城/工厂/生产区’ | +| 能耗排名演示方法 | 空间数据>能耗分类分析，空间选择‘一度城’，点击‘提交’后，在‘子空间数据’表格中点击‘电’‘自来水’等排序 | +| 能耗占比、碳排放等演示方法 | 空间数据>能耗分类分析，空间选择‘一度城’，点击‘提交’后，在结果第二行显示‘子空间分类占比’包含‘电’‘自来水’‘中水’等，鼠标停放到饼状图上显示数值 | +| 报表导出演示方法 | 空间数据>能耗分类分析 ，空间选择‘一度城’，点击‘提交’待结果出现后，点击‘导出’，使用Office软件打开下载的文件 | +| 配电系统实时数据 | 辅助系统>配电系统 | +| 能流图 | 辅助系统>能流图 | +| 高级报表 | 菜单：高级报表（TBD)，可结合高级报表邮件演示 | +| 故障检测与诊断FDD | 菜单：故障检测与诊断（TBD)，可结合报警邮件演示 | +| 连锁门店演示方法 | 门店数据>能耗分类分析，空间选择‘一度城/连锁门店/东区’ | +| 制冷站设备能耗数据 | 设备数据>能耗分类分析，空间选择‘一度城/公用动力/制冷站’ | +| 多级用户权限演示方法 | 使用连锁门店专用账号登录，空间数据>能耗分类分析，空间选择‘连锁门店’，其它业态空间不可见 | +| 调试空间 | 不参与能耗计算，已绑定所有系统中的对象，用于快速查看和故障分析 | +| 能源管理平台管理员登录地址 | 请咨询销售人员 | + + +## 申请账号 + +- 姓名: 张能远 +- 电话微信: (+86) 13011132526 +- QQ: 1853444168 +- Email: zny@myems.org + +![WeChat: 13011132526](/img/wechat_nengyuanzhang.jpg) +![QQ: 1853444168](/img/qq_nengyuanzhang.jpg) diff --git a/docusaurus.config.js b/docusaurus.config.js index 0dd4459..60f48b3 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,8 +1,9 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion -const lightCodeTheme = require('prism-react-renderer/themes/github'); -const darkCodeTheme = require('prism-react-renderer/themes/dracula'); +const themes = require('prism-react-renderer').themes; +const lightCodeTheme = themes.github; +const darkCodeTheme = themes.dracula; /** @type {import('@docusaurus/types').Config} */ const config = { @@ -37,7 +38,7 @@ const config = { // metadata like html lang. For example, if your site is Chinese, you may want // to replace "en" with "zh-Hans". i18n: { - defaultLocale: 'en', + defaultLocale: 'zh-Hans', locales: ['en', 'zh-Hans', 'de'], }, @@ -83,6 +84,11 @@ const config = { label: 'Installation', href: '/docs/category/installation', }, + { + position: 'left', + label: 'Tutorial', + href: '/docs/category/tutorial', + }, { position: 'left', label: 'API', @@ -128,6 +134,10 @@ const config = { label: 'Installation', to: '/docs/category/installation', }, + { + label: 'Tutorial', + href: '/docs/category/tutorial', + }, { label: 'API', to: '/docs/api', diff --git a/i18n/de/docusaurus-plugin-content-docs/current.json b/i18n/de/docusaurus-plugin-content-docs/current.json index b4cb695..918174f 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current.json +++ b/i18n/de/docusaurus-plugin-content-docs/current.json @@ -3,9 +3,9 @@ "message": "Next", "description": "The label for version current" }, - "sidebar.tutorialSidebar.category.Tutorial - Extras": { - "message": "Tutorial - Extras", - "description": "The label for category Tutorial - Extras in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Tutorial": { + "message": "Tutorial", + "description": "The label for category Tutorial in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Installation": { "message": "Installation", diff --git a/i18n/de/docusaurus-plugin-content-docs/current/api.md b/i18n/de/docusaurus-plugin-content-docs/current/api.md index 0fa924c..65476fd 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/api.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/api.md @@ -373,8 +373,8 @@ Result in JSON | name | string | Data Source name | | gateway | object | Gateway | | uuid | string | Data Source UUID | -| protocol | string | Protocol Type Supported: 'modbus-tcp', 'modbus-rtu', 'bacnet-ip', 's7', 'profibus', 'profinet', 'opc-ua', 'lora', 'simulation', 'controllogix', 'weather', 'mysql', 'sqlserver', 'postgresql', 'oracle', 'mongodb', 'influxdb', 'mqtt' | -| connection | json | Connection data in JSON. BACnet/IP example: {"host":"10.1.2.88"}, Modbus TCP example: {"host":"10.1.2.88", "port":502}, S7 example: {"host":"10.1.2.202", "port":102, "rack": 0, "slot": 2}, ControlLogix example: {"host":"10.1.2.88","port":44818,"processorslot":3} OPC UA example: {"url":"opc.tcp://10.1.2.5:49320/OPCUA/SimulationServer/"} | +| protocol | string | Protocol Type Supported: 'modbus-tcp', 'modbus-rtu', 'bacnet-ip', 's7', 'profibus', 'profinet', 'opc-ua', 'lora', 'simulation', 'controllogix', 'weather', 'mysql', 'sqlserver', 'postgresql', 'oracle', 'mongodb', 'influxdb', 'mqtt' | +| connection | json | Connection data in JSON. | | last_seen_datetime | string | Indicates the last time when the data source was seen in local timezone | | status | string | 'online' or 'offline' determined by last seen datetime | diff --git a/i18n/de/docusaurus-plugin-content-docs/current/installation/freebsd.md b/i18n/de/docusaurus-plugin-content-docs/current/installation/freebsd.md index d1df286..9e08903 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/installation/freebsd.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/installation/freebsd.md @@ -317,6 +317,7 @@ Aktualisieren der nginx Standard-Conf-Datei: nano /etc/nginx/conf.d/default.conf ``` Schreiben Sie mit Direktiven wie unten und ersetzen Sie die Standard-myems-api-URL http://127.0.0.1:8000/ mit tatsächlicher URL, wenn die myems-api-Servcie auf einem anderen Server gehostet wird +``` server { listen 80; server_name myems-web; diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/manage-docs-versions.md b/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index e12c3f3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/_category_.json similarity index 67% rename from i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/_category_.json rename to i18n/de/docusaurus-plugin-content-docs/current/tutorial/_category_.json index a8ffcc1..060e502 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/_category_.json +++ b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/_category_.json @@ -1,5 +1,5 @@ { - "label": "Tutorial - Extras", + "label": "Tutorial", "position": 3, "link": { "type": "generated-index" diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/img/docsVersionDropdown.png b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/img/docsVersionDropdown.png similarity index 100% rename from i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/img/docsVersionDropdown.png rename to i18n/de/docusaurus-plugin-content-docs/current/tutorial/img/docsVersionDropdown.png diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/img/localeDropdown.png b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/img/localeDropdown.png similarity index 100% rename from i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/img/localeDropdown.png rename to i18n/de/docusaurus-plugin-content-docs/current/tutorial/img/localeDropdown.png diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/translate-your-site.md b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/translate-your-site.md similarity index 100% rename from i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/translate-your-site.md rename to i18n/de/docusaurus-plugin-content-docs/current/tutorial/translate-your-site.md diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorial/use-online-demo.md b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/use-online-demo.md new file mode 100644 index 0000000..ba44710 --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/tutorial/use-online-demo.md @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +--- + +# 使用在线演示 + +## 项目概要 + +建筑面积100万平方米，计量表179个，数据点284个，各种业态子系统18个，部署在阿里云容器服务 +Kubernetes集群，现场安装一台数据采集器用于数据采集和上传 + +## 参考手册 + +| 我想看 |怎么看 | +| :--- | :----- | +| 能源管理平台地址 | https://myems.cloud | +| 能源管理平台数据大屏地址 | 请咨询销售人员 | +| 空间能耗数据 | 空间数据>能耗分类分析 | +| 空间成本数据 | 空间数据>能耗成本分析 | +| 空间数据能耗分项分析 | 空间数据>能耗分项分析，空间选择‘一度城/办公楼’ | +| 各种业态数据演示方法 | 空间数据>能耗分类分析，空间选择‘一度城/ABC’,ABC指各种业态空间名称：市政府、办公楼、商场、酒店、博物馆、工厂、全国连锁门店、住宅小区、医院、大学、机场、火车站、养殖场、公寓、地铁站、体育场、公用动力、数据中心 | +| 租户数据 | 租户数据>能耗分类分析,空间选择‘一度城/商场/租区’
租户数据>租户账单，空间选择‘一度城/商场/租区’，点击‘提交’和‘导出’
租户数据>批量分析，空间选择‘一度城/商场/租区’，点‘提交’和‘导出’ | +| 单个计量表趋势数据 | 计量表数据>计量表趋势分析，空间选择‘一度城/调试空间’ | +| 总分表平衡分析 | 计量表数据>总分表平衡分析，空间选择‘一度城/调试空间’，搜索‘ahb01’ | +| 碳排放数据分析 | 计量表数据>计量表碳排放分析，空间选择‘一度城/调试空间’ | +| 制冷站效率 | 组合设备数据>效率分析，空间选择‘一度城/公用动力/制冷站’ | +| 数据中心效率 | 组合设备数据>效率分析，空间选择‘一度城/数据中心’ | +| 车间能耗数据 | 车间数据>能耗分类分析，空间选择‘一度城/工厂/生产区’ | +| 能耗排名演示方法 | 空间数据>能耗分类分析，空间选择‘一度城’，点击‘提交’后，在‘子空间数据’表格中点击‘电’‘自来水’等排序 | +| 能耗占比、碳排放等演示方法 | 空间数据>能耗分类分析，空间选择‘一度城’，点击‘提交’后，在结果第二行显示‘子空间分类占比’包含‘电’‘自来水’‘中水’等，鼠标停放到饼状图上显示数值 | +| 报表导出演示方法 | 空间数据>能耗分类分析 ，空间选择‘一度城’，点击‘提交’待结果出现后，点击‘导出’，使用Office软件打开下载的文件 | +| 配电系统实时数据 | 辅助系统>配电系统 | +| 能流图 | 辅助系统>能流图 | +| 高级报表 | 菜单：高级报表（TBD)，可结合高级报表邮件演示 | +| 故障检测与诊断FDD | 菜单：故障检测与诊断（TBD)，可结合报警邮件演示 | +| 连锁门店演示方法 | 门店数据>能耗分类分析，空间选择‘一度城/连锁门店/东区’ | +| 制冷站设备能耗数据 | 设备数据>能耗分类分析，空间选择‘一度城/公用动力/制冷站’ | +| 多级用户权限演示方法 | 使用连锁门店专用账号登录，空间数据>能耗分类分析，空间选择‘连锁门店’，其它业态空间不可见 | +| 调试空间 | 不参与能耗计算，已绑定所有系统中的对象，用于快速查看和故障分析 | +| 能源管理平台管理员登录地址 | 请咨询销售人员 | + + +## 申请账号 + +- 姓名: 张能远 +- 电话微信: (+86) 13011132526 +- QQ: 1853444168 +- Email: zny@myems.org + +![WeChat: 13011132526](/img/wechat_nengyuanzhang.jpg) +![QQ: 1853444168](/img/qq_nengyuanzhang.jpg) diff --git a/i18n/de/docusaurus-theme-classic/footer.json b/i18n/de/docusaurus-theme-classic/footer.json index 165f75a..bb09065 100644 --- a/i18n/de/docusaurus-theme-classic/footer.json +++ b/i18n/de/docusaurus-theme-classic/footer.json @@ -47,6 +47,10 @@ "message": "Installation", "description": "The label of footer link with label=Installation linking to /docs/category/installation" }, + "link.item.label.Tutorial": { + "message": "Tutorial", + "description": "The label of footer link with label=Tutorial linking to /docs/category/tutorial" + }, "link.item.label.API": { "message": "API", "description": "The label of footer link with label=API linking to /docs/api" diff --git a/i18n/de/docusaurus-theme-classic/navbar.json b/i18n/de/docusaurus-theme-classic/navbar.json index 59410bd..4086019 100644 --- a/i18n/de/docusaurus-theme-classic/navbar.json +++ b/i18n/de/docusaurus-theme-classic/navbar.json @@ -23,6 +23,10 @@ "message": "Installation", "description": "Navbar item with label Installation" }, + "item.label.Tutorial": { + "message": "Tutorial", + "description": "Navbar item with label Tutorial" + }, "item.label.API": { "message": "API", "description": "Navbar item with label API" diff --git a/i18n/en/docusaurus-plugin-content-docs/current.json b/i18n/en/docusaurus-plugin-content-docs/current.json index c1cebf5..cb1030a 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/i18n/en/docusaurus-plugin-content-docs/current.json @@ -3,9 +3,9 @@ "message": "Next", "description": "The label for version current" }, - "sidebar.tutorialSidebar.category.Tutorial - Extras": { - "message": "Tutorial - Extras", - "description": "The label for category Tutorial - Extras in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Tutorial": { + "message": "Tutorial", + "description": "The label for category Tutorial in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Installation": { "message": "Installation", diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index af8aa9f..dd70c61 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -47,6 +47,10 @@ "message": "Installation", "description": "The label of footer link with label=Installation linking to /docs/category/installation" }, + "link.item.label.Tutorial": { + "message": "Tutorial", + "description": "The label of footer link with label=Tutorial linking to /docs/category/tutorial" + }, "link.item.label.API": { "message": "API", "description": "The label of footer link with label=API linking to /docs/api" diff --git a/i18n/en/docusaurus-theme-classic/navbar.json b/i18n/en/docusaurus-theme-classic/navbar.json index ccabb05..d4eaa7a 100644 --- a/i18n/en/docusaurus-theme-classic/navbar.json +++ b/i18n/en/docusaurus-theme-classic/navbar.json @@ -23,6 +23,10 @@ "message": "Installation", "description": "Navbar item with label Installation" }, + "item.label.Tutorial": { + "message": "Tutorial", + "description": "Navbar item with label Tutorial" + }, "item.label.API": { "message": "API", "description": "Navbar item with label API" diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json index 00b7a90..096b146 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json @@ -3,9 +3,9 @@ "message": "Next", "description": "The label for version current" }, - "sidebar.tutorialSidebar.category.Tutorial - Extras": { - "message": "Tutorial - Extras", - "description": "The label for category Tutorial - Extras in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Tutorial": { + "message": "教程", + "description": "The label for category Tutorial in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Installation": { "message": "安装", diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api.md index 0fa924c..65476fd 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api.md @@ -373,8 +373,8 @@ Result in JSON | name | string | Data Source name | | gateway | object | Gateway | | uuid | string | Data Source UUID | -| protocol | string | Protocol Type Supported: 'modbus-tcp', 'modbus-rtu', 'bacnet-ip', 's7', 'profibus', 'profinet', 'opc-ua', 'lora', 'simulation', 'controllogix', 'weather', 'mysql', 'sqlserver', 'postgresql', 'oracle', 'mongodb', 'influxdb', 'mqtt' | -| connection | json | Connection data in JSON. BACnet/IP example: {"host":"10.1.2.88"}, Modbus TCP example: {"host":"10.1.2.88", "port":502}, S7 example: {"host":"10.1.2.202", "port":102, "rack": 0, "slot": 2}, ControlLogix example: {"host":"10.1.2.88","port":44818,"processorslot":3} OPC UA example: {"url":"opc.tcp://10.1.2.5:49320/OPCUA/SimulationServer/"} | +| protocol | string | Protocol Type Supported: 'modbus-tcp', 'modbus-rtu', 'bacnet-ip', 's7', 'profibus', 'profinet', 'opc-ua', 'lora', 'simulation', 'controllogix', 'weather', 'mysql', 'sqlserver', 'postgresql', 'oracle', 'mongodb', 'influxdb', 'mqtt' | +| connection | json | Connection data in JSON. | | last_seen_datetime | string | Indicates the last time when the data source was seen in local timezone | | status | string | 'online' or 'offline' determined by last seen datetime | diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/manage-docs-versions.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index e12c3f3..0000000 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/_category_.json b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/_category_.json similarity index 67% rename from i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/_category_.json rename to i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/_category_.json index a8ffcc1..060e502 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/tutorial-extras/_category_.json +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/_category_.json @@ -1,5 +1,5 @@ { - "label": "Tutorial - Extras", + "label": "Tutorial", "position": 3, "link": { "type": "generated-index" diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/img/docsVersionDropdown.png b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/img/docsVersionDropdown.png similarity index 100% rename from i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/img/docsVersionDropdown.png rename to i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/img/docsVersionDropdown.png diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/img/localeDropdown.png b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/img/localeDropdown.png similarity index 100% rename from i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/img/localeDropdown.png rename to i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/img/localeDropdown.png diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/translate-your-site.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/translate-your-site.md similarity index 100% rename from i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial-extras/translate-your-site.md rename to i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/translate-your-site.md diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/use-online-demo.md b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/use-online-demo.md new file mode 100644 index 0000000..ba44710 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/tutorial/use-online-demo.md @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +--- + +# 使用在线演示 + +## 项目概要 + +建筑面积100万平方米，计量表179个，数据点284个，各种业态子系统18个，部署在阿里云容器服务 +Kubernetes集群，现场安装一台数据采集器用于数据采集和上传 + +## 参考手册 + +| 我想看 |怎么看 | +| :--- | :----- | +| 能源管理平台地址 | https://myems.cloud | +| 能源管理平台数据大屏地址 | 请咨询销售人员 | +| 空间能耗数据 | 空间数据>能耗分类分析 | +| 空间成本数据 | 空间数据>能耗成本分析 | +| 空间数据能耗分项分析 | 空间数据>能耗分项分析，空间选择‘一度城/办公楼’ | +| 各种业态数据演示方法 | 空间数据>能耗分类分析，空间选择‘一度城/ABC’,ABC指各种业态空间名称：市政府、办公楼、商场、酒店、博物馆、工厂、全国连锁门店、住宅小区、医院、大学、机场、火车站、养殖场、公寓、地铁站、体育场、公用动力、数据中心 | +| 租户数据 | 租户数据>能耗分类分析,空间选择‘一度城/商场/租区’
租户数据>租户账单，空间选择‘一度城/商场/租区’，点击‘提交’和‘导出’
租户数据>批量分析，空间选择‘一度城/商场/租区’，点‘提交’和‘导出’ | +| 单个计量表趋势数据 | 计量表数据>计量表趋势分析，空间选择‘一度城/调试空间’ | +| 总分表平衡分析 | 计量表数据>总分表平衡分析，空间选择‘一度城/调试空间’，搜索‘ahb01’ | +| 碳排放数据分析 | 计量表数据>计量表碳排放分析，空间选择‘一度城/调试空间’ | +| 制冷站效率 | 组合设备数据>效率分析，空间选择‘一度城/公用动力/制冷站’ | +| 数据中心效率 | 组合设备数据>效率分析，空间选择‘一度城/数据中心’ | +| 车间能耗数据 | 车间数据>能耗分类分析，空间选择‘一度城/工厂/生产区’ | +| 能耗排名演示方法 | 空间数据>能耗分类分析，空间选择‘一度城’，点击‘提交’后，在‘子空间数据’表格中点击‘电’‘自来水’等排序 | +| 能耗占比、碳排放等演示方法 | 空间数据>能耗分类分析，空间选择‘一度城’，点击‘提交’后，在结果第二行显示‘子空间分类占比’包含‘电’‘自来水’‘中水’等，鼠标停放到饼状图上显示数值 | +| 报表导出演示方法 | 空间数据>能耗分类分析 ，空间选择‘一度城’，点击‘提交’待结果出现后，点击‘导出’，使用Office软件打开下载的文件 | +| 配电系统实时数据 | 辅助系统>配电系统 | +| 能流图 | 辅助系统>能流图 | +| 高级报表 | 菜单：高级报表（TBD)，可结合高级报表邮件演示 | +| 故障检测与诊断FDD | 菜单：故障检测与诊断（TBD)，可结合报警邮件演示 | +| 连锁门店演示方法 | 门店数据>能耗分类分析，空间选择‘一度城/连锁门店/东区’ | +| 制冷站设备能耗数据 | 设备数据>能耗分类分析，空间选择‘一度城/公用动力/制冷站’ | +| 多级用户权限演示方法 | 使用连锁门店专用账号登录，空间数据>能耗分类分析，空间选择‘连锁门店’，其它业态空间不可见 | +| 调试空间 | 不参与能耗计算，已绑定所有系统中的对象，用于快速查看和故障分析 | +| 能源管理平台管理员登录地址 | 请咨询销售人员 | + + +## 申请账号 + +- 姓名: 张能远 +- 电话微信: (+86) 13011132526 +- QQ: 1853444168 +- Email: zny@myems.org + +![WeChat: 13011132526](/img/wechat_nengyuanzhang.jpg) +![QQ: 1853444168](/img/qq_nengyuanzhang.jpg) diff --git a/i18n/zh-Hans/docusaurus-theme-classic/footer.json b/i18n/zh-Hans/docusaurus-theme-classic/footer.json index 5437f63..239fe7a 100644 --- a/i18n/zh-Hans/docusaurus-theme-classic/footer.json +++ b/i18n/zh-Hans/docusaurus-theme-classic/footer.json @@ -47,6 +47,10 @@ "message": "安装", "description": "The label of footer link with label=Installation linking to /docs/category/installation" }, + "link.item.label.Tutorial": { + "message": "教程", + "description": "The label of footer link with label=Tutorial linking to /docs/category/tutorial" + }, "link.item.label.API": { "message": "API", "description": "The label of footer link with label=API linking to /docs/api" diff --git a/i18n/zh-Hans/docusaurus-theme-classic/navbar.json b/i18n/zh-Hans/docusaurus-theme-classic/navbar.json index 490168c..3ea8a70 100644 --- a/i18n/zh-Hans/docusaurus-theme-classic/navbar.json +++ b/i18n/zh-Hans/docusaurus-theme-classic/navbar.json @@ -23,6 +23,10 @@ "message": "安装", "description": "Navbar item with label Installation" }, + "item.label.Tutorial": { + "message": "教程", + "description": "Navbar item with label Tutorial" + }, "item.label.API": { "message": "API", "description": "Navbar item with label API" diff --git a/package.json b/package.json index 62441b1..15a20b5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "myems.io", - "version": "3.2.0", + "version": "4.2.0", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,16 +14,17 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "^2.4.0", - "@docusaurus/preset-classic": "^2.4.0", - "@mdx-js/react": "^1.6.22", - "clsx": "^1.2.1", - "prism-react-renderer": "^1.3.5", - "react": "^17.0.2", - "react-dom": "^17.0.2" + "@docusaurus/core": "3.1.1", + "@docusaurus/preset-classic": "3.1.1", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^18.0.0", + "react-dom": "^18.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^2.4.0" + "@docusaurus/module-type-aliases": "3.1.1", + "@docusaurus/types": "3.1.1" }, "browserslist": { "production": [ @@ -32,12 +33,12 @@ "not op_mini all" ], "development": [ - "last 1 chrome version", - "last 1 firefox version", - "last 1 safari version" + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" ] }, "engines": { - "node": ">=16.14" + "node": ">=18.0" } }