Robot Simulator

8 Access Point students take on the task of creating a Robot Simulator, while learning the components needed in making an App. Java, JavaFX, Scene Builder, Postgres, and the inner workings of a Databases.

Deliverables versions

Java version 21.0.5 JavaFX version 21 Maven version 3.8.6 release version 21

Roles

1.co-technical-leads: Isaiah, Jonathan

2.Business analyst Isaiah, Zoe

3.Co-test-leads Jonathan, Erik

4.Document lead Drew, Ariel

5.Scrum master Jayla

6.Focal Jayla

7.Feature integrator Mohommadou, Erik

8.Database Leads: Ariel, Mohommadou

Branches

Dev branch holds changes made by developers before there ready to go into production

UAT/User Acceptance Testing branch is necessary for final checking where quality assurances teams simulate user interactions and features

Production branch is used to prepare for specific development releases.

Pages

Create Account Page When a valid full name and email address are entered, and the passwords match, the "Create Account" button will be enabled, and the account will be stored in the database.

Login Page After entering login credentials, they will be validated against the database. If valid, you will be directed to the dashboard; if invalid, a message will indicate the reason for the failure.

Dashboard Page Users will be able to navigate between layouts and rulesets, view up to six layouts, and perform actions such as delete, view/edit, or run a simulation on a selected layout.

Factory Layout Page When editing a layout, users can update the layout name and/or modify the grid. Changes can be saved, and users can return to the dashboard where the updated list of layouts is displayed. All updates will be saved in the database.

Rulesets Page When the "Rulesets" tab is selected from the dashboard, a list of up to six rules will be displayed. Users can view reports on rulesets, and they can remove, view/edit, or run a simulation based on a ruleset.

Rules Engine Administration Page Users can view and edit the details of a selected rule. There is an option to return to the list of rules on the dashboard. Any changes made to the rules will be updated and saved in the database.

Simulation Runner Page When the "Play" button is clicked on a layout or ruleset, the simulation runner will open. Users can still make changes to the layout, ruleset, or the maximum number of robot attempts before running the robot simulator. The robot's actions will be tracked and saved in the database.

Reports Page When the "Reports" button is selected from any view, a list of simulation results will be displayed in a table format along with at least one plot. Users can filter results by layout and/or ruleset.

How to Run code

1. download vscode
2. download Debugger for Java (Extension in Visual Studio Code)
3. Download Extension Pack for Java (Extension in Visual Studio Code)
4. Download Gradle for Java (Extension in Visual Studio Code)
5. Download Language Support for Java(TM) by Red Hat (Extension in Visual Studio Code)
6. Download Maven for Java (Extension in Visual Studio Code)
7. Download RedHat JDK 17

How to Use Database

1. Create or login into account

2. Create a dashboard and desired layout map for robot

3. Create rules that must be enforced for the robot

4. Manage rulesets and manage names and rules for the robot

5. Run the simulation to watch how robot does using rules with layouts

6. See reports to see how robot did with specific layout and rule combinations

Make Database working

Step 1: Open your google drive

Step 2: look in the section called shared with me on the left hand side

Step 3: Open your shared and locate the folder titled "partpeng" , open it

Step 4: Here you will see a file called test3. Download it.

Step 5: Open Pgadmin , select the server 16.4 verify the port is 5432 , the server address is localhost and the name is posgres

Step 6: Open the databases drop down

step 7; right click on the database called postgres (any of the databases will work) and select restore

Step 8: in the restore pop up youll see custom or tar as the format, do not change it. Locate the file test3. Make sure that the file type in the bottom right hand side of the screen in your file explored is either "All files " or "SQL" or you wont find the test3 file

Step 9: Select open.

Step 10: Once you are returned to the restore screen, select restore. You will see two boxes in the bottom corner of the right hand side of the screen , they should be green. If they are not, reach out to a team member for assistance.

Step 11: Once both the boxes are green you can open up the database drop down and you should have 2 databases one of them will be test3.

Step 12: To verify it works open the RobotSim file in the Fixmismatch_1_ZE branch and run the file titled test.java

Step 13: To verify that it works open your pgshell, authenticate and type SELECT * FROM ACCOUNTCENTERA. You should see two entries.

Important Links

Working agreement

https://www.canva.com/design/DAGOnDWP-rM/VkgUwu-qCoejSO3-tgsFmA/edit

Database Download