Threshold api docs - 01 (#336)

* Local commit

* Throw on more topics

* Throw in threshold topics for infrared
This commit is contained in:
Galen Nickel
2018-02-21 22:35:25 -08:00
committed by Peli de Halleux
parent 84c8e31ff5
commit 8cfb70c97b
11 changed files with 240 additions and 6 deletions

View File

@ -0,0 +1,37 @@
# set Threshold
Set the distance threshold for when objects are near, far, or detected.
```sig
sensors.ultrasonic1.setThreshold(UltrasonicSensorEvent.ObjectDetected, 0)
```
Whether something is near or far away really depends on the situation. A object moving towards you is "near" at further distance than something that isn't moving due to the time necessary to move out of its way. So, in certain situations you may want change which distances mean near or far.
You can change the distances for near and far by setting their _thresholds_. A threshold is a boundary or a limit. If you wanted near to mean anything that's closer that 20 centimeters, then that is your threshold for ``near``. Also, if anything further than 35 centimeters is thought of as far, then the threshold for ``far`` is `35`.
Similarly, if you are just concerned about knowing that something has moved within a distance from you, then you set that distance as the threshold for ``detected``.
## Parameters
* **condition**: the threshold condition to set a distance for. These are: ``near``, ``far``, and ``detected``.
* **value**: a [number](/types/number) that the distance in centimeters to set the threshold for.
## Example
Set a threshold for detecting something moving within 30 centimeters. Wait for an object to show up. When it does, flash the status light and make noise as an alarm.
```blocks
sensors.ultrasonic1.setThreshold(UltrasonicSensorEvent.ObjectDetected, 30)
sensors.ultrasonic1.pauseUntil(UltrasonicSensorEvent.ObjectDetected)
brick.clearScreen()
brick.showString("Perimeter Breach!!!", 3)
brick.setStatusLight(StatusLight.RedFlash)
for (let i = 0; i < 10; i++) {
music.playSoundEffectUntilDone(sounds.mechanicalHorn2)
}
```
## See also
[threshold](/reference/sensors/ultrasonic/threshold)

View File

@ -0,0 +1,35 @@
# threshold
Get the distance threshold for when objects are near, far, or detected.
```sig
sensors.ultrasonic1.threshold(UltrasonicSensorEvent.ObjectDetected)
```
Whether something is near or far away really depends on the situation. A object moving towards you is "near" at further distance than something that isn't moving due to the time necessary to move out of its way.
Distances for near and far by have set _thresholds_. A threshold is a boundary or a limit. If near means anything that's closer that 20 centimeters, then the threshold for ``near``. Also, if anything further than 35 centimeters is thought of as far, then the threshold for ``far`` is `35`.
Also, the threshold for nowing that something has moved within a distance from you is set for ``detected``.
## Parameters
* **condition**: the condition to get the threshold distance for. These are: ``near``, ``far``, and ``detected``.
## Returns
* a [number](/types/number) that is the threshold distance in centimeters.
## Example
When a near object is detected, show what the threshold is.
```blocks
sensors.ultrasonic4.onEvent(UltrasonicSensorEvent.ObjectNear, function () {
brick.showValue("NearObjectThreshold", sensors.ultrasonic4.threshold(UltrasonicSensorEvent.ObjectNear), 1)
})
```
## See also
[set threshold](/reference/sensors/ultrasonic/set-threshold)