Skip to content

💧Water Mirror: AI-powered Water Quality Analysis by MPR_Model

License

Notifications You must be signed in to change notification settings

KageRyo/WaterMirror

Repository files navigation

WaterMirror 水之鏡

💧Water Mirror: AI-powered Water Quality Analysis

「水之鏡,山之屏」

水可以映照出山的形貌,透過 WaterMirror 可以輕鬆反映出各項水質資訊。

自行編譯

  1. 首先將 WaterMirror 及 MPR_Model 儲存庫分別 Clone 至您的環境。
git clone https://github.com/KageRyo/WaterMirror.git
git clone https://github.com/KageRyo/MPR_Model.git
  1. WaterMirror/src/config.json 中將 API 與 port 更換成您 MPR_Model 的伺服器位址。
    範例如下:
{
    "api_url": "https://192.168.0.1",
    "port": "8000"
}

請將 api_url 與 port 依據您的真實情況更改。

  1. MPR_Model 伺服器建立於您的裝置或雲端平臺。
  2. 安裝 WaterMirror 所需的函示庫。
cd WaterMirror
npm install
  1. 透過以下指令透過 Expo 開啟 WaterMirror,並進入「輸入資料」頁面,應於 5 秒內顯示「連線成功」提示訊息。
npx expo start

若未出現「連線成功」訊息,可能是您的 MPR_Model 未成功開啟或是權限不足。

支援類型

目前本程式支援以下水質資料:

  • 溶氧量 DO
  • 生物需氧量 BOD
  • 浮懸固體 SS
  • 氨氮 NH3-N
  • 導電度 EC

請注意

  • 此 README.md 文件皆為預設您將 WaterMirror 搭配 MPR_Model 使用。
  • 當然,您也可以在不違反 Apache License 2.0 的前提下自由修改。
  • WaterMirror 將會在您初次使用「輸入資料」功能時向您請求權限,若拒絕權限將無法使用「上傳水質資料檔案」之功能。
  • 「上傳水質資料檔案」功能目前僅限於CSV格式,上傳時請遵循以下格式:
DO BOD NH3N EC SS
DO數值 BOD數值 NH3N數值 EC數值 SS數值
...

語言支援

WaterMirror 支援以下語言:

  • 正體中文
  • 簡體中文
  • English
  • 日本語
  • 歡迎貢獻 :D

貢獻

歡迎貢獻! 如果您發現任何錯誤或有改進建議,歡迎提出 Issues 或 Pull Requests。

LICENSE

本程式採用 Apache License 2.0 授權 - 有關詳細信息,請參閱 LICENSE 文件。
有任何疑問請洽 [email protected]

${{\color{orange}{\textsf{本作品為 張健勳 與 吳國維 用於「國立臺中科技大學智慧生產工程系」畢業專題之作品,其著作權由兩人共同擁有。}}}}$
${{\color{yellow}{\textsf{特別感謝「國立臺中科技大學資訊與流通學院」蔡文宗 教授指導。}}}}$