Repository navigation
Releases: vsreality/jskinisi
Release list
v2.3.1 - Position PID controls and angle settings
Add motor and platform position PID controls, separate velocity and position tuning, and measured/target response graphs.
- Set targets, speed limits and tolerances, reset the position origin and read feedback.
- Choose global radians or degrees in Settings; the preference saves automatically in the browser. PID gains retain their firmware units.
- Display firmware identity and improve page layouts and graph controls.
Connections remain compatible with protocol 2.1+. Full position PID controls require protocol 2.3+; the SDK retains legacy proportional position methods for 2.2. Initialize velocity before position and retune velocity gains for firmware 2.3.1.
The attached ZIP is the production Web Serial browser build. Serve it over HTTPS or localhost. Proxy support remains available when building the source with npm run build.
Validation: 101 tests, lint and the production Web Serial build passed.
v2.1.0 — Heartbeats and odometry subscriptions
Release JavaScript SDK and browser client 2.1.0 with idle heartbeats and automatic odometry updates. Requires protocol 2.1 firmware for the new session features.
- Configure a 500 ms watchdog after setup and send heartbeats only when other outgoing traffic is idle.
- Support encoder/platform odometry subscriptions with a bounded cache of timestamped samples across serial and proxy transports.
- Clear heartbeat timers and cached telemetry when a session is lost.
- Generate added commands from compatible v2 schemas without pinning the generator to a specific minor version.
Validation: 35 JavaScript tests, lint, production Web Serial build, and four generator tests. The attached browser build uses Web Serial; proxy support remains available in local builds.
v2.0.0 — Messages API 2.0.0
JavaScript SDK and browser client 2.0.0 for Kinisi Messages API 2.0.0.
Changes
- Web Serial and WebSocket proxy transports share INIT/READY setup, message-ID matching, and background time synchronization.
- Setters await ACKs; controller errors appear in the UI.
- Board identity is shown after connection.
- Encoder and platform odometry show acquisition timestamps, clock quality, and grouped controls/readings.
- 64-bit timestamp fields retain precision as bigint; the UI formats Unix time as UTC and uptime as elapsed time.
Compatibility and downloads
Requires API 2.0.0 firmware. API 1.x firmware is incompatible.
The attached web-serial ZIP is a prebuilt client with Web Serial support. Serve it over HTTPS or localhost. To include the WebSocket proxy, build the source with npm run build; the protocol guide covers proxy configuration. The package remains private and is not published to npm.
Validation: 32 tests, ESLint, normal production build, deployment build, and deterministic command regeneration pass.
v1.0.0 — Protocol v1 client
First GitHub release of the JavaScript SDK and browser client for Kinisi protocol v1.
Included
- JavaScript controller commands and a React/Vite browser interface.
- Local USB connections through Web Serial and remote connections through the WebSocket serial proxy.
- Motor, encoder, controller, platform, GPIO, and odometry controls.
- Sidebar navigation and consistent button styling.
Compatibility
Use this release with v1 firmware and its command protocol.
Based on main commit 002c7df, with package metadata aligned to 1.0.0 on the release/v1.0.0 branch. The package remains private; this GitHub release does not publish it to npm.
Run locally with npm install and npm run dev. Source archives are provided by GitHub.