Skip to content

API summary#

This page is a quick public API map for the current public SDKs. The Rust SDK is the core SDK and CLI surface. Python bindings use the same 0.2.x model, and the JavaScript SDK currently uses the 0.1.x line.

Authoritative package and source locations:

Use those sources for exact signatures when a page here summarizes behavior.

Core types#

Rust and Python names are shown in their native casing. JavaScript uses camelCase for several equivalent methods.

Type Purpose
Configuration Display intent: blackbody, chromaticity, manual, flux, or spectral.
Flux Flux target, currently represented as relative output.
Chromaticity CIE 1931 (x, y) coordinate.
SpectralSample Wavelength and measurement pair.
SpectralData Collection of spectral samples.
Token WiFi authorization token in Rust and Python; JavaScript exposes token generation and codec helpers.
TokenStore Load, save, and upsert WiFi tokens in Rust and Python.

Discovery#

Type / function Purpose
UsbEnvironment Discover USB-attached devices in Rust, Python, and JavaScript.
WifiEnvironment Discover saved-token WiFi devices in Rust and Python.
WifiConnection::discover_token_generation_devices() Find EP01 devices ready for WiFi token generation in Rust.
discover_runtimes() Python helper that combines USB and WiFi discovery.

Runtime hierarchy#

Type Key methods
Runtime host(), connect(), disconnect(), is_connected(), enable_logging(), generate_token()
Host identifier(), version(), fixtures(), wifi_scan(), wifi_join()
Fixture identifier(), sources(), display()
Source identifier(), emitters(), display(), tensor()
Emitter identifier(), spectral_data(), set_flux(), tensor()

Update#

Type Key methods
EP01UpdateTarget attached(), info(), available_firmware(), update_available(), update_device()

Python and JavaScript bindings expose equivalent update flows with their native method naming.

Python optimization helpers#

Function Purpose
ssi(test, reference) Spectral Similarity Index for 301-sample tensors.
cie_1931_chromaticity(t) CIE 1931 chromaticity coordinates.
melanopic_response(t) Melanopic response.
rhodopic_response(t) Rod response.
s_cone_response(t) S-cone response.
m_cone_response(t) M-cone response.
l_cone_response(t) L-cone response.
cie_x_response(t) CIE X response.
cie_y_response(t) CIE Y response.
cie_z_response(t) CIE Z response.

JavaScript optimization helpers#

Function / type Purpose
SpectralOptimizer Iterative optimizer for chromaticity, CCT, SSI, and plant-profile targets.
AdamOptimizer Typed-array Adam optimizer helper.
blackbodySpectrum(kelvin, wavelengths) Generate a normalized blackbody spectrum.
computeEmission(weights, spdMatrix, numEmitters, numWavelengths) Mix emitter spectra from weights.
computeChromaticity(emission401, cieX, cieY, cieZ) CIE 1931 chromaticity coordinates.
computeSSI(test301, reference301) Spectral Similarity Index.
computePlantBandMetrics(spectrum) Plant-band metrics for blue, green, red, and far-red ranges.
melanopicResponse(distributions) Melanopic response.
rhodopicResponse(distributions) Rod response.
sConeResponse(distributions) S-cone response.
mConeResponse(distributions) M-cone response.
lConeResponse(distributions) L-cone response.
cieXResponse(distributions) CIE X response.
cieYResponse(distributions) CIE Y response.
cieZResponse(distributions) CIE Z response.