From 803eb88d0d0fd63e15bd336e97a59eedd78415a3 Mon Sep 17 00:00:00 2001 From: iambossTC Date: Tue, 19 Nov 2024 07:36:37 +0800 Subject: [PATCH] add doc --- Doc/example/appsettings.Sub-1.json | 63 ++++++++++++++++++++ Doc/example/appsettings.Sub-2.json | 63 ++++++++++++++++++++ Doc/startup.zh-Hant.md | 92 ++++++++++++++++++++++++++++++ 3 files changed, 218 insertions(+) create mode 100644 Doc/example/appsettings.Sub-1.json create mode 100644 Doc/example/appsettings.Sub-2.json create mode 100644 Doc/startup.zh-Hant.md diff --git a/Doc/example/appsettings.Sub-1.json b/Doc/example/appsettings.Sub-1.json new file mode 100644 index 0000000..0bd4b08 --- /dev/null +++ b/Doc/example/appsettings.Sub-1.json @@ -0,0 +1,63 @@ +{ + "DetailedErrors": true, + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "Kestrel": { + "Endpoints": { + "Http": { + "Url": "http://localhost:3301" + }, + //"Https": { + // "Url": "https://xxxx.xxxx.xxxx:4301", + // "Certificate": { + // "Subject": "xxxx.xxxx.xxxx", + // "Store": "WebHosting", + // "AllowInvalid": true + // } + //}, + "Grpc": { + "Protocols": "Http2", + "Url": "http://localhost:5301" + } + } + }, + "HiNC": { + "CacheDbId": "Sub-1", + "DatabasePort": 28001, + "AdminDirectory": "../HiNC-Root", + "OptCoreNum": 0, + "Users": [ + { + "Name": "admin", + "Pw": "00000", + "Role": "Admin", + "IsFixedUser": true + }, + { + "Name": "worker", + "Pw": "111111", + "Role": "Collaborator", + "IsFixedUser": false + }, + { + "Name": "guest", + "Pw": "22222", + "Role": "Guest", + "IsFixedUser": false + } + ] + }, + "LicenseManager": { + //Available Command: "DoNothing","AutoLicenseUpdate","GetC2V","GenV2C","ApplyV2C","WriteInfo" + "Command": "AutoLicenseUpdate", + "Server": { + "URI": "superhightech.com.tw", + "Port": 20201, + "ReceiveTimeout": 200 + } + } +} diff --git a/Doc/example/appsettings.Sub-2.json b/Doc/example/appsettings.Sub-2.json new file mode 100644 index 0000000..ab66968 --- /dev/null +++ b/Doc/example/appsettings.Sub-2.json @@ -0,0 +1,63 @@ +{ + "DetailedErrors": true, + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "Kestrel": { + "Endpoints": { + "Http": { + "Url": "http://localhost:3302" + }, + //"Https": { + // "Url": "https://xxxx.xxxx.xxxx:4302", + // "Certificate": { + // "Subject": "xxxx.xxxx.xxxx", + // "Store": "WebHosting", + // "AllowInvalid": true + // } + //}, + "Grpc": { + "Protocols": "Http2", + "Url": "http://localhost:5302" + } + } + }, + "HiNC": { + "CacheDbId": "Sub-2", + "DatabasePort": 28002, + "AdminDirectory": "../HiNC-Root", + "OptCoreNum": 0, + "Users": [ + { + "Name": "admin", + "Pw": "00000", + "Role": "Admin", + "IsFixedUser": true + }, + { + "Name": "worker", + "Pw": "111111", + "Role": "Collaborator", + "IsFixedUser": false + }, + { + "Name": "guest", + "Pw": "22222", + "Role": "Guest", + "IsFixedUser": false + } + ] + }, + "LicenseManager": { + //Available Command: "DoNothing","AutoLicenseUpdate","GetC2V","GenV2C","ApplyV2C","WriteInfo" + "Command": "AutoLicenseUpdate", + "Server": { + "URI": "superhightech.com.tw", + "Port": 20201, + "ReceiveTimeout": 200 + } + } +} diff --git a/Doc/startup.zh-Hant.md b/Doc/startup.zh-Hant.md new file mode 100644 index 0000000..00c246c --- /dev/null +++ b/Doc/startup.zh-Hant.md @@ -0,0 +1,92 @@ +--- +Key: startup +--- +# 軟體啟動與資源 + +## 啟用HiNC於Windows系統 + +1. 至官網下載HiNC安裝包並解壓縮： + + https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-Manager-Win/archive/master.zip + +2. 插上HiNC授權鎖，執行資料夾內`HiNC-loop-with-update.bat`。 + + 該腳本會於每次執行下載或更新HiNC軟件。 + + 首次執行過後，將產生HiNC子資料夾。該資料夾內可找到`appsettings.json` 檔案，該檔案用來設定HiNC組態。 + + `appsettings.json` 檔案中可以設定網頁位置及使用者帳號密碼等組態。以下使用預設值說明。 + + 依`appsettings.json`預設值，每次HiNC啟動時，會連結授權伺服器檢查是否有授權更新。授權更新的預設設置如下，如果要取消自動授權鎖更新，可將`AutoLicenseUpdate`改為`DoNothing`。 + + ``` + "LicenseManager": { + //Available Command: "DoNothing","AutoLicenseUpdate","GetC2V","GenV2C","ApplyV2C","WriteInfo" + "Command": "AutoLicenseUpdate", + "Server": { + "URI": "http://superhightech.com.tw:20201", + } + } + ``` + + `appsettings.json` 檔案中預設創建 `../HiNC-Root` 作為資料與專案的存放位置。 + +:::{.alert .alert-info} +**疑難排解** + +如果啟動HiNC時，反覆出現錯誤長訊息，可能是作業系統太舊或久未更新，請安裝 `Microsoft Visual C++`。 +::: + +3. 打開網頁瀏覽器，進入預設網址： + http://localhost:4330 + +4. 輸入預設使用者帳密即可登入使用。 + 帳號： `admin` + 密碼： `00000` + + +## 單機多站 + +如果有開通多程序授權，可以使用不同 `appsettings.<組態名稱>.json` 伺服多個程序。每個程序可同時執行不同的專案。 + +同個主機中各程序`appsettings.<組態名稱>.json`中以下項目不可相同： + +- `Endpoints` +- `DatabasePort` +- `CacheDbId` + +在命令列執行以下指令啟動指定程序： + +`dotnet run HiNcServer.dll --environment <組態名稱>` + + +!!! success "組態範例" + + - [appsettings.Sub-1.json](example/appsettings.Sub-1.json) + - [appsettings.Sub-2.json](example/appsettings.Sub-2.json) + + +## 以授權器作第二層伺服(多主機) + +如果有開通多主機授權，下載並解壓縮[DelegateAuthorization.zip](https://superhightech.com.tw/download2/DelegateAuthorization.zip)，並根據裡面的兩個pdf說明檔操作，分別設定授權伺服器與被授權客戶端。 + +## 教學視頻 + +### 建立機構與刀具 + +- https://superhightech.com.tw/download2/機構建構器建立虛擬機床.mp4 +- https://superhightech.com.tw/download2/建立臥式機床.mp4 +- https://superhightech.com.tw/download2/刀具建立-銑削與刀把.mp4 + +### 專案設定與執行 + +1. https://superhightech.com.tw/download2/範例專案設置說明.mp4 +2. https://superhightech.com.tw/download2/範例專案仿真說明.mp4 +3. https://superhightech.com.tw/download2/建立專案.mp4 + + +!!! success "範例專案下載" + + - https://superhightech-gitea.webredirect.org/HiNC-Deploy/DemoStandardPath/archive/master.zip + +