Skip to content

Revise 2027 addressable LEDs documentation for Systemcore#3195

Open
Another-Person1 wants to merge 77 commits into
wpilibsuite:mainfrom
Another-Person1:patch-3
Open

Revise 2027 addressable LEDs documentation for Systemcore#3195
Another-Person1 wants to merge 77 commits into
wpilibsuite:mainfrom
Another-Person1:patch-3

Conversation

@Another-Person1

@Another-Person1 Another-Person1 commented Dec 15, 2025

Copy link
Copy Markdown

Updated 2027 Systemcore documentation for addressable LEDs to include additional LED types and clarify connections. Added notes on powering and best practices.

sciencewhiz and others added 30 commits June 3, 2025 22:18
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
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 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed duplicate lines and hopefully fixed indent issue

Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst Outdated
Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst Outdated

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixing docs issues

Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst
Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst Outdated
Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed more stuff and added a basic diagram

Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst Outdated

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. image:: https://github.com/user-attachments/assets/2f1d7f05-f11b-4bed-bb91-267134f04f23)
(insert one here in the future)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that makes sense

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll see if I can do that

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed wiring diagram, checking to see if it is fixed

Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst Outdated
Comment thread source/docs/software/hardware-apis/misc/addressable-leds.rst Outdated
@github-actions github-actions Bot added the 2027 label Jan 4, 2026
@Another-Person1 Another-Person1 changed the title Revise 2027 addressable LEDs documentation for clarity Revise 2027 addressable LEDs documentation for Systemcore Feb 22, 2026

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

made a bunch of stuff more concise and removed unneeded information

@@ -1,25 +1,43 @@
# Addressable LEDs
Addressable LEDs
================

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted here, frc-docs uses a mixture of md and rst syntax. Headings should use md syntax

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't that md syntax already?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like it might be an alternate syntax for md, but it doesn't match the frc-docs style-guid

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see what you are talking about now, it should be fixed

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed build issues, added note recommending against vrm for new purchases

@sciencewhiz

Copy link
Copy Markdown
Collaborator

5 admonitions in a row is excessive and some of the information there might be better to collect into its own section

I agree. Particularly the notes about supported strips with timing information and the powering should be made into their own sections.

@Another-Person1 Another-Person1 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hopefully fixed the redirect error

@sciencewhiz sciencewhiz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a note about timing not being configurable like roboRIO

:language: java
:lines: 32-47
:lineno-match:
.. code-block:: java

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes should be PRed to allwpilib, rather then removing the remoteliteralincludes

@sciencewhiz sciencewhiz changed the base branch from 2027 to main June 5, 2026 01:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.