Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.88 KB

README.md

File metadata and controls

28 lines (22 loc) · 1.88 KB
Raw

Robotic Scout Magic (RSM)

A mockup working prototype for a FRC scouting web app.

  • Completly customizable forms built with JSON.
  • Export to a USB from the Web App.
  • Very extensible with React and Material-UI.

Getting Started

  1. To start, make sure you have Node.js and Node GYP installed.
  2. Clone or download this repository to a folder somewhere on the device.
  3. Run npm i -D && npm run build to install all the needed dependencies. Always run npm i -D on the machine that is hosting the server. This is because we use the npm module, drivelist.
  4. Some how connect your devices to the host machine using a Bluetooth PAN or reverse tethering.
  5. Run npm run production to start the server and access the form page at http://localhost:8000/.
  6. If you connect external devices, connect to the server though the PAN network, and instead of localhost, use the server's local IP. You can find this by running ipconfig in the console.

It is very important that you run npm i -D && npm run build before your start the production server, as the rendering happens from the dist/ folder. Also remember to do this if you ever update RSM.

Why Bluetooth?

RSM uses bluetooth for it's connections to it's devices because WiFi access points are banned at competitions. no-wifi Soruce at https://firstfrc.blob.core.windows.net/frc2019/EventRules/EventRulesManual.pdf.

Documentation

You can view the full documentation for RSM including how to create, edit, and export form data at wearedevs.github.io/robotic-scout-magic.

Licensing

This software is under the MIT License, meaning you can do what ever you want with it. Just don't sue us.