@fugood/bricks-project 2.22.0-beta.9 → 2.22.0

package/types/generators/ThermalPrinter.ts

@@ -0,0 +1,185 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Init thermal printer connection */
+export type GeneratorThermalPrinterActionInit = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_INIT'
+}
+
+/* Scan thermal printer */
+export type GeneratorThermalPrinterActionScan = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_SCAN'
+}
+
+/* Dispose thermal printer connection */
+export type GeneratorThermalPrinterActionDispose = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_DISPOSE'
+}
+
+/* Start print */
+export type GeneratorThermalPrinterActionPrint = ActionWithParams & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_PRINT'
+  params?: Array<
+    | {
+        input: 'options'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payload'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'rawCommands'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Check thermal printer status */
+export type GeneratorThermalPrinterActionCheckStatus = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_CHECK_STATUS'
+}
+
+interface GeneratorThermalPrinterDef {
+  /*
+Default property:
+{
+  "init": false,
+  "lang": "ANK",
+  "scanTimeout": 5000,
+  "stateUpdateInterval": 5000,
+  "cutMode": "PARTIAL"
+}
+  */
+  property?: {
+    /* Connect printer on generator initialized */
+    init?: boolean | DataLink
+    /* Connection driver */
+    driver?: 'escpos' | 'star' | 'tsc' | DataLink
+    /* The address of the printer */
+    connectString?: string | DataLink
+    /* The language of the printer (only for EPSON) */
+    lang?: 'ANK' | 'CHINESE' | 'TAIWAN' | 'KOREAN' | 'THAI' | 'SOUTHASIA' | DataLink
+    /* The timeout of scanning */
+    scanTimeout?: number | DataLink
+    /* State update interval, 0 means no update automatically */
+    stateUpdateInterval?: number | DataLink
+    /* Enable page mode on printing */
+    pageMode?: boolean | DataLink
+    /* Printable page area width */
+    pageWidth?: number | DataLink
+    /* Printable page area height */
+    pageHeight?: number | DataLink
+    /* Cut mode at the end of printing */
+    cutMode?: 'NONE' | 'FULL' | 'PARTIAL' | DataLink
+    /* Print payload  
+ example:  
+ { type: 'text', content: 'Hello, World!' }  
+ { type: 'feed', feedLines: 1 }  
+ { type: 'reverse-feed', feedLines: 1 }  
+ { type: 'image', content: '/path/to/file' }  
+ { type: 'line-space', lineSpace: 1 }  
+ { type: 'barcode', content: '1234567890', barcodeType: 'CODE128' }  
+ { type: 'symbol', content: '1234567890', symbolType: 'QRCODE' }  
+ Notes:  
+ - `reverse-feed` only works on ESC/POS driver  
+ - `width` and `height` in Star driver is magnification factor  
+ - `y` position in ESC/POS is use feed lines to offset  
+ - `textFont` only works on TSC driver */
+    payload?:
+      | Array<
+          | DataLink
+          | {
+              type?:
+                | 'text'
+                | 'image'
+                | 'barcode'
+                | 'qrcode'
+                | 'line-space'
+                | 'feed'
+                | 'reverse-feed'
+                | DataLink
+              content?: string | DataLink
+              width?: number | DataLink
+              height?: number | DataLink
+              x?: number | DataLink
+              y?: number | DataLink
+              align?: 'LEFT' | 'CENTER' | 'RIGHT' | DataLink
+              textSmooth?: boolean | DataLink
+              textEmphasize?: boolean | DataLink
+              textUnderline?: boolean | DataLink
+              textLang?: 'EN' | 'JA' | 'ZH_CN' | 'ZH_TW' | 'KO' | 'TH' | 'VI' | 'MULTI' | DataLink
+              textFont?: string | DataLink
+              barcodeType?:
+                | 'CODE39'
+                | 'CODE93'
+                | 'CODE128'
+                | 'EAN13'
+                | 'JAN13'
+                | 'EAN8'
+                | 'JAN8'
+                | 'UPC_A'
+                | 'UPC_E'
+                | 'ITF'
+                | DataLink
+              barcodeHRI?: 'OFF' | 'ABOVE' | 'BELOW' | 'BOTH' | DataLink
+              qrcodeModel?: '1' | '2' | DataLink
+              qrcodeSize?: number | DataLink
+              qrcodeLevel?: 'L' | 'M' | 'Q' | 'H' | DataLink
+              qrcodeMask?: 'S0' | 'S1' | 'S2' | 'S3' | 'S4' | 'S5' | 'S6' | 'S7' | DataLink
+              feedLines?: number | DataLink
+              lineSpace?: number | DataLink
+            }
+        >
+      | DataLink
+    /* Raw ASCII commands to print */
+    rawCommands?: string | DataLink
+  }
+  events?: {
+    /* Event of connection error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Is thermal printer initialized */
+    initialized?: () => Data
+    /* Thermal printer status */
+    status?: () => Data
+    /* Discovered devices */
+    discoveredDevices?: () => Data
+    /* Last error message */
+    lastError?: () => Data
+  }
+}
+
+/* Thermal Printer */
+export type GeneratorThermalPrinter = Generator &
+  GeneratorThermalPrinterDef & {
+    templateKey: 'GENERATOR_THERMAL_PRINTER'
+    switches: Array<
+      SwitchDef &
+        GeneratorThermalPrinterDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'initialized' | 'status' | 'discoveredDevices' | 'lastError'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Tick.ts

@@ -0,0 +1,75 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Start the tick */
+export type GeneratorTickAction_ = Action & {
+  __actionName: 'GENERATOR_TICK'
+}
+
+/* Cancel the tick */
+export type GeneratorTickActionCancel = Action & {
+  __actionName: 'GENERATOR_TICK_CANCEL'
+}
+
+interface GeneratorTickDef {
+  /*
+Default property:
+{}
+  */
+  property?: {
+    /* Start tick on generator initialized */
+    init?: boolean | DataLink
+    /* Interval of second for countdown */
+    interval?: number | DataLink
+    /* Initial value of countdown */
+    countdownStartValue?: number | DataLink
+    /* Interval of value for countdown */
+    countdownInterval?: number | DataLink
+    /* Make countdown repeatable */
+    repeat?: boolean | DataLink
+    /* Map for PROPERTY_BANK_RESULT */
+    map?: {} | DataLink
+    /* Fallback of MAP_OBJECT */
+    mapFallback?: any
+  }
+  events?: {
+    /* Event for each tick start */
+    ticking?: Array<EventAction>
+    /* Event for tick completed */
+    completed?: Array<EventAction>
+  }
+  outlets?: {
+    /* Countdown step value */
+    countdown?: () => Data
+  }
+}
+
+/* Execute event in countdown manner */
+export type GeneratorTick = Generator &
+  GeneratorTickDef & {
+    templateKey: 'GENERATOR_TICK'
+    switches: Array<
+      SwitchDef &
+        GeneratorTickDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'countdown'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/Udp.ts

@@ -0,0 +1,109 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Bind UDP port */
+export type GeneratorUDPActionBind = Action & {
+  __actionName: 'GENERATOR_UDP_BIND'
+}
+
+/* Send data to target */
+export type GeneratorUDPActionSend = ActionWithParams & {
+  __actionName: 'GENERATOR_UDP_SEND'
+  params?: Array<
+    | {
+        input: 'targetHost'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'targetPort'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'sendData'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Close UDP */
+export type GeneratorUDPActionClose = Action & {
+  __actionName: 'GENERATOR_UDP_CLOSE'
+}
+
+interface GeneratorUDPDef {
+  /*
+Default property:
+{
+  "init": false,
+  "type": "udp4",
+  "encoding": "base64",
+  "broadcast": false,
+  "multicast": ""
+}
+  */
+  property?: {
+    /* Bind port on generator initialized */
+    init?: boolean | DataLink
+    /* The family of socket */
+    type?: 'udp4' | 'udp6' | DataLink
+    /* Encoding of data */
+    encoding?: 'base64' | 'utf8' | 'ascii' | DataLink
+    /* Local bind port of UDP (0 or empty is random) */
+    localPort?: number | DataLink
+    /* Enable receive broadcast packets */
+    broadcast?: boolean | DataLink
+    /* Join multicast group (Multicast address) */
+    multicast?: string | DataLink
+  }
+  events?: {
+    /* Event of UDP port is binded */
+    onReady?: Array<EventAction>
+    /* Event of receive data */
+    onData?: Array<EventAction>
+    /* Event of socket closeed */
+    onClose?: Array<EventAction>
+    /* Event of socket error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Local UDP binded port */
+    port?: () => Data
+    /* Last received packet */
+    lastReceive?: () => Data
+    /* Error message */
+    errorMessage?: () => Data
+  }
+}
+
+/* TCP Server */
+export type GeneratorUDP = Generator &
+  GeneratorUDPDef & {
+    templateKey: 'GENERATOR_UDP'
+    switches: Array<
+      SwitchDef &
+        GeneratorUDPDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'port' | 'lastReceive' | 'errorMessage'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/VadGgml.ts

@@ -0,0 +1,211 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Load the model */
+export type GeneratorVadInferenceActionLoadModel = Action & {
+  __actionName: 'GENERATOR_VAD_INFERENCE_LOAD_MODEL'
+}
+
+/* Detect speech in audio file. You can provide `File URL` property, if not provided, it will use the default `File URL` */
+export type GeneratorVadInferenceActionDetectFile = ActionWithParams & {
+  __actionName: 'GENERATOR_VAD_INFERENCE_DETECT_FILE'
+  params?: Array<
+    | {
+        input: 'fileUrl'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'threshold'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'minSpeechDurationMs'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'minSilenceDurationMs'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'maxSpeechDurationS'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'speechPadMs'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'samplesOverlap'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Detect speech in audio data. Currently only support base64 encoded audio data (16-bit PCM, mono, 16kHz) */
+export type GeneratorVadInferenceActionDetectData = ActionWithParams & {
+  __actionName: 'GENERATOR_VAD_INFERENCE_DETECT_DATA'
+  params?: Array<
+    | {
+        input: 'data'
+        value?: any | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'threshold'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'minSpeechDurationMs'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'minSilenceDurationMs'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'maxSpeechDurationS'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'speechPadMs'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'samplesOverlap'
+        value?: number | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Clear downloaded files (model, audio) & current jobs */
+export type GeneratorVadInferenceActionClearDownload = Action & {
+  __actionName: 'GENERATOR_VAD_INFERENCE_CLEAR_DOWNLOAD'
+}
+
+/* Release context */
+export type GeneratorVadInferenceActionReleaseContext = Action & {
+  __actionName: 'GENERATOR_VAD_INFERENCE_RELEASE_CONTEXT'
+}
+
+interface GeneratorVadInferenceDef {
+  /*
+Default property:
+{
+  "init": false,
+  "modelName": "silero-v5.1.2",
+  "modelUseGPU": true,
+  "modelThreads": 4,
+  "detectThreshold": 0.5,
+  "detectMinSpeechDurationMs": 250,
+  "detectMinSilenceDurationMs": 100,
+  "detectMaxSpeechDurationS": 30,
+  "detectSpeechPadMs": 30,
+  "detectSamplesOverlap": 0.1
+}
+  */
+  property?: {
+    /* Initialize the VAD context on generator initialization  
+ Please note that it will take some RAM depending on the model size */
+    init?: boolean | DataLink
+    /* Use model name, currently only supports the Silero VAD model.  
+ The model download progress will be done in preload stage or  the generator initialization stage.  
+ You can also choose `custom` option and set `Model URL` and `Model SHA1` to use your own model */
+    modelName?: 'custom' | 'silero-v5.1.2' | DataLink
+    /* The URL or path of model  
+ We used `ggml` format model, please refer to https://huggingface.co/ggml-org/whisper-vad */
+    modelUrl?: string | DataLink
+    /* Hash type of model */
+    modelHashType?: 'md5' | 'sha256' | 'sha1' | DataLink
+    /* Hash of model */
+    modelHash?: string | DataLink
+    /* Use GPU Acceleration for inference. Currently iOS only. */
+    modelUseGPU?: boolean | DataLink
+    /* Number of threads to use for processing */
+    modelThreads?: number | DataLink
+    /* Speech probability threshold (0.0-1.0) */
+    detectThreshold?: number | DataLink
+    /* Minimum speech duration in milliseconds */
+    detectMinSpeechDurationMs?: number | DataLink
+    /* Minimum silence duration in milliseconds */
+    detectMinSilenceDurationMs?: number | DataLink
+    /* Maximum speech duration in seconds */
+    detectMaxSpeechDurationS?: number | DataLink
+    /* Padding around speech segments in milliseconds */
+    detectSpeechPadMs?: number | DataLink
+    /* Overlap between analysis windows (0.0-1.0) */
+    detectSamplesOverlap?: number | DataLink
+    /* The file URL or path to be analyzed.  
+ It only supported `wav` format with 16kHz sample rate & single (mono) channel */
+    detectFileUrl?: string | DataLink
+    /* MD5 of file to be analyzed */
+    detectFileMd5?: string | DataLink
+  }
+  events?: {
+    /* Event triggered when context state changes */
+    onContextStateChange?: Array<EventAction>
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction>
+    /* Event triggered when got detection result */
+    onDetected?: Array<EventAction>
+  }
+  outlets?: {
+    /* Context state */
+    contextState?: () => Data
+    /* Context details */
+    contextDetails?: () => Data
+    /* Is detecting */
+    isDetecting?: () => Data
+    /* Detection segments result */
+    detectionSegments?: () => Data
+    /* Detection details */
+    detectionDetails?: () => Data
+  }
+}
+
+/* Local Voice Activity Detection (VAD) inference based on GGML and [whisper.rn](https://github.com/mybigday/whisper.rn) */
+export type GeneratorVadInference = Generator &
+  GeneratorVadInferenceDef & {
+    templateKey: 'GENERATOR_VAD_INFERENCE'
+    switches: Array<
+      SwitchDef &
+        GeneratorVadInferenceDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet:
+                    | 'contextState'
+                    | 'contextDetails'
+                    | 'isDetecting'
+                    | 'detectionSegments'
+                    | 'detectionDetails'
+                  value: any
+                }
+          }>
+        }
+    >
+  }