xp-command 1.5.0 → 1.6.0

package/README.md

@@ -73,15 +73,25 @@ If you changed the Web API port from 8086 to another port, you'll need to start
 xp-command --port 8090
 ```
 
+### One-shot mode
+
+Run a single command and exit immediately (useful for scripts or keybindings):
+
+```bash
+xp-command --run x7000
+```
+
+Exits with code `0` on success, `1` on failure.
+
 ### Exiting
 
 Type `exit` or press `Ctrl+C`
 
 ---
 
-## 📋 Pre-configured commands
+## 📋 Pre-configured triggers
 
-All pre-configured commands work well with most aircraft I currently fly, but you may want to adjust them for **your** aircraft (see _Aircraft-specific profiles_ section below).
+All pre-configured triggers work well with most aircraft I currently fly, but you may want to adjust them for **your** aircraft (see _Aircraft-specific profiles_ section below).
 
 ### Barometric pressure
 
@@ -200,7 +210,10 @@ In addition to reading/writing datarefs, you can trigger X-Plane commands. Comma
 **Duration syntax**: Append `[duration]` to specify how long the command stays active (in seconds):
 - `command` or `command[0]`: Press and immediately release (default behavior)
 - `command[5]`: Hold for 5 seconds then release
-- Maximum duration: 10 seconds
+
+**Repeat syntax**: Append `[repeatCount]` to specify how often the command should be repeated:
+- `command[0][3]`: Press and immediately release three times
+- `command[0][$]`: Press and immediately release as often as defined by captured value
 
 **Examples**:
 

package/bin/index.js

@@ -40,10 +40,12 @@ program
   .version(packageJson.version)
   .description(`${PREFIX} ${packageJson.name}\n${packageJson.description}`)
   .option("-p, --port <number>", "server port number")
+  .option("-r, --run <command>", "run a single command and exit")
   .helpOption("-h, --help", "display this help text");
 
 /**
  * @param {string} command
+ * @returns {Promise<boolean>} true if command succeeded, false otherwise
  */
 const processCommand = async (command) => {
   const spinner = ora(`${PREFIX} ${chalk.cyan(command ?? "")}`).start();
@@ -60,7 +62,7 @@ const processCommand = async (command) => {
       hideCursor();
       await sleep(1500);
       showCursor();
-      return;
+      return false;
     }
   }
 
@@ -70,7 +72,7 @@ const processCommand = async (command) => {
     hideCursor();
     await sleep(1500);
     clearLine();
-    return;
+    return true;
   }
 
   /**
@@ -100,7 +102,7 @@ const processCommand = async (command) => {
     return value;
   };
 
-  /** @type {Array<[RegExp, (regExpResult: Array<string> | null) => Promise<void>]>} */
+  /** @type {Array<[RegExp, (regExpResult: Array<string> | null) => Promise<boolean>]>} */
   const matches = config.commands.map((c) => {
     if (!c.type) {
       return [
@@ -112,7 +114,7 @@ const processCommand = async (command) => {
           hideCursor();
           await sleep(1500);
           clearLine();
-          return;
+          return false;
         },
       ];
     }
@@ -127,7 +129,7 @@ const processCommand = async (command) => {
               hideCursor();
               await sleep(1500);
               clearLine();
-              return;
+              return false;
             }
 
             /** @type {number|string|Array<number|string>}*/
@@ -147,6 +149,7 @@ const processCommand = async (command) => {
             hideCursor();
             await sleep(1500);
             clearLine();
+            return true;
           },
         ];
       case "set":
@@ -160,11 +163,19 @@ const processCommand = async (command) => {
               hideCursor();
               await sleep(1500);
               clearLine();
-              return;
+              return false;
             }
 
             if (c.command) {
-              await activateCommands(c.command);
+              let value = String(regExpResult[1]);
+              if (isNaN(Number(value))) {
+                await activateCommands(c.command);
+              } else {
+                c.transform?.forEach((t) => {
+                  value = String(getTransformedValue(value, t));
+                });
+                await activateCommands(c.command, Number(value));
+              }
             }
             if (c.dataref) {
               let value = String(regExpResult[1]);
@@ -182,6 +193,7 @@ const processCommand = async (command) => {
             hideCursor();
             await sleep(1500);
             clearLine();
+            return true;
           },
         ];
     }
@@ -191,12 +203,15 @@ const processCommand = async (command) => {
     const regexpResult = regexp.exec(command);
     if (regexpResult !== null) {
       try {
-        await cb(regexpResult);
+        const success = await cb(regexpResult);
 
-        spinner.succeed();
+        if (success) {
+          spinner.succeed();
+        }
         hideCursor();
 
         showCursor();
+        return success;
       } catch (error) {
         logger.error(error);
         spinner.fail();
@@ -220,8 +235,8 @@ const processCommand = async (command) => {
 
         await sleep(500);
         showCursor();
+        return false;
       }
-      return;
     }
   }
 
@@ -230,6 +245,7 @@ const processCommand = async (command) => {
 
   await sleep(1500);
   showCursor();
+  return false;
 };
 
 const sayHello = () => {
@@ -291,17 +307,27 @@ const askForCommand = async () => {
   await askForCommand();
 };
 
-program.action(async (/** @type {{ port: number | undefined }} */ options) => {
-  initAPI({ port: options.port ?? 8086 });
+program.action(
+  async (
+    /** @type {{ port: number | undefined, run: string | undefined }} */ options,
+  ) => {
+    initAPI({ port: options.port ?? 8086 });
 
-  hideCursor();
-  clearLine();
-  sayHello();
-  await sleep(1000);
-  showCursor();
+    if (options.run) {
+      history.addCommand(options.run);
+      const success = await processCommand(options.run);
+      process.exit(success ? 0 : 1);
+    }
 
-  await askForCommand();
-});
+    hideCursor();
+    clearLine();
+    sayHello();
+    await sleep(1000);
+    showCursor();
+
+    await askForCommand();
+  },
+);
 
 program.parse(process.argv);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xp-command",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Quick cockpit commands for X-Plane 12 - set your radios, altimeter, autopilot, and more from the terminal while flying.",
   "keywords": [
     "xplane",

package/src/api.js

@@ -39,18 +39,27 @@ const parseDataref = (datarefString) => {
 
 /**
  * @param {string} commandString
- * @return {[string, number|null]}
+ * @param {number|string} [value]
+ * @return {[string, number|null, number|null]}
  */
-const parseCommand = (commandString) => {
-  // Regex pattern: captures base name and optional duration value
-  const pattern = /^(.+?)(?:\[(\d+)\])?$/;
+const parseCommand = (commandString, value) => {
+  // Regex pattern: captures base name and optional duration and repeat count values
+  const pattern = /^(.+?)(?:\[(\d+)\])?(?:\[(\d+|\$)\])?$/;
   const match = commandString.match(pattern);
 
   if (!match) {
     throw new CustomError("invalid_command");
   }
 
-  return [match[1], match[2] ? parseInt(match[2]) : null];
+  let repeatCount = match[3] ? parseInt(match[3]) : null;
+  if (isNaN(repeatCount)) {
+    repeatCount = typeof value === "number" ? value : parseInt(value);
+  }
+  if (isNaN(repeatCount)) {
+    repeatCount = 1;
+  }
+
+  return [match[1], match[2] ? parseInt(match[2]) : null, repeatCount];
 };
 
 /**
@@ -104,9 +113,16 @@ export const getCommandId = async (commandName) => {
 
 /**
  * @param {string} commandNameWithOptionalDuration
+ * @param {number|string} [value]
  */
-export const activateCommand = async (commandNameWithOptionalDuration) => {
-  const [commandName, duration] = parseCommand(commandNameWithOptionalDuration);
+export const activateCommand = async (
+  commandNameWithOptionalDuration,
+  value,
+) => {
+  const [commandName, duration, repeatCount] = parseCommand(
+    commandNameWithOptionalDuration,
+    value,
+  );
 
   const commandId = await getCommandId(commandName);
 
@@ -114,19 +130,19 @@ export const activateCommand = async (commandNameWithOptionalDuration) => {
     `http://localhost:${port}/api/v2/command/${commandId}/activate`,
   );
 
-  const response = await fetch(url, {
-    method: "POST",
-    body: JSON.stringify({ duration: duration || 0 }),
-  });
-  const json = /** @type { {data: number|string } | APIError } */ (
-    await response.json()
-  );
+  for (let i = Math.max(1, repeatCount ?? 1); i--; ) {
+    const response = await fetch(url, {
+      method: "POST",
+      body: JSON.stringify({ duration: duration || 0 }),
+    });
+    const json = /** @type { {data: number|string } | APIError } */ (
+      await response.json()
+    );
 
-  if (json && "error_code" in json) {
-    throw new CustomError(json.error_code);
+    if (json && "error_code" in json) {
+      throw new CustomError(json.error_code);
+    }
   }
-
-  return json;
 };
 
 /**
@@ -242,16 +258,20 @@ export const setDatarefValues = async (
 
 /**
  * @param {string|Array<string>} commandNamesWithOptionalDuration
+ * @param {number|string} [value]
  * @return {Promise<void>}
  */
-export const activateCommands = async (commandNamesWithOptionalDuration) => {
+export const activateCommands = async (
+  commandNamesWithOptionalDuration,
+  value,
+) => {
   if (Array.isArray(commandNamesWithOptionalDuration)) {
     await Promise.all(
       commandNamesWithOptionalDuration.map((command) =>
-        activateCommand(command),
+        activateCommand(command, value),
       ),
     );
   } else {
-    await activateCommand(commandNamesWithOptionalDuration);
+    await activateCommand(commandNamesWithOptionalDuration, value);
   }
 };