Merge branch 'master' into dgt/interactive-troubleshooter

raccube · web-flow · commit 95553d4b1976 · 2021-11-13T00:14:46.000+01:00
diff --git a/_config.yml b/_config.yml
@@ -16,6 +16,7 @@ plugins:
 links:
   compete: //docs.google.com/forms/d/1Ryg2cfAxfwMOBnT01aj-fzsp51F3B182S5e53ye8aMw/viewform
   volunteer: //docs.google.com/forms/d/1MIGf3P30dw0QAtP8OkxK2v7VRDEAN_54JoZHCVMbqDY/viewform
+  donate: //link.justgiving.com/v1/charity/donate/charityId/3118662?tipScheme=TipJar2.1&isRecurring=true&amount=20.00&reference=givingcheckout_tj21
 
 navigation:
   - about
diff --git a/_data/sidebar_tree.yaml b/_data/sidebar_tree.yaml
@@ -27,9 +27,13 @@ tree:
       title: Servo Board
     - url: /kit/wifi
       title: WiFi
+    - url: /kit/safety-regulations
+      title: Safety Regulations
   - url: /programming/
     title: Programming
     tree:
+    - url: /programming/getting_code_on_the_robot
+      title: Getting Code on the Robot
     - url: /programming/python/
       title: Python
       tree:
diff --git a/_includes/footer.html b/_includes/footer.html
@@ -4,7 +4,6 @@
       <h4>For Competitors</h4>
       <ul class="sitemap">
         <li><a href="{{ site.url }}/teams/">Teams Dashboard</a></li>
-        <li><a href="{{ site.url }}/ide/">IDE</a></li>
         <li><a href="{{ site.url }}/docs/">Documentation</a></li>
       </ul>
     </div>
@@ -24,6 +23,12 @@ <h4>&nbsp;</h4>
         <li><a href="{{ site.url }}/contact/">Contact us</a></li>
       </ul>
     </div>
+    <div class="column d-4-12 m-2-12">
+      <h4>&nbsp;</h4>
+      <ul class="sitemap">
+        <li><a href="{{ site.links.donate }}">Donate</a></li>
+      </ul>
+    </div>
   </div>
   <div class="row fixed-width">
     <div class="column d-6-12">
diff --git a/_includes/navigation.html b/_includes/navigation.html
@@ -17,5 +17,8 @@
     <li>
       <a class="page-link" href="{{ site.url }}/sponsor/">Sponsor</a>
     </li>
+    <li>
+      <a class="page-link" href="{{ site.links.donate }}">Donate</a>
+    </li>
   </ul>
 </nav>
diff --git a/_sass/brand b/_sass/brand
@@ -1 +1 @@
-Subproject commit 3edcff2e0b642c24408a13f8eb9fba2259ee1361
+Subproject commit fe1bd8e36ec1c7a860aaec6336cd101f301a0573
diff --git a/images/content/kit/etcher.png b/images/content/kit/etcher.png
diff --git a/images/content/kit/zip_macOS.png b/images/content/kit/zip_macOS.png
diff --git a/images/content/kit/zip_win10.jpg b/images/content/kit/zip_win10.jpg
diff --git a/images/content/kit/zip_win11.png b/images/content/kit/zip_win11.png
diff --git a/kit/brain_board.md b/kit/brain_board.md
@@ -9,3 +9,31 @@ Brain Board
 <img src="{{ site.baseurl }}/images/content/kit/brain.png" alt="A photo of a brain board" title="A brain board" class="right" />
 The Odroid U3+ Brain Board provided with your kit is what runs the code you write
 and controls the other peripheral boards.
+
+### Flashing SD card
+
+In order to get access to the SD card, you will need to open up the case for the brain board. Pull the latch at the end of the case in order to hinge it open.
+The SD card is located on the underside of the board. Carefully open the Brain Board's plastic case, grab the SD card with your fingers and simply pull it out of the slot.
+
+To fully update your Brain Board's software, or refresh it if you think it's not working correctly, you can flash our SD card image onto the microSD card in your Brain Board.
+
+To update the SD card, you'll need to download our image, [`srobo-robot-2022.0.0.img.xz`][robot-image].
+The flashing procedure is identical to flashing Raspberry Pi images.
+
+[robot-image]: https://kit-downloads.studentrobotics.org/kit-software/2022.0.0/srobo-robot-2022.0.0.img.xz
+
+## Etcher
+
+We recommend using [etcher](https://etcher.io), as it's simple to use, and available on Windows, macOS and Linux. If you're familiar with Raspberry Pis or other similar boards and have flashed images before with a different tool, that will also work.
+
+![Etcher example]({{ site.baseurl }}/images/content/kit/etcher.png)
+
+<div class="info">
+If you choose to use a tool other than Etcher, you may need to extract the `srobo-robot-2022.0.0.img.xz` to `srobo-robot-2022.0.0.img`. There are many tools available for this, e.g. [7-zip](http://www.7-zip.org/).
+</div>
+
+### Flashing
+
+1. Open Etcher and select the `srobo-robot-2022.0.0.img.xz` file you downloaded
+2. Select your SD card from the devices window
+3. Click 'Flash!'
diff --git a/kit/index.md b/kit/index.md
@@ -40,11 +40,8 @@ As well as the aforementioned boards the kit also contains the following items.
 | USB Memory Stick       | 1   | Kingston Datatraveler 16GB SE9H                                       | [DTSE9H/16GB][DTSE9H-16GB]                  |
 | Standard USB cable     | 3   | Standard USB A to B connector                                         | N/A                                         | For connecting the ruggeduino (via a hub) and USB hubs to the ODROID
 | Micro USB cable        | 5   | Standard USB A to Micro USB B                                         | N/A                                         | For connecting the motor boards, servo boards and power board to the ODROID
-| Blue Hook-up Wire      | 1   | 2.5m<br />0.5mm<sup>2</sup><br />4A                                   | [RS 361-585][RS-361-585]                    | General purpose wire
-| Yellow Hook-up Wire    | 1   | 2.5m<br />0.5mm<sup>2</sup><br />4A                                   | [RS 361-636][RS-361-636]                    | General purpose wire
-| Green Power Wire       | 1   | 2.5m<br />1mm<sup>2</sup><br />10A                                    | [RS 748-2042][RS-748-2042]                  | To connect the motors to the motor boards only
-| Red Power Wire         | 1   | 2.5m<br />1mm<sup>2</sup><br />10A                                    | [RS 361-759][RS-361-759]                    | To connect power from the power board to the motor/servo boards
-| Black Power Wire       | 1   | 2.5m<br />1mm<sup>2</sup><br />10A                                    | [RS 361-715][RS-361-715]                    | To connect power from the power board to the motor/servo boards
+| Coloured Power Wire    | 1   |                                                                       |                                             | To connect power from the power board to the motor/servo boards
+| Black Power Wire       | 1   |                                                                       |                                             | To connect power from the power board to the motor/servo boards
 | CamCon                 | 10  | 2 way<br />7.5mm<br />12A                                             | [Farnell 3882275][F-3882275]                | To connect 12V from the power board to the motor and servo boards
 | MiniCamCon             | 7   | 2 way<br />5mm<br />12A                                               | [Farnell 3881854][F-3881854]                | To connect motors to the motor boards, and to connect an external power switch
 | MicroCamCon            | 1   | 2 way<br />3.81mm<br />12A                                            | [Farnell 1717047][F-1717047]                | To connect a 5V component to the power board or to connect an external start button
@@ -60,11 +57,7 @@ As well as the aforementioned boards the kit also contains the following items.
 [F-3881854]: https://uk.farnell.com/3881854
 [F-1717047]: https://uk.farnell.com/1717047
 [F-2103271]: https://uk.farnell.com/2103271
-[RS-361-715]: https://uk.rs-online.com/web/p/products/361-715
-[RS-361-759]: https://uk.rs-online.com/web/p/products/361-759
 [RS-748-2042]: https://uk.rs-online.com/web/p/products/748-2042
-[RS-361-585]: https://uk.rs-online.com/web/p/products/361-585
-[RS-361-636]: https://uk.rs-online.com/web/p/products/361-636
 [EB-230435]: https://www.ebuyer.com/230435-logitech-c270-hd-webcam-720p-hd-video-960-000582
 [G138960965859]: https://www.hardkernel.com/main/products/prdt_info.php?g_code=G138960965859
 [0000153]: https://www.modelsport.co.uk/overlander-lipo-safe-sack/rc-car-products/38313
diff --git a/kit/safety-regulations.md b/kit/safety-regulations.md
@@ -0,0 +1,28 @@
+---
+layout: page
+title: Safety Regulations
+---
+
+# Safety Regulations
+
+To maintain safety at the competition, all robots at the event are required to pass the safety regulations that are listed below. Robots that do not comply to these rules will not be permitted to compete.
+
+These regulations are intended to identify a base level of safety — the inspector will use their own judgement and common sense when assessing your robot, and your robot may be judged to be unsafe for reasons or features not listed here.
+
+We recommend that you bear these regulations in mind during development too, although it’s not always possible to meet them while building and testing your robot.
+
+The following procedure will be used when testing a robot:
+- Check that there is a battery installed in the robot.
+- Check that any additional power sources have already been authorised.
+- Check that the battery cable originally provided by Student Robotics is being used to connect the power board to the battery. If not, check that the replacement has suitable rating and quality.
+- Leaving the battery physically installed, unplug the deans connector.
+- Check the battery’s mounting holds the battery securely, and does not expose the battery to sharp edges.
+- Check that the battery’s casing is rigid, and strong – i.e. bubble wrap is not suitable.
+- Locate the large green power connector that connects the battery to the power board. In turn, give each of the wires that enter it a gentle tug. The cables must not move.
+- Check that there is not an excessive amount of unshielded wire protruding from the large green power connector.
+- Check that the cable between the large green power connector and the deans connector is not damaged. The sheath must not have any holes in etc.
+- Check that the cables between the power board and body of the battery do not pass through areas of the robot that could cause them to be damaged by moving mechanical parts.
+- Check that only the power board is connected to the battery (if the deans connector were currently connected).
+- Check that the power switch on the power board is easily accessible.
+- Check that all electronics are securely fixed to the robot.
+- Check for unreasonably sharp edges and dangerous moving parts.
diff --git a/programming/editors/index.md b/programming/editors/index.md
@@ -5,14 +5,9 @@ title: Code Editors
 
 # Code Editors
 
-When developing code to run on our robotics kit, we recommend that you start by
-using our hosted IDE. The hosted IDE provides an easy way to get going, as well
-as ensuring that you have a history of your code which is available from
-anywhere and your mentor can access. We appreciate that you may wish to use your
-own editor instead, which you are free to do.
-
-When developing code to run in the simulator, you will need to have both the
-simulator and your own editor set up.
+In order to develop the code for your robot, we recommend that you use a code
+editor. A code editor (rather than a plain text editor) will make it easier to
+develop your code and help you catch errors sooner.
 
 <div class="info">
 However you are working on your code, you are encouraged to ensure you have a backup!
diff --git a/programming/getting_code_on_the_robot.md b/programming/getting_code_on_the_robot.md
@@ -0,0 +1,40 @@
+---
+layout: page
+title: Getting Code on the Robot
+---
+
+# Getting Code on the Robot
+
+Getting your code on to the robot is quite simple.
+You will need to put your code on a USB drive
+Which will need to be formatted with either FAT32, exFAT, NTFS or ext2/3/4.
+Upon plugging in the drive or starting up, the robot will run the `robot.py` file found in the `robot.zip` in the root of the drive.
+
+## Windows
+
+1. Open your code in File Explorer
+2. Select all of your code files (<kbd>Ctrl</kbd><kbd>A</kbd> to select all files)
+3. Right-click the files
+4. Click Compress to Zip file
+5. Name the newly created file `robot` (or `robot.zip` if you have file extentions shown)
+
+<img src="{{ site.baseurl }}/images/content/kit/zip_win10.jpg" alt="Screenshot for Windows 10" class="column half" />
+<img src="{{ site.baseurl }}/images/content/kit/zip_win11.png" alt="Screenshot for Windows 11" class="column half" />
+
+If you are on Windows 10 or older, you will need to use Send to &rarr; Compressed (zipped) folder.
+
+## macOS
+
+1. Open your code in Finder
+2. Select all of your code files (<kbd>⌘</kbd><kbd>A</kbd> to select all files)
+3. Right-click (or Control-click) the files and click Compress
+4. Name the newly created file `robot.zip`
+
+![Screenshot]({{ site.baseurl }}/images/content/kit/zip_macOS.png)
+
+To re-run your program, simply remove the USB stick and plug it back in again and it will restart automatically.
+
+## Robot Logs
+
+When your program runs on the robot, the output of `print(...)` calls and any
+errors which occur are written to a log file on the USB stick as `log.txt`.
diff --git a/programming/sr/cheat_sheet.md b/programming/sr/cheat_sheet.md
@@ -236,7 +236,7 @@ The API also makes some information about where your code is running
 ### Starting Zone for a match
 
 ~~~~~ python
-zone = r.zone  # -> 0, 1, 2, or 3
+zone = R.zone  # -> 0, 1, 2, or 3
 ~~~~~
 
 ### Arena Information
diff --git a/programming/sr/servos/index.md b/programming/sr/servos/index.md
@@ -10,69 +10,72 @@ Servos
 This documentation refers to a feature which is only available on the physical robot kits.
 </div>
 
-The `servos` object is used to control a collection of Servo Boards.
-Similar to `motors` and `ruggeduinos`, `servos` can be used like a list.
-To do something with the **first Servo Board**, you would use:
+The `servo_board` object is used to control a collection of Servo Boards.
+
+When a single Servo Board is connected to your robot, you can control it
+using the `servo_board` object.
 
 ~~~~~ python
-R.servos[0].something...
+R.servo_board.something...
 ~~~~~
 
-...because indexes are 0-based (counting starts from 0, not 1).
-
-When you have more than one Servo Board connected to your kit
-they will be ordered based upon their serial number.
-
-The SR Part Code of each detected motor board is also printed to the log when your robot starts.
+The serial number of each detected Servo Board is printed to the log when your robot starts.
 It will look something like this:
 
 ~~~~~ not-code
-Found the following devices:
- - Servos:
-    0: Servo( serialnum = "SR0LG31" )
+sr.robot3.robot INFO - Found Student Robotics Servo Board v4 - srABC1
 ~~~~~
 
-
-However, like `motors` and `ruggeduinos`, `servos` is actually a dictionary.
-As a result, in `servos` you can also use the SR Part Code of the Servo Board as a key.
-For example, if you had a board that was labelled "SR0LG31",
-you could do this instead:
+If you have more than one Servo Board attached, you need to specify which one you want to control. This is done using the serial number of the board. For example: if you had a board that was labelled "srABC1",
 
 ~~~~~ python
-R.servos["SR0LG31"].something...
+R.servo_boards["srABC1"].something...
 ~~~~~
 
+<div class="warning">
+    When you have more than one servo board connected to your kit,
+    you must use `R.servo_boards` and index by serial number. This is so
+    that the kit knows which servo board you want to control.
+</div>
+
 Setting servo positions
 -----------------------
 
-The position of servos can range from `-100` to `100` inclusive:
+The position of servos can range from `-1` to `1` inclusive:
 
 ~~~~~ python
-# R.servos[SERVO_BOARD_ID][SERVO_NUMBER] = POS
+# R.servo_board.servos[SERVO_NUMBER].position = POS
 
-# set servo 1's position (on the first Servo Board connected, board 0) to 20
-R.servos[0][1] = 20
-# Set servo 2's position (on the Servo Board with part code SRABC) to -55
-R.servos["SRABC"][2] = -55
-~~~~~
+# set servo 1's position to 0.2
+R.servo_board.servos[1].position = 0.2
 
-<div class="warning" markdown="1">
-It is important that you use integers (whole numbers, such as `10` instead of
-`10.0`) when specifying servo positions.
-</div>
+# Set servo 2's position (on the Servo Board with serial number srABC) to -0.55
+R.servo_boards["srABC"].servos[2].position = -0.55
+~~~~~
 
 You can read the last value a servo was set to using similar code:
 
 ~~~~~ python
 # get the last setting of the second servo on the first Servo Board
-lastSetting = R.servos[0][1]
+last_setting = R.servo_board.servos[1].position
 ~~~~~
 
 <div class="info" markdown="1">
 While it is possible to retrieve the last position a servo was set to,
 this does not guarantee that the servo is currently in that position.
 </div>
 
+Turning off a servo
+-------------------
+
+You can also set a servo output to be unpowered, so that there is no longer a PWM signal from the output on the servo board.
+
+You can unpower the servo output by setting the position to `None`.
+
+~~~~~ python
+r.servo_board.servos[11].position = None
+~~~~~
+
 [How the set position relates to the servo angle](#ServoAngle) {#ServoAngle}
 -----------------------------------------------
 
@@ -84,4 +87,4 @@ Some servos are very strong and it could damage the internal gears.
 The angle of an RC servo is controlled by the width of a pulse supplied to it periodically.
 There is no standard for the width of this pulse and there are differences between manufacturers as to what angle the servo will turn to for a given pulse width.
 To be able to handle the widest range of all servos our hardware outputs a very wide range of pulse widths which in some cases will force the servo to try and turn past its internal end-stops.
-You should experiment and find what the actual limit of your servos are (it almost certainly won't be -100 and 100) and not drive them past that.
+You should experiment and find what the actual limit of your servos are (it almost certainly won't be -1 and 1) and not drive them past that.
diff --git a/troubleshooting/index.md b/troubleshooting/index.md
@@ -10,7 +10,7 @@ If you are experiencing problems with either the Student Robotics hardware or py
 If you don't find the information you need in this section you can use the
 [forum]({{ site.url }}/forum/) to get help with your specific problem.
 
-1. [`sr.robot` python library issues](/docs/troubleshooting/python) &mdash; Common problems with the `sr.robot` python library and possible solutions.
+1. [`sr.robot3` python library issues](/docs/troubleshooting/python) &mdash; Common problems with the `sr.robot3` python library and possible solutions.
 2. [Interactive Troubleshooter](/docs/troubleshooting/interactive_troubleshooter) &mdash; Consider using the Interactive Troubleshooter to narrow down your problem and find a solution.
 
 [General Troubleshooting Tips](#GeneralTips) {#GeneralTips}
diff --git a/tutorials/python.md b/tutorials/python.md
@@ -6,7 +6,7 @@ title: "Python: A whirlwind tour"
 Python: A whirlwind tour
 ========================
 
-In this tutorial, we'll introduce the basic concepts of programming, which will be central to the programs that you will run on your robot. There are many different languages in which computers can be programmed, all with their advantages and disadvantages, but for the Student Robotics competition we use one called Python 2.6. We chose it because it's good for beginners, but also elegant and powerful.
+In this tutorial, we'll introduce the basic concepts of programming, which will be central to the programs that you will run on your robot. There are many different languages in which computers can be programmed, all with their advantages and disadvantages, but for the Student Robotics competition we use one called Python 3.9. We chose it because it's good for beginners, but also elegant and powerful.
 
 Sprinkled through the tutorial are exercises. The first ones for each section should be quite easy, while the higher-numbered exercises will be harder. Some will be very hard; try these if you're up for a challenge.
 
