Update the glossary to generate from glossary.ts#73
Conversation
|
🌐 Preview URL: https://pr-73.frcsoftware.pages.dev |
Co-authored-by: Andrew Haselton <13470989+roboteer5291@users.noreply.github.com>
| term: 'PWM', | ||
| definition: | ||
| 'The process of creating threads in a hole using a tap tool', | ||
| 'Pulse Width Modulation: three-wire cable used to communicate with motor controllers and sensors, needs to connect back to MRC', |
There was a problem hiding this comment.
PWM doesn't just refer to the cable though, it's the actual signal/protocol. For example "Get me a PWM" doesn't make sense to ask for a pwm cable.
| term: 'Limit Switch', | ||
| definition: | ||
| 'Plate for mounting electronics on the underside of your drivebase', | ||
| 'Type of sensor that triggers when physically or magnetically hit. Can be used to trigger actions on a rising or falling edge', |
There was a problem hiding this comment.
Mentioning the edge but not that you can just also detect the state itself is funky. You need to mention that as well or neither I think. Though maybe just mention that you can detect the state?
| term: 'CAN', | ||
| definition: | ||
| 'Process of removing threads or bolt heads, often due to excessive force or wear', | ||
| 'Controller Area Network: yellow and green cable used to communicate with motor controllers and sensors, can be run in a loop instead of each cable needing to connect to the MRC.', |
There was a problem hiding this comment.
Similar note to pwm, it's not just the cables. Green/yellow should be mentioned as typical, as I expect a number of teams to adopt different colors for different can busses. Also, can isn't a loop really (technically yes it forms a loop, but in terms of a device to device level, it's a bus). Also MRC??? It's SystemCore
| { | ||
| term: '3DP', | ||
| definition: 'Abbreviation for 3D printed or 3D printing', | ||
| 'Main Robot Controller (MRC), contains a CM5 chip and has CAN and USB inputs.', |
There was a problem hiding this comment.
Main robot controller isn't really a term? In the RFP, it was mobile robot controller. But also, I don't see that or MRC getting used still. This definition should also include a purpose, not just the internals (noting especially that cm5 isn't defined anywhere, nor should it be in our glossary). I'm also hesitant to mention the can and USB inputs considering there's more ports. I think this really just need needs to say that this is the main processor for the robot and is where code runs, while also having various forms of io
| term: 'Throughbore Encoder', | ||
| definition: | ||
| 'A physical limit designed to prevent a mechanism or component from moving beyond a certain point', | ||
| 'An encoder that allows shafts to pass through its center to record position', |
There was a problem hiding this comment.
Should also have a note that it's angular position/velocity (as opposed to linear position with the passing through), or should just say that it's an encoder that allows shafts to pass through, as opposed to being on the end of a shaft.
| term: 'Billet', | ||
| definition: 'Component machined down from a solid block of material', | ||
| term: 'Blinkin', | ||
| definition: 'LED controller for REV', |
There was a problem hiding this comment.
Is this really necessary to include? I wouldn't expect it to make an appearance in the course
| term: 'Repository', | ||
| definition: | ||
| 'Designed in a way that uses relationships between steps to maintain design intent', | ||
| 'A storage location for software packages, often used in version control systems like Git. Repositories are just folders that contain files and subfolders, and they can be hosted on platforms like GitHub to facilitate collaboration and version tracking', |
There was a problem hiding this comment.
Adding a small example, like "In FRC, your robot code for a single season is usually located within one repository" would be a good idea.
| }, | ||
| { | ||
| term: 'SparkMAX', | ||
| term: 'Spark MAX', |
There was a problem hiding this comment.
I think definitions for TalonFX, SparkFlex, and TalonFXS would be useful as well.
If we don't plan to have any exercises that use the latter 2, it would be ok to exclude them, but they're still useful terms to know anyways.
3 participants
This PR updates the glossary to be generated from a typescript file that contains definitions. It also adds glossary highlighting for all the terms in the glossary that end up in the site.