README.md

Capacitor Scan plugin

Scan 3.1 draughts engine by Fabien Letouzey, interface for Ionic Capacitor.

Example usage

• https://github.com/roepstoep/lidrobile/blob/master/src/scan.ts
• https://github.com/roepstoep/lidrobile/blob/master/src/ui/analyse/ceval/ScanClient.ts

API

• getMaxMemory()
• getCPUArch()
• start(...)
• cmd(...)
• exit()

getMaxMemory()

getMaxMemory() => Promise<{ value: number; }>

Returns the maximum number of MB that can be used by the engine.

Returns: Promise<{ value: number; }>

---

getCPUArch()

getCPUArch() => Promise<{ value: string; }>

Returns CPU architecture. Possible values are: armeabi, armeabi-v7a, arm64-v8a, x86, x86_64, mips, mips64.

Returns: Promise<{ value: string; }>

---

start(...)

start(options: { variant: string; }) => Promise<void>

Initialize the engine. You must call this method before sending commands.

Param	Type
options	{ variant: string; }

---

cmd(...)

cmd(options: { cmd: string; }) => Promise<void>

Sends a command to the engine. You can listen to the output using the "scan" window event.

Param	Type
options	{ cmd: string; }

---

exit()

exit() => Promise<void>

Stops the engine.

---