Add 'showPorts' api doc (#392)
This commit is contained in:
committed by
Peli de Halleux
parent
3cad464ea5
commit
8abc137d60
24
docs/reference/brick/show-ports.md
Normal file
24
docs/reference/brick/show-ports.md
Normal file
@ -0,0 +1,24 @@
|
||||
# show Ports
|
||||
|
||||
Show the status of everything connected to the ports.
|
||||
|
||||
```sig
|
||||
brick.showPorts()
|
||||
```
|
||||
|
||||
You can find out what's connected to the ports on the brick and show its status. The status information from each sensor or motor connected is displayed on the screen.
|
||||
|
||||
## Example
|
||||
|
||||
Show the status of the ports on the brick when the ``enter`` button is pressed.
|
||||
|
||||
```blocks
|
||||
brick.showString("Press ENTER for port status", 1)
|
||||
brick.buttonEnter.onEvent(ButtonEvent.Pressed, function () {
|
||||
brick.showPorts()
|
||||
})
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
[show string](/reference/brick/show-string), [show value](/reference/brick/show-value)
|
Reference in New Issue
Block a user