AnalogActor

Base class for PWM output components with 0–255 value control (fade, pulse, blink animations).

#Extends

• DigitalActor

#Extended by

• LedDimmable
• ServoMotor

#Constructors

#Constructor

TypeScript

new AnalogActor(options): AnalogActor;

#Parameters

Parameter	Type
options	AnalogActorOptions

#Returns

AnalogActor

#Overrides

DigitalActor.constructor

#Accessors

#isAnimating

#Get Signature

TypeScript

get isAnimating(): boolean;

Check if an animation is running

#Returns

boolean

#Inherited from

DigitalActor.isAnimating

---

#isOn

#Get Signature

TypeScript

get isOn(): boolean;

Check if the component is currently on (above minimum value)

#Returns

boolean

#Overrides

DigitalActor.isOn

---

#value

#Get Signature

TypeScript

get value(): T | undefined;

Get the current value of the component.

#Returns

T | undefined

#Inherited from

DigitalActor.value

#Methods

#blink()

TypeScript

blink(interval?): this;

Blink the component at a given interval (Arduino-side animation)

#Parameters

Parameter	Type	Default value	Description
interval	number	500	Blink interval in milliseconds (default: 500)

#Returns

this

#Inherited from

DigitalActor.blink

---

#cleanup()

TypeScript

cleanup(): void;

Cleanup resources when board closes. Override in subclasses to add component-specific cleanup.

#Returns

void

#Inherited from

DigitalActor.cleanup

---

#fadeTo()

TypeScript

fadeTo(targetValue, duration?): this;

Fade to a target value over time (Arduino-side animation)

#Parameters

Parameter	Type	Default value	Description
targetValue	number	undefined	Target brightness value
duration	number	1000	Duration in milliseconds (default: 1000)

#Returns

this

---

#handleData()

TypeScript

handleData(data): void;

Handle incoming data from Arduino via serial protocol. Called by Board when data arrives for this component's ID.

#Parameters

Parameter	Type
data	unknown

#Returns

void

#Inherited from

DigitalActor.handleData

---

#off()

TypeScript

off(): this;

Turn the component off to min value

#Returns

this

#Overrides

DigitalActor.off

---

#on()

#Call Signature

TypeScript

on(): this;

Turn the component on to max value (no arguments) or register an event listener.

#Returns

this

#Overrides

DigitalActor.on

#Call Signature

TypeScript

on(event, listener): this;

Turn the component on to max value (no arguments) or register an event listener.

#Parameters

Parameter	Type
event	"change"
listener	(value) => void

#Returns

this

#Overrides

DigitalActor.on

---

#once()

#Call Signature

TypeScript

once<K>(event, listener): this;

Register a one-time event listener with typed events.

#Type Parameters

Type Parameter
K extends keyof ComponentEventMap<number>

#Parameters

Parameter	Type
event	K
listener	ComponentEventMap<number>[K]

#Returns

this

#Inherited from

DigitalActor.once

#Call Signature

TypeScript

once(event, listener): this;

Register a one-time event listener with typed events.

#Parameters

Parameter	Type
event	string | symbol
listener	(...args) => void

#Returns

this

#Inherited from

DigitalActor.once

---

#pulse()

TypeScript

pulse(interval?): this;

Pulse the component at a given interval (Arduino-side animation)

#Parameters

Parameter	Type	Default value	Description
interval	number	1000	Pulse interval in milliseconds (default: 1000)

#Returns

this

---

#removeAllListeners()

#Call Signature

TypeScript

removeAllListeners<K>(event?): this;

Remove all listeners for a specific event, or all events if no event specified.

#Type Parameters

Type Parameter
K extends keyof ComponentEventMap<number>

#Parameters

Parameter	Type
event?	K

#Returns

this

#Inherited from

DigitalActor.removeAllListeners

#Call Signature

TypeScript

removeAllListeners(event?): this;

Remove all listeners for a specific event, or all events if no event specified.

#Parameters

Parameter	Type
event?	string | symbol

#Returns

this

#Inherited from

DigitalActor.removeAllListeners

---

#removeListener()

#Call Signature

TypeScript

removeListener<K>(event, listener): this;

Remove an event listener with typed events.

#Type Parameters

Type Parameter
K extends keyof ComponentEventMap<number>

#Parameters

Parameter	Type
event	K
listener	ComponentEventMap<number>[K]

#Returns

this

#Inherited from

DigitalActor.removeListener

#Call Signature

TypeScript

removeListener(event, listener): this;

Remove an event listener with typed events.

#Parameters

Parameter	Type
event	string | symbol
listener	(...args) => void

#Returns

this

#Inherited from

DigitalActor.removeListener

---

#set()

TypeScript

set(value): this;

Set the value of the component

#Parameters

Parameter	Type	Description
value	number	Value between minValue and maxValue (0-255 by default)

#Returns

this

#Overrides

DigitalActor.set

---

#setBoard()

TypeScript

setBoard(board): void;

#Parameters

Parameter	Type
board	Board

#Returns

void

#Inherited from

DigitalActor.setBoard

---

#stop()

TypeScript

stop(): this;

Stop any running animation (blink, pulse)

#Returns

this

#Inherited from

DigitalActor.stop

---

#toggle()

TypeScript

toggle(): this;

Toggle the component between min and max values

#Returns

this

#Overrides

DigitalActor.toggle

---

#updateOptions()

TypeScript

updateOptions(options): void;

#Parameters

Parameter	Type
options	{ invert?: boolean; }
options.invert?	boolean

#Returns

void

#Inherited from

DigitalActor.updateOptions