SmearTransformer(uuid?: string, defaultValue?: { version: number, dimmerMode: DimmerMode, effect: number, ledNumber: number, smearMode: SmearMode, hue: number, saturation: number, value: number, brightness: number, temperature: number })

Requires:
@ray-js/panel-sdk≥1.0.0

Description

Paint DP protocol converter for bidirectional conversion between light-strip paint control data and the DP hexadecimal protocol

Parameters

ParameterTypeRequiredDescription
uuidstringNoDP identifier, defaults to paint_colour_data
defaultValue{ version: number, dimmerMode: DimmerMode, effect: number, ledNumber: number, smearMode: SmearMode, hue: number, saturation: number, value: number, brightness: number, temperature: number }NoDefault paint data returned when parsing fails

Return Value

Type: SmearTransformer
SmearTransformer instance

Referenced Types

enumDimmerMode
ValueActual ValueDescription
DimmerMode.whitewhiteWhite light
DimmerMode.colourcolourColor light
DimmerMode.colourCardcolourCardColor palette
DimmerMode.combinationcombinationCombination
enumSmearMode
ValueActual ValueDescription
SmearMode.allallAll
SmearMode.singlesingleSingle point
SmearMode.clearclearErase

Methods

MethodDescription
parserParse the DP hexadecimal string into a paint data object
formatterFormat the paint data object into a DP hexadecimal string

Examples

Example

import { SmearTransformer } from '@ray-js/panel-sdk';

const transformer = new SmearTransformer();
// Parse smear DP string
const data = transformer.parser('0001000a00000003e803e8');

// Format to DP string
const dpStr = transformer.formatter({
  dimmerMode: DimmerMode.colour,
  smearMode: SmearMode.all,
  hue: 120,
  saturation: 1000,
  value: 1000,
});