NAFC Test Engine

Help Page

Close

Script Table Columns

Tip: Any column can be filtered to show only values containing the filter string. Prefix with ! to show rows that do not include that string.


Step Name

• The step name provides dual purposes:
  • Acts as a unique step identifier for jumps
  • Provides the user/log with a description of the step being executed
• Step names may contain spaces and special characters
• Step names are case sensitive for jumps and swap references
• Step names can use swap variables <> and [] to reference other step returned/result values

Tip: Step names starting with --- or with an empty Comm Label are skipped for execution/evaluation (noop).


Comm Label

• Comm Labels identify the device to use
• Script tells the engine to use an internal script command
• Any other value is treated as a device
• Comm Labels are case sensitive: Pico != pico
• The first use of a device must include all properties
• {"label":"Pico","protocol":"serial","baud":204000,"commandTerminator":"CR","autoFind":{"command":"id","expect":"Pico"}}
• {"label":"UUT","protocol":"serial","baud":19200,"commandTerminator":"CR","autoFind":{"command":"sn","expect":"CR"}}
• {"label":"USBDevice","protocol":"dll","dllPath":"C:\\\\Drivers\\\\MyDevice\\\\api.dll","function":"SendCommand","callType":"stdcall","returnType":"string"}.
• Once a Comm Label has been used, later steps can reference it by label only: Pico / UUT / USBDevice
  If a comm label was used with all properties and new properties are provided, the new properties are used.
  Swap variables can be used for comm lenles

Tip: Empty Comm Label rows are skipped for execution/evaluation (noop).


Command

• Script Commands are special internal commands executed by the script engine.
• Script Commands are not case sensitive; device labels/variables may be.
• Commands are delimited by commas
• When a device requires a literal comma inside an argument, use comma or -comma- or 0x2c or -0x2c-(placeholders restored to , after parsing)
• Commands can be cascaded within a single cell by separating commands with | or / (spaces allowed)
• | returns all results separated by |
• / returns only the last result
• If any delimiter is /, only the last result is returned; all must be | to get all results
• Cascaded commands (script or device) can use a prior result via _index_
• DIO:0:1 | DIO:13:0 | DIO:17:_0_ will result in these three commands: DIO:0:1 | DIO:13:0 | DIO:17:1 because DIO:0:1 should return a 1 Returned will be 1:0:1
• DIO:0:1 / DIO:13:0 / DIO:17:_0_ will result in these three commands: DIO:0:1 | DIO:13:0 | DIO:17:1 because DIO:0:1 should return a 1. Returned will be 1.

Tip: Script commands are delimited by commas; best practice is no spaces around delimiters.
Script command keys (before the first delimiter) are case insensitve and may contain _ or spaces in any portion of the command: Set Sn = Set_Sn = setsn = S__eT_S_N.
Underscored, non-underscored, spaced and cased spellings are interchangeable (float_to_hex_le = float to hex le = float2hexle, set_line_delay = Set Line Delay= setlinedelay, report_save = report save = reportsave, etc.).

Min/Max

• The returned value is evaluated against these limits to determine pass/fail
• Min/Max or both may be left empty
• Empty min = no lower limit; empty max = no upper limit; both empty = no limits
• If returned/min/max are numeric, numeric comparison is used; otherwise lexicographic comparison

Returned

• This column holds the result of the command(s)
• This value is used for <> swaps within commands/limits
• Compared against Min/Max to determine pass/fail

Result

• This column holds the evaluated result of the returned value against the Min/Max limits
• This column can have only 4 values
• This column is used for [] swaps within commands/limits
• Empty: not executed yet
• pass: returned value met limits
• fail: returned value outside limits
• aborted: catastrophic failure or stop pressed

Log

• The value in the log column controls visibility, reporting and logging.
• Log=0 : Steps execute but are hidden unless they fail (typically no limits) and are not logged for passed tests.
• Log=1 : Steps execute and log, but are hidden by default from display and reports.
• Log=2 : Steps execute, log, and display on screen and in reports.
• Log='' : Empty filter shows all; use 0 to show only 0; !0 shows everything except 0.

Variable Swaps

Cascaded Commands

Command Quick Reference

Examples show typical usage; underscores/spaces are interchangeable where noted. Commands are case-insensitive.

Math Operators (for math / mathint)

Tip: Separators (step names starting with --- or empty commLabel) are skipped for execution.
Tip: Script commands are delimited by , (comma) and may contain spaces before or after delimiters.

Operation

• Start/Pause/Stop controls the run. Stop on fail will halt on first fail.
• Run uses resolved values; table shows original commands, reports show resolved.
• Overall status locks at EndScript; post-EndScript steps still execute for reporting.
• Troubleshoot mode: double-click or Enter runs the selected row manually.
• Banner tones: double chime for pass, double buzz for fail, mid beep for aborted.

Maintenance & Editing

• Unlock Maintenance to edit, drag/drop, add/delete, duplicate, or reorder steps.
• Shortcuts (when unlocked): Add before (Ctrl+I), Add after (Ctrl+B), Duplicate (Ctrl+D), Delete (Ctrl+X), Move up/down (Ctrl+Arrow), To top/bottom (Ctrl+Home/End), Undo (Ctrl+Z), Run step (Ctrl+R).
• Table filters: default Log=2; prefix with ! to exclude.
• Save updates the current script (JSON or SQLite source).

Devices & Comm Labels

• Comm label can include device profile JSON (auto-find etc.). Examples:
  {"label":"Pico","protocol":"serial","baud":19200,"commandTerminator":"CR","autoFind":{"command":"id","expect":"Pico"}}
  {"label":"UUT","protocol":"serial","port":"/dev/ttyACM0","baud":115200,"pw":"Efos123","commandTerminator":"CR","autoFind":{"command":"sn","expect":"\\r"}}
• Ethernet protocol supports: get,http://host:port/path, post,http://host:port/path,payload, and raw:payload (host/port from profile).
  comm Label: "EthernetGET":{"protocol":"ethernet","host":"172.165.5.189","port":9110,"timeout":3000}
  Command Ex: http://172.165.5.189:9110/daq?cmd=DIO:1:?&returnType=raw
  get,http://172.165.5.189:9110/daq?cmd=DIO:1:?&returnType=raw
  or this wil also work because ip and port are in comm Label
  get,/daq?cmd=DIO:1:?&returnType=raw
  http calls prefer IPv4 (localhost resolves to 127.0.0.1)
• Windows USB: if the vendor driver exposes the device as a COM port (virtual serial), it will work with the serial protocol here. If it does not create a COM port (custom USB class), a dedicated adapter module is needed.
• DLL protocol (Windows): if the vendor exposes a DLL API, set "protocol":"dll" and provide:
  • dllPath: absolute path to the DLL
  • function: entry point name
  • callType: optional (e.g., stdcall)
  • args: optional array of argument types (ffi-napi/ref types)
  • returnType: optional return type (default string)
  Example: {"label":"USBDevice","protocol":"dll","dllPath":"C:\\\\Drivers\\\\MyDevice\\\\api.dll","function":"SendCommand","callType":"stdcall","returnType":"string"}. The script command text is split on commas and passed as arguments unless a custom arg parser is provided. Use -comma- or 0x2c as placeholders for literal commas.
Tip: CommandTerminaors must be in the form CR. LF or CRLF, but for autofind commands if only a return or line feed is expected, use \\r, \\n or \\r\\n

Program Structure (Execution Flow)

• UI loop: Clicking Run triggers runFrom in public/app.js. It iterates steps and calls executeRow for each (handles cascades, dialogs, limits, and status).
• Backend entry: executeRow POSTs to /execute (nafcTestEngine_r0.js), which calls engine.executeStep.
• Step dispatch: engine.executeStep resolves the comm label via registry and dispatches:
  • CommLabel = Script → modules/scriptCommands.js (logic, math, jumps, prompts, reports, etc.).
  • Protocol serial → modules/serialAdapter.
  • Protocol ethernet/tcp → modules/tcpAdapter (HTTP GET/POST or raw socket).
  • Protocol dll → modules/dllAdapter.
  • Legacy TCP: modules/TCP/genTcpService if available.
  Cascaded commands (| or /) execute in order; _index_ placeholders pull prior cascade results.
• Limit evaluation: engine.evaluateLimits checks returned vs. Min/Max; engine.updateOverall tracks overall status.
• Completion/abort: The UI loop stops on end, fail (if Stop on Fail), or abort. It locks overall status, updates banners, and logs the run to SQLite (modules/logStore.js)—passes log only steps with log ≥ 1; fail/abort logs all.
• Reports: Report requests (report command/buttons) call /report, rendered by modules/report.js using current meta and steps (log/full/fail filters).