User Interface
PyQt6-based graphical interface for game interaction and configuration.
Related Components: Game Engine | Hardware Control | Vision System | Communication
Overview
The User Interface component is responsible for:
- Game Visualization - Display board state and piece positions
- User Interaction - Handle move input and game control
- Settings Management - Configure system parameters
- Visual Feedback - Show status, timers, and notifications
- Navigation - Switch between game, settings, and home screens
Game Flow
Home Page (Game Mode Selection)
↓
Game Page (Play Chess)
├─ Human Move Detection
├─ Chess Engine Move Generation
└─ Board Update/Display
↓
End Game Dialog (Result)
├─ Play Again → Home Page
└─ Exit → Application Close
Navigation Structure
Main Application
├── Home Page
│ ├── Difficulty Choice
│ ├── Color Choice
│ └── Settings Button
├── Game Page
│ ├── Chess Board
│ ├── Move History
│ ├── Chess Clocks
│ ├── Settings Button (Context)
│ ├── Undo Button
│ └── Resign Button
├── Settings Page
│ ├── Core XY Control
│ ├── Camera Calibration and Control
│ └── Magnet Control
└── Dialogs
├── Game Over (Win/Draw/Loss)
├── Invalid Move Warning
├── Promotion Selection
└── Waiting Indicator
Key Features
- Responsive Design - Adapts to different screen sizes
- Drag & Drop Moves - Click pieces and drag to destination
- Keyboard Shortcuts - Quick access to common functions
- Undo/Redo - Review and navigate game history
- Settings Persistence - Save preferences between sessions
- Error Messages - Clear feedback for user actions
- Accessible Controls - Large buttons and readable fonts
Styling
The interface uses Material Design theme with custom stylesheet (cnchess_theme.qss) for consistent visual appearance.
Usage Example
from main_ui import MainWindow
from PyQt6.QtWidgets import QApplication
import sys
# Create application
app = QApplication(sys.argv)
# Create main window
window = MainWindow()
window.show()
# Run application
sys.exit(app.exec())
Dependencies
PyQt6- GUI frameworkPyQt6.QtCore- Core Qt functionalityPyQt6.QtGui- Graphics and iconsPyQt6.QtWidgets- Widget components- Custom stylesheets (QSS files)
Module Documentation
Main UI Application
The primary application window and navigation system.
File for the main window of the application, which contains the home page, the game and the settings page. The main window is responsible for switching between the different pages and managing the overall layout of the application using a QStackedWidget.
MainUI
Bases: QMainWindow
Source code in python/ui/main_ui.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | |
__del__()
Destructor to ensure cleanup on object destruction.
Return
None
Source code in python/ui/main_ui.py
208 209 210 211 212 213 214 215 216 217 218 219 220 | |
__init__(chess_model, control, communication, cam)
Initialize the main application window with pages and signal connections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chess_model
|
Model instance for chess game state management. |
required | |
control
|
Control instance for game control operations. |
required | |
communication
|
Communication instance for hardware communication. |
required | |
cam
|
Camera instance for board capture and analysis. |
required |
Return
None
Source code in python/ui/main_ui.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | |
back_button_settings_page()
Return to the previous page (game or home) from the settings page.
Return
None
Source code in python/ui/main_ui.py
142 143 144 145 146 147 148 149 150 151 152 153 154 | |
cleanup_all_threads()
Terminate all worker threads and release resources before closing.
Return
None
Source code in python/ui/main_ui.py
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | |
closeEvent(event)
Handle application window close event and perform cleanup.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
QCloseEvent instance triggered by window closure. |
required |
Return
None
Source code in python/ui/main_ui.py
156 157 158 159 160 161 162 163 164 165 166 167 | |
keyPressEvent(event)
Handle key presses for fullscreen escape.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
QKeyEvent instance. |
required |
Return
None
Source code in python/ui/main_ui.py
89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
switch_to_game_page()
Switch the main window display to the game page and initialize the board.
Return
None
Source code in python/ui/main_ui.py
117 118 119 120 121 122 123 124 125 126 127 128 | |
switch_to_home_page()
Switch the main window display to the home page and reset the game board.
Return
None
Source code in python/ui/main_ui.py
104 105 106 107 108 109 110 111 112 113 114 115 | |
switch_to_settings_page()
Switch the main window display to the settings page.
Return
None
Source code in python/ui/main_ui.py
130 131 132 133 134 135 136 137 138 139 140 | |
toggle_fullscreen()
Toggle fullscreen mode for the main window.
Return
None
Source code in python/ui/main_ui.py
75 76 77 78 79 80 81 82 83 84 85 86 87 | |
Game Page
The main game interface where chess is played.
File containing the game page of the application, which is where the user plays the chess game. It contains the chess board, move history, and buttons to undo moves, resign, and start a new game.
AspectRatioWidget
Bases: QWidget
Source code in python/ui/game_page.py
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 | |
__init__(board_widget, parent=None)
Create a container that keeps the board widget square.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
board_widget
|
QWidget
|
The board widget to constrain to a square. |
required |
parent
|
QWidget | None
|
Optional parent widget. |
None
|
Return
None
Source code in python/ui/game_page.py
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 | |
resizeEvent(event)
Resize the child board widget to keep a square aspect ratio.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
Qt resize event. |
required |
Return
None
Source code in python/ui/game_page.py
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 | |
ChessBoardWidget
Bases: QWidget
Source code in python/ui/game_page.py
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 | |
__init__()
Create the chess board widget.
Builds an 8x8 grid of clickable squares, loads piece images, and prepares an overlay to display robot trajectories.
Return
None
Source code in python/ui/game_page.py
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 | |
clear_trajectory()
Remove the trajectory overlay. Args: None Return: None
Source code in python/ui/game_page.py
1518 1519 1520 1521 1522 1523 1524 1525 | |
draw_piece(button, piece_char)
Draw the piece on the given square button. Args: button (QPushButton): The button representing the square to draw on. piece_char (str): Character representing the piece to draw (e.g., 'K') Return: None
Source code in python/ui/game_page.py
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 | |
fen_to_board_array(fen)
Convert FEN string to 8x8 board array. Args: fen (str): FEN string representing the board state. Return: list[list[str]]: 2D list representing the board, where each element is a piece character or '_' for empty squares. The orientation is adjusted based on player color.
Source code in python/ui/game_page.py
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 | |
handle_square_click(row, col)
Handle click events on the squares. Emit signal to controller with the clicked square's coordinates.
Args:
row (int): Row index of the clicked square.
col (int): Column index of
Return:
None
Source code in python/ui/game_page.py
1468 1469 1470 1471 1472 1473 1474 1475 1476 | |
init_board()
Create and layout all square buttons for the board.
Return
None
Source code in python/ui/game_page.py
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 | |
load_piece_images()
Load piece images from assets directory.
Args:
None
Return:
None
Source code in python/ui/game_page.py
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 | |
paint_board()
Paints the squares' board the right color
Args:
None
Return:
None
Source code in python/ui/game_page.py
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 | |
resizeEvent(event)
Handle widget resize by resizing the trajectory overlay. Args: event: Qt resize event. Return: None
Source code in python/ui/game_page.py
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 | |
set_player_color(player_color)
Set player color and update orientation-dependent behavior. Args: player_color: Player color (typically chess.WHITE or chess.BLACK). Return: None
Source code in python/ui/game_page.py
1527 1528 1529 1530 1531 1532 1533 1534 | |
set_trajectory(path)
Show the gantry trajectory on the board. Args: path (list[Command]): List of Command objects representing the move trajectory. Return: None
Source code in python/ui/game_page.py
1509 1510 1511 1512 1513 1514 1515 1516 | |
update_board(board_state, resize=False)
Update the board display based on the new board state (FEN string). Args: board_state (str): FEN string representing the current board state. resize (bool): True if this update is due to a resize event, False for normal Return: None
Source code in python/ui/game_page.py
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 | |
update_square_highlight(row, col)
Highlight the selected square and possible move squares. Args: row (int): Row index of the square to highlight. col (int): Column index of the square to highlight. Return: None
Source code in python/ui/game_page.py
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 | |
ChessClock
Bases: QWidget
Chess clock widget with automatic countdown timer.
Source code in python/ui/game_page.py
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | |
__init__(initial_time, clock_label, color='white')
Initialize chess clock with initial time and display label.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
initial_time
|
int
|
Initial time in seconds. |
required |
clock_label
|
QLabel
|
Label widget to display time. |
required |
color
|
str
|
Clock color identification ("white" or "black"). |
'white'
|
Return
None
Source code in python/ui/game_page.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
reset_clock()
Reset clock to initial time.
Return
None
Source code in python/ui/game_page.py
209 210 211 212 213 214 215 216 217 218 219 220 | |
set_initial_time(new_initial_time)
Set a new initial time for the clock and reset it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
new_initial_time
|
int
|
New initial time in seconds. |
required |
Source code in python/ui/game_page.py
234 235 236 237 238 239 240 241 | |
stop()
Stop the timer.
Return
None
Source code in python/ui/game_page.py
222 223 224 225 226 227 228 229 230 231 232 | |
tick()
Decrement time and emit signal when time runs out.
Return
None
Source code in python/ui/game_page.py
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | |
toggle_timer()
Start or stop the chess clock timer.
Return
None
Source code in python/ui/game_page.py
195 196 197 198 199 200 201 202 203 204 205 206 207 | |
update_display()
Update clock display with current time.
Return
None
Source code in python/ui/game_page.py
183 184 185 186 187 188 189 190 191 192 193 | |
GamePageController
Bases: QObject
Controller for game page interactions and move execution.
Source code in python/ui/game_page.py
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 | |
__init__(chess_game, view=None, control=None, communication=None, cam=None)
Initialize game page controller with chess game and hardware instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chess_game
|
Chess game model instance. |
required | |
view
|
GameView
|
Game view widget. |
None
|
control
|
Control instance for pathfinding. |
None
|
|
communication
|
Communication instance for device control. |
None
|
|
cam
|
Camera instance for board detection. |
None
|
Return
None
Source code in python/ui/game_page.py
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | |
check_piece_selected(row, col)
Select a piece (if valid) and highlight its legal destination squares.
If the clicked square contains one of the current player's pieces, the piece is selected and the view highlights all legal moves from that square.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
row
|
int
|
Board row coordinate (0-7). |
required |
col
|
int
|
Board column coordinate (0-7). |
required |
Return
None
Source code in python/ui/game_page.py
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 | |
clear_list()
Clear all entries from the move list widget.
Return
None
Source code in python/ui/game_page.py
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 | |
computer_move()
Execute computer's best move on the board and update UI.
Return
None
Source code in python/ui/game_page.py
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 | |
coordinate_to_square(row, col)
Convert board coordinates to chess square notation (e.g., (0,0) -> 'a8').
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
row
|
int
|
Board row coordinate (0-7). |
required |
col
|
int
|
Board column coordinate (0-7). |
required |
Return: str: Chess square in algebraic notation corresponding to the given coordinates.
Source code in python/ui/game_page.py
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 | |
get_screen_coordinates_from_square(square_widget, screen, promotion_dialog)
Calculate screen coordinates to position the promotion dialog anchored to the given square widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
square_widget
|
QWidget
|
The widget representing the chess square. |
required |
screen
|
QScreen
|
The primary screen for geometry calculations. |
required |
promotion_dialog
|
QDialog
|
The promotion dialog to be positioned. |
required |
Return
(int, int): The (x, y) screen coordinates to position the promotion dialog.
Source code in python/ui/game_page.py
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 | |
handle_game_outcome()
Check game outcome and show appropriate end-game dialog.
Return
str: Game outcome ("white", "black", "draw", or None).
Source code in python/ui/game_page.py
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 | |
handle_square_click(row, col)
Handle click events on the squares. Handles move selection and execution logic.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
row
|
int
|
Row index of the clicked square. |
required |
col
|
int
|
Column index of the clicked square. |
required |
Return: None
Source code in python/ui/game_page.py
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 | |
launch_promotion_dialog(square_widget)
Launch the promotion dialog anchored to the given square widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
square_widget
|
QWidget
|
The widget representing the chess square where promotion is happening. |
required |
Return
str: The piece type chosen for promotion ('q', 'r', 'b', or 'n').
Source code in python/ui/game_page.py
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 | |
make_move(move)
Apply a chess move and generate the robot path for executing it.
This updates the control/path planner with the current board state, generates a movement path for the gantry, applies the move to the chess model, updates material score, and updates the UI turn indicator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
move
|
Move
|
Move to apply (typically a chess.Move instance). |
required |
Return
list[Command]: Path as a list of Command objects produced by the control layer.
Source code in python/ui/game_page.py
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 | |
move_back_position()
Step backward in the stored board position history.
Return: None
Source code in python/ui/game_page.py
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 | |
move_forward_position()
Step forward in the stored board position history.
Return
None
Source code in python/ui/game_page.py
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 | |
on_send_path_error(error_msg)
Handler when send_path encounters an error.
Return: None
Source code in python/ui/game_page.py
634 635 636 637 638 639 640 641 642 643 644 645 646 | |
on_send_path_finished()
Handler when send_path completes successfully.
Return
None
Source code in python/ui/game_page.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 | |
on_wait_button_error(error_msg)
Handler when waiting for button press fails or times out. Args: error_msg (str): Description of the error that occurred while waiting for button press. Return: None
Source code in python/ui/game_page.py
714 715 716 717 718 719 720 721 722 723 724 725 | |
on_wait_button_finished()
Handler when the ESP button press is detected. Processes the move from the camera and updates the game state accordingly.
Return: None
Source code in python/ui/game_page.py
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 | |
outOfTime(losing_color)
Handle timeout condition and show outcome dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
losing_color
|
str
|
Color of player that ran out of time. |
required |
Return
None
Source code in python/ui/game_page.py
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 | |
prepare_for_new_game()
Re-arm async operations when entering a fresh game. Args: None
Return
None
Source code in python/ui/game_page.py
532 533 534 535 536 537 538 539 540 541 | |
quit_game()
Stop workers and return to home page.
Return
None
Source code in python/ui/game_page.py
450 451 452 453 454 455 456 457 458 459 460 461 | |
reset_board()
Reset board to starting position and clear all UI elements.
Return
None
Source code in python/ui/game_page.py
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 | |
reset_score()
Clear the material score display.
Return
None
Source code in python/ui/game_page.py
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 | |
send_path_async(path, is_valid_move=True)
Send path to device asynchronously without blocking the UI.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
The path to send to the device |
required | |
is_valid_move
|
True if this is a valid move path, False if it's a move reversal |
True
|
Return: None
Source code in python/ui/game_page.py
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 | |
settings_button_clicked()
Emit settings signal to navigate to settings page.
Return
None
Source code in python/ui/game_page.py
439 440 441 442 443 444 445 446 447 448 | |
shutdown()
Stop async workers and prevent new operations during app shutdown. Args: None
Return
None
Source code in python/ui/game_page.py
509 510 511 512 513 514 515 516 517 518 | |
stop_active_workers()
Stop current game async operations without locking the controller permanently. Args: None
Return
None
Source code in python/ui/game_page.py
520 521 522 523 524 525 526 527 528 529 530 | |
stop_clocks()
Stop both white and black chess clocks.
Return
None
Source code in python/ui/game_page.py
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 | |
update_chess_board()
Update the board widget and store the new board state in history.
This refreshes the displayed board after a move and appends the current FEN position to the controller's history list.
Return
None
Source code in python/ui/game_page.py
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 | |
update_list(move, turn)
Append a move to the UI move list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
move
|
str
|
Move string to display (e.g., "Pe4", "Nf3", "Qxd5"). |
required |
turn
|
str
|
Player side for this move ("white" or "black"). |
required |
Return
None
Source code in python/ui/game_page.py
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 | |
update_score()
Recompute and display the material score difference. Shows a positive score next to the side that is ahead in material.
Return
None
Source code in python/ui/game_page.py
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 | |
wait_for_button_press_async()
Wait for physical button press asynchronously without blocking the UI. Args: None
Return
None
Source code in python/ui/game_page.py
576 577 578 579 580 581 582 583 584 585 586 | |
wait_for_button_thread()
Wait for any running button-wait thread to fully finish.
Return
None
Source code in python/ui/game_page.py
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 | |
wait_for_thread()
Wait for any running send_path thread to fully finish.
Return
None
Source code in python/ui/game_page.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | |
wait_for_threads()
Wait for all communication worker threads to finish. Args: None
Return
None
Source code in python/ui/game_page.py
499 500 501 502 503 504 505 506 507 | |
GameView
Bases: QWidget
Game page view containing chess board, clocks, and move history.
Source code in python/ui/game_page.py
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 | |
__init__(chess_game, control, communication, cam)
Initialize game view with chess game and hardware instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chess_game
|
Chess game model instance. |
required | |
control
|
Control instance for pathfinding. |
required | |
communication
|
Communication instance for device control. |
required | |
cam
|
Camera instance for board detection. |
required |
Return
None
Source code in python/ui/game_page.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 | |
cleanup_threads()
Clean up all worker threads in the game page. Args: None Return: None
Source code in python/ui/game_page.py
318 319 320 321 322 323 324 325 | |
setup_board()
Set up board for new game by preparing controller and resetting state. Sends home command to gantry at start of game.
Return
None
Source code in python/ui/game_page.py
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | |
start_time()
Start the chess clocks and initiate game based on player color.
Return
None
Source code in python/ui/game_page.py
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | |
update_highlighted_squares(squares)
Highlight the given squares on the board.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
squares
|
list
|
List of (row, col) tuples to highlight. |
required |
Return
None
Source code in python/ui/game_page.py
374 375 376 377 378 379 380 381 382 383 384 385 386 | |
GridButton
Bases: QPushButton
Source code in python/ui/game_page.py
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 | |
__init__()
Create a grid button that stays square within layouts.
Return
None
Source code in python/ui/game_page.py
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 | |
heightForWidth(width)
Return the preferred height for a given width. This enforces a square shape. Args: width (int): Current width. Return: int: Height equal to width.
Source code in python/ui/game_page.py
1591 1592 1593 1594 1595 1596 1597 1598 1599 | |
SendPathWorker
Bases: QObject
Worker thread to send path commands without blocking the UI.
Source code in python/ui/game_page.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | |
__init__(communication, path)
Initialize the send-path worker.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
communication
|
Communication instance used to send commands to the ESP/device. |
required | |
path
|
List of Command objects (or equivalent) to send to the device. |
required |
Return
None
Source code in python/ui/game_page.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 | |
cancel()
Request cancellation of the worker operation.
Return
None
Source code in python/ui/game_page.py
47 48 49 50 51 52 53 54 55 56 | |
run()
Execute send_path in the worker thread.
Return: None
Source code in python/ui/game_page.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | |
TrajectoryOverlay
Bases: QWidget
Transparent overlay that draws the move trajectory on top of the board.
Source code in python/ui/game_page.py
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 | |
__init__(parent=None)
Initialize the trajectory overlay widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent
|
QWidget | None
|
Parent widget (typically the board widget). |
None
|
Return
None
Source code in python/ui/game_page.py
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 | |
clear_trajectory()
Clear the currently displayed trajectory.
Return
None
Source code in python/ui/game_page.py
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 | |
paintEvent(event)
Paint the trajectory overlay on top of the board.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
Qt paint event. |
required |
Return
None
Source code in python/ui/game_page.py
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 | |
set_trajectory(path, player_color)
Set trajectory from a list of Command objects.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
list[Command]
|
List of Command objects representing the move trajectory. |
required |
player_color
|
bool
|
Player color to determine coordinate orientation (True for white, False for black). |
required |
Return: None
Source code in python/ui/game_page.py
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 | |
WaitForButtonWorker
Bases: QObject
Worker thread to wait for ESP button press without blocking the UI.
Source code in python/ui/game_page.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
__init__(communication)
Initialize the button-wait worker.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
communication
|
Communication instance used to wait for the ESP button press. |
required |
Return
None
Source code in python/ui/game_page.py
85 86 87 88 89 90 91 92 93 94 95 96 | |
cancel()
Request cancellation of the worker operation.
Return: None
Source code in python/ui/game_page.py
98 99 100 101 102 103 104 105 106 | |
run()
Execute wait_for_button_press in the worker thread.
Return: None
Source code in python/ui/game_page.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
Home Page
The home/welcome screen and game mode selection.
File for the home page of the application, which is the first page that the user sees when they open the app. It contains buttons to choose difficulty, start a new game, and view settings
HomePageController
Bases: QObject
Controller for home page user interactions and difficulty/color selection.
Source code in python/ui/home_page.py
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 | |
__init__(chess_model)
Initialize home page controller with chess model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chess_model
|
Chess game model instance. |
required |
Return
None
Source code in python/ui/home_page.py
449 450 451 452 453 454 455 456 457 458 459 | |
black_button_clicked()
Handle black color selection for player.
Return
None
Source code in python/ui/home_page.py
549 550 551 552 553 554 555 556 557 558 | |
easy_button_clicked()
Handle easy difficulty selection.
Return
None
Source code in python/ui/home_page.py
461 462 463 464 465 466 467 468 469 470 | |
hard_button_clicked()
Handle hard difficulty selection.
Return
None
Source code in python/ui/home_page.py
483 484 485 486 487 488 489 490 491 492 | |
medium_button_clicked()
Handle medium difficulty selection.
Return
None
Source code in python/ui/home_page.py
472 473 474 475 476 477 478 479 480 481 | |
settings_button_clicked()
Emit settings signal to navigate to settings page.
Return
None
Source code in python/ui/home_page.py
572 573 574 575 576 577 578 579 580 581 | |
start_game()
Emit start game signal to navigate to game page.
Return
None
Source code in python/ui/home_page.py
560 561 562 563 564 565 566 567 568 569 570 | |
time_10_button_clicked()
Handle 10 minute time control selection.
Return
None
Source code in python/ui/home_page.py
516 517 518 519 520 521 522 523 524 525 | |
time_3_button_clicked()
Handle 3 minute time control selection.
Return
None
Source code in python/ui/home_page.py
494 495 496 497 498 499 500 501 502 503 | |
time_5_button_clicked()
Handle 5 minute time control selection.
Return
None
Source code in python/ui/home_page.py
505 506 507 508 509 510 511 512 513 514 | |
time_none_button_clicked()
Handle no time limit selection.
Return
None
Source code in python/ui/home_page.py
527 528 529 530 531 532 533 534 535 536 | |
white_button_clicked()
Handle white color selection for player.
Return
None
Source code in python/ui/home_page.py
538 539 540 541 542 543 544 545 546 547 | |
HomeView
Bases: QWidget
Home page view for difficulty selection and game initialization.
Source code in python/ui/home_page.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | |
__init__(chess_model)
Initialize home page view with chess model instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chess_model
|
Chess game model instance. |
required |
Return
None
Source code in python/ui/home_page.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | |
build_color_buttons()
Build player color selection buttons (White, Black).
Return
QHBoxLayout: Layout containing color selection buttons.
Source code in python/ui/home_page.py
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | |
build_level_buttons()
Build difficulty level selection buttons (Easy, Medium, Hard).
Return
QHBoxLayout: Layout containing difficulty buttons.
Source code in python/ui/home_page.py
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | |
build_menu_buttons()
Build menu buttons (Start Game, Settings).
Return
QVBoxLayout: Layout containing menu buttons.
Source code in python/ui/home_page.py
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | |
build_time_control_buttons()
Build time control selection buttons (3 min, 5 min, 10 min, No limit).
Return
QHBoxLayout: Layout containing time control buttons.
Source code in python/ui/home_page.py
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | |
init_ui()
Initialize home page UI layout with logo, difficulty, and color buttons.
Return
None
Source code in python/ui/home_page.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | |
resizeEvent(event)
Handle window resize events and coalesce frequent updates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
Resize event. |
required |
Return
None
Source code in python/ui/home_page.py
219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
Settings Page
Configuration interface for system settings and calibration.
GridView
Bases: QWidget
Grid visualization widget for gantry position display.
Source code in python/ui/settings_page.py
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 | |
__init__(parent=None)
Initialize grid view widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent
|
Parent widget (optional). |
None
|
Return
None
Source code in python/ui/settings_page.py
673 674 675 676 677 678 679 680 681 682 683 | |
init()
Initialize grid dimensions and styling.
Return
None
Source code in python/ui/settings_page.py
685 686 687 688 689 690 691 692 693 694 695 | |
paintEvent(event)
Paint grid with lines and position indicator dot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
Paint event. |
required |
Return
None
Source code in python/ui/settings_page.py
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 | |
SendHomeWorker
Bases: QObject
Worker thread to send home command without blocking the UI.
Source code in python/ui/settings_page.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | |
__init__(communication)
Initialize worker with communication instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
communication
|
Communication instance for sending commands. |
required |
Return
None
Source code in python/ui/settings_page.py
59 60 61 62 63 64 65 66 67 68 69 70 | |
cancel()
Cancel current home operation.
Return
None
Source code in python/ui/settings_page.py
72 73 74 75 76 77 78 79 80 81 | |
run()
Execute go_home in the worker thread.
Return
None
Source code in python/ui/settings_page.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | |
SendPositionWorker
Bases: QObject
Worker thread to send position commands without blocking the UI.
Source code in python/ui/settings_page.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
__init__(communication, position)
Initialize worker with communication and target position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
communication
|
Communication instance for sending commands. |
required | |
position
|
Position
|
Target position to send. |
required |
Return
None
Source code in python/ui/settings_page.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 | |
run()
Execute send_position in the worker thread.
Source code in python/ui/settings_page.py
42 43 44 45 46 47 48 49 50 51 52 | |
SettingsController
Bases: QObject
Source code in python/ui/settings_page.py
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | |
__init__(view, com, cam)
Initialize settings controller with view and hardware instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view
|
SettingsView
|
Settings view widget. |
required |
com
|
Communication instance for device control. |
required | |
cam
|
Camera instance for image capture. |
required |
Return
None
Source code in python/ui/settings_page.py
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 | |
calibrate_camera()
Launch camera calibration from UI.
Return
None
Source code in python/ui/settings_page.py
656 657 658 659 660 661 662 663 664 665 | |
cleanup_threads()
Clean up all worker threads in the controller.
Source code in python/ui/settings_page.py
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 | |
home()
Home the gantry to origin position.
Return
None
Source code in python/ui/settings_page.py
575 576 577 578 579 580 581 582 583 584 585 586 | |
on_send_home_error(error_msg)
Handler when send_home encounters an error.
Source code in python/ui/settings_page.py
565 566 567 568 569 570 571 572 573 | |
on_send_home_finished()
Handler when send_home completes successfully.
Source code in python/ui/settings_page.py
556 557 558 559 560 561 562 563 | |
on_send_position_error(error_msg)
Handler when send_position encounters an error.
Source code in python/ui/settings_page.py
512 513 514 515 516 517 518 519 520 | |
on_send_position_finished()
Handler when send_position completes successfully.
Source code in python/ui/settings_page.py
503 504 505 506 507 508 509 510 | |
quit()
Cleanup and emit back button signal to return to previous page.
Return
None
Source code in python/ui/settings_page.py
461 462 463 464 465 466 467 468 469 470 471 | |
send_home_async()
Send home command to device asynchronously without blocking the UI.
Source code in python/ui/settings_page.py
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 | |
send_position_async(position)
Send position to device asynchronously without blocking the UI.
Source code in python/ui/settings_page.py
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 | |
stop()
Stop the gantry motor immediately.
Return
None
Source code in python/ui/settings_page.py
588 589 590 591 592 593 594 595 596 597 | |
take_picture()
Capture image from camera and display it.
Return
None
Source code in python/ui/settings_page.py
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 | |
update_picture(img_path)
Update camera image display with new image.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image
|
New image to display. |
required |
Return
None
Source code in python/ui/settings_page.py
642 643 644 645 646 647 648 649 650 651 652 653 654 | |
z_move_down()
Move servo magnet down.
Return
None
Source code in python/ui/settings_page.py
610 611 612 613 614 615 616 617 618 619 | |
z_move_up()
Move servo magnet up.
Return
None
Source code in python/ui/settings_page.py
599 600 601 602 603 604 605 606 607 608 | |
SettingsView
Bases: QWidget
Source code in python/ui/settings_page.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | |
__init__(com=None, cam=None)
Initialize settings view with communication and camera instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
com
|
Communication instance for device control. |
None
|
|
cam
|
Camera instance for image capture. |
None
|
Return
None
Source code in python/ui/settings_page.py
104 105 106 107 108 109 110 111 112 113 114 115 116 117 | |
build_camera()
Build camera display and calibration section.
Return
QVBoxLayout: Layout containing camera image and control buttons.
Source code in python/ui/settings_page.py
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | |
build_controls()
Build home and stop control buttons.
Return
QVBoxLayout: Layout containing HOME and STOP buttons.
Source code in python/ui/settings_page.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | |
build_coord()
Build coordinate input spinners and GO button.
Return
QHBoxLayout: Layout containing X/Y spinners and GO button.
Source code in python/ui/settings_page.py
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | |
build_grid()
Build grid display widget.
Return
GridView: Grid visualization widget.
Source code in python/ui/settings_page.py
260 261 262 263 264 265 266 267 268 269 270 271 | |
build_remoteXY()
Build XY axis manual movement control panel.
Return
QHBoxLayout: Layout containing movement buttons and step control.
Source code in python/ui/settings_page.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
cleanup_threads()
Clean up all worker threads in the settings page.
Source code in python/ui/settings_page.py
119 120 121 | |
init_ui()
Initialize settings page UI layout.
Return
None
Source code in python/ui/settings_page.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | |
move_down()
Move gantry down (decrease Y coordinate).
Return
None
Source code in python/ui/settings_page.py
360 361 362 363 364 365 366 367 368 369 370 | |
move_left()
Move gantry left (decrease X coordinate).
Return
None
Source code in python/ui/settings_page.py
372 373 374 375 376 377 378 379 380 381 382 | |
move_right()
Move gantry right (increase X coordinate).
Return
None
Source code in python/ui/settings_page.py
384 385 386 387 388 389 390 391 392 393 394 | |
move_up()
Move gantry up (increase Y coordinate).
Return
None
Source code in python/ui/settings_page.py
348 349 350 351 352 353 354 355 356 357 358 | |
on_spinner_changed()
Handle coordinate spinner value changes.
Return
None
Source code in python/ui/settings_page.py
333 334 335 336 337 338 339 340 341 342 343 344 345 346 | |
update_captured_image(img_path=os.path.join(os.path.dirname(__file__), 'assets', 'captured_image.jpg'))
Take picture and update image in view.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
img_path
|
str
|
File path to new image. |
join(dirname(__file__), 'assets', 'captured_image.jpg')
|
Return
None
Source code in python/ui/settings_page.py
396 397 398 399 400 401 402 403 404 405 | |
update_coord(x, y, computer_move=False)
Update coordinate spinners and grid position indicator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
float
|
X coordinate value. |
required |
y
|
float
|
Y coordinate value. |
required |
computer_move
|
bool
|
Whether this is a computer move (affects Y transformation). |
False
|
Return
None
Source code in python/ui/settings_page.py
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | |
Dialog Components
Popup dialogs for notifications and selections.
DrawDialog
Bases: QDialog
Dialog shown at end of game to announce a draw and offer play again or quit options.
Source code in python/ui/dialog_ui.py
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | |
__init__(parent=None)
Initialize the draw dialog. Args: parent (QWidget | None): Optional parent widget. Return: None
Source code in python/ui/dialog_ui.py
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | |
HoverIconToolButton
Bases: QToolButton
Source code in python/ui/dialog_ui.py
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | |
__init__(parent=None)
Create a tool button that swaps icons on hover.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent
|
QWidget | None
|
Optional parent widget. |
None
|
Return
None
Source code in python/ui/dialog_ui.py
105 106 107 108 109 110 111 112 113 114 115 116 117 118 | |
enterEvent(event)
Handle mouse enter by switching to the hover icon. Args: event: Qt enter event. Return: None
Source code in python/ui/dialog_ui.py
156 157 158 159 160 161 162 163 164 165 | |
leaveEvent(event)
Handle mouse leave by restoring the normal icon. Args: event: Qt leave event. Return: None
Source code in python/ui/dialog_ui.py
167 168 169 170 171 172 173 174 175 176 | |
setHoverIcons(normal_icon, hover_icon)
Set the icons used for normal and hover states.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
normal_icon
|
QIcon
|
Icon displayed normally. |
required |
hover_icon
|
QIcon
|
Icon displayed while hovering. |
required |
Return
None
Source code in python/ui/dialog_ui.py
142 143 144 145 146 147 148 149 150 151 152 153 154 | |
InvalidMoveDialog
Bases: QDialog
Dialog showing invalid move message that automatically closes after 2 seconds.
Source code in python/ui/dialog_ui.py
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | |
__init__(parent=None)
Initialize the invalid move dialog. Args: parent (QWidget | None): Optional parent widget. Return: None
Source code in python/ui/dialog_ui.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | |
PromotionWidget
Bases: QDialog
Source code in python/ui/dialog_ui.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | |
__init__(player_color)
Create the promotion choice dialog. Displays piece options (Q/R/B/N) and returns the selected promotion type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
player_color
|
Player color (chess.WHITE or chess.BLACK) used to choose correct piece icons. |
required |
Return
None
Source code in python/ui/dialog_ui.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | |
promote(piece)
Select a promotion piece and close the dialog.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
piece
|
str
|
One of 'Q', 'R', 'B', 'N' (case-insensitive). |
required |
Return
None
Source code in python/ui/dialog_ui.py
91 92 93 94 95 96 97 98 99 100 101 | |
SpinningGear
Bases: QWidget
Spinning gear widget for animations and loading states.
Source code in python/ui/dialog_ui.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | |
__init__(size=50, image_path='ui/assets/gear_icon.png')
Initialize the spinning gear widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
size
|
int
|
Size of the gear in pixels (width and height). |
50
|
image_path
|
str
|
Path to the gear image file. |
'ui/assets/gear_icon.png'
|
Return
None
Source code in python/ui/dialog_ui.py
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | |
paintEvent(event)
Paint the rotating gear on the widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
Qt paint event. |
required |
Return
None
Source code in python/ui/dialog_ui.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | |
rotate_gear()
Rotate the gear by a small increment.
Return
None
Source code in python/ui/dialog_ui.py
208 209 210 211 212 213 214 215 216 217 218 219 220 | |
set_image(image_path, size=None)
Update the gear image (optional method for dynamic image changes).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image_path
|
str
|
Path to the new gear image file. |
required |
size
|
int | None
|
Optional new size. If None, keeps current size. |
None
|
Return
None
Source code in python/ui/dialog_ui.py
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | |
TurnIndicatorWidget
Bases: QWidget
Combined widget showing current turn with dynamic background and optional waiting spinner.
Source code in python/ui/dialog_ui.py
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 | |
__init__(parent=None)
Initialize the turn indicator widget. Args: parent (QWidget | None): Optional parent widget. Return: None
Source code in python/ui/dialog_ui.py
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 | |
hide_waiting()
Hide waiting state and show turn indicator. Args : None Return : None
Source code in python/ui/dialog_ui.py
599 600 601 602 603 604 605 606 607 608 609 | |
show_waiting(message='Processing...')
Show waiting state with spinning gear and message.
Args :
message (str): Message to display next to the spinning gear.
Return :
None
Source code in python/ui/dialog_ui.py
587 588 589 590 591 592 593 594 595 596 597 | |
update_turn(color)
Update the turn indicator with new color (white or black). Args: color (str): "white" or "black" indicating the current player's turn. Return: None
Source code in python/ui/dialog_ui.py
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 | |
WaitingDialog
Bases: QDialog
Simple waiting dialog to show while path is being sent.
Source code in python/ui/dialog_ui.py
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | |
__init__(parent=None)
Initialize the waiting dialog. Args: parent (QWidget | None): Optional parent widget. Return: None
Source code in python/ui/dialog_ui.py
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 | |
set_message(message)
Update the waiting message displayed in the dialog. Args: message (str): New message to display. Return: None
Source code in python/ui/dialog_ui.py
497 498 499 500 501 502 503 | |
WinnerDialog
Bases: QDialog
Dialog shown at end of game to announce winner and offer play again or quit options. Quit exits the application, while play again just closes the dialog and returns to the main menu.
Source code in python/ui/dialog_ui.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | |
__init__(winner_color='white', parent=None, reason='checkmate')
Initialize the winner dialog. Args: winner_color (str): "white" or "black" indicating the winner's color. parent (QWidget | None): Optional parent widget. reason (str): "checkmate" or "timeout" indicating how the game was won Return: None
Source code in python/ui/dialog_ui.py
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | |
User Interface Components
Game Board
- Visual Representation - 8x8 chess board with pieces
- Square Highlighting - Show selected piece and legal moves
- Trajectory Display - Show robot movement path
Move History
- Notation List - Display all moves in algebraic notation
- Move Navigation - Step backward/forward through game
- Capture Indicators - Mark captured pieces
Chess Clock
- Time Display - Show remaining time for each player
- Color Indicators - White/black background for current player
- Out of Time Detection - Automatic game end on timeout
Status Indicators
- Turn Indicator - Show which player's turn it is
- Waiting Spinner - Show processing status with animated gear
- Error Messages - Display issues or invalid moves
Settings Controls
- Board Orientation - Rotate board perspective (possible to play as black or white)
- Difficulty Selection - Choose chess engine opponent strength
- Device Configuration - Select and test hardware (core XY or camera)