pxt-common-packages 13.1.4 → 13.1.5

package/libs/light/defaultlights.ts

@@ -10,7 +10,7 @@ namespace light {
      * @param rgb RGB color of the LED
      */
     //% blockId="builtin_neopixel_set_strip_color" block="set all pixels to %rgb=colorNumberPicker"
-    //% help="light/set-all"
+    //% help="light/neopixelstrip/set-all"
     //% weight=79 blockGap=8
     export function setAll(rgb: number) {
         light.pixels.setAll(rgb);
@@ -32,7 +32,7 @@ namespace light {
      */
     //% blockId="builtin_neopixel_clear" block="clear"
     //% parts="neopixel"
-    //% help="light/clear"
+    //% help="light/neopixelstrip/clear"
     //% group="More" weight=9 blockGap=8
     export function clear() {
         light.pixels.clear();
@@ -45,7 +45,7 @@ namespace light {
      * @param high maximum value, 0 to autoscale
      */
     //% blockId=builtin_neopixel_show_bar_graph block="graph %value||up to %high" icon="\uf080"
-    //% help=light/graph blockGap=8
+    //% help=light/neopixelstrip/graph blockGap=8
     //% weight=10
     export function graph(value: number, high?: number): void {
         light.pixels.graph(value, high);
@@ -58,7 +58,7 @@ namespace light {
      * @param color RGB color of the LED
      */
     //% blockId="builtin_neopixel_set_pixel_color" block="set pixel color at %pixeloffset|to %rgb=colorNumberPicker"
-    //% help="light/set-pixel-color"
+    //% help="light/neopixelstrip/set-pixel-color"
     //% group="More" weight=89 blockGap=8
     export function setPixelColor(pixeloffset: number, color: number): void {
         light.pixels.setPixelColor(pixeloffset, color);
@@ -69,7 +69,7 @@ namespace light {
      * @param pixeloffset position of the NeoPixel in the strip
      */
     //% blockId="builtin_neopixel_pixel_color" block="pixel color at %pixeloffset"
-    //% help="light/pixel-color"
+    //% help="light/neopixelstrip/pixel-color"
     //% group="More" weight=88
     export function pixelColor(pixeloffset: number): number {
         return light.pixels.pixelColor(pixeloffset);
@@ -81,7 +81,7 @@ namespace light {
      */
     //% blockId="builtin_neopixel_set_brightness" block="set brightness %brightness"
     //% brightness.min=0 brightness.max=255
-    //% help="light/set-brightness"
+    //% help="light/neopixelstrip/set-brightness"
     //% weight=2 blockGap=8
     export function setBrightness(brightness: number): void {
         light.pixels.setBrightness(brightness);
@@ -92,7 +92,7 @@ namespace light {
      * @param steps number of steps (lights) to move, eg: 1
      */
     //% blockId=builtin_neophoton_fd block="photon forward by %steps"
-    //% help="light/photon-forward"
+    //% help="light/neopixelstrip/photon-forward"
     //% group="Photon" weight=41 blockGap=8
     export function photonForward(steps: number) {
         light.pixels.photonForward(steps);
@@ -101,7 +101,7 @@ namespace light {
          * Switch the direction of the photon pulse.
          */
     //% blockId=builtin_neophoton_flip block="photon flip"
-    //% help="light/photon-flip"
+    //% help="light/neopixelstrip/photon-flip"
     //% parts="neopixel"
     //% group="Photon" weight=40 blockGap=8
     export function photonFlip() {
@@ -114,7 +114,7 @@ namespace light {
      * @param index index of the light, if out of bound, the index is wrapped
      */
     //% blockId=builtin_light_photon_set_position block="photon set position %index"
-    //% help="light/set-photon-position"
+    //% help="light/neopixelstrip/set-photon-position"
     //% parts="neopixel"
     //% group="Photon" weight=39 blockGap=8
     export function setPhotonPosition(index: number) {
@@ -126,7 +126,7 @@ namespace light {
      * @param hue the color hue of the photon
      */
     //% blockId=builtin_neophoton_set_pen_hue block="photon set pen hue %hue=colorWheelHsvPicker"
-    //% help="light/set-photon-pen-hue"
+    //% help="light/neopixelstrip/set-photon-pen-hue"
     //% group="Photon" weight=39 blockGap=8
     export function setPhotonPenHue(hue: number) {
         light.pixels.setPhotonPenHue(hue);
@@ -137,7 +137,7 @@ namespace light {
      * @param mode the desired mode
      */
     //% blockId=builtin_neophoton_set_photon block="photon %mode"
-    //% help="light/set-photon-mode"
+    //% help="light/neopixelstrip/set-photon-mode"
     //% group="Photon" weight=38
     export function setPhotonMode(mode: PhotonMode) {
         light.pixels.setPhotonMode(mode);
@@ -149,7 +149,7 @@ namespace light {
      * @param duration the duration to run in milliseconds, eg: 500
      */
     //% blockId=builtin_neopixel_show_animation block="show animation %animation=light_animation_picker|for %duration=timePicker|ms"
-    //% help="light/show-animation" blockGap=8
+    //% help="light/neopixelstrip/show-animation" blockGap=8
     //% weight=81
     export function showAnimation(animation: NeoPixelAnimation, duration: number) {
         light.pixels.showAnimation(animation, duration);
@@ -160,7 +160,7 @@ namespace light {
       * @param animation the animation to run, eg: light.rainbowAnimation
       */
     //% blockId=builtin_neopixel_show_animation_frame block="show frame of %animation=light_animation_picker|animation"
-    //% help="light/show-animation-frame"
+    //% help="light/neopixelstrip/show-animation-frame"
     //% group="More" weight=24 blockGap=8
     export function showAnimationFrame(animation: NeoPixelAnimation) {
         light.pixels.showAnimationFrame(animation);
@@ -170,7 +170,7 @@ namespace light {
      * Stop the current animation and any other animations ready to show.
      */
     //% blockId=builtin_neopixel_stop_all_animations block="stop all animations"
-    //% help="light/stop-all-animations"
+    //% help="light/neopixelstrip/stop-all-animations"
     //% group="More" weight=23
     export function stopAllAnimations() {
         light.pixels.stopAllAnimations();

package/libs/light/docs/reference/light/animation.md

@@ -0,0 +1,33 @@
+# animation
+
+Return an instance of the selected builtin animation.
+
+```sig
+light.animation(LightAnimation.Sparkle)
+```
+
+## Parameters
+
+* **kind**: the type of animation to select, one of the following:
+
+>* `running lights`
+>* `comet`
+>* `color wipe`
+>* `theater chase`
+>* `rainbow`
+
+## Example
+
+Show the `rainbow` animation continuously at `500` millisecond intervals.
+
+```blocks
+forever(function() {
+    light.showAnimation(LightAnimation.Rainbow, 500)
+})
+```
+
+## See Also
+
+```package
+light
+```

package/libs/mixer/melody.ts

@@ -598,6 +598,8 @@ namespace music {
     //% song.fieldOptions.taggedTemplate="hex;assets.song"
     //% song.fieldOptions.decompileIndirectFixedInstances="true"
     //% song.fieldOptions.decompileArgumentAsString="true"
+    //% song.snippet="hex`00780004080100`"
+    //% song.pySnippet='hex("""00780004080100""")'
     //% toolboxParent=music_playable_play
     //% toolboxParentArgument=toPlay
     //% group="Songs"

package/libs/rotary-encoder/docs/reference/encoders/on-changed.md

@@ -0,0 +1,29 @@
+# on Changed
+
+Run some code when the rotary encoder changes position.
+
+```sig
+encoders.createRotaryEncoder(pins.A2, pins.A1).onChanged(function () {})
+```
+
+## Example #example
+
+Show the encoder position on the game console when it changes.
+
+```typescript
+const crank = encoders.createRotaryEncoder(pins.A2, pins.A1);
+game.consoleOverlay.setVisible(true);
+let sprite = sprites.create(sprites.castle.heroFrontAttack1)
+crank.onChanged(function () {
+    console.log(crank.position())
+    sprite.x = screen.width / 2 + crank.position()
+})
+```
+
+## See also #seealso
+
+[position](/reference/encoders/position)
+
+```package
+encoders
+```

package/libs/rotary-encoder/docs/reference/encoders/position.md

@@ -0,0 +1,33 @@
+# position
+
+Get the current position rotary encoder.
+
+```sig
+encoders.createRotaryEncoder(pins.A2, pins.A1).position( )
+```
+
+## Returns
+
+* a [number](/types/number) that indicates the encoder's position.
+
+## Example #example
+
+Show the encoder position on the game console when it changes.
+
+```typescript
+const crank = encoders.createRotaryEncoder(pins.A2, pins.A1);
+game.consoleOverlay.setVisible(true);
+let sprite = sprites.create(sprites.castle.heroFrontAttack1)
+crank.onChanged(function () {
+    console.log(crank.position())
+    sprite.x = screen.width / 2 + crank.position()
+})
+```
+
+## See also #seealso
+
+[on changed](/reference/encoders/on-changed)
+
+```package
+encoders
+```

package/libs/rotary-encoder/rotary.cpp

@@ -78,7 +78,7 @@ namespace RotaryEncoderMethods {
  */
 //% blockNamespace="encoders"
 //% blockId=rotaryencoderonchaned block="on %this changed"
-//% weight=80 blockGap=8
+//% weight=80 blockGap=8 help=encoders/on-changed
 void onChanged(RotaryEncoder encoder, Action body) {
     registerWithDal(encoder->id, ROT_EV_CHANGED, body);
 }
@@ -88,7 +88,7 @@ void onChanged(RotaryEncoder encoder, Action body) {
  */
 //% blockNamespace="encoders"
 //% blockId=rotaryencoderposition block="%this position"
-//% weight=79 blockGap=8
+//% weight=79 blockGap=8 help=encoders/position
 int position(RotaryEncoder encoder) {
     // the position always changes by 4 per tick
     return encoder->position >> 2;

package/libs/rotary-encoder/shims.d.ts

@@ -23,7 +23,7 @@ declare interface RotaryEncoder {
      */
     //% blockNamespace="encoders"
     //% blockId=rotaryencoderonchaned block="on %this changed"
-    //% weight=80 blockGap=8 shim=RotaryEncoderMethods::onChanged
+    //% weight=80 blockGap=8 help=encoders/on-changed shim=RotaryEncoderMethods::onChanged
     onChanged(body: () => void): void;
 
     /**
@@ -31,7 +31,7 @@ declare interface RotaryEncoder {
      */
     //% blockNamespace="encoders"
     //% blockId=rotaryencoderposition block="%this position"
-    //% weight=79 blockGap=8 shim=RotaryEncoderMethods::position
+    //% weight=79 blockGap=8 help=encoders/position shim=RotaryEncoderMethods::position
     position(): int32;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pxt-common-packages",
-  "version": "13.1.4",
+  "version": "13.1.5",
   "description": "Microsoft MakeCode (PXT) common packages",
   "keywords": [
     "MakeCode",