From dfca86999f9fb0c7a62043a02d7abed58a787fad Mon Sep 17 00:00:00 2001 From: Tom Ball Date: Mon, 27 Feb 2017 09:07:36 -0800 Subject: [PATCH] add doc for showIcon --- docs/reference/basic.md | 5 ++++- docs/reference/basic/show-icon.md | 22 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/reference/basic/show-icon.md diff --git a/docs/reference/basic.md b/docs/reference/basic.md index 91383e9f..7d519c38 100644 --- a/docs/reference/basic.md +++ b/docs/reference/basic.md @@ -4,6 +4,7 @@ Provides access to basic @boardname@ functionality. ```cards basic.showNumber(0); +basic.showIcon(IconNames.Heart); basic.showLeds(` . . . . . . . . . . @@ -35,6 +36,8 @@ basic.showAnimation(` ### See Also -[showNumber](/reference/basic/show-number), [showLeds](/reference/basic/show-leds), [showString](/reference/basic/show-string), +[showNumber](/reference/basic/show-number), +[showIcon](/reference/basic/show-icon), +[showLeds](/reference/basic/show-leds), [showString](/reference/basic/show-string), [clearScreen](/reference/basic/clear-screen), [forever](/reference/basic/forever), [pause](/reference/basic/pause), [showAnimation](/reference/basic/show-animation) diff --git a/docs/reference/basic/show-icon.md b/docs/reference/basic/show-icon.md new file mode 100644 index 00000000..876f3aea --- /dev/null +++ b/docs/reference/basic/show-icon.md @@ -0,0 +1,22 @@ +# Show Icon + +Shows the selected icon on the LED screen + +```sig +basic.showIcon(IconNames.Heart) +``` + +### Example + +This program shows a happy face and then a sad face with the ``show icon`` function, with a one second pause in between. + +```blocks +basic.showIcon(IconNames.Happy) +basic.pause(1000) +basic.showIcon(IconNames.Sad) +``` + +### See also + +[show leds](/reference/led/show-leds) +