axionSDK (UI)

The complete export list of the axionSDK module available to device UIs.

axionSDK is a virtual module registered for vue3-sfc-loader, so a device SFC imports from it directly:

import { useDeviceInstance, useMeterData, useHardware } from 'axionSDK';

The exports below are the full public surface. For usage and examples, see The axionSDK.

Composables

Export Purpose
useDeviceInstance(instanceId?) Read/write this device’s parameters and metadata: getParameter, setParameter, getParameterMetadata, getStateProperty, getPropertyOptions.
useParameterDock(instanceId, options) Arrange the custom view’s parameter dock: first pins ids to the front (the rest follow), order(params) reorders/drops/adds. A plain array means first.
useMeterData(meterId, deviceUuid?) Reactive meter level [0,1] as a Ref; subscribes on mount, unsubscribes on unmount.
useMeterDataSmoothed(...) As useMeterData, with decay smoothing for VU-style displays.
useHardware() Bind the physical rotary encoders and footswitches.
provideDeviceContext / useDeviceContext Set / read the ambient device UUID so composables can infer it without an explicit prop.

Encoder & LED utilities

Export Purpose
ENCODER_CONFIG Shared encoder configuration constants.
scaleEncoderValue(...) Map an encoder delta to a linear parameter range.
scaleEncoderValueQuadratic(...) As above, with a quadratic taper for fine control.
normalizeValue(...) Normalize a value within a parameter range.
ledBrightness(...) Compute an encoder-ring LED brightness from a value.
createEncoderHandler(...) Build an encoder rotation handler.
createParameterEncoderHandler(...) Build an encoder handler wired straight to a parameter.
pushLedLayer(...) Claim an encoder-LED layer (ownership stack).
isLedOwner(...) Check whether you currently own an LED.
reclaimLedOwnership(...) Reclaim LED ownership after another layer released it.
updateEncoderLedsFromAssignments(...) Set encoder LEDs from footswitch/param assignments.
reclaimFootswitchLeds(...) Reclaim footswitch LEDs.

State

Export Purpose
globalState The reactive global store (device instances, parameter values, system state).