build details

Show: section status errors & todos local changes recent changes last change in-page changes feedback controls

Group name: Instructions template

Modified 2021-01-05 by Liam Paull

Before starting, you should have a look at some tips on how to write beautiful Duckiebook pages.

This is the template for the description of a what we should do to reproduce the results you got in your project. The spirit of this document is to be an operation manual, i.e., a straightforward, unambiguous recipe for reproducing the results of a specific behavior or set of behaviors.

It starts with the “knowledge box” that provides a crisp description of the border conditions needed:

  • Duckiebot hardware configuration (see Duckiebot configurations)
  • Duckietown hardware configuration (loops, intersections, robotarium, etc.)
  • Number of Duckiebots
  • Duckiebot setup steps

For example:

Duckiebot in configuration DB19

Duckietown without intersections

Camera calibration completed

Video of expected results

Modified 2021-01-01 by Dishank Bansal

First, we show a video of the expected behavior (if the demo is successful).

Make sure the video is compliant with Duckietown, i.e. : the city meets the appearance specifications and the Duckiebots have duckies on board.

Laptop setup notes

Modified 2021-01-01 by Dishank Bansal

Does the user need to do anything to modify their local laptop configuration?

Duckietown setup notes

Modified 2021-01-01 by Dishank Bansal

Here, describe the assumptions about the Duckietown, including:

  • Layout (tiles types)
  • Infrastructure (traffic lights, WiFi networks, …) required
  • Weather (lights, …)

Do not write instructions on how to build the city here, unless you are doing something very particular that is not in the Duckietown operation manual (unknown ref opmanual_duckietown/duckietowns)

warning next (1 of 7) index
warning
I will ignore this because it is an external link. 

 > I do not know what is indicated by the link '#opmanual_duckietown/duckietowns'.

Location not known more precisely.

Created by function n/a in module n/a.
. Here, merely point to them.

Duckiebot setup notes

Modified 2021-01-01 by Dishank Bansal

Write here any special setup for the Duckiebot, if needed.

Do not repeat instructions here that are already included in the Duckiebot operation manual (unknown ref opmanual_duckiebot/opmanual_duckiebot)

previous warning next (2 of 7) index
warning
I will ignore this because it is an external link. 

 > I do not know what is indicated by the link '#opmanual_duckiebot/opmanual_duckiebot'.

Location not known more precisely.

Created by function n/a in module n/a.
.

Pre-flight checklist

Modified 2021-01-01 by Dishank Bansal

The pre-flight checklist describes the steps that are sufficient to ensure that the demo will be correct:

Check: operation 1 done

Check: operation 2 done

Instructions

Modified 2021-01-01 by Dishank Bansal

Here, give step by step instructions to reproduce the demo.

Step 1: XXX

task next (1 of 5) index
task

The following was marked as "status-XXX".

Step 1: XXX

Location not known more precisely.

Created by function n/a in module n/a.

Step 2: XXX

previous task next (2 of 5) index
task

The following was marked as "status-XXX".

Step 2: XXX

Location not known more precisely.

Created by function n/a in module n/a.

Make sure you are specifying where to write each line of code that needs to be executed, and what should the expected outcome be. If there are typical pitfalls / errors you experienced, point to the next section for troubleshooting.

Troubleshooting

Modified 2021-01-01 by Dishank Bansal

Add here any troubleshooting / tips and tricks required, in the form:

The Duckiebot flies

Unplug the battery and send an email to info@duckietown.org

I run this elegant snippet of code and get this error: a nasty line of gibberish

Power cycle until it works.

Demo failure demonstration

Modified 2021-01-01 by Dishank Bansal

Finally, put here video of how the demo can fail, when the assumptions are not respected.

You can upload the videos to the Duckietown Vimeo account and link them here.