Skip to content

Commit b0b73fa

Browse files
committed
Review tweaks
1 parent 5b4b72e commit b0b73fa

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

programming/cheat_sheet.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ robot.wait_start() # wait for the start button
3737

3838
### Initialisation with extra logging
3939

40-
You can also tell the robot to print extra logging information, although this is quite noisy.
40+
You can also tell the robot to print extra logging information, although this will create a lot of logs.
4141

4242
~~~~~ python
4343
robot = Robot(debug=True)
@@ -154,7 +154,7 @@ You can also set the position to `0`, which is the approximate centre.
154154
It can sometimes be useful to save a photo of what markers the robot can see:
155155

156156
~~~~~ python
157-
robot.camera.save("my-photo.png") # Save my-photo.png to the USB drive
157+
robot.camera.save("my-photo.jpg") # Save my-photo.jpg to the USB drive
158158
~~~~~
159159

160160
### Capturing an openCV array
@@ -210,25 +210,27 @@ robot.ruggeduino.pins[4].mode = INPUT_PULLUP
210210
You can set the output for a pin of the Arduino:
211211

212212
~~~~~ python
213-
robot.ruggeduino.pins[4].mode = OUTPUT
213+
robot.ruggeduino.pins[2].mode = OUTPUT
214214

215215
robot.ruggeduino.pins[2].digital_write(True)
216216
robot.ruggeduino.pins[2].digital_write(False)
217217
~~~~~
218218

219219
### Digital Read
220220

221-
You can read a digital value from the pins of the Ruggeduino:
221+
You can read a digital value from the pins of the Arduino:
222222

223223
~~~~~ python
224224
robot.ruggeduino.pins[3].mode = INPUT
225+
robot.ruggeduino.pins[5].mode = INPUT_PULLUP
225226

226227
value = robot.ruggeduino.pins[3].digital_read()
228+
value = robot.ruggeduino.pins[5].digital_read()
227229
~~~~~
228230

229231
### Analogue Read
230232

231-
You can read an analogue value from the analogue pins of the Ruggeduino:
233+
You can read an analogue value from the analogue pins of the Arduino:
232234

233235
~~~~~ python
234236
robot.ruggeduino.pins[A0].mode = INPUT
@@ -240,28 +242,28 @@ value = robot.ruggeduino.pins[A0].analogue_read()
240242

241243
The API also makes some information about where your code is running
242244

243-
### Starting Zone for a match
245+
### Starting zone for a match
244246

245247
~~~~~ python
246248
zone = robot.zone # -> 0, 1, 2, or 3
247249
~~~~~
248250

249-
### Robot Mode
251+
### Robot mode
250252

251253
This is set to `COMP` when your robot is in a match.
252254

253255
~~~~~ python
254256
robot_mode = robot.mode # -> DEV or COMP
255257
~~~~~
256258

257-
### USB stick Path
259+
### USB stick path
258260

259261
This is the path to where your USB stick is mounted.
260262

261263
You can use this to save files and information to the drive.
262264

263265
~~~~~ python
264-
usb_key_path = robot.usbkey # -> pathlib.Path
266+
usb_key_path = robot.usbkey
265267
~~~~~
266268

267269
### Is simulated

0 commit comments

Comments
 (0)