Merge branch 'update-simulator-more'

Author: PeterJCLaw

_data/sidebar_tree.yaml

@@ -103,9 +103,9 @@ tree:
     title: Simulator
     tree:
     - url: /simulator/setting_up_simulator
-      title: Setting up the simulator
+      title: Setting up the Simulator
     - url: /simulator/using_the_simulator
-      title: Using the simulator
+      title: Using the Simulator
     - url: /simulator/simulator_programming
       title: Simulator Programming
   - url: /troubleshooting/

index.md

@@ -11,6 +11,7 @@ The information is spread across multiple sections:
 
 - The [kit](/docs/kit/) section will give you an overview of the physical kit that is provided to your team, how to connect to each board and what features they have.
 - The [programming](/docs/programming/) section talks through how to write code that interacts with all the boards.
+- The [simulator](/docs/simulator/) section explains how to use the simulator for testing your code, exploring strategies as well as preparing for the virtual competition.
 - The [rules](/docs/rules/) section is important as it talks through the aim of this year's game and what task you are trying to achieve.
 - [Tutorials](/docs/tutorials/) are a series of guides that will help you get started.
 

programming/arduino/custom_firmware.md

@@ -12,6 +12,10 @@ On this page we talk specifically about Arduinos.
 However this page is applicable to opening any device that shows up as a serial port.
 </div>
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 
 ## Ignoring a device
 

programming/arduino/extended_sr_firmware.md

@@ -5,6 +5,10 @@ title: Arduino extended firmware
 
 # Arduino with extended SR firmware
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 You may wish to extend the SR firmware with additional functionality.
 This will allow you to continue using the commands already provided by the SR firmware (e.g. `digital_read()`),
 which means any existing robot code you have won't need modifying very much.

programming/cheat_sheet.md

@@ -124,6 +124,10 @@ robot.motor_board.motors[1].power = -1
 
 ### Special motor values
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 Setting a motor to `BRAKE` is equivalent to power level `0`.
 
 ~~~~~ python
@@ -153,6 +157,10 @@ You can also set the position to `0`, which is the approximate centre.
 
 ### Taking a photo
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 It can sometimes be useful to save a photo of what markers the robot can see:
 
 ~~~~~ python
@@ -161,6 +169,10 @@ robot.camera.save("my-photo.jpg")  # Save my-photo.jpg to the USB drive
 
 ### Capturing an openCV array
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 Take a photo using the webcam, and return the image data as an OpenCV array:
 
 ~~~~~ python
@@ -183,6 +195,7 @@ for marker in markers:
     marker.id  # The ID of the marker
     marker.size  # Physical size of the marker in mm.
 
+    # Position of the marker on the image (physical kits only)
     marker.pixel_centre  # The co-ordinates of the centre of the marker
     marker.pixel_corners  # A list of corners of the marker
 

programming/compass.md

@@ -8,6 +8,10 @@ title: Brain Board LED API
 Brain Board LED API
 ===================
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 The KCH board provides diagnostic information about the state of your robot through a collection of preconfigured and user-controllable LEDs.
 It is part of the [Brain Board](/docs/kit/brain_board) assembly and will be found attached to the top of the Raspberry Pi.
 

programming/leds.md

@@ -124,6 +124,10 @@ print(robot.motor_boards["srABC1"].motors[0].power)
 Special Values
 --------------
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 In addition to the numeric values, there are two special constants that can be used:
 - `BRAKE`
 - `COAST`
@@ -151,6 +155,10 @@ robot.motor_boards["srABC1"].motors[0].power = COAST
 Motor currents
 --------------
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 The Motor Board can also measure the current being drawn by each of the ports on the board.
 This value is measured in amps.
 

programming/motors.md

@@ -58,6 +58,10 @@ print(robot.servo_board.servos[1].position)
 Disabling servo outputs
 -----------------------
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 Setting a position to `None` will disable an output.
 This is the state all the servo outputs are in when the board turns on, where no servo pulses are being sent to the outputs.
 
@@ -70,6 +74,10 @@ robot.servo_board.servos[5].position = None
 Extended servo range
 --------------------
 
+<div class="info">
+  This documentation refers to a feature which is only available on the physical robot kits.
+</div>
+
 For an RC servo the angle of rotation is determined by the width of an electrical pulse on the control wire.
 A typical servo expects to see a pulse every 20ms, with a pulse width between 1ms and 2ms.
 Our API will take the position provided (between -1 and 1) and map it to the correct pulse width.