Add some 'infrared' api docs (#326)

* Add some 'infrared' api docs

* Fix display messages

* Change discussion of distance to relative

* Include motor speed note
This commit is contained in:
Galen Nickel
2018-02-20 10:38:41 -08:00
committed by GitHub
parent 05e916e247
commit 3a67190914
10 changed files with 134 additions and 9 deletions

View File

@ -20,7 +20,7 @@ Both **near** and **far** have distance thresholds set in centimeters. The **det
> * ``object detected``: some other object is sending out an ultrasonic sound
> * ``object near``: the sensor detected something within the distance of the near threshold
> * ``object far``: the sensor detected somethin within the distance of the far threshold
* **body**: the code you want to run when something happens to the touch sensor.
* **body**: the code you want to run when something is dectected by the ultrasonic sensor.
## Example

View File

@ -17,9 +17,9 @@ Both **near** and **far** have distance thresholds set in centimeters. The **det
## Parameters
* **event**: the object detection action to wait for. The detection types (events) are:
> * ``object detected``: some other object is sending out an ultrasonic sound
> * ``object near``: the sensor detected something within the distance of the near threshold
> * ``object far``: the sensor detected somethin within the distance of the far threshold
> * ``detected``: some other object is sending out an ultrasonic sound
> * ``near``: the sensor detected something within the distance of the near threshold
> * ``far``: the sensor detected somethin within the distance of the far threshold
## Example