Skip to content

Docs update for 2027 #27

@Kobsy7748

Description

@Kobsy7748

Getting started

  • Update image for new game theme and sponsor list
  • Update kit contents (if changed)

Hardware

Batteries

Overview

  • Ensure that battery specs are up to date
  • Describe mAh as a unit?
  • Give ballpark estimates for battery life

Battery safety

  • Explain that provided battery compartment (or suitable alternative) must be used

Charging

  • Ensure that charging instructions are up to date (we still use the same chargers?)

The brainbox

Overview

  • Update brain image (if it would have changed)

How to turn everything on

  • Ensure power up procedure has not changed

Power

  • Check that the stated voltages provided from the brain are still accurate (Did we add 3.3V?)

Motors & 12V Power

  • Check that voltage and current tolerances are accurate (Have they changed?)

USB’s

  • Check that the number of usb ports is still accurate (have we moved to 2 usbs?)

GPIO out

  • Check that GPIO resistors have not changed in value

GPIO in

  • Remove reference to forums (if forums have not been reproduced)

GPIO limits

  • Check that the max current through GPIO has not changed

PWM pins

  • Check that link to PWM tutorial functions
  • Check that PWM pins voltage and current limits are currently accurate
  • Check that PWM ranges have not changed

Pinout

  • Update all images in this section

Expanding functionality

I2C

  • Remove section

USB

  • Add dev/ttyACM0

UART

  • Remove section
  • Remove reference to forums (if forums have not been reproduced)

Kit List of Parts

  • Check that the Kit has not had any parts added/removed

Minibot Assembly

  • Find instruction set that does not reference :battery compartment, protection wrap,encoder wheels
    Or, instead of above, change minibot provided

Programming

Learning Python

  • Check that blockly is functional

Initialising the Robot

  • Make “if the brain has crashed” section accessible from other locations

Motors

  • Remove direct reference to cubes (may not be a part of a future game)

GPIO

  • Check that number of GPIO pins has not changed

Servos

  • Remove direct reference to cubes (may not be a part of a future game)

Vision

  • Update data that refers directly to the 2026 game

Changing the resolution

  • Check that updating the resolution is functional (I believe it was broken during kickoff)

Using USB cameras

  • Warn that results from USB cameras may vary

Markers

  • Update with markers used for the 2027 game

Zones

  • Check that zones as a concept are still relevant for the 2027 game
  • The code example states: “This code checks if the first marker in the list belongs to the current robot.” However the code in actuality checks if the robot is in the red sector

Libraries

  • Check that this list of libraries (and their versions) are up to date

Toggling 12v and 5v power

  • Check that the enable/disable code have not changed

Tools

Connecting

  • Remove reference to windows (I believe we hand out linux devices)
  • Check that the nomenclature for brain’s wifi connections (RoboConYYYY-TeamXX) has not changed
  • Update image for shepherd code management system

Using the editor

The editor interface

  • Update editor interface image with what it currently looks like

USB tricks

  • Remove reference to green robocon brains
  • Update number of USB ports on red robocon brains (if changed)

Running your code from a USB

  • Update “troubleshooting” hyperlink so it functions properly

Updating your team image

  • Move this section to a more appropriate location as it no longer requires a usb stick (maybe in the tutorials section?)
  • Update this section with the modern process to update the team image

Troubleshooting

  • Assess if the student robotics troubleshooting page is still relevant (could we copy useful things to our website?)
  • See if more concise headings for each problem could be used (or if they could be grouped under a more general heading?)

The BrainBox appears to power up, the blue LED light flashes but I cannot connect to it using the WiFi.

  • Check if we still use the font with the problems stated

What is the patch and how do I install it?

  • Check if the patch referred to is relevant

Patching the Robot

  • Check if this procedure to install a patch is still correct
  • Update editor image
  • Update patch passphrase

Uploading and Running Code

  • Check if this section is needed (given that its content is depreciated)

Collecting Images and Raw Analysis

  • Check if this method for image collection is still accurate

Tutorials

Turning everything on

  • Remove reference to “tablet”

Hello world

  • Update shepard image (If its ui has changed)

Hello GPIO

LED Output

  • Change comment in code example to refer to GPIO pin 0 instead of “GPIO pin 1”

Buttons

  • Should we recommend buttons as a form of collision detection?

Potentiometers

  • Making reference to the fact the wire/pin attached to the potentiometer’s wiper (usually the centre wire/pin) must be connected to “POT_PIN” for this code to work properly may be helpful

Using sensors with retroreflective tape

  • Check if this section is still relevant (are we still distributing these sensors?)
  • Check that retroreflective tape is, in fact , used to mark the edges of each quadrant (I don’t believe this was true for 2026 and may not even be relevant for the 2027 game)

Hello servos

  • Check that -100 - 100 is the range of servo values we want teams to use

Hello Challenges

  • Update the PDF of kickoff challenges (if we have changed the kickoff challenges)

General notes

  • When the website’s text is copied while in dark mode it is copied in white with a black highlight (Not really a problem but odd behaviour)
  • A “master reference” with all the status led states and their respective meanings/causes could be useful

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions