-
Notifications
You must be signed in to change notification settings - Fork 285
Update ssh, ftp, web dashboard and imaging pages for the systemcore #3161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
update roborioSsh branch
|
Also, should i make this use the #3041 template ? |
Gold856
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's still quite a few roboRIO mentions; at least the lines that were modified to point to Systemcore articles should have them changed.
Also, it's still the alpha period. I'm concerned about these docs falling out of date relatively soon.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Redirects should only be appended to; our redirect extension will consolidate nested redirects to just one redirect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See this for more details: https://docs.wpilib.org/en/2027/docs/contributing/frc-docs/build-instructions.html#redirect-check
|
|
||
| Supported image files are named ``limelightsystemcorecm5-limelightosr-YEAR-VERSION.zip``. | ||
|
|
||
| .. note:: Raspberry Pi images will not boot on a Systemcore because the OS and drivers are incompatible. Similarly, a Systemcore image is not compatible with Raspberry Pi controller boards. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically not true.
| 2. :doc:`Install WPILib </docs/zero-to-robot/step-2/wpilib-setup>` (Java / C++ teams only) | ||
| 3. :doc:`Update third party libraries </docs/software/vscode-overview/3rd-party-libraries>` | ||
| 4. Reimage :doc:`roboRIO 1 </docs/zero-to-robot/step-3/imaging-your-roborio>` or :doc:`roboRIO 2 </docs/zero-to-robot/step-3/roborio2-imaging>` | ||
| 4. :doc:`Reimage </docs/zero-to-robot/step-3/systemcore-imaging>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This just says Reimage now, and I think it's slightly better to at least mention Systemcore by name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels rather sparse. I'll defer to the official maintainers for this, but I feel like it should contain more info, like what every option in the System dropdown does.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it should, but given the limited distribution of Systemcores where someone would have the info to document this, it wouldn't hold up merging this PR
|
|
||
| .. note:: This document contains advanced topics not required for typical FRC\ |reg| programming | ||
|
|
||
| The Systemcore image contains a number of accounts, this article will highlight the main on used for FRC and provide some detail about its purpose. It will also describe how to connect to the Systemcore over SSH. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
number of accounts
Seems irrelevant to mention. There's technically a pi account I think, but that's not used iirc.
|
|
||
| The Systemcore requires to be powered on while the USB-C cable is plugged in to enter flash mode. | ||
|
|
||
| .. warning:: Before imaging your Systemcore, you must have completed installation of the :doc:`FRC Game Tools</docs/zero-to-robot/step-2/frc-game-tools>`. You also must have the Systemcore power properly wired to the CTRE Power Distribution Panel or REV Power Distribution Hub. Make sure the power wires to the Systemcore are secure. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
game tools isn't necessary for imaging Systemcore
| .. image:: images/systemcore-filesystem.png | ||
| :alt: User will use the right pane to browse the Linux file system. | ||
|
|
||
| After connecting to the Systemcore, Filezilla will open to the \\home\\systemcore directory. The right pane is the remote system (the roboRIO), the left pane is the local system (your computer). The top section of each pane shows you the hierarchy to the current directory you are browsing, the bottom pane shows contents of the directory. To transfer files, simply click and drag from one side to the other. To create directories on the roboRIO, right click and select "Create Directory". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| After connecting to the Systemcore, Filezilla will open to the \\home\\systemcore directory. The right pane is the remote system (the roboRIO), the left pane is the local system (your computer). The top section of each pane shows you the hierarchy to the current directory you are browsing, the bottom pane shows contents of the directory. To transfer files, simply click and drag from one side to the other. To create directories on the roboRIO, right click and select "Create Directory". | |
| After connecting to the Systemcore, Filezilla will open to the `/home/systemcore` directory. The right pane is the remote system (the roboRIO), the left pane is the local system (your computer). The top section of each pane shows you the hierarchy to the current directory you are browsing, the bottom pane shows contents of the directory. To transfer files, simply click and drag from one side to the other. To create directories on the roboRIO, right click and select "Create Directory". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it should, but given the limited distribution of Systemcores where someone would have the info to document this, it wouldn't hold up merging this PR
| The roboRIO RS-232 serial port uses RS-232 signaling levels (+/- 15v). The MXP serial port uses CMOS signaling levels with a 3.3v output, and a 3.3v to 5v tolerant input. | ||
|
|
||
| .. note:: By default, the onboard RS-232 port is utilized by the roboRIO's serial console. In order to use it for an external device, the serial console must be disabled using the :ref:`Imaging Tool <docs/zero-to-robot/step-3/imaging-your-roborio:Imaging your roboRIO 1>` or :ref:`docs/software/systemcore-info/roborio-web-dashboard:roboRIO Web Dashboard`. | ||
| .. note:: By default, the onboard RS-232 port is utilized by the roboRIO's serial console. In order to use it for an external device, the serial console must be disabled using the //TODO |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Systemcore doesn't have a serial console or RS-232 serial port. This section can be deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See this for more details: https://docs.wpilib.org/en/2027/docs/contributing/frc-docs/build-instructions.html#redirect-check
I updated the ftp, ssh, web dashboard and imaging pages to 2027.
This is my first pr to an actual project so please tell me what i could improve.