Updated example and build script

Author: nabeelio

README.md

@@ -3,12 +3,10 @@
 ## Overview
 
 The plugins and scripts for vmsACARS are written in Typescript, and then
-transpiled to JS.
-Typescript ensures that the interfaces required are following, and that the
-proper things
-are returned so ACARS can run them. While Typescript isn't required, it's best
-to use it to
-ensure proper values are passed - especially around enums.
+transpiled to JS. Typescript ensures that the interfaces required are following,
+and that the proper things are returned so ACARS can run them. While Typescript
+isn't required, it's best to use it to ensure proper values are passed - especially
+around enums.
 
 This PDK includes build scripts to:
 
@@ -19,11 +17,15 @@ This PDK includes build scripts to:
 
 ---
 
+# Structure
+
+All of the scripts are contained in the `/src` folder.
+
 # Setup
 
 ## Required:
 
-- nodejs/npm
+- nodejs/npm or pnpm
 - Typescript
 - Gulp
 
@@ -681,3 +683,9 @@ export default class MyScript implements CallbackHook {
   }
 }
 ```
+
+### Sounds
+
+Place your sounds (`mp3` or `wav`) format in the `src/sounds` directory (create
+it if it doesn't exist). When you call `Acars.PlayAudio`, it will look in this
+directory for them.

gulpfile.mjs

@@ -29,7 +29,7 @@ const paths = {
  * Build the project, copy the appropriate files over
  * @public
  */
-export const build = series(buildTsTask, copyPackageJsonTask)
+export const build = series(buildTsTask, copySoundsTask, copyPackageJsonTask)
 
 /**
  * Clean the build directories
@@ -108,6 +108,14 @@ function buildTsTask() {
   return pipeline
 }
 
+/**
+ * This copies the package.json file to the output directory
+ *
+ */
+function copySoundsTask() {
+  return src([paths.src + '/sounds/**/*']).pipe(dest(paths.out + '/sounds'))
+}
+
 /**
  * This copies the package.json file to the output directory
  *

src/scripts/announcements.ts

@@ -0,0 +1,63 @@
+import { PirepState } from '../defs'
+import { CallbackHook, Meta } from '../types/callback'
+import { Pirep, Telemetry } from '../types/types'
+
+/**
+ * This is an example of a script which does announcements on the different
+ * flight phases. It's missing the audio files - place your files into the
+ * `sounds` directory, and then package up the script.
+ *
+ * See the phaseChange() method for the meat of it. Note, this is also disabled
+ * by default
+ */
+export default class Annoucements implements CallbackHook {
+  meta: Meta = {
+    id: 'default_announcements',
+    name: 'Default phase change announcements',
+    enabled: false,
+  }
+
+  setup() {}
+
+  /**
+   * This runs about once a second, sometimes more
+   * @param pirep
+   * @param data
+   */
+  run(pirep: Pirep, data: Telemetry): void {}
+
+  /**
+   * Play these sounds on the different phase changes
+   *
+   * @param pirep
+   * @param data
+   * @param newPhase
+   * @param oldPhase
+   */
+  phaseChange(
+    pirep: Pirep,
+    data: Telemetry,
+    newPhase: PirepState,
+    oldPhase: PirepState,
+  ) {
+    if (newPhase == PirepState.Pushback) {
+      Acars.PlayAudio('pushback.mp3')
+    } else if (newPhase == PirepState.TaxiIn) {
+      Acars.PlayAudio('taxi_in.mp3')
+    } else if (newPhase == PirepState.TaxiOut) {
+      Acars.PlayAudio('taxi_out.mp3')
+    } else if (newPhase == PirepState.Takeoff) {
+      Acars.PlayAudio('takeoff.mp3')
+    } else if (newPhase == PirepState.Enroute) {
+      Acars.PlayAudio('enroute.mp3')
+    } else if (newPhase == PirepState.Approach) {
+      Acars.PlayAudio('approach.mp3')
+    } else if (newPhase == PirepState.Final) {
+      Acars.PlayAudio('landing.mp3')
+    } else if (newPhase == PirepState.Landed) {
+      Acars.PlayAudio('landing.mp3')
+    } else if (newPhase == PirepState.Arrived) {
+      Acars.PlayAudio('arrived.mp3')
+    }
+  }
+}

src/scripts/example.ts

@@ -14,34 +14,33 @@ export default class ExampleScript implements CallbackHook {
   }
 
   setup() {
-    Acars.Set('above_1k', false)
-    Acars.Set('launched_message', false)
+    Acars.Set('above_18k', false)
   }
 
   /**
-   * This once a second.
+   * This runs about once a second.
    * @param pirep
    * @param data
    */
   run(pirep: Pirep, data: Telemetry): void {
     Acars.AddPirepLogOnce('script_loaded', 'Example script loaded')
-    if (Acars.Get('launched_message') === false) {
-      Acars.SetPirepField('Loaded', 'True')
+    Acars.SetPirepField('Example Script Loaded', 'True')
 
-      Acars.Set('launched_message', true)
-    }
+    this.descentAnnouncement(data)
+  }
 
-    if (data.groundAltitude.Feet > 1000) {
-      Acars.Set('above_1k', true)
-      Acars.SetPirepField('Above 1000 feet', 'True')
+  /**
+   * See if we should play the descent announcement. It should only play
+   * if we were above 18k', and now are below 16k or so
+   * @param data
+   */
+  descentAnnouncement(data: Telemetry) {
+    if (data.groundAltitude.Feet > 18000) {
+      Acars.Set('above_18k', false)
     }
 
-    /*
-     * Just a silly example, if they crossed above 1000 feet and then they went
-     * back below it, send a message about that
-     */
-    if (Acars.Get('above_1k') === true && data.groundAltitude.Feet < 1000) {
-      Acars.AddPirepLog("Went above 1000', now back down")
+    if (data.groundAltitude.Feet < 16000 && Acars.Get('above_18k')) {
+      Acars.PlayAudio('descent_annoucement.mp3')
     }
   }
 
@@ -58,9 +57,8 @@ export default class ExampleScript implements CallbackHook {
     newPhase: PirepState,
     oldPhase: PirepState,
   ) {
-    Acars.AddPirepLog(`Phase changed from ${oldPhase} to ${newPhase}`)
     if (newPhase == PirepState.Pushback) {
-      Acars.PlayAudio('departure.mp3')
+      Acars.PlayAudio('pushback.mp3')
     }
   }
 }