Skip to content

arkona-technologies/excelibur

Repository files navigation

Excelibur

Excelibur is a tool that converts Excel-based configuration sheets into machine-readable configuration data for Arkona Technologies AT300 Processing Cards. It provides a convenient way to define and deploy AT300 configurations through familiar spreadsheet workflows.

Overview

Excelibur reads structured Excel workbooks (based on the provided AT300-XLSX-TEMPLATE.xlsx) and translates their content into configuration commands that can be sent to an AT300 device. These configurations typically include:

  • Channel and core allocations
  • Signal routing definitions
  • Processing block parameters
  • Network I/O and stream mappings

Important: Excelibur does not manage or configure timing parameters such as PTP or related synchronization settings. These must be set up separately by the end user.

Usage

1. Prerequisites

  • Node.js (version ≥ 18)
  • TypeScript
  • npx (bundled with npm)
  • A valid .xlsx configuration file that follows the AT300-XLSX-TEMPLATE structure

2. Build and Run

Update the bladerunner sdk dependencies to point at a local AT300 running the appropriate release.

  "dependencies": {
    "vapi": "http://CHANGE-THIS-TO-YOUR-AT300/vapi.tar.gz",
    "vscript": "http://CHANGE-THIS-TO-YOUR-AT300/vscript.tar.gz",
    "vutil": "http://CHANGE-THIS-TO-YOUR-AT300/vutil.tar.gz",
  }

Install dependencies via your preferred package manager

npm install --legacy-peer-deps 

Transpile and run via node

npx tsc && URL=ws://172.16.210.107 SHEET=./MY-AT300.xlsx node build/main.js

Parameters:

Variable Description
URL WebSocket endpoint for the AT300 card (e.g., ws://172.16.210.107)
SHEET Path to the Excel configuration file (.xlsx)

Note

  • The .xlsx file must follow the structure of the AT300-XLSX-TEMPLATE, including sheet names, headers, and data formats.
  • Incorrect or missing fields will trigger validation warnings or errors during execution.
  • Excelibur communicates via WebSocket — ensure the AT300 is reachable and configured to accept connections.
  • Timing and synchronization (e.g., PTP) must be configured separately by the user.

image

About

(excel-)sheet based configuration tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published