awtrix-ts 1.0.0 → 1.1.0

package/dist/api.d.ts

@@ -0,0 +1,83 @@
+import * as interaction from './interaction.js';
+import * as transitions from './transitions.js';
+import * as indicators from './indicators.js';
+import * as settings from './settings.js';
+import * as stats from './stats.js';
+import * as moodlight from './moodlight.js';
+declare class Awtrix {
+    #private;
+    url: string;
+    Transitions: {
+        readonly Random: 0;
+        readonly Slide: 1;
+        readonly Dim: 2;
+        readonly Zoom: 3;
+        readonly Rotate: 4;
+        readonly Pixelate: 5;
+        readonly Curtain: 6;
+        readonly Ripple: 7;
+        readonly Blink: 8;
+        readonly Reload: 9;
+        readonly Fade: 10;
+    };
+    Indicators: {
+        readonly UpperRight: 1;
+        readonly CenterRight: 2;
+        readonly BottomRight: 3;
+    };
+    Effects: {
+        readonly BrickBreaker: "BrickBreaker";
+        readonly Checkerboard: "Checkerboard";
+        readonly Fireworks: "Fireworks";
+        readonly PingPong: "PingPong";
+        readonly Radar: "Radar";
+        readonly Ripple: "Ripple";
+        readonly Snake: "Snake";
+        readonly TwinklingStars: "TwinklingStars";
+        readonly TheaterChase: "TheaterChase";
+        readonly ColorWaves: "ColorWaves";
+        readonly SwirlOut: "SwirlOut";
+        readonly SwirlIn: "SwirlIn";
+        readonly LookingEyes: "LookingEyes";
+        readonly Matrix: "Matrix";
+        readonly Pacifica: "Pacifica";
+        readonly Plasma: "Plasma";
+        readonly PlasmaCloud: "PlasmaCloud";
+        readonly MovingLine: "MovingLine";
+        readonly Fade: "Fade";
+    };
+    PushIcon: {
+        readonly Static: 0;
+        readonly MoveOnce: 1;
+        readonly MoveRepeat: 2;
+    };
+    constructor(url: URL);
+    power(power: boolean): Promise<void>;
+    sleep(time: number): Promise<void>;
+    reboot(): Promise<void>;
+    settings(settings: settings.Settings): Promise<void>;
+    resetDefaultSettings(): Promise<void>;
+    erase(): Promise<void>;
+    screen(): Promise<string>;
+    stats(): Promise<stats.Stats>;
+    effects(): Promise<interaction.Effect[]>;
+    transitions(): Promise<transitions.Transitions[]>;
+    loop(): Promise<{
+        [app: string]: number;
+    }>;
+    playMelody(rtttl: string): Promise<void>;
+    playMelodyFile(name: string): Promise<void>;
+    setIndicator(indicator: indicators.IndicatorPayload): Promise<void>;
+    clearIndicator(indicator: indicators.Indicators): Promise<void>;
+    moodlight(setting: moodlight.MoodlightColor | moodlight.MoodlightKelvin): Promise<void>;
+    clearMoodlight(): Promise<void>;
+    notify(notification: interaction.Interaction): Promise<void>;
+    dismissNotification(): Promise<void>;
+    app(name: string, app: interaction.Interaction): Promise<void>;
+    launchApp(name: string): Promise<void>;
+    nextApp(): Promise<void>;
+    previousApp(): Promise<void>;
+    get(endpoint: string): Promise<any>;
+    post(endpoint: string, data?: object): Promise<void>;
+}
+export { Awtrix };

package/{api.ts → dist/api.js}

@@ -1,42 +1,33 @@
 import { setTimeout } from 'node:timers/promises';
-import * as interaction from './interaction.ts';
-import * as transitions from './transitions.ts';
-import * as indicators from './indicators.ts';
-import * as settings from './settings.ts';
-import './stats.d.ts';
-import './moodlight.d.ts';
-
+import * as interaction from './interaction.js';
+import * as transitions from './transitions.js';
+import * as indicators from './indicators.js';
 class Awtrix {
     #bootTime = 15 * 1000;
-    url: string;
+    url;
     Transitions = transitions.Transition;
     Indicators = indicators.Indicator;
     Effects = interaction.Effect;
     PushIcon = interaction.PushIcon;
-
-    constructor(url: URL) {
+    constructor(url) {
         this.url = url.href + 'api';
     }
-
-    async power(power: boolean): Promise<void> {
+    async power(power) {
         await this.post('power', { power });
     }
-
-    async sleep(time: number): Promise<void> {
+    async sleep(time) {
         await Promise.all([
             await this.post('sleep', { sleep: time }),
             await setTimeout((time * 1000) + this.#bootTime)
         ]);
     }
-
-    async reboot(): Promise<void> {
+    async reboot() {
         await Promise.all([
             await this.post('reboot'),
             await setTimeout(this.#bootTime)
         ]);
     }
-
-    async settings(settings: settings.Settings): Promise<void> {
+    async settings(settings) {
         await this.post('settings', {
             ATIME: settings.appTime,
             TEFF: settings.transitionEffect,
@@ -74,96 +65,75 @@ class Awtrix {
             MATP: settings.matrixPower,
             VOL: settings.volume,
             OVERLAY: settings.globalEffectOverlay
-        } as settings.SettingsPayload);
+        });
     }
-
-    async resetDefaultSettings(): Promise<void> {
+    async resetDefaultSettings() {
         await this.post('resetSettings');
     }
-
-    async erase(): Promise<void> {
+    async erase() {
         await this.post('erase');
     }
-
-    async screen(): Promise<string> {
+    async screen() {
         return this.get('screen');
     }
-
-    async stats(): Promise<Stats> {
+    async stats() {
         return this.get('stats');
     }
-
-    async effects(): Promise<interaction.Effect[]> {
+    async effects() {
         return this.get('effects');
     }
-
-    async transitions(): Promise<transitions.Transitions[]> {
+    async transitions() {
         return this.get('transitions');
     }
-
-    async loop(): Promise<{ [app: string]: number; }> {
+    async loop() {
         return this.get('loop');
     }
-
-    async playMelody(rtttl: string): Promise<void> {
+    async playMelody(rtttl) {
         await this.post('rtttl', { rtttl });
     }
-
-    async playMelodyFile(name: string): Promise<void> {
+    async playMelodyFile(name) {
         await this.post('sound', { sound: name });
     }
-
-    async setIndicator(indicator: indicators.IndicatorPayload): Promise<void> {
+    async setIndicator(indicator) {
         await this.post('indicator' + indicator.position, {
             color: indicator.color,
             blink: indicator.blink,
             fade: indicator.fade
         });
     }
-
-    async clearIndicator(indicator: indicators.Indicators): Promise<void> {
+    async clearIndicator(indicator) {
         await this.post('indicator' + indicator);
     }
-
-    async moodlight(setting: MoodlightColor | MoodlightKelvin): Promise<void> {
+    async moodlight(setting) {
         await this.post('moodlight', setting);
     }
-
-    async clearMoodlight(): Promise<void> {
+    async clearMoodlight() {
         await this.post('moodlight');
     }
-
-    async notify(notification: interaction.Interaction): Promise<void> {
+    async notify(notification) {
         await this.post('notify', notification);
     }
-
-    async dismissNotification(): Promise<void> {
+    async dismissNotification() {
         await this.post('notify/dismiss');
     }
-
-    async app(name: string, app: interaction.Interaction): Promise<void> {
+    async app(name, app) {
         await this.post(`custom?name=${name}`, app);
     }
-
-    async launchApp(name: string): Promise<void> {
+    async launchApp(name) {
         await this.post('switch', { name });
     }
-
-    async nextApp(): Promise<void> {
+    async nextApp() {
         await this.post('nextapp');
     }
-
-    async previousApp(): Promise<void> {
+    async previousApp() {
         await this.post('previousapp');
     }
-
-    async get(endpoint: string): Promise<any> {
+    async get(endpoint) {
         const response = await fetch(`${this.url}/${endpoint}`);
-        const data: any = await response.json();
+        const data = await response.json();
         return data;
     }
-
-    async post(endpoint: string, data?: object): Promise<void> {
+    async post(endpoint, data) {
         await fetch(`${this.url}/${endpoint}`, {
             method: 'POST',
             headers: {
@@ -173,5 +143,4 @@ class Awtrix {
         });
     }
 }
-
 export { Awtrix };

package/dist/demo.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/demo.js

@@ -0,0 +1,75 @@
+import { setTimeout } from 'node:timers/promises';
+import { Awtrix } from './api.js';
+const clockUrl = 'http://SOME_IP_ADDRESS'; // Replace with your Awtrix clock IP address
+const clock = new Awtrix(new URL(clockUrl));
+// Get status
+console.log(await clock.stats());
+// Get app loop
+console.log(await clock.loop());
+// Power on/off
+await clock.power(true);
+await clock.power(false);
+// Hibernate
+await clock.sleep(5);
+// Switch apps
+await clock.nextApp();
+await setTimeout(2000);
+await clock.previousApp();
+// Change settings
+await clock.settings({
+    automaticAppSwitching: false,
+    globalTextColor: [0, 255, 0],
+    // ...other settings
+});
+// Set/clear indicators
+await clock.setIndicator({
+    color: [255, 0, 0],
+    position: clock.Indicators.UpperRight,
+    // blink: 500, // blink every 500ms
+    // fade: 1000, // fade in duration 1000ms
+});
+await setTimeout(3000);
+await clock.clearIndicator(clock.Indicators.UpperRight);
+// Send a notification
+await clock.notify({
+    text: 'Hello World!',
+    icon: '3049',
+    pushIcon: clock.PushIcon.MoveOnce,
+    effect: clock.Effects.PlasmaCloud,
+    repeat: 5
+});
+await setTimeout(10000);
+// Dismiss a notification
+await clock.dismissNotification();
+// Create/update a custom app
+await clock.app('demoApp', {
+    text: 'This is a custom app!',
+    icon: '1000',
+    repeat: 5,
+    duration: 3000,
+    effect: clock.Effects.TwinklingStars,
+    scrollSpeed: 150
+});
+// Launch the custom app
+await clock.launchApp('demoApp');
+await setTimeout(20000);
+// Display progress bar
+for (let i = 0; i <= 100; i++) {
+    if (i % 5 === 0) {
+        await clock.app('Progress', {
+            text: `${i}%`,
+            progress: i,
+            duration: 1,
+        });
+        if (i === 0) {
+            await clock.launchApp('Progress');
+        }
+        if (i === 100) {
+            await clock.app('Progress', {
+                text: `Done!`,
+                color: [0, 255, 0],
+            });
+        }
+        await setTimeout(500);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,83 @@
+import * as interaction from './interaction.js';
+import * as transitions from './transitions.js';
+import * as indicators from './indicators.js';
+import * as settings from './settings.js';
+import * as stats from './stats.js';
+import * as moodlight from './moodlight.js';
+declare class Awtrix {
+    #private;
+    url: string;
+    Transitions: {
+        readonly Random: 0;
+        readonly Slide: 1;
+        readonly Dim: 2;
+        readonly Zoom: 3;
+        readonly Rotate: 4;
+        readonly Pixelate: 5;
+        readonly Curtain: 6;
+        readonly Ripple: 7;
+        readonly Blink: 8;
+        readonly Reload: 9;
+        readonly Fade: 10;
+    };
+    Indicators: {
+        readonly UpperRight: 1;
+        readonly CenterRight: 2;
+        readonly BottomRight: 3;
+    };
+    Effects: {
+        readonly BrickBreaker: "BrickBreaker";
+        readonly Checkerboard: "Checkerboard";
+        readonly Fireworks: "Fireworks";
+        readonly PingPong: "PingPong";
+        readonly Radar: "Radar";
+        readonly Ripple: "Ripple";
+        readonly Snake: "Snake";
+        readonly TwinklingStars: "TwinklingStars";
+        readonly TheaterChase: "TheaterChase";
+        readonly ColorWaves: "ColorWaves";
+        readonly SwirlOut: "SwirlOut";
+        readonly SwirlIn: "SwirlIn";
+        readonly LookingEyes: "LookingEyes";
+        readonly Matrix: "Matrix";
+        readonly Pacifica: "Pacifica";
+        readonly Plasma: "Plasma";
+        readonly PlasmaCloud: "PlasmaCloud";
+        readonly MovingLine: "MovingLine";
+        readonly Fade: "Fade";
+    };
+    PushIcon: {
+        readonly Static: 0;
+        readonly MoveOnce: 1;
+        readonly MoveRepeat: 2;
+    };
+    constructor(url: URL);
+    power(power: boolean): Promise<void>;
+    sleep(time: number): Promise<void>;
+    reboot(): Promise<void>;
+    settings(settings: settings.Settings): Promise<void>;
+    resetDefaultSettings(): Promise<void>;
+    erase(): Promise<void>;
+    screen(): Promise<string>;
+    stats(): Promise<stats.Stats>;
+    effects(): Promise<interaction.Effect[]>;
+    transitions(): Promise<transitions.Transitions[]>;
+    loop(): Promise<{
+        [app: string]: number;
+    }>;
+    playMelody(rtttl: string): Promise<void>;
+    playMelodyFile(name: string): Promise<void>;
+    setIndicator(indicator: indicators.IndicatorPayload): Promise<void>;
+    clearIndicator(indicator: indicators.Indicators): Promise<void>;
+    moodlight(setting: moodlight.MoodlightColor | moodlight.MoodlightKelvin): Promise<void>;
+    clearMoodlight(): Promise<void>;
+    notify(notification: interaction.Interaction): Promise<void>;
+    dismissNotification(): Promise<void>;
+    app(name: string, app: interaction.Interaction): Promise<void>;
+    launchApp(name: string): Promise<void>;
+    nextApp(): Promise<void>;
+    previousApp(): Promise<void>;
+    get(endpoint: string): Promise<any>;
+    post(endpoint: string, data?: object): Promise<void>;
+}
+export { Awtrix };

package/dist/index.js

@@ -0,0 +1,146 @@
+import { setTimeout } from 'node:timers/promises';
+import * as interaction from './interaction.js';
+import * as transitions from './transitions.js';
+import * as indicators from './indicators.js';
+class Awtrix {
+    #bootTime = 15 * 1000;
+    url;
+    Transitions = transitions.Transition;
+    Indicators = indicators.Indicator;
+    Effects = interaction.Effect;
+    PushIcon = interaction.PushIcon;
+    constructor(url) {
+        this.url = url.href + 'api';
+    }
+    async power(power) {
+        await this.post('power', { power });
+    }
+    async sleep(time) {
+        await Promise.all([
+            await this.post('sleep', { sleep: time }),
+            await setTimeout((time * 1000) + this.#bootTime)
+        ]);
+    }
+    async reboot() {
+        await Promise.all([
+            await this.post('reboot'),
+            await setTimeout(this.#bootTime)
+        ]);
+    }
+    async settings(settings) {
+        await this.post('settings', {
+            ATIME: settings.appTime,
+            TEFF: settings.transitionEffect,
+            TSPEED: settings.transitionSpeed,
+            TCOL: settings.globalTextColor,
+            TMODE: settings.timeAppStyle,
+            CHCOL: settings.calendarHeaderColor,
+            CBCOL: settings.calendarBodyColor,
+            CTCOL: settings.calendarTextColor,
+            WD: settings.weekdayDisplay,
+            WDCA: settings.activeWeekdayColor,
+            WDCI: settings.inactiveWeekdayColor,
+            BRI: settings.matrixBrightness,
+            ABRI: settings.automaticBrightnessControl,
+            ATRANS: settings.automaticAppSwitching,
+            CCORRECTION: settings.colorCorrection,
+            CTEMP: settings.colorTemperature,
+            TFORMAT: settings.timeFormat,
+            DFORMAT: settings.dateFormat,
+            SOM: settings.startWeekOnMonday,
+            CEL: settings.celsiusTemperature,
+            BLOCKN: settings.blockNavigationKeys,
+            UPPERCASE: settings.uppercaseText,
+            TIME_COL: settings.timeAppTextColor,
+            DATE_COL: settings.dateAppTextColor,
+            TEMP_COL: settings.temperatureAppTextColor,
+            HUM_COL: settings.humidityAppTextColor,
+            BAT_COL: settings.batteryAppTextColor,
+            SSPEED: settings.scrollSpeedModification,
+            TIM: settings.enableTimeApp,
+            DAT: settings.enableDateApp,
+            HUM: settings.enableHumidityApp,
+            TEMP: settings.enableTemperatureApp,
+            BAT: settings.enableBatteryApp,
+            MATP: settings.matrixPower,
+            VOL: settings.volume,
+            OVERLAY: settings.globalEffectOverlay
+        });
+    }
+    async resetDefaultSettings() {
+        await this.post('resetSettings');
+    }
+    async erase() {
+        await this.post('erase');
+    }
+    async screen() {
+        return this.get('screen');
+    }
+    async stats() {
+        return this.get('stats');
+    }
+    async effects() {
+        return this.get('effects');
+    }
+    async transitions() {
+        return this.get('transitions');
+    }
+    async loop() {
+        return this.get('loop');
+    }
+    async playMelody(rtttl) {
+        await this.post('rtttl', { rtttl });
+    }
+    async playMelodyFile(name) {
+        await this.post('sound', { sound: name });
+    }
+    async setIndicator(indicator) {
+        await this.post('indicator' + indicator.position, {
+            color: indicator.color,
+            blink: indicator.blink,
+            fade: indicator.fade
+        });
+    }
+    async clearIndicator(indicator) {
+        await this.post('indicator' + indicator);
+    }
+    async moodlight(setting) {
+        await this.post('moodlight', setting);
+    }
+    async clearMoodlight() {
+        await this.post('moodlight');
+    }
+    async notify(notification) {
+        await this.post('notify', notification);
+    }
+    async dismissNotification() {
+        await this.post('notify/dismiss');
+    }
+    async app(name, app) {
+        await this.post(`custom?name=${name}`, app);
+    }
+    async launchApp(name) {
+        await this.post('switch', { name });
+    }
+    async nextApp() {
+        await this.post('nextapp');
+    }
+    async previousApp() {
+        await this.post('previousapp');
+    }
+    async get(endpoint) {
+        const response = await fetch(`${this.url}/${endpoint}`);
+        const data = await response.json();
+        return data;
+    }
+    async post(endpoint, data) {
+        await fetch(`${this.url}/${endpoint}`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            ...(data ? { body: JSON.stringify(data) } : {}),
+        });
+    }
+}
+export { Awtrix };

package/dist/indicators.d.ts

@@ -0,0 +1,13 @@
+export interface IndicatorPayload {
+    position: Indicators;
+    color: string | number[];
+    blink?: number;
+    fade?: number;
+}
+declare const Indicator: {
+    readonly UpperRight: 1;
+    readonly CenterRight: 2;
+    readonly BottomRight: 3;
+};
+export type Indicators = typeof Indicator[keyof typeof Indicator];
+export { Indicator };

package/dist/indicators.js

@@ -0,0 +1,6 @@
+const Indicator = {
+    UpperRight: 1,
+    CenterRight: 2,
+    BottomRight: 3
+};
+export { Indicator };

package/dist/interaction.d.ts

@@ -0,0 +1,72 @@
+declare module './interaction.js' {
+    interface Interaction {
+        text?: string;
+        textCase?: number;
+        topText?: boolean;
+        textOffset?: number;
+        center?: boolean;
+        color?: string | number[];
+        gradient?: (string | number)[];
+        blinkText?: number;
+        fadeText?: number;
+        background?: string | number[];
+        rainbow?: boolean;
+        icon?: string;
+        pushIcon?: PushIcon;
+        repeat?: number;
+        duration?: number;
+        hold?: boolean;
+        sound?: string;
+        rtttl?: string;
+        loopSound?: boolean;
+        bar?: number[];
+        line?: number[];
+        autoscale?: boolean;
+        barBC?: string | number[];
+        progress?: number;
+        progressC?: string | number[];
+        progressBC?: string | number[];
+        pos?: number;
+        draw?: object[];
+        lifetime?: number;
+        lifetimeMode?: number;
+        stack?: boolean;
+        wakeup?: boolean;
+        noScroll?: boolean;
+        clients?: string[];
+        scrollSpeed?: number;
+        effect?: Effect;
+        effectSettings?: Record<string, unknown>;
+        save?: boolean;
+        overlay?: string;
+    }
+}
+declare const PushIcon: {
+    readonly Static: 0;
+    readonly MoveOnce: 1;
+    readonly MoveRepeat: 2;
+};
+type PushIcon = typeof PushIcon[keyof typeof PushIcon];
+declare const Effect: {
+    readonly BrickBreaker: "BrickBreaker";
+    readonly Checkerboard: "Checkerboard";
+    readonly Fireworks: "Fireworks";
+    readonly PingPong: "PingPong";
+    readonly Radar: "Radar";
+    readonly Ripple: "Ripple";
+    readonly Snake: "Snake";
+    readonly TwinklingStars: "TwinklingStars";
+    readonly TheaterChase: "TheaterChase";
+    readonly ColorWaves: "ColorWaves";
+    readonly SwirlOut: "SwirlOut";
+    readonly SwirlIn: "SwirlIn";
+    readonly LookingEyes: "LookingEyes";
+    readonly Matrix: "Matrix";
+    readonly Pacifica: "Pacifica";
+    readonly Plasma: "Plasma";
+    readonly PlasmaCloud: "PlasmaCloud";
+    readonly MovingLine: "MovingLine";
+    readonly Fade: "Fade";
+};
+type Effect = typeof Effect[keyof typeof Effect];
+export { PushIcon, Effect };

package/dist/interaction.js

@@ -0,0 +1,27 @@
+const PushIcon = {
+    Static: 0,
+    MoveOnce: 1,
+    MoveRepeat: 2
+};
+const Effect = {
+    BrickBreaker: "BrickBreaker",
+    Checkerboard: "Checkerboard",
+    Fireworks: "Fireworks",
+    PingPong: "PingPong",
+    Radar: "Radar",
+    Ripple: "Ripple",
+    Snake: "Snake",
+    TwinklingStars: "TwinklingStars",
+    TheaterChase: "TheaterChase",
+    ColorWaves: "ColorWaves",
+    SwirlOut: "SwirlOut",
+    SwirlIn: "SwirlIn",
+    LookingEyes: "LookingEyes",
+    Matrix: "Matrix",
+    Pacifica: "Pacifica",
+    Plasma: "Plasma",
+    PlasmaCloud: "PlasmaCloud",
+    MovingLine: "MovingLine",
+    Fade: "Fade"
+};
+export { PushIcon, Effect };

package/dist/moodlight.d.ts

@@ -0,0 +1,8 @@
+export interface MoodlightKelvin {
+    brightness: number;
+    kelvin: number;
+}
+export interface MoodlightColor {
+    brightness: number;
+    color: string;
+}

package/dist/moodlight.js

@@ -0,0 +1 @@
+export {};

package/dist/settings.d.ts

@@ -0,0 +1,77 @@
+import * as transitions from './transitions.js';
+export interface SettingsPayload {
+    ATIME?: number;
+    TEFF?: typeof transitions.Transition;
+    TSPEED?: number;
+    TCOL?: string | number[];
+    TMODE?: number;
+    CHCOL?: string | number[];
+    CBCOL?: string | number[];
+    CTCOL?: string | number[];
+    WD?: boolean;
+    WDCA?: string | number[];
+    WDCI?: string | number[];
+    BRI?: number;
+    ABRI?: boolean;
+    ATRANS?: boolean;
+    CCORRECTION?: number[];
+    CTEMP?: number[];
+    TFORMAT?: string;
+    DFORMAT?: string;
+    SOM?: boolean;
+    CEL?: boolean;
+    BLOCKN?: boolean;
+    UPPERCASE?: boolean;
+    TIME_COL?: string | number[];
+    DATE_COL?: string | number[];
+    TEMP_COL?: string | number[];
+    HUM_COL?: string | number[];
+    BAT_COL?: string | number[];
+    SSPEED?: number;
+    TIM?: boolean;
+    DAT?: boolean;
+    HUM?: boolean;
+    TEMP?: boolean;
+    BAT?: boolean;
+    MATP?: boolean;
+    VOL?: number;
+    OVERLAY?: string;
+}
+export interface Settings {
+    appTime?: number;
+    transitionEffect?: typeof transitions.Transition;
+    transitionSpeed?: number;
+    globalTextColor?: string | number[];
+    timeAppStyle?: number;
+    calendarHeaderColor?: string | number[];
+    calendarBodyColor?: string | number[];
+    calendarTextColor?: string | number[];
+    weekdayDisplay?: boolean;
+    activeWeekdayColor?: string | number[];
+    inactiveWeekdayColor?: string | number[];
+    matrixBrightness?: number;
+    automaticBrightnessControl?: boolean;
+    automaticAppSwitching?: boolean;
+    colorCorrection?: number[];
+    colorTemperature?: number[];
+    timeFormat?: string;
+    dateFormat?: string;
+    startWeekOnMonday?: boolean;
+    celsiusTemperature?: boolean;
+    blockNavigationKeys?: boolean;
+    uppercaseText?: boolean;
+    timeAppTextColor?: string | number[];
+    dateAppTextColor?: string | number[];
+    temperatureAppTextColor?: string | number[];
+    humidityAppTextColor?: string | number[];
+    batteryAppTextColor?: string | number[];
+    scrollSpeedModification?: number;
+    enableTimeApp?: boolean;
+    enableDateApp?: boolean;
+    enableHumidityApp?: boolean;
+    enableTemperatureApp?: boolean;
+    enableBatteryApp?: boolean;
+    matrixPower?: boolean;
+    volume?: number;
+    globalEffectOverlay?: string;
+}

package/dist/settings.js

@@ -0,0 +1 @@
+export {};

package/{stats.d.ts → dist/stats.d.ts}

@@ -1,4 +1,4 @@
-interface Stats {
+export interface Stats {
     bat: number;
     bat_raw: number;
     type: number;

package/dist/stats.js

@@ -0,0 +1 @@
+export {};

package/dist/transitions.d.ts

@@ -0,0 +1,15 @@
+declare const Transition: {
+    readonly Random: 0;
+    readonly Slide: 1;
+    readonly Dim: 2;
+    readonly Zoom: 3;
+    readonly Rotate: 4;
+    readonly Pixelate: 5;
+    readonly Curtain: 6;
+    readonly Ripple: 7;
+    readonly Blink: 8;
+    readonly Reload: 9;
+    readonly Fade: 10;
+};
+export type Transitions = keyof typeof Transition;
+export { Transition };

package/dist/transitions.js

@@ -0,0 +1,14 @@
+const Transition = {
+    Random: 0,
+    Slide: 1,
+    Dim: 2,
+    Zoom: 3,
+    Rotate: 4,
+    Pixelate: 5,
+    Curtain: 6,
+    Ripple: 7,
+    Blink: 8,
+    Reload: 9,
+    Fade: 10
+};
+export { Transition };

package/package.json

@@ -1,18 +1,32 @@
 {
   "name": "awtrix-ts",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "TypeScript API for Awtrix LED Matrix Display",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gledrich/awtrix-ts.git"
   },
-  "main": "api.ts",
   "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
   "devDependencies": {
     "eslint": "^9.39.2",
-    "eslint-config": "github:7digital/eslint-config"
-  },
-  "dependencies": {
-    "@types/node": "^25.0.3"
+    "eslint-config": "github:7digital/eslint-config",
+    "@types/node": "^25.0.3",
+    "typescript": "^5.9.3"
   }
 }

package/indicators.ts

@@ -1,15 +0,0 @@
-export interface IndicatorPayload {
-  position: Indicators;
-  color: string | number[];
-  blink?: number; // interval in ms
-  fade?: number; // duration in ms
-}
-
-const Indicator = {
-  UpperRight: 1,
-  CenterRight: 2,
-  BottomRight: 3
-} as const;
-
-export type Indicators = typeof Indicator[keyof typeof Indicator];
-export { Indicator };

package/interaction.ts

@@ -1,75 +0,0 @@
-export interface Interaction {
-    text?: string; // The text to display
-    textCase?: number; // Changes the Uppercase setting. 0=global setting, 1 = forces uppercase; 2 = shows as sent.
-    topText?: boolean; // Draw the text on top.
-    textOffset?: number; // Sets an offset for the x position of a starting text.
-    center?: boolean; // Centers a short, non-scrollable text.
-    color?: string | number[]; // The text, bar or line color.
-    gradient?: (string | number)[]; // Colorizes the text in a gradient of two given colors.
-    blinkText?: number; // Blinks the text in an given interval in ms, not compatible with gradient or rainbow.
-    fadeText?: number; // Fades the text on and off in an given interval, not compatible with gradient or rainbow.
-    background?: string | number[]; // Sets a background color.
-    rainbow?: boolean; // Fades each letter in the text differently through the entire RGB spectrum.
-    icon?: string; // The icon ID or filename (without extension) to display on the app. You can also send a 8x8 jpg as Base64 string.
-    pushIcon?: PushIcon; // 0 = Icon doesn't move. 1 = Icon moves with text and will not appear again. 2 = Icon moves with text but appears again when the text starts to scroll again.
-    repeat?: number; // Sets how many times the text should be scrolled through the matrix before the app ends.
-    duration?: number; // Sets how long the app or notification should be displayed.
-    hold?: boolean; // Set it to true, to hold your notification on top until you press the middle button or dismiss it via HomeAssistant. This key only belongs to notification.
-    sound?: string; // The filename of your RTTTL ringtone file placed in the MELODIES folder (without extension). Or the 4 digit number of your MP3 if you're using a DFplayer.
-    rtttl?: string; // Allows to send the RTTTL sound string with JSON.
-    loopSound?: boolean; // Loops the sound or RTTTL as long as the notification is running.
-    bar?: number[]; // Draws a bargraph. Without icon maximum 16 values, with icon 11 values.
-    line?: number[]; // Draws a linechart. Without icon maximum 16 values, with icon 11 values.
-    autoscale?: boolean; // Enables or disables autoscaling for bar and linechart.
-    barBC?: string | number[]; // Backgroundcolor of the bars.
-    progress?: number; // Shows a progress bar. Value can be 0–100.
-    progressC?: string | number[]; // The color of the progress bar.
-    progressBC?: string | number[]; // The color of the progress bar background.
-    pos?: number; // Defines the position of your custom page in the loop, starting at 0 for the first position. This will only apply with your first push. This function is experimental.
-    draw?: object[]; // Array of drawing instructions. Each object represents a drawing command. See the drawing instructions below.
-    lifetime?: number; // Removes the custom app when there is no update after the given time in seconds.
-    lifetimeMode?: number; // 0 = deletes the app, 1 = marks it as staled with a red rectangle around the app.
-    stack?: boolean; // Defines if the notification will be stacked. false will immediately replace the current notification.
-    wakeup?: boolean; // If the Matrix is off, the notification will wake it up for the time of the notification.
-    noScroll?: boolean; // Disables the text scrolling.
-    clients?: string[]; // Allows forwarding a notification to other AWTRIX devices. Use the MQTT prefix for MQTT and IP addresses for HTTP.
-    scrollSpeed?: number; // Modifies the scroll speed. Enter a percentage value of the original scroll speed.
-    effect?: Effect; // Shows an effect as background. The effect can be removed by sending an empty string for effect.
-    effectSettings?: Record<string, unknown>; // Changes color and speed of the effect.
-    save?: boolean; // Saves your custom app into flash and reloads it after boot. Avoid this for custom apps with high update frequencies because the ESP's flash memory has limited write cycles.
-    overlay?: string; // Sets an effect overlay (cannot be used with global overlays).
-}
-
-const PushIcon = {
-    Static: 0,
-    MoveOnce: 1,
-    MoveRepeat: 2
-} as const;
-
-type PushIcon = typeof PushIcon[keyof typeof PushIcon];
-
-const Effect = {
-    BrickBreaker: "BrickBreaker",
-    Checkerboard: "Checkerboard",
-    Fireworks: "Fireworks",
-    PingPong: "PingPong",
-    Radar: "Radar",
-    Ripple: "Ripple",
-    Snake: "Snake",
-    TwinklingStars: "TwinklingStars",
-    TheaterChase: "TheaterChase",
-    ColorWaves: "ColorWaves",
-    SwirlOut: "SwirlOut",
-    SwirlIn: "SwirlIn",
-    LookingEyes: "LookingEyes",
-    Matrix: "Matrix",
-    Pacifica: "Pacifica",
-    Plasma: "Plasma",
-    PlasmaCloud: "PlasmaCloud",
-    MovingLine: "MovingLine",
-    Fade: "Fade"
-} as const;
-
-type Effect = typeof Effect[keyof typeof Effect];
-
-export { PushIcon, Effect };

package/moodlight.d.ts

@@ -1,9 +0,0 @@
-interface MoodlightKelvin {
-  brightness: number;
-  kelvin: number;
-}
-
-interface MoodlightColor {
-  brightness: number;
-  color: string;
-}

package/settings.ts

@@ -1,79 +0,0 @@
-import * as transitions from './transitions.ts';
-
-export interface SettingsPayload {
-  ATIME?: number; // Duration an app is displayed in seconds.
-  TEFF?: number; // Choose between app transition effects.
-  TSPEED?: number; // Time taken for the transition to the next app in milliseconds.
-  TCOL?: string | number[]; // Global text color.
-  TMODE?: number; // Changes the time app style.
-  CHCOL?: string | number[]; // Calendar header color of the time app.
-  CBCOL?: string | number[]; // Calendar body color of the time app.
-  CTCOL?: string | number[]; // Calendar text color in the time app.
-  WD?: boolean; // Enable or disable the weekday display.
-  WDCA?: string | number[]; // Active weekday color.
-  WDCI?: string | number[]; // Inactive weekday color.
-  BRI?: number; // Matrix brightness.
-  ABRI?: boolean; // Automatic brightness control.
-  ATRANS?: boolean; // Automatic switching to the next app.
-  CCORRECTION?: number[]; // Color correction for the matrix.
-  CTEMP?: number[]; // Color temperature for the matrix.
-  TFORMAT?: string; // Time format for the TimeApp.
-  DFORMAT?: string; // Date format for the DateApp.
-  SOM?: boolean; // Start the week on Monday.
-  CEL?: boolean; // Shows the temperature in Celsius (Fahrenheit when false).
-  BLOCKN?: boolean; // Block physical navigation keys (still sends input to MQTT).
-  UPPERCASE?: boolean; // Display text in uppercase.
-  TIME_COL?: string | number[]; // Text color of the time app. Use 0 for global text color.
-  DATE_COL?: string | number[]; // Text color of the date app. Use 0 for global text color.
-  TEMP_COL?: string | number[]; // Text color of the temperature app. Use 0 for global text color.
-  HUM_COL?: string | number[]; // Text color of the humidity app. Use 0 for global text color.
-  BAT_COL?: string | number[]; // Text color of the battery app. Use 0 for global text color.
-  SSPEED?: number; // Scroll speed modification.
-  TIM?: boolean; // Enable or disable the native time app (requires reboot).
-  DAT?: boolean; // Enable or disable the native date app (requires reboot).
-  HUM?: boolean; // Enable or disable the native humidity app (requires reboot).
-  TEMP?: boolean; // Enable or disable the native temperature app (requires reboot).
-  BAT?: boolean; // Enable or disable the native battery app (requires reboot).
-  MATP?: boolean; // Enable or disable the matrix. Similar to power endpoint but without the animation.
-  VOL?: number; // Allows to set the volume of the buzzer and DFplayer.
-  OVERLAY?: string; // Sets a global effect overlay (cannot be used with app specific overlays).
-}
-
-export interface Settings {
-  appTime?: number;
-  transitionEffect?: transitions.Transitions;
-  transitionSpeed?: number;
-  globalTextColor?: string | number[];
-  timeAppStyle?: number;
-  calendarHeaderColor?: string | number[];
-  calendarBodyColor?: string | number[];
-  calendarTextColor?: string | number[];
-  weekdayDisplay?: boolean;
-  activeWeekdayColor?: string | number[];
-  inactiveWeekdayColor?: string | number[];
-  matrixBrightness?: number;
-  automaticBrightnessControl?: boolean;
-  automaticAppSwitching?: boolean;
-  colorCorrection?: number[];
-  colorTemperature?: number[];
-  timeFormat?: string;
-  dateFormat?: string;
-  startWeekOnMonday?: boolean;
-  celsiusTemperature?: boolean;
-  blockNavigationKeys?: boolean;
-  uppercaseText?: boolean;
-  timeAppTextColor?: string | number[];
-  dateAppTextColor?: string | number[];
-  temperatureAppTextColor?: string | number[];
-  humidityAppTextColor?: string | number[];
-  batteryAppTextColor?: string | number[];
-  scrollSpeedModification?: number;
-  enableTimeApp?: boolean;
-  enableDateApp?: boolean;
-  enableHumidityApp?: boolean;
-  enableTemperatureApp?: boolean;
-  enableBatteryApp?: boolean;
-  matrixPower?: boolean;
-  volume?: number;
-  globalEffectOverlay?: string;
-}

package/test.js

@@ -1,8 +0,0 @@
-import { setTimeout } from 'node:timers/promises';
-import { Awtrix } from './api.ts';
-
-const clockUrl = 'http://192.168.1.109';
-
-const clock = new Awtrix(new URL(clockUrl));
-
-await clock.resetDefaultSettings();

package/transitions.ts

@@ -1,17 +0,0 @@
-const Transition = {
-  Random: 0,
-  Slide: 1,
-  Dim: 2,
-  Zoom: 3,
-  Rotate: 4,
-  Pixelate: 5,
-  Curtain: 6,
-  Ripple: 7,
-  Blink: 8,
-  Reload: 9,
-  Fade: 10
-} as const;
-
-export type Transitions = keyof typeof Transition;
-
-export { Transition };