Revise 2027 addressable LEDs documentation for Systemcore#3195
Revise 2027 addressable LEDs documentation for Systemcore#3195Another-Person1 wants to merge 77 commits into
Conversation
Fixes NI forums linkcheck failure
Made a separate workflow so it runs hours later to avoid rate limits
Changed the cable to a USB-C one as non-beta XRPs use that, and updated the Micro USB link to one that's actually available. --------- Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com>
Fixes dependabot alerts Unpin urllib3 since it's no longer maintained
Update link to AdvantageScope 2025 changes to CD post, since removed from AdvantageScope website Update link to Spark Max getting started Ignore filezilla and miktex as they are blocking
also updated the description a bit
Python 3.9 will be out of support soon Update RTD to Ubuntu 22.04 since 20.04 is out of support
Appears to be unused and is unmaintained
Don't automatically add 2 newlines after a code block, check to see if there's options after, and only add a newline after the options are added. This fixes the code blocks in the stacktrace page. Fixes wpilibsuite#2728
* General refresh of document. Specifics: * put "Operator Console" in title because that's what FIRST calls it in the game manual * expand on wifi band recommendation with links to Vivid documents * restructure document into more sections * add table of contents * more recommendations on constructing the driver station * recommend fresh Windows install * more specific recommendation on the account used * brought windows update and power settings to current UI * relocate credits to bottom * Clarify reference to driver station peripherals. Clarify 6GHz language. Use link text for DS rather than showing Google link. Fix trailing whitespace. * Remove TOC. Make specific Ethernet dongle recommendation based on CD recommendation. Blast Windows 10 harder. Add more nuance to Wi-Fi 6E discussion. Use a CD link for driver station examples. Add more details on why wall power is good for your laptop. * Trailing whitespace for the win. * Update source/docs/software/driverstation/driver-station-best-practices.rst Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com> * Update source/docs/software/driverstation/driver-station-best-practices.rst Co-authored-by: Dan Katzuv <31829093+katzuv@users.noreply.github.com> * Update source/docs/software/driverstation/driver-station-best-practices.rst Co-authored-by: Dan Katzuv <31829093+katzuv@users.noreply.github.com> * Bump minimum recommended display size to 14". FIRST in their recommendations says 15" but that eliminates many used ultrabooks. * Update source/docs/software/driverstation/driver-station-best-practices.rst Co-authored-by: Jason Daming <jason.daming@intralox.com> --------- Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com> Co-authored-by: Dan Katzuv <31829093+katzuv@users.noreply.github.com> Co-authored-by: Jason Daming <jason.daming@intralox.com>
…3107) Updated SSH documentation to use OpenSSH command-line interface instead of PuTTY, as OpenSSH is included by default on Windows, macOS, and Linux. Removed outdated PuTTY screenshots and simplified connection instructions. Fixes wpilibsuite#2919
Another-Person1
left a comment
There was a problem hiding this comment.
Removed duplicate lines and hopefully fixed indent issue
Another-Person1
left a comment
There was a problem hiding this comment.
Fixed more stuff and added a basic diagram
Another-Person1
left a comment
There was a problem hiding this comment.
Fixed image, should hopefully fix error
|
|
||
| .. warning:: WS2815 LEDs (and maybe other products as well, **check the label**) are designed for **12V** but have **5V** data (see above note). The **backup line on the first strip** needs to be connected to **ground**, **not** connected to the data line despite what other guides may say. | ||
| Example wiring diagram: | ||
| .. image:: https://github.com/user-attachments/assets/2f1d7f05-f11b-4bed-bb91-267134f04f23) |
There was a problem hiding this comment.
| .. image:: https://github.com/user-attachments/assets/2f1d7f05-f11b-4bed-bb91-267134f04f23) | |
| (insert one here in the future) |
There was a problem hiding this comment.
I'm not familiar with the github web editor, but you'll need to commit the image to the repo, not just have it upload to the github server.
There was a problem hiding this comment.
i'll see if I can do that
Another-Person1
left a comment
There was a problem hiding this comment.
removed wiring diagram, checking to see if it is fixed
Another-Person1
left a comment
There was a problem hiding this comment.
made a bunch of stuff more concise and removed unneeded information
| @@ -1,25 +1,43 @@ | |||
| # Addressable LEDs | |||
| Addressable LEDs | |||
| ================ | |||
There was a problem hiding this comment.
isn't that md syntax already?
There was a problem hiding this comment.
It looks like it might be an alternate syntax for md, but it doesn't match the frc-docs style-guid
There was a problem hiding this comment.
I see what you are talking about now, it should be fixed
Another-Person1
left a comment
There was a problem hiding this comment.
fixed build issues, added note recommending against vrm for new purchases
I agree. Particularly the notes about supported strips with timing information and the powering should be made into their own sections. |
Another-Person1
left a comment
There was a problem hiding this comment.
hopefully fixed the redirect error
sciencewhiz
left a comment
There was a problem hiding this comment.
It's looking a lot better. Undoing the change to redirects.txt and rebaseing on the 2027 branch should fix the redirect failure
|
|
||
| .. warning:: WS2812B LEDs are designed for 5V, but roboRIO PWM/Servo ports output 6V. While the LEDs will function, this may reduce their lifespan. Consider using a voltage regulator or level shifter if longevity is a concern. | ||
| This library supports only WS2812B-compliant LEDs. LEDs that do not follow the timings below may not work correctly. For example, WS2815 and DotStar LEDs are not supported. | ||
|
|
There was a problem hiding this comment.
Add a note about timing not being configurable like roboRIO
| :language: java | ||
| :lines: 32-47 | ||
| :lineno-match: | ||
| .. code-block:: java |
There was a problem hiding this comment.
These changes should be PRed to allwpilib, rather then removing the remoteliteralincludes
Updated 2027 Systemcore documentation for addressable LEDs to include additional LED types and clarify connections. Added notes on powering and best practices.