fossekall-interface
v0.1.122
Published
API contracts between client and server (rocket and GUI)
Downloads
627
Readme
fossekall-interface
fossekall-interface provides TypeScript interfaces and generated typed-binary schemas for avionics commands and telemetry.
Install
npm install fossekall-interfaceProject Structure
fossekall-interface/
scripts/
generate-index.ts
src/
index.ts
constants.ts
types.ts
generated/
index.ts
fc/
index.ts
commands.ts
telemetry.ts
ecu/
index.ts
commands.ts
telemetry.tsExports
The package root exports three namespaces:
- mcu: Generated
typed-binaryschemas from the avionics codebase - constants: Manually added constants (e.g. IP addresses, port numbers, etc...)
- types: Utility types
Build Pipeline
Running the build executes two steps:
- prebuild: scripts/generate-index.ts regenerates index.ts files under src/generated
- build: TypeScript compiles src to dist
Build commands:
npm install
npm run buildPackage Output
Published artifacts are emitted to .dist/:
- JavaScript modules
- Type declarations
Publishing
npm version patch
npm publish --access privateThe package runs build automatically during prepack.
