fossekall-interface 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,91 @@
+# fossekall-interface
+
+`fossekall-interface` provides generated TypeScript interfaces/schemas for
+Fossekall data objects.
+
+Current package exports are telemetry schemas and types from `ecu/telemetry`.
+
+## Install
+
+```bash
+npm install fossekall-interface
+```
+
+## Usage
+
+Import from the package root:
+
+```ts
+import {
+  STATE_NAME,
+  BLDCTelemetry,
+  type BLDCTelemetry as BLDCTelemetryType,
+  FsmTelemetry,
+  type FsmTelemetry as FsmTelemetryType,
+  SawWaveTelemetry,
+  type SawWaveTelemetry as SawWaveTelemetryType,
+} from "fossekall-interface";
+```
+
+`index.ts` currently re-exports:
+
+- `./ecu/telemetry`
+
+### Current Generated API
+
+- `STATE_NAME`
+- `type STATE_NAME`
+- `BLDCTelemetry`
+- `type BLDCTelemetry`
+- `FsmTelemetry`
+- `type FsmTelemetry`
+- `SawWaveTelemetry`
+- `type SawWaveTelemetry`
+
+## What Gets Published
+
+Only the compiled output in `dist/` is published to npm.
+
+This package ships:
+
+- JavaScript (`dist/**/*.js`)
+- Type declarations (`dist/**/*.d.ts`)
+
+## Source Layout
+
+- `index.ts`: package root exports
+- `ecu/telemetry.ts`: generated telemetry schemas/types
+- `dist/`: compiled output used by npm consumers
+
+## Development
+
+Run from this directory (`generated/`):
+
+```bash
+npm install
+npm run build
+```
+
+The build uses `tsc` and outputs to `dist/`.
+
+## Publishing
+
+1. Update version:
+
+```bash
+npm version patch
+```
+
+2. Publish:
+
+```bash
+npm publish --access public
+```
+
+If you publish using a token, configure `.npmrc` with:
+
+```ini
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}
+```
+
+and export `NPM_TOKEN` in your shell before publishing.

package/dist/ecu/telemetry.d.ts

@@ -0,0 +1,49 @@
+import bin, { MaxValue, Schema, type IMeasurer, type ISerialInput, type ISerialOutput } from 'typed-binary';
+declare class UInt64Schema extends Schema<bigint> {
+    readonly maxSize = 8;
+    read(input: ISerialInput): bigint;
+    write(output: ISerialOutput, value: bigint): void;
+    measure(_: bigint | typeof MaxValue, measurer?: IMeasurer): IMeasurer;
+}
+export declare const STATE_NAME: {
+    readonly IDLE: 0;
+    readonly N2_FILL: 1;
+    readonly N2_FILL_HOLD: 2;
+    readonly PRESSURIZE: 3;
+    readonly RUN: 4;
+    readonly HOLD: 5;
+    readonly CALIBRATE: 6;
+};
+export type STATE_NAME = (typeof STATE_NAME)[keyof typeof STATE_NAME];
+export declare const BLDCTelemetry: import("typed-binary").ObjectSchema<{
+    valve_position: import("typed-binary").Float32Schema;
+    motor_position: import("typed-binary").Float32Schema;
+    upstream_pressure: import("typed-binary").Float32Schema;
+    downstream_pressure: import("typed-binary").Float32Schema;
+    venturi_pressure: import("typed-binary").Float32Schema;
+    timestamp: UInt64Schema;
+    current_draw: import("typed-binary").Float32Schema;
+    u_p: import("typed-binary").Float32Schema;
+    u_i: import("typed-binary").Float32Schema;
+    u_d: import("typed-binary").Float32Schema;
+    u_pid: import("typed-binary").Float32Schema;
+    u_ff: import("typed-binary").Float32Schema;
+    u_set: import("typed-binary").Float32Schema;
+    u_total: import("typed-binary").Float32Schema;
+    position_raw: import("typed-binary").Float32Schema;
+    servo_encoder: import("typed-binary").Float32Schema;
+    calibrated: import("typed-binary").ByteSchema;
+    fsm_state: import("typed-binary").Uint16Schema;
+}>;
+export type BLDCTelemetry = bin.Parsed<typeof BLDCTelemetry>;
+export declare const FsmTelemetry: import("typed-binary").ObjectSchema<{
+    currentState: import("typed-binary").Uint16Schema;
+}>;
+export type FsmTelemetry = bin.Parsed<typeof FsmTelemetry>;
+export declare const SawWaveTelemetry: import("typed-binary").ObjectSchema<{
+    value: import("typed-binary").Float32Schema;
+    inverse: import("typed-binary").Float32Schema;
+    derivative: import("typed-binary").Float32Schema;
+}>;
+export type SawWaveTelemetry = bin.Parsed<typeof SawWaveTelemetry>;
+export {};

package/dist/ecu/telemetry.js

@@ -0,0 +1,99 @@
+import bin, { Measurer, Schema } from 'typed-binary';
+// This file was generated by FRICC on 2026-03-05 14:48:28. Do not edit manually!
+// The current version of typed-binary does not support 64-bit primitives.
+// So for we'll implement our own schemas. :) 
+const __littleEndian = true;
+class UInt64Schema extends Schema {
+    maxSize = 8;
+    read(input) {
+        const bytes = new Uint8Array(8);
+        input.readSlice(bytes, 0, 8);
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        return view.getBigUint64(0, __littleEndian);
+    }
+    write(output, value) {
+        const bytes = new Uint8Array(8);
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        view.setBigUint64(0, value, __littleEndian);
+        output.writeSlice(bytes);
+    }
+    measure(_, measurer = new Measurer()) {
+        return measurer.add(8);
+    }
+}
+class Int64Schema extends Schema {
+    maxSize = 8;
+    read(input) {
+        const bytes = new Uint8Array(8);
+        input.readSlice(bytes, 0, 8);
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        return view.getBigInt64(0, __littleEndian);
+    }
+    write(output, value) {
+        const bytes = new Uint8Array(8);
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        view.setBigInt64(0, value, __littleEndian);
+        output.writeSlice(bytes);
+    }
+    measure(_, measurer = new Measurer()) {
+        return measurer.add(8);
+    }
+}
+class Float64Schema extends Schema {
+    maxSize = 8;
+    read(input) {
+        const bytes = new Uint8Array(8);
+        input.readSlice(bytes, 0, 8);
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        return view.getFloat64(0, __littleEndian);
+    }
+    write(output, value) {
+        const bytes = new Uint8Array(8);
+        const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        view.setFloat64(0, value, __littleEndian);
+        output.writeSlice(bytes);
+    }
+    measure(_, measurer = new Measurer()) {
+        return measurer.add(8);
+    }
+}
+const u64 = new UInt64Schema();
+const i64 = new Int64Schema();
+const f64 = new Float64Schema();
+export const STATE_NAME = {
+    IDLE: 0,
+    N2_FILL: 1,
+    N2_FILL_HOLD: 2,
+    PRESSURIZE: 3,
+    RUN: 4,
+    HOLD: 5,
+    CALIBRATE: 6,
+};
+export const BLDCTelemetry = bin.object({
+    valve_position: bin.f32, // float
+    motor_position: bin.f32, // float
+    upstream_pressure: bin.f32, // float
+    downstream_pressure: bin.f32, // float
+    venturi_pressure: bin.f32, // float
+    timestamp: u64, // unsigned long long
+    current_draw: bin.f32, // float
+    u_p: bin.f32, // float
+    u_i: bin.f32, // float
+    u_d: bin.f32, // float
+    u_pid: bin.f32, // float
+    u_ff: bin.f32, // float
+    u_set: bin.f32, // float
+    u_total: bin.f32, // float
+    position_raw: bin.f32, // float
+    servo_encoder: bin.f32, // float
+    calibrated: bin.u8, // unsigned char
+    fsm_state: bin.u16, // STATE_NAME
+});
+export const FsmTelemetry = bin.object({
+    currentState: bin.u16, // STATE_NAME
+});
+export const SawWaveTelemetry = bin.object({
+    value: bin.f32, // float
+    inverse: bin.f32, // float
+    derivative: bin.f32, // float
+});

package/dist/index.d.ts

@@ -1,2 +1 @@
-export * from "./fc/anothertest";
-export * from "./ecu/test";
+export * from "./ecu/telemetry";

package/dist/index.js

@@ -1,2 +1 @@
-export * from "./fc/anothertest";
-export * from "./ecu/test";
+export * from "./ecu/telemetry";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fossekall-interface",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "API contracts between client and server (rocket and GUI)",
   "license": "ISC",
   "author": "Propulse",
@@ -13,9 +13,13 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc -p tsconfig.json",
-    "prepack": "npm run build"
+    "prepack": "npm run build",
+    "publish": "npm publish --access private"
   },
   "devDependencies": {
     "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "typed-binary": "^4.3.2"
   }
 }

package/dist/ecu/test.d.ts

@@ -1,4 +0,0 @@
-export declare const EcuTestObject: {
-    name: string;
-    description: string;
-};

package/dist/ecu/test.js

@@ -1,4 +0,0 @@
-export const EcuTestObject = {
-    name: "Test object",
-    description: "This is a test object for the ECU module.",
-};

package/dist/fc/anothertest.d.ts

@@ -1,4 +0,0 @@
-export declare const FcTestObject: {
-    name: string;
-    description: string;
-};

package/dist/fc/anothertest.js

@@ -1,4 +0,0 @@
-export const FcTestObject = {
-    name: "Test object",
-    description: "This is a test object for the FC module.",
-};