系统管理主控台使用说明

基本设定

系统管理主控台是一个网页介面,当您启动 MCS Lite 应用程式同时会看到管理主控台介面,其主要目的是为了方便您自行维护 MCS Lite 的系统设定,省去手动修改设定档的时间。在第一次使用 MCS Lite 时,必须先注册一个管理者帐号,之后皆必须透过此管理者帐号登入主控台,启动服务或修改相关设定。

若您没有看到注册画面,请直接在浏览器输入 http://localhost:3002/admin/signup,完成注册。

系统管理主控台提供有下面几个功能:

  1. 开关服务:启动与停止 MCS Lite 物联网平台,当服务停止时,网路上的装置则无法连线到 MCS Lite。
  2. 连线介面列表:也就是 MCS Lite 所运行的电脑的网路位址 (IP) 以及 MCS Lite 服务所绑定的连接埠 (port),在同个网路内的使用者与装置则可连线到 IP:port 来使用 MCS Lite 服务。当 MCS Lite 所运行的电脑有不只一张网路卡或是连接上不只一个网路时,您将会看到这些网路位址 (IP) 一一的被列出。
  3. 系统管理:修改资料库 (database),使用者身份验证 (OAuth),网路应用接口 (web APIs) 的服务设定,以下为系统设定档的详细说明,在一般的环境下,建议使用预设值,无须特意更改。
档案名称 说明
db.json 此为 nedb 连线相关设定,一般情况皆维持预设即可。
oauth.json 此为 OAuth service 相关设定。在尚无 auto scaling 与 distributed deployment 的需求之前,OAuth service 的 host 与 port(预设 port 为 3000)设定,与 RESTful service 相同即可。另外注意,如果为 production 环境,建议 JWT_SECRET 不要使用预设的 "superSecret"。
rest.json 此为 RESTful service 相关设定。设定 MCS Lite API 所要连线的 host 与 port(预设 port 为 3000),如果有更改请务必通知使用者。另外注意,如果为 production 环境, secretKey, prototypeKey, deviceKey, session 请务必改成另外的内容。
stream.json 此为 streaming service 的参数设定。
wot.json 此为 WebSocket 的所要连线的 host 与 port(预设 port 为 8000)

更新上述的檔案之後,請務必重新啟動 MCS Lite 服務以載入最新的設定。

资料库管理

NeDB

除了系统设定,资料的维护也是管理者关注的功能之一,MCS Lite 采用的 NeDB 是一个轻量的 JavaScript 资料库,所有的资料是以 JSON 档案的格式储存,不需额外安装任何资料库软件。新版同时支援 MySQL 资料库,详细操作步骤请看下节介绍。

预设的 NeDB 档案位于 mcs-lite-app/db 资料夹下。

档案名称 说明
datachannels.json 储存所建立的资料通道。当通道被删除时,资料依然保存,但 isActive 变成 false
datapoints.json 储存所上传的资料点。
devices.json 储存所建立的测试装置。当装置被删除时,资料依然保存,但 isActive 变成 false
prototypes.json 儲存所建立的產品原型。當原型被刪除時,資料依然保存,但 isActive 變成 false
unittypes.json 数值型态的资料通道所要使用的“单位”。系统预设已有 53 个最常用的单位,您也可以在创建资料通道时,自行建立新的度量单位。
users.json 储存系统上所有的使用者资讯。

更新上述的资料库档案之后,请务必重新启动 MCS Lite 服务以载入最新的资料。

由于目前产品原型 (Prototype),测试装置 (Test Device),资料通道 (Data Channel),上传资料 (Data Channel) 与使用者帐户 (User Account) 等资料,都是以 JSON 格式储存在 mcs-lite-app/db 资料夹下,若要進行备份资料只要把这个资料夹的档案备份好即可。

MySQL

MCS Lite 另外支援使用 MySQL 资料库来存取资料。

如果您已经使用 MySQL 作为主要的资料库,并希望将 MCS Lite 的资料也整合到 MySQL 当中用以取代预设的 NeDB,请按照下列步骤来完成资料库表格与数据的搬迁:

  1. 请先关闭 MCS Lite 应用程序。
  2. 更改 configs/db.json 中的资料库设定。请参考栏位说明与范例:

    • db: 资料库类型,这里使用的是 MySQL,不需更改。
    • host: MCS Lite 连线的资料库的主机名称或 IP 位址。
    • port: MCS Lite 连线的资料库的连接埠。
    • username: MCS Lite 连线的资料库的帐号。
    • password: MCS Lite 连线的资料库的密码。
    • database: 您为 MCS Lite 建立的资料库名称。
    • dialect: 资料库类型,这里使用的是 MySQL,不需更改。

      {
        "db": "mysql",
           "host": "127.0.0.1",
           "port": 3306,
           "username": "root",
           "password": "1234",
           "database": "mcslite",
           "dialect": "mysql",
           "logging": true
      }
      
  3. 完成上个步骤后,请在 MCS Lite 应用程式所在的目录下,使用命令提式视窗透过 Node.js 执行 migration.js 脚本,在指定的 MySQL 资料库中建立对应的表格,栏位与数据。看到 Migration success 提示即表示数据搬迁完成。

     $ node ./mcs-lite-app/migration.js
    
     Migration start...
     ******
     Migration success.
    
  4. 此时,您已经可以开启 MCS Lite 应用程式,使用其完整的功能。并可以在 MySQL 资料库中看到先前已经存入 NeDB 的与之后产生的数据。

如果您在操作的过程中遇到任何问题,可以先使用原有的 SQL client 连线到 MCS Lite MySQL 资料库,确保连线以及数据的正确性。

使用者管理

使用者管理提供了在主控台上新增,修改,删除与查询 MCS Lite 使用者的功能。您可以单笔或是透过汇入 CSV 档案的方式批次新增使用者,但若您的 CSV 档案中有格式错误或是重复的使用者等问题,则会造成整笔资料汇入失败,请详细检查您的使用者汇入清单。使用者汇入清单的格式如下:

昵称,信箱帐号,密码

例如

a123,a123@abc.com,11111111
a124,a124@abc.com,11111111
a125,a125@abc.com,11111111
a126,a126@abc.com,11111111
a127,a127@abc.com,11111111

备注:若发现管理主控台的资料与物联网平台不一致时,请重新启动整个 MCS Lite 应用程式,此乃 NeDB 中的资料在多个程式间会无法即时同步的问题。若您使用的为 MySQL 资料库,则不会有此问题。

资料管理

资料管理让管理者可以在主控台上删除所有使用者新增的数据。资料库中的资料会完全被删除,除了预设的资料通道单位与管理者帐号。

备注:若发现管理主控台的资料与物联网平台不一致时,请重新启动整个 MCS Lite 应用程式,此乃 NeDB 中的资料在多个程式间会无法即时同步的问题。若您使用的为 MySQL 资料库,则不会有此问题。

关闭 MCS Lite 应用程序

MCS Lite 应用程序可分为两个部分,物联网平台与管理主控台。

物联网平台主要是让使用者能透过网页介面建立产品原型,操作装置并视觉化数据,可透过在管理主控台上的开关开启与关闭。

管理主控台则是让管理者可以管理使用者数据与物联网平台的设定。当您从系统常驻图示的选单中关闭 MCS Lite 时,整个 MCS Lite 应用程式都会被关闭,包括物联网平台服务。

results matching ""

    No results matching ""