Contact Sales User Login
Plugin Reference Manuals

Plugins Documentation

Browse configuration schemas, route definitions, and integration guides for all official Uniflow dynamic plugins.

Kisan CM

Kisan CM

ID: uniflow.plugin.kisancm • Category: Financial & POS • Version: v1.2.0 • Min Uniflow Version: Uniflow ≥ v1.4.0

Kisan CM Plugin Reference Manual

1. Overview

Plugin Name: Kisan CM

Type: Financial & POS

Identifier: uniflow.plugin.kisancm

Description

Integration with Kisan Cash Management devices.

2. Technical Architecture

The Kisan CM plugin communicates with Kisan Cash Management currency counters and sorters via RS-232 serial or TCP binary socket connections. It listens for incoming cash processing events, decodes banknote count telemetry, denomination breakdown tables, bill serial numbers, and machine status error codes, publishing structured JSON data to the catalog.

System Interaction & Exposed Catalog Routes

The Kisan CM plugin connects to Kisan currency counting hardware via RS-232 serial or TCP sockets. It parses serial packet framing, extracting banknote count totals, denomination breakdowns, and counterfeit detection alarms.

Catalog Routes & Node Integration

Input Event Triggers (Input Nodes):

  • kisancm.count_completed - Emitted when a banknote counting batch finishes.
  • kisancm.denomination_breakdown - Emitted with count per denomination.
  • kisancm.error_detected - Counterfeit or jam error event.

    • Executable Actions (Action Nodes):

  • kisancm.request_status - Queries machine status.
  • kisancm.clear_count - Resets total count counters.
  • kisancm.send_command - Transmits raw protocol control commands.

    • Architecture Diagram

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...

    3. Configuration Parameters

    The following configuration fields are available in the User Interface for this plugin:

    Configuration SettingDescription
    Local Bind IPSpecifies the local bind ip.
    Listening PortNumeric value specifying the listening port.

    4. Exposed Routes & Data Types

    This plugin exposes catalog fields across the following rule graph nodes:

    Input Source

    The Input Source node reads live counter connection status and total note metrics.

    Human-Readable Field NameData TypeDescription
    Client IP  String
    ↳IP address of the connected Kisan currency counting machine.
    Currency Code  String
    ↳Active currency code identifier (e.g. USD, EUR, RON).
    Total  Int32
    ↳Total count/value of banknotes processed in the current count transaction.

    Event Input

    The Event Input node listens for real-time banknote counting events pushed by Kisan CM hardware.

    Human-Readable Field NameData TypeExposed Event Fields & Data TypesDescription
    Count Transaction Event  Event Object
    ↳
    ClientIp (String)
    CurrencyCode (String)
    Total (Int32)
    Timestamp (DateTime)
    		Real-time event triggered immediately whenever a banknote counting batch completes on the Kisan machine.

    Data Source

    The Data Source node queries denomination breakdown arrays for counted cash.

    Human-Readable Collection NameData TypeExposed Fields & Data TypesDescription
    Denominations  Json` (`collection`)
    ↳
    Index (Int32)
    Value (Int32)
    Count (Int32)
    Total (Int32)
    		Array collection of banknote denomination details (note face value, piece count, total value per denomination).

    5. Usage Examples

    Scenario A: Banknote Count Transaction Batch Completion Inserts Database Audit Record & Webhook

    Workflow Overview:

    When a Kisan CM cash sorter finishes counting a deposit batch (kisancm.count_completed / Count Transaction Event), Uniflow intercepts the count telemetry (Total = 15000, CurrencyCode = "USD"), inserts a row into DB Link table cash_deposits, and dispatches an HTTP POST webhook to the POS back-office API.

    Rule Node Configuration:

    1. Event Input Node: Kisan CM Listener

  • Filter Event: Count Transaction Event (kisancm.count_completed)
  • Exposed Fields: Total (Int32), CurrencyCode (String), ClientIp (String), Timestamp (DateTime)

    • 2. Logic Pass-Through Node: Transaction Formatter

  • Mapping: Total, CurrencyCode, ClientIp

    • 3. Output Target Node A: DB Link Target

  • Action Target: Database Table Write Target (dblink.insert_row)
  • Table: cash_deposits
  • total_amount: ${Total}
  • currency: ${CurrencyCode}
  • source_ip: ${ClientIp}

    • 4. Output Target Node B: HTTP Client Action

  • Action Target: POST Request
  • URL: https://pos.bank.local/api/deposits

    • Logic Flow Diagram:

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...

    Scenario B: Counterfeit / Suspect Note Error Alarm Triggers Milestone Alarm & PTZ Camera Preset

    Workflow Overview:

    When a Kisan CM unit detects a counterfeit or suspect banknote (kisancm.error_detected with ErrorCode == "SUSPECT_NOTE"), Uniflow immediately triggers a high-priority alarm in Milestone XProtect VMS and moves teller dome camera CAM_TELLER_02 to PTZ Preset 1.

    Rule Node Configuration:

    1. Event Input Node: Kisan CM Listener

  • Filter Event: Error Detected Event (kisancm.error_detected)
  • Exposed Fields: ClientIp (String), ErrorCode (String), Timestamp (DateTime)

    • 2. Logic Condition Node: Equal

  • Expression: ErrorCode == "SUSPECT_NOTE"

    • 3. Output Target Node A: Milestone Action Target

  • Action Target: Milestone Trigger Alarm
  • Name: COUNTERFEIT_NOTE_ALERT
  • Message: Suspect banknote detected at teller station ${ClientIp}
  • Source: CAM_TELLER_02_GUID

    • 4. Output Target Node B: ONVIF / Avigilon PTZ

  • Action Target: Go to Preset
  • PresetId: 1

    • Logic Flow Diagram:

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...
    Architecture Flow Diagram — Full Preview