------------------------------------------
|                                        |
| The Intelligent Cocktail-making System |
|                                        |
|                README                  |
|                                        |
------------------------------------------

* The content of this public warehouse is only for course acceptance demonstration!
* Any form of copying is prohibited except for learning purposes!
*
* 本公开仓库内容仅供课程验收演示！
* 除学习目的，禁止任何形式的复制！
*
* System design - 系统设计 - B39VS




----------
Basic Info
基本信息

  HW -   *********   - ******** **
  XD -  ***********  - ***

  Project started at - 2023.02.06
  Txt last edited at - 2023.02.24

  IDE                - Microsoft Visual Studio Community 2022 (Version 17.4.4)
  Project dependency - .NET Framework 4.8

  Official Website   - https://icms.jamsg.cn
  Browse in Github   - https://github.com/Suntend/vsGUI
  Contact Author     - https://space.bilibili.com/340532672




------------------------------------------
Introduction of highlights and precautions
亮点介绍与注意事项

  + Adaptive page layout.
    自适应布局。

  + Multi-threading technology.(Cancel)
    多线程技术。（取消）

  + Multi-language switching.(EN/CN)
    多语言切换。（中文/英文）

  + Use Git for project collaboration and version control.
    使用Git进行项目协同与版本控制。

  + Use rigorous and proven state machine logic to minimize state chaos.
    使用严谨的且经过验证的状态机逻辑，最大程度防止状态混乱。

  +++ "Project-oriented" development, not "Curriculum-oriented" development.
      "面向 项目 开发"，而不是 "面向 课设 开发"。

  ! If the receiving end has already occupied a port,
    and the port is opened again in the program,
    the program will report an error
    如果接收端已经占用了一个端口，而在程序中再次打开该端口，程序会报错。




---------------------
Cocktails composition
鸡尾酒成份
  
  1 - Tequila
  2 - Rum
  3 - Vodka
  4 - Lemon Juice
  5 - Pineapple Juice
  6 - Blue Curacao

  Tequila Sunrise      - 144252 - 1 40ml, 4 20ml, 5 20ml.
  Blue Hawaii          - 245262 - 2 40ml, 5 20ml, 6 20ml.
  Long Island Iced Tea - 133342 - 1 30ml, 3 30ml, 4 20ml.

  Max 80ml




------------
Global Value
全局变量

  GlobalValue.globalFormNumber (int)
    Used to represent the current window ID.
      | 0 - Home Page           - W E L C O M E
      | 1 - Classic             - Classic cocktails
      | | 4 - Classic.1.info    - Tequila Sunrise
      | | 5 - Classic.2.info    - Blue Hawaii
      | | 6 - Classic.3.info    - Long Island Iced Tea
      | 2 - Design              - Design your own
      | | 7 - Design list       - Check your design
      | 3 - Settings            - Settings
      | 8 - Bartending / Finish *

  GlobalValue.globalLanguage (bool)
    Used to represent the current language.
      | false - EN  English  英文
      | true  - CN  Chinese  中文




--------------------
Serial communication
串口通信
  
  (GUI)
  Send "checkP"
  (Arduino)
  LED Green off
  LED Red off
  Check Press
    If true,  Send "y"
    If false, Send "n"

  (GUI)
  Send "144252"
  (Arduino)
  LED Red on
  Move...
  Move back to position 0
  Send "d"
  LED Red off
  LED Green on

  (Arduino)
  Send ("t" + (string)temperature(xxx.x))




---
Log
日志

  2023.02.06  UI - Main window.(Deleted)
              页面设计：主页面。（废案）

  2023.02.07  UI - Main / Classic.C1.C2.C3. / BF Form are finished.
              页面设计：完成了以上六个页面。

  2023.02.08  Serial communication: Send test, successful.
              串口通信：完成发送测试。

  2023.02.09  Serial communication: Receive test, successful.
              串口通信：完成接收测试。

  2023.02.13  First meet class.
              Serial communication: Complete the serial port status judgment and detection.
              第一次见面课。
              串口通信：完成串口状态判断与检测。

  2023.02.14  Serial communication: Improve the serial port loading mechanism.
              串口通信：完善串口加载机制。

  2023.02.15  Multi-language switch.
              中英文切换。

  2023.02.16  Multi-language switch.
              中英文切换。

  2023.02.17  Refactor the page layout and code logic of the Settings Form.
              Serial communication: Improve communication with Arduino.
              重构设置页的页面布局与业务逻辑。
              串口通信：完善与Arduino通信业务。

  2023.02.18  Two major businesses: the first part of "Classic Cocktails" and "Design your own":
              Completed all business logic and verified all serial communication processes.
              两大部分业务：“经典鸡尾酒”和“DIY鸡尾酒”的第一部分：
              完成了全部业务逻辑，验证了全部串口通信流程。

  2023.02.21  Added voice broadcast function.
              添加语音播报功能。

  2023.02.22  Two major businesses: the second part of "Classic Cocktails" and "Design your own":
              Completed all business logic and verified all serial communication processes.
              两大部分业务：“经典鸡尾酒”和“DIY鸡尾酒”的第二部分：
              完成了全部业务逻辑，验证了全部串口通信流程。

  2023.02.23  Add notes.
              添加注释。

  2023.02.24  Add notes.
              添加注释。




----
Note
笔记（这一部分不写双语了，懒了）

  * 页面切换

    1.在 Main form 中放置 panel 控件，使用 OpenForm(Form childForm, ...) 方法，原理是在主窗口的 panel 中显示子窗口。
      需要 childForm.FormBorderStyle = FormBorderStyle.None 来让子窗口没有"- □ ×"。

    2.在 Main form 中放置多个 panel 控件，每个 panel 内放置每个"页面"的控件，
      使用 panel.Visible = false/true 来控制显示哪个 panel，即显示哪个页面。
      需要让所有的 panel 在可视化编辑窗口中的位置重合来达到更好的效果。但是由于控件互相遮挡，会严重影响可视化编辑。
      建议 panel_1 > fill > 1的控件 > panel_2 > fill > 2的控件 > ... 一次成，否则后续调整布局或样式会很麻烦。

    3.方法2的降级版，把所有控件放在一个窗口中，遍历所有控件并设置可见性。

  * 语言切换

    定义静态类，用于存放字符串
    public static class LanguageStrings {
      public static string FM_E_labelTitle1 = "W E L C O M E";
      public static string FM_C_labelTitle1 = "欢 迎"; }
    
    定义全局变量，用于记录当前语言状态
    public static bool globalLanguage = false;  // false = EN, true = CN

    在需要调用相应文本时，先判断全局变量，再根据全局变量读取对应字符串。

    所以在仅有很少文本需要更改的情况下时，先判断全局变量，再根据其直接设置控件文本，也是一种简单的方法。

  * 串口通信

    string s = serial.ReadExisting();
    string s = serial.ReadLine();
    这两个方法需要记清使用情况！

    string SerialPort.ReadExisting()
      在编码的基础上，读取 SerialPort 对象的流和输入缓冲区中所有立即可用的字节。
      返回结果：SerialPort 对象的流和输入缓中区的内容。

    string SerialPort.ReadLine()
      一直读取到入缓冲区中的 SerialPort.NewLine 值。
      返回结果：输入缓中区中直到首次出现 SerialPort.NewLine 值的内容。

  * 变量监控

    在相应页面放置 timer 控件，设置 Enabled 和 Interval，添加触发 Tick 行为所要执行的方法。
    每隔 interval 毫秒，触发一次 Tick。

  * 串口通信 - 卡死但不是未响应

    串口注册事件received，每次收到消息时会调用该方法。
    该方法内可以写字符串处理，可以将获取内容写入变量，但 是 不 能 执 行 更 新 UI ！（如 label1.Text = "...";）