Skip to content

Web Interface

David Masin edited this page Oct 30, 2024 · 2 revisions

Web Interface

Dashboard

  • Battery Table

    • Displays a list of all batteries in the system along with their codes, statuses, elapsed or remaining cooldown times, and last status change timestamps.

    • Each battery row includes an Edit button for modifying the battery code and status.

  • Video Feed

    • A draggable video feed from the connected camera for barcode scanning.
    • Can be repositioned on the screen by clicking and dragging.
  • Notifications

    • Flash messages provide feedback on actions like adding, editing, or deleting batteries.

Manual Battery Entry

  • Located at the top of the dashboard.
  • Enter a battery code manually to update its status.
  • If the battery is not in the system, you will be prompted to add it.

Adding Batteries

  • Automatic Addition via Scanning

    • When a new battery code is scanned and not recognized, the system will prompt you to add it.
  • Manual Addition

    • Use the Add Battery button on the dashboard to generate a new battery code and add it to the system.

Editing Batteries

  • Click the Edit button next to a battery in the table.

  • A modal will appear allowing you to:

    • Change the Battery Code

      • Modify the battery code if necessary.
      • Caution: Changing the code will affect how the battery is tracked.
    • Update the Battery Status

      • Manually set the battery to a different status.
      • Ensure that status transitions are logical and adhere to the battery lifecycle.
    • Delete Battery

      • Within the edit modal, you have the option to delete the battery from the system.
      • A confirmation prompt will appear to prevent accidental deletions.

Deleting Batteries

  • Batteries can be deleted from the system via the edit modal.
  • Permanence: Deletion is permanent and cannot be undone.

Settings

  • Accessed via the Settings button on the dashboard.

    • Cooldown Duration

      • Set the duration (in seconds) for cooldown periods.
    • Team Number

      • Update your team's number used for generating battery codes.

Logs

  • Accessed via the View Logs button on the dashboard.
  • Displays a table of all battery status changes and actions.
  • Includes timestamps, battery codes, statuses, and other relevant information.

Barcode Scanning

  • The application continuously scans for barcodes using the connected camera.

  • When a battery barcode is scanned:

    • Existing Battery

      • The battery's status is updated according to the predefined lifecycle.
    • New Battery

      • If the battery is not recognized, the system will prompt you to add it.
      • Once added, scanning the battery will update its status as usual.
    • Audio Notification

      • A beep sound is played when a barcode is successfully scanned.

Battery Status Lifecycle

The application enforces a logical progression of battery statuses to ensure proper battery management.

  1. Charging

    • Initial status when a battery is added.
    • Transitions to Cooldown To Robot after scanning.
  2. Cooldown To Robot

    • Cooldown period after charging before the battery can be used.
    • Automatically transitions to Ready for ROBOT after the cooldown duration.
  3. Ready for ROBOT

    • Battery is ready to be used in the robot.
    • Transitions to In Use after scanning.
  4. In Use

    • Battery is currently in use.
    • Transitions to Cooldown To Charge after scanning.
  5. Cooldown To Charge

    • Cooldown period after use before the battery can be charged again.
    • Automatically transitions to Ready for CHARGING after the cooldown duration.
  6. Ready for CHARGING

    • Battery is ready to be charged.
    • Transitions back to Charging after scanning.