Brick ref topics 02 (#283)
* Add brick button topics * Add the rest of the brick api
This commit is contained in:
committed by
Peli de Halleux
parent
8a331648d6
commit
822227eb48
@ -5,6 +5,7 @@ namespace brick {
|
||||
*/
|
||||
//% blockId=brickBatteryLevel block="battery level"
|
||||
//% group="More"
|
||||
//% help=brick/battery-level
|
||||
export function batteryLevel(): number {
|
||||
const info = sensors.internal.getBatteryInfo();
|
||||
return info.current;
|
||||
|
@ -75,7 +75,7 @@ namespace brick {
|
||||
* Check if button is currently pressed or not.
|
||||
* @param button the button to query the request
|
||||
*/
|
||||
//% help=input/button/is-pressed
|
||||
//% help=brick/button/is-pressed
|
||||
//% block="%button|is pressed"
|
||||
//% blockId=buttonIsPressed
|
||||
//% parts="brick"
|
||||
@ -91,7 +91,7 @@ namespace brick {
|
||||
* See if the button was pressed again since the last time you checked.
|
||||
* @param button the button to query the request
|
||||
*/
|
||||
//% help=input/button/was-pressed
|
||||
//% help=brick/button/was-pressed
|
||||
//% block="%button|was pressed"
|
||||
//% blockId=buttonWasPressed
|
||||
//% parts="brick"
|
||||
@ -111,7 +111,7 @@ namespace brick {
|
||||
* @param event the kind of button gesture that needs to be detected
|
||||
* @param body code to run when the event is raised
|
||||
*/
|
||||
//% help=input/button/on-event
|
||||
//% help=brick/button/on-event
|
||||
//% blockId=buttonEvent block="on %button|%event"
|
||||
//% parts="brick"
|
||||
//% blockNamespace=brick
|
||||
@ -126,7 +126,7 @@ namespace brick {
|
||||
* Waits until the event is raised
|
||||
* @param ev the event to wait for
|
||||
*/
|
||||
//% help=input/button/pause-until
|
||||
//% help=brick/button/pause-until
|
||||
//% blockId=buttonWaitUntil block="pause until %button|%event"
|
||||
//% parts="brick"
|
||||
//% blockNamespace=brick
|
||||
@ -251,6 +251,7 @@ namespace brick {
|
||||
*/
|
||||
//% blockId=setLights block="set light to %pattern"
|
||||
//% weight=100 group="Buttons"
|
||||
//% help=brick/set-light
|
||||
export function setLight(pattern: BrickLight): void {
|
||||
if (currPattern === pattern)
|
||||
return
|
||||
|
37
libs/mood/docs/reference/brick/show-mood.md
Normal file
37
libs/mood/docs/reference/brick/show-mood.md
Normal file
@ -0,0 +1,37 @@
|
||||
# show Mood
|
||||
|
||||
Show a mood on the brick. A mood will have a image on the display along with a sound and solid or flashing light.
|
||||
|
||||
```sig
|
||||
brick.showMood(moods.sleeping)
|
||||
```
|
||||
You can choose one of several moods to show on the display. Use a mood to help show what your @boardname@ is doing at the moment.
|
||||
|
||||
## Parameters
|
||||
|
||||
**mood**: A mood to show on the brick. Choose one of these moods:
|
||||
>* ``sleeping``
|
||||
* ``awake``
|
||||
* ``tired``
|
||||
* ``angry``
|
||||
* ``sad``
|
||||
* ``dizzy``
|
||||
* ``knockedOut``
|
||||
* ``middleLeft``
|
||||
* ``middleRight``
|
||||
* ``love``
|
||||
* ``winking``
|
||||
* ``neutral``
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
Show a ``winking`` mood on the brick.
|
||||
|
||||
```blocks
|
||||
brick.showMood(moods.winking)
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
[show image](/reference/brick/show-image)
|
Reference in New Issue
Block a user