feat(scenario): expect-pin command

Author: urish

src/APIClient.ts

@@ -7,6 +7,7 @@ import type {
   APIResponse,
   APIResultError,
   APISimStartParams,
+  PinReadResponse,
 } from './APITypes';
 
 const DEFAULT_SERVER = process.env.WOKWI_CLI_SERVER ?? 'wss://wokwi.com/api/ws/beta';
@@ -135,6 +136,10 @@ export class APIClient {
     return await this.sendCommand('control:set', { part: partId, control, value });
   }
 
+  async pinRead(partId: string, pin: string) {
+    return await this.sendCommand<PinReadResponse>('pin:read', { part: partId, pin });
+  }
+
   async sendCommand<T = unknown>(command: string, params?: any) {
     return await new Promise<T>((resolve, reject) => {
       const id = this.lastId++;

src/APITypes.ts

@@ -53,3 +53,8 @@ export interface APISimStartParams {
   pause?: boolean;
   chips?: string[];
 }
+
+export interface PinReadResponse {
+  pin: string;
+  value: number;
+}

src/main.ts

@@ -15,6 +15,7 @@ import { readVersion } from './readVersion';
 import { DelayCommand } from './scenario/DelayCommand';
 import { SetControlCommand } from './scenario/SetControlCommand';
 import { WaitSerialCommand } from './scenario/WaitSerialCommand';
+import { ExpectPinCommand } from './scenario/ExpectPinCommand';
 
 const millis = 1_000_000;
 
@@ -117,6 +118,7 @@ async function main() {
     );
     scenario.registerCommands({
       delay: new DelayCommand(eventManager),
+      'expect-pin': new ExpectPinCommand(),
       'set-control': new SetControlCommand(),
       'wait-serial': new WaitSerialCommand(expectEngine),
     });

src/scenario/ExpectPinCommand.ts

@@ -0,0 +1,26 @@
+import chalk from 'chalk';
+import type { APIClient } from '../APIClient';
+import type { IScenarioCommand, TestScenario } from '../TestScenario';
+
+export interface IExpectPinParams {
+  'part-id': string;
+  pin: string;
+  value: number;
+}
+
+export class ExpectPinCommand implements IScenarioCommand {
+  async run(scenario: TestScenario, client: APIClient, params: IExpectPinParams) {
+    const partId = params['part-id'];
+    const pinName = params.pin;
+    const expectedValue = params.value;
+    scenario.log(
+      chalk`expect-pin {yellow ${partId}}:{magenta ${pinName}} == {yellow ${expectedValue}}`
+    );
+    const value = (await client.pinRead(partId, pinName))?.value ? 1 : 0;
+    if (value !== expectedValue) {
+      scenario.fail(
+        chalk`GPIO {yellow ${partId}}:{magenta ${pinName}} expected to be {yellow ${expectedValue}} but was {red ${value}}`
+      );
+    }
+  }
+}