awtrix-ts 1.1.0 → 1.1.2

package/README.md

@@ -1,4 +1,4 @@
-# awtrix-ts
+# awtrix-ts [![npm version](https://badge.fury.io/js/awtrix-ts.svg)](https://badge.fury.io/js/awtrix-ts)
 
 TS wrapper for Awtrix API.
 
@@ -9,7 +9,7 @@ The `Awtrix` class provides a TypeScript interface for interacting with the Awtr
 ### Usage
 
 ```typescript
-import { Awtrix } from './api.ts';
+import { Awtrix } from 'awtrix-ts';
 
 const awtrix = new Awtrix(new URL('http://your-awtrix-device-ip'));
 
@@ -24,8 +24,8 @@ await awtrix.notify({ text: 'Hello World!' }); // Send a notification
 Turn the device on or off.
 
 ```typescript
-await clock.power(true); // Turn on
-await clock.power(false); // Turn off
+await awtrix.power(true); // Turn on
+await awtrix.power(false); // Turn off
 ```
 
 #### reboot()
@@ -33,7 +33,7 @@ await clock.power(false); // Turn off
 Reboot the device.
 
 ```typescript
-await clock.reboot();
+await awtrix.reboot();
 ```
 
 #### sleep(time: number)
@@ -41,7 +41,7 @@ await clock.reboot();
 Put the device to sleep for a specified time (in seconds).
 
 ```typescript
-await clock.sleep(5); // Sleep for 5 seconds
+await awtrix.sleep(5); // Sleep for 5 seconds
 ```
 
 #### settings(settings: Settings)
@@ -49,7 +49,7 @@ await clock.sleep(5); // Sleep for 5 seconds
 Update device settings.
 
 ```typescript
-await clock.settings({
+await awtrix.settings({
   automaticAppSwitching: false,
   globalTextColor: [0, 255, 0],
   // ...other settings
@@ -61,7 +61,7 @@ await clock.settings({
 Resets the device settings back to default.
 
 ```typescript
-await clock.resetDefaultSettings();
+await awtrix.resetDefaultSettings();
 ```
 
 #### erase()
@@ -69,7 +69,7 @@ await clock.resetDefaultSettings();
 Factory resets the device. Does not modify WiFi settings.
 
 ```typescript
-await clock.erase();
+await awtrix.erase();
 ```
 
 #### screen()
@@ -77,7 +77,7 @@ await clock.erase();
 Get the current screen content.
 
 ```typescript
-const screen = await clock.screen();
+const screen = await awtrix.screen();
 ```
 
 #### stats()
@@ -85,7 +85,7 @@ const screen = await clock.screen();
 Retrieve device statistics.
 
 ```typescript
-console.log(await clock.stats());
+console.log(await awtrix.stats());
 ```
 
 #### effects()
@@ -93,7 +93,7 @@ console.log(await clock.stats());
 List available effects.
 
 ```typescript
-const effects = await clock.effects();
+const effects = await awtrix.effects();
 ```
 
 #### transitions()
@@ -101,7 +101,7 @@ const effects = await clock.effects();
 List available transitions.
 
 ```typescript
-const transitions = await clock.transitions();
+const transitions = await awtrix.transitions();
 ```
 
 #### loop()
@@ -109,7 +109,7 @@ const transitions = await clock.transitions();
 Get the app loop configuration.
 
 ```typescript
-console.log(await clock.loop());
+console.log(await awtrix.loop());
 ```
 
 #### playMelody(rtttl: string)
@@ -117,7 +117,7 @@ console.log(await clock.loop());
 Play a melody using RTTTL format.
 
 ```typescript
-await clock.playMelody('d=4,o=5,b=140:c6,e6,g6');
+await awtrix.playMelody('d=4,o=5,b=140:c6,e6,g6');
 ```
 
 #### playMelodyFile(name: string)
@@ -125,7 +125,7 @@ await clock.playMelody('d=4,o=5,b=140:c6,e6,g6');
 Play a melody file by name.
 
 ```typescript
-await clock.playMelodyFile('melody.mp3');
+await awtrix.playMelodyFile('melody.mp3');
 ```
 
 #### setIndicator(indicator: IndicatorPayload)
@@ -133,9 +133,9 @@ await clock.playMelodyFile('melody.mp3');
 Set an indicator LED.
 
 ```typescript
-await clock.setIndicator({
+await awtrix.setIndicator({
   color: [255, 0, 0],
-  position: clock.Indicators.UpperRight,
+  position: awtrix.Indicators.UpperRight,
   // blink: 500,
   // fade: 1000,
 });
@@ -146,7 +146,7 @@ await clock.setIndicator({
 Clear an indicator LED.
 
 ```typescript
-await clock.clearIndicator(clock.Indicators.UpperRight);
+await awtrix.clearIndicator(awtrix.Indicators.UpperRight);
 ```
 
 #### moodlight(setting: MoodlightColor | MoodlightKelvin)
@@ -154,7 +154,7 @@ await clock.clearIndicator(clock.Indicators.UpperRight);
 Set moodlight color or temperature.
 
 ```typescript
-await clock.moodlight({ r: 255, g: 255, b: 255 });
+await awtrix.moodlight({ r: 255, g: 255, b: 255 });
 ```
 
 #### clearMoodlight()
@@ -162,7 +162,7 @@ await clock.moodlight({ r: 255, g: 255, b: 255 });
 Turn off moodlight.
 
 ```typescript
-await clock.clearMoodlight();
+await awtrix.clearMoodlight();
 ```
 
 #### notify(notification: Interaction)
@@ -170,11 +170,11 @@ await clock.clearMoodlight();
 Send a notification.
 
 ```typescript
-await clock.notify({
+await awtrix.notify({
   text: 'Hello World!',
   icon: '3049',
-  pushIcon: clock.PushIcon.MoveOnce,
-  effect: clock.Effects.PlasmaCloud,
+  pushIcon: awtrix.PushIcon.MoveOnce,
+  effect: awtrix.Effects.PlasmaCloud,
   repeat: 5,
 });
 ```
@@ -184,7 +184,7 @@ await clock.notify({
 Dismiss the current notification.
 
 ```typescript
-await clock.dismissNotification();
+await awtrix.dismissNotification();
 ```
 
 #### app(name: string, app: Interaction)
@@ -192,12 +192,12 @@ await clock.dismissNotification();
 Send a custom app payload.
 
 ```typescript
-await clock.app('demoApp', {
+await awtrix.app('demoApp', {
   text: 'This is a custom app!',
   icon: '1000',
   repeat: 5,
   duration: 3000,
-  effect: clock.Effects.TwinklingStars,
+  effect: awtrix.Effects.TwinklingStars,
   scrollSpeed: 150,
 });
 ```
@@ -207,7 +207,7 @@ await clock.app('demoApp', {
 Launch an app by name.
 
 ```typescript
-await clock.launchApp('demoApp');
+await awtrix.launchApp('demoApp');
 ```
 
 #### nextApp(), previousApp()
@@ -215,9 +215,9 @@ await clock.launchApp('demoApp');
 Switch between apps.
 
 ```typescript
-await clock.nextApp();
+await awtrix.nextApp();
 await setTimeout(2000);
-await clock.previousApp();
+await awtrix.previousApp();
 ```
 
 #### Progress Bar Example
@@ -227,16 +227,16 @@ Display a progress bar using a custom app:
 ```typescript
 for (let i = 0; i <= 100; i++) {
   if (i % 5 === 0) {
-    await clock.app('Progress', {
+    await awtrix.app('Progress', {
       text: `${i}%`,
       progress: i,
       duration: 1,
     });
     if (i === 0) {
-      await clock.launchApp('Progress');
+      await awtrix.launchApp('Progress');
     }
     if (i === 100) {
-      await clock.app('Progress', {
+      await awtrix.app('Progress', {
         text: `Done!`,
         color: [0, 255, 0],
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "awtrix-ts",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "TypeScript API for Awtrix LED Matrix Display",
   "repository": {
     "type": "git",
@@ -20,13 +20,12 @@
     "src/**/*.d.ts"
   ],
   "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
+    "build": "tsc"
   },
   "devDependencies": {
+    "@types/node": "^25.0.3",
     "eslint": "^9.39.2",
     "eslint-config": "github:7digital/eslint-config",
-    "@types/node": "^25.0.3",
     "typescript": "^5.9.3"
   }
 }

package/dist/api.d.ts

@@ -1,83 +0,0 @@
-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/api.js

@@ -1,146 +0,0 @@
-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/demo.d.ts

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

package/dist/demo.js

@@ -1,75 +0,0 @@
-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);
-    }
-}