Skip to content

Commit 57f4814

Browse files
committed
Remove outdated warnings about features not supported by the simulator
1 parent 31f3b94 commit 57f4814

File tree

7 files changed

+1
-54
lines changed

7 files changed

+1
-54
lines changed

programming/arduino/custom_firmware.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ On this page we talk specifically about Arduinos.
1212
However this page is applicable to opening any device that shows up as a serial port.
1313
</div>
1414

15-
<div class="info">
16-
This documentation refers to a feature which is only available on the physical robot kits.
17-
</div>
18-
19-
2015
## Ignoring a device
2116

2217
By default when the `robot` object is created it will try to communicate with all Arduinos and will expect them to respond in the way the SR firmware does.

programming/arduino/extended_sr_firmware.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ title: Arduino extended firmware
55

66
# Arduino with extended SR firmware
77

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

programming/cheat_sheet.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,6 @@ robot.motor_board.motors[1].power = -1
124124

125125
### Special motor values
126126

127-
<div class="info">
128-
This documentation refers to a feature which is only available on the physical robot kits.
129-
</div>
130-
131127
Setting a motor to `BRAKE` is equivalent to power level `0`.
132128

133129
~~~~~ python
@@ -157,10 +153,6 @@ You can also set the position to `0`, which is the approximate centre.
157153

158154
### Taking a photo
159155

160-
<div class="info">
161-
This documentation refers to a feature which is only available on the physical robot kits.
162-
</div>
163-
164156
It can sometimes be useful to save a photo of what markers the robot can see:
165157

166158
~~~~~ python
@@ -169,10 +161,6 @@ robot.camera.save("my-photo.jpg") # Save my-photo.jpg to the USB drive
169161

170162
### Capturing an openCV array
171163

172-
<div class="info">
173-
This documentation refers to a feature which is only available on the physical robot kits.
174-
</div>
175-
176164
Take a photo using the webcam, and return the image data as an OpenCV array:
177165

178166
~~~~~ python

programming/leds.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ title: Brain Board LED API
88
Brain Board LED API
99
===================
1010

11-
<div class="info">
12-
This documentation refers to a feature which is only available on the physical robot kits.
13-
</div>
14-
1511
The KCH board provides diagnostic information about the state of your robot through a collection of preconfigured and user-controllable LEDs.
1612
It is part of the [Brain Board](/docs/kit/brain_board) assembly and will be found attached to the top of the Raspberry Pi.
1713

programming/motors.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,6 @@ print(robot.motor_boards["srABC1"].motors[0].power)
124124
Special Values
125125
--------------
126126

127-
<div class="info">
128-
This documentation refers to a feature which is only available on the physical robot kits.
129-
</div>
130-
131127
In addition to the numeric values, there are two special constants that can be used:
132128
- `BRAKE`
133129
- `COAST`
@@ -156,7 +152,7 @@ Motor currents
156152
--------------
157153

158154
<div class="info">
159-
This documentation refers to a feature which is only available on the physical robot kits.
155+
In the simulator, the current values always return 0.
160156
</div>
161157

162158
The Motor Board can also measure the current being drawn by each of the ports on the board.

programming/servos.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,6 @@ print(robot.servo_board.servos[1].position)
5858
Disabling servo outputs
5959
-----------------------
6060

61-
<div class="info">
62-
This documentation refers to a feature which is only available on the physical robot kits.
63-
</div>
64-
6561
Setting a position to `None` will disable an output.
6662
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.
6763

@@ -74,10 +70,6 @@ robot.servo_board.servos[5].position = None
7470
Extended servo range
7571
--------------------
7672

77-
<div class="info">
78-
This documentation refers to a feature which is only available on the physical robot kits.
79-
</div>
80-
8173
For an RC servo the angle of rotation is determined by the width of an electrical pulse on the control wire.
8274
A typical servo expects to see a pulse every 20ms, with a pulse width between 1ms and 2ms.
8375
Our API will take the position provided (between -1 and 1) and map it to the correct pulse width.

programming/vision/index.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@ Try pausing movement while taking an image.
4949

5050
save
5151
: Take a photo using the webcam, draw a box around the detected markers and save it to the provided location.
52-
<div class="info">
53-
This function is only available on the physical robot kits.
54-
</div>
5552

5653
~~~~~ python
5754
from sr.robot3 import *
@@ -63,9 +60,6 @@ robot.camera.save(robot.usbkey / "initial-view.jpg")
6360

6461
capture
6562
: Take a photo using the webcam, and return the image data as an OpenCV array.
66-
<div class="info">
67-
This function is only available on the physical robot kits.
68-
</div>
6963

7064
~~~~~ python
7165
import cv2
@@ -114,15 +108,9 @@ size
114108

115109
pixel_centre
116110
: A [`PixelCoordinates`](#pixel-coordinates) object describing the position of the centre of the marker in the image.
117-
<div class="info">
118-
This attribute is only available on the physical robot kits.
119-
</div>
120111

121112
pixel_corners
122113
: A list of 4 [`PixelCoordinates`](#pixel-coordinates) objects, each representing the position of a corner of the marker in the image.
123-
<div class="info">
124-
This attribute is only available on the physical robot kits.
125-
</div>
126114

127115
position
128116
: A `Position` object describing the position of the marker.
@@ -163,10 +151,6 @@ orientation
163151

164152
### Pixel Coordinates
165153

166-
<div class="info">
167-
This documentation refers to a feature which is only available on the physical robot kits.
168-
</div>
169-
170154
A named tuple of `x` and `y` coordinates for the point, in pixels relative to the top left of the image.
171155

172156
~~~~~ python

0 commit comments

Comments
 (0)