-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Creates the best practices file in the root folder.
- Loading branch information
1 parent
8b30328
commit dc12444
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# BEST PRACTICES TO MAKE THE LOGGER HAPPY: # | ||
###### Treat errors as severe issues, warnings as mid-level statuses, and messages as essentially ignorable when choosing PrintStyles in TelemetryUtil. | ||
# | ||
--- | ||
###### When a failure occurs in a specific subsystem, include the CASE-SENSITIVE name of the subsystem. | ||
# | ||
>This should be the EXACT SAME as one of the names within the list of subsystem names that you >input within the "config" file. | ||
>Subsystems for our robot are listed below. | ||
--- | ||
###### Tag actuators properly (bounded by @). | ||
# | ||
###### Read the "README" file and edit the "config" file properly before running the program. | ||
# | ||
#### Current actuators (and the subsystem they are in) within the logger are: | ||
###### Drive: | ||
# | ||
- "Left Master Falcon" | ||
- "Right Master Falcon" | ||
- "Left Slave Falcon" | ||
- "Right Slave Falcon" | ||
###### Hopper: | ||
# | ||
- "Left Hopper Motor | ||
- "Right Hopper Motor" | ||
###### Intake: | ||
# | ||
- "Left Intake Motor" | ||
- "Right Intake Motor" | ||
- "Left Deploy Piston" | ||
- "Right Deploy Piston" | ||
###### Climb: | ||
# | ||
- "Left Winch Motor" | ||
- "Right Winch Motor" | ||
- "Slide Motor" | ||
###### Shooter: | ||
# | ||
- "Index Motor" | ||
- "Left Shooter Motor" | ||
- "Right Shooter Motor" | ||
###### Limelight: | ||
# | ||
- "Limelight" | ||
|
||
[Link to Source Code (you may need to sign in to view it)](https://github.com/SkylineSpartabots/RobotErrorIdentifier "Spartabots Github - RobotErrorIdentifier") |