APCS Final Project

THIS DOCUMENT IS REQUIRED

Group Info

Group Members: Dylan Ma and David Cai Liang

Group Name: Dangerous Direct Current

Overview

We've created a circuit simulator that returns the total resistance, current, voltage, and power of the circuit as well as that of individual components where you can have a parallel circuit within a series circuit within a parallel circuit and so on using resistors, junctions, and batteries. You can change the battery voltage, individual resistor resistance, and the relationships of all the components.

Instructions

#Mouse 4 On Screen Buttons From Left to Right

• 4 part circle
  • Allows you to move between run mode and edit mode.
  • You can only edit current components and their connections in edit mode.
  • You can only see data about the circuit in run mode
• pill shape
  • allows you to select resistors as the objects you put down
    • resistors have one input and one output component
• right facing y
  • allows you to select start junctions as the objects you put down
    • start junctions have one input and two outputs component
• left facing y
  • allows you to select end junctions as the objects you put down
    • end junctions have two input and one output components

2 On Screen Sliders Top - Right of Screen Slider

• Allows you to adjust the total amount of voltage through the circuit, pull right to increase voltage
• Goes from 0 volts to 28.5 volts. Bottom Slider
• Only appears when you have selected a resistor by right clicking it.
• This allows you adjust the resistance of a resistor.
• Goes from 0 ohms to 28.5 ohms.

2 Mouse Inputs

• 'left click'
  • Edit mode
    • You can place down components.
    • Will sometimes fail when you do not follow the rules provided above about resistors, startJunctions, and endJunctions in the buttons documentation.
    • If attempt to place down components fails, your selection circle will go to center and no new component will be made.
    • If you want to return selection circle to the center for any reason, you can double left click on any component.
  • Run mode
    • Click on component to see its statistics.
    • Click on a component that is already selected as in the selection circle to see the statistics for the whole circuit.
• 'right click'
  • Edit mode
    • chooses the component for the next component you place down connect to
    • chooses the component for a previously placed component to connect to
    • The selected component will the component from which charge flows in these connections.
  • Run mode
  • Click on component to see its statistics.
  • Click on a component that is already selected as in the selection circle to see the statistics for the whole circuit.

#Keyboard 6 Hotkeys

• 'e'
  • does same thing as 4 part circle (read more below)
• 'r'
  • allows you to restart the simulation
  • will automatically return you to edit mode.
• ' '
  • will remove the last component that was placed down.
  • will automatically return your cursor to the previous component to the one you just removed
• 'a'
  • loops through 3 options: info, voltage, and resistance
    • info
      • provides information about Hotkeys
    • voltage
      • type the voltage and press 'enter' / 'return' to set it.
      • if you want digits to the right of a decimal point press the 'decimal point' / 'period' button and type your following digits. You can have a max of 3 digits to the right of the decimal point. Please don't numbers with more than 5 digits as things tend to break past that.
    • resistance
      • similar to voltage mode but for resistors.
      • when you press the 'enter' / 'return' button you must have selected a resistor (the circle is around it) for the resistor's resistance to be changed.
      • This has limitations similar to that of voltage mode.
• 's'
  • saves the current position into a text file that can be found in the program folder.
  • you have to wait 2 seconds between each time you press the button.
  • the name of the file generated will have the following format: YEAR-MONTH-DAY-HOUR-MINUTE-SECOND.txt
• 'g'
  • will open up a window where you can choose which file to open in CircuitSim2.
  • you choose to press open on any files, all current work will be deleted PERMANENTLY if you don't choose to save it

Note: You would right click on an element to set it as the prior element to connect to and any spot you left click where there isn't already a component will create a component such that component is tied to the one you previously right clicked. If there is already an element, the simulator will attempt to connect it using the same logic as when there isn't a component already there.

Note: All endJunctions must have a corresponding startJunction that is placed before the endJunction. Both output paths from the startJunction must lead to the endJunction, if the endJunction is preseent. startJunctions don't necessarily need a corresponding endJunction.

Note: This program can only handle uni-directional current flow and not bi-directional current flow. If you input a situation that results in bi-directional current flow, the resistance, current, voltage, and power readings for all components and the whole circuit will be inaccurate. Please use the following circuit simulator if you a situation that can't be handled by our simulator: https://www.falstad.com/circuit/

Note: If a connection fails, there is a non-insignificant chance that when you transition to run mode it will fail.

Note: If the program crashes, please restart the simulation with r, if possible, and re-input all the components and their relationships while avoiding the same error.

Note: All audio taken from the following website: https://theremin.music.uiowa.edu/MIS-Pitches-2012/