GirlsOfSteelDocsLogo
latest

Helpful links:

  • WPI Documentation
  • wpilib Source Code
  • CTRE Documentation
  • REV Documentation
  • Electronics Status Lights
  • SnobotSim Documentation
  • Latest Robot Code

Environment Setup:

  • FRC Programming Environment
  • Intellij Setup
    • Installing Intellij
    • Installing Plugins
    • Navigating Intellij
      • 1. Run Configurations
      • 2. Version Control
      • 3. Source Tree
      • 4. FRC Tab / RioLog
    • FRC Plugin
      • Adding a Subsystem
      • Adding a Command

Coding Standard:

  • Style Guide
    • Class Names
    • Function Names
    • Variable Names
    • Braces and Spacing
  • Direction Conventions
    • Motor Conventions
    • Digital Input Conventions
    • Field Coordinate System
  • General Guidelines

Github Workflow:

  • Git-Flow Introduction
    • Scenario: I want to add a new feature
      • 1. Get Latest
      • 2. Create and Checkout a new branch
      • 3. Start working!
      • 5. Push your final commit
      • 6. Create a Pull Request
      • 7. Wait for Review and Approval
      • 8. Run “Squash and Merge”
      • 9. Cleanup
  • Code Review
    • What To Look for
    • Requesting changes
    • Merging Changes
  • Github Issue

Technical Resources:

  • Git
    • What is git?
    • Git Command Line
      • Clone a repository
      • Get the latest from GitHub
      • Switching Branches
      • Committing Files
      • Pushing code to GitHub
      • Look at your current status
      • Merging Branches
      • Resetting
  • Installers
    • Software Installers Kept on USB Drives
      • Required Installers
      • Helpful Commands
    • Team Laptop Setup
    • Upgrading Firmware and Setting Up Electronics
      • RoboRio
      • PCM, PDP, and CAN Talons
      • Wi-Fi Radio
    • Changing the Team Number
  • Sensors
    • LIDAR-Lite
      • Connection options
        • I2C
        • PWM Output
      • Minimal roboRIO Interface
      • Source Code
    • Navigation Sensors
      • Pigeon
      • NavX
    • Tuning PID and Related Parameters
      • Open-Loop Parameters
      • Motion Magic Tuning

Code Labs:

  • Code Labs
    • Gitflow Lab
      • Part One
        • 1. Checkout a new branch
        • 2. Create a new Subsystem
        • 3. Put a print line in the constructor
        • 4. Create your command
        • 5. Run SnobotSim
        • 6. Commit, Push, Create PR
        • 7. Fix conflict, re-push
      • Part Two
    • Simulator Lab
      • Robot Overview
      • Implement the Punch Subsystem
      • Implement the Elevator Manual Controls
      • Implement the Chassis Manual Controls
      • Implementing Joystick Interactions
      • Implement Driving with Timers
      • Implement Driving a Distance
      • Implement Moving the Elevator to a Height
      • Wire Up Commands to Buttons
    • Custom Shuffleboard Widget Lab
      • Introduction into JavaFX
      • Making a View
      • Setting up the Controller
      • Making the Widget Dynamic
    • Calculator Lab
      • Part One
        • 1. Run the existing calculator
        • 2. Find the file you just ran
        • 3. Edit the line printed.
        • 4. Create a calculator object
        • 5. Use the add function of the calculator
        • 6. Find Calculator.java
        • 7. Add functions to Calculator.java
        • Bonus: Call your functions in RunCalculator.java
      • Part Two
        • 1. Find CalculatorTest.java.
        • 2. Make a test fail
        • 3. Test your subtraction method
        • 4. Test your other methods

Monorepo:

  • Monorepo intro
    • Creating a New Robot Project
      • 1. Create a new module
      • 2. Select the FRC Robot Project
      • 3. Select a template to start with. We use the Timed Robot template
      • 4. Set the team number and packge name
      • 5. Select where the project should live
      • 6. Add libraries.
        • a. Copy vendor deps
        • b. Add internal library dependencies
      • 7. Cleanup
        • a. Remove the project from intellij’s gradle tab
        • b. Add the new robot project to the overall project
      • 8. Build the project
      • 9. Make a PR and land the new robot
    • Create New Shuffleboard Plugin
GirlsOfSteelDocs
  • »
  • Welcome to the Girls of Steel documentation page for programmers
  • Edit on GitHub

Welcome to the Girls of Steel documentation page for programmers¶

Follow the steps in Environment Setup to install all of the required tools, then read through the rest of the documentation for details about our coding standard and workflow practices.

Helpful links:

  • WPI Documentation
  • wpilib Source Code
  • CTRE Documentation
  • REV Documentation
  • Electronics Status Lights
  • SnobotSim Documentation
  • Latest Robot Code

Environment Setup:

  • FRC Programming Environment
  • Intellij Setup

Coding Standard:

  • Style Guide
  • Direction Conventions
  • General Guidelines

Github Workflow:

  • Git-Flow Introduction
  • Code Review
  • Github Issue

Technical Resources:

  • Git
    • What is git?
    • Git Command Line
  • Installers
    • Software Installers Kept on USB Drives
    • Team Laptop Setup
    • Upgrading Firmware and Setting Up Electronics
    • Changing the Team Number
  • Sensors
    • LIDAR-Lite
    • Navigation Sensors
    • Tuning PID and Related Parameters

Code Labs:

  • Code Labs
    • Gitflow Lab
    • Simulator Lab
    • Custom Shuffleboard Widget Lab
    • Calculator Lab

Monorepo:

  • Monorepo intro
    • Creating a New Robot Project
    • Create New Shuffleboard Plugin

Indices and tables¶

  • Index
  • Module Index
  • Search Page
Next

© Copyright 2020, Girls of Steel Robotics. Revision 0d16e8e2.

Built with Sphinx using a theme provided by Read the Docs.