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

@ -184,7 +184,7 @@ namespace sensors {
* Registers code to run when an object is getting near.
* @param handler the code to run when detected
*/
//% help=input/infrared/on
//% help=sensors/infrared/on-event
//% block="on %sensor|%event"
//% blockId=infraredOn
//% parts="infraredsensor"
@ -199,7 +199,7 @@ namespace sensors {
/**
* Waits for the event to occur
*/
//% help=input/ultrasonic/wait
//% help=sensors/infrared/pause-until
//% block="pause until %sensor| %event"
//% blockId=infraredwait
//% parts="infraredsensor"
@ -215,7 +215,7 @@ namespace sensors {
* Get the promixity measured by the infrared sensor, from ``0`` (close) to ``100`` (far)
* @param sensor the infrared sensor
*/
//% help=input/infrared/proximity
//% help=sensors/infrared/proximity
//% block="%sensor|proximity"
//% blockId=infraredGetProximity
//% parts="infrared"