Update mdbook for 0.3.1

pmnxis · Nov 11, 2023 · 06fb086 · 06fb086
1 parent 8253646
commit 06fb086
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,11 @@ cargo build --features hw_mini_0v4 --no-default-features --release
 ```
 
 ### Target hardware image
-![Actual BillMock PCB 0v3](https://billmock.gpark.biz/images/BillMockPCB_0v4.jpg)
+![Actual BillMock PCB 0v5](https://billmock.gpark.biz/images/BillMockPCB_0v5_mini.jpg)
+The hardware revision currently adopted for final mass production is 0.5-MINI, and the software development is also progressing according to this version.
+
+![Actual BillMock PCB 0v4](https://billmock.gpark.biz/images/BillMockPCB_0v4.jpg)
+Old revisions.
 
 ### Hardware design
 BillMock hardware schematic repository (only pdf)

diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -10,6 +10,8 @@ SPDX-License-Identifier: MIT OR Apache-2.0
 - [DIP Switch Configuration](./dip_switch.md)
 - [Application Logic](./application.md)
     - [`DisplayRom` feature](./feature_disp_rom.md)
+    - [`DisplayHwInfo` feature](./feature_disp_hw_info.md)
+    - [`Counter Reset` feature](./feature_counter_reset.md)
 - [Machine installation](./installation.md)
 - [Hardware and pin-map](./port_overview.md)
     - [BillMock Mini (Rectangular)](./port_04_mini_overview.md)

diff --git a/book/src/dip_switch.md b/book/src/dip_switch.md
@@ -81,5 +81,7 @@ of a device that has under the maintenance in the field engineer.
 - `11`: DisplayRom
     > ![display rom screen](https://billmock.gpark.biz/images/dip_switch_rom_disp_enus.png)
     > - It displays information about BillMock's firmware, the card terminal's TID, and accumulated card and bill (coin) counts. It can be used as an alternative to a magnetic coin meter.
+    > - Upon exiting this mode, [DisplayHwInfo](./feature_disp_hw_info.md) will display hardware information.
+    > - When the SVC button is held for more than 10 seconds, the counts are reset to 0 through the [Counter Reset](./feature_counter_reset.md) feature.
     > - If the connected card terminal's TID changes, the accumulated card count will be reset to 0.
-    > For detailed information, please refer to [DisplayRom Detailed Information](./feature_disp_rom.md).\
+    > For detailed information, please refer to [DisplayRom Detailed Information](./feature_disp_rom.md).
diff --git a/book/src/feature_counter_reset.md b/book/src/feature_counter_reset.md
@@ -0,0 +1,16 @@
+<!--
+SPDX-FileCopyrightText: © 2023 Jinwoo Park ([email protected])
+
+SPDX-License-Identifier: MIT OR Apache-2.0
+-->
+
+# Counter Reset
+
+![display counter reset screen](https://billmock.gpark.biz/images/dip_switch_disp_reset_rom_enus.png)
+
+- The warning message appears for 10 seconds, and the ROM contents are already initialized when the warning message is displayed.
+
+- The counts displayed in [DispRom](./feature_disp_rom.md) for `P1 Card`, `P2 Card`, `P1 Coin`, `P2 Coin` are reset to 0, but information such as boot count and uptime remains unaffected.
+
+- This feature is available starting from firmware version `0.3.1` and hardware version `0.5` or `Mini 0.5`. The SVC button on hardware version `0.5` or `Mini 0.5` must be held for more than 10 seconds to activate this feature.
+  > ![svc button](https://billmock.gpark.biz/images/svc_button.jpg)
diff --git a/book/src/feature_disp_hw_info.md b/book/src/feature_disp_hw_info.md
@@ -0,0 +1,34 @@
+<!--
+SPDX-FileCopyrightText: © 2023 Jinwoo Park ([email protected])
+
+SPDX-License-Identifier: MIT OR Apache-2.0
+-->
+
+# DisplayRom
+
+![display hw info screen](https://billmock.gpark.biz/images/dip_switch_disp_hw_info_enus.png)
+
+- To view such information during normal operation, please check and configure the [DIP SWITCH execution mode](./dip_switch.md#application-mode-dip-switch-configuration).
+
+- The information will appear for 10 seconds, divided into four lines, displaying details about ROM and the program:
+    - Line 1 : `{Boot Cnt}   Ver:{x.y.z}`
+        - **Boot Cnt**: Number of boots for the BillMock hardware. It increments by 1 each time the device is powered off and on.
+        - **x.y.z**: Firmware version of the BillMock program [billmock-app-rs](https://github.com/pmnxis/billmock-app-rs).
+
+    - Line 2 : `S/N : {Serial Number}`
+        - **Serial Number**: Unique serial number assigned to the BillMock hardware during mass production.
+
+    - Line 3 : `TID : {TID}`
+        - **TID**: The unique Terminal ID of the card terminal. It is a value set in the card terminal when connecting it to the payment gateway (PG). It is also a unique identifier in the PG's system.
+
+    - Line 4 : `Uptime : {Uptime} Mins`
+        - **Uptime**: Represents the duration the BillMock hardware has been powered on, measured in minutes.
+
+- This feature is available from firmware version `0.2.1` and hardware version `0.4` or `Mini 0.4` onwards. It is not supported on earlier hardware versions.
+
+- From hardware version 0.5 or Mini 0.5 onwards, you can use the SVC button by pressing 2 seconds.
+  > ![svc button](https://billmock.gpark.biz/images/svc_button.jpg)
+
+- This feature is available starting from firmware version `0.2.0` and hardware `0.4` or `Mini 0.4` and later. It is not available for previous hardware versions.
+
+- When exiting [DispRom](./feature_disp_rom.md) through the DIP switch on hardware version `0.4` or `Mini 0.4` and above, the display is also shown.
diff --git a/book/src/feature_disp_rom.md b/book/src/feature_disp_rom.md
@@ -32,3 +32,6 @@ SPDX-License-Identifier: MIT OR Apache-2.0
 - All count numbers are displayed in 6 digits (0 ~ 999,999). If the count exceeds 1,000,000, it will be displayed as 000,000, and the next count after that will increment normally, such as 000,001.
 
 - This feature is available starting from firmware version `0.2.0` and hardware `0.4` or `Mini 0.4` and later. It is not available for previous hardware versions.
+
+- From hardware version 0.5 or Mini 0.5 onwards, you can use the SVC button by pressing it briefly.
+  > ![svc button](https://billmock.gpark.biz/images/svc_button.jpg)
diff --git a/book/src/overview.md b/book/src/overview.md
@@ -13,8 +13,11 @@ SPDX-License-Identifier: MIT OR Apache-2.0
 To configure it for desired settings on-site, "Billmock" allows preconfigured I/O remapping adjustments through DIP switches. In terms of wiring, it is installed between the HOST GAME PCB and the bill acceptor device.
 
 ## Hardware
-![Actual BillMock PCB 0v3](https://billmock.gpark.biz/images/BillMockPCB_0v4.jpg)
-There are currently three hardware revisions available: 0.2, 0.3, and 0.4. The development is focused on compatibility with versions 0.3 and 0.4, which are the ones actively in use. Detailed hardware schematics are here
+![Actual BillMock PCB 0v5](https://billmock.gpark.biz/images/BillMockPCB_0v5_mini.jpg)
+The hardware revision currently adopted for final mass production is 0.5-MINI, and the software development is also progressing according to this version.
+
+![Actual BillMock PCB 0v4](https://billmock.gpark.biz/images/BillMockPCB_0v4.jpg)
+There are three previous hardware revisions available: 0.2, 0.3, and 0.4. The development is focused on compatibility with versions 0.3 and 0.4, which are the ones actively in use. Detailed hardware schematics are here
 [BillMock-HW-RELEASE](https://github.com/pmnxis/BillMock-HW-RELEASE)
 
 ## Application