https://github.com/cristian-5/lcdope

LCD Pixel Display Widget for macOS
https://github.com/cristian-5/lcdope

lcd macos widget

Last synced: 14 days ago
JSON representation

LCD Pixel Display Widget for macOS

• Host: GitHub
• URL: https://github.com/cristian-5/lcdope
• Owner: cristian-5
• Created: 2024-12-15T15:49:38.000Z (21 days ago)
• Default Branch: main
• Last Pushed: 2024-12-15T16:12:55.000Z (21 days ago)
• Last Synced: 2024-12-15T16:39:21.321Z (21 days ago)
• Topics: lcd, macos, widget
• Language: Swift
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# LCDope

LCD Display Widget for macOS that runs **your** JavaScript code.

![screen-1](screen-1.png)

![screen-2](screen-2.png)

## API Usage

To interact with the widget, you can use the following javascript API.

```typescript

/// width of the screen in pixels

const WIDTH: number;

/// height of the screen in pixels

const HEIGHT: number;

/// date for the requested frame (might be a future date for prefetching)

const DATE: Date;

/// sets the pixel at (x, y) to the given rgb hex color

function pixel(x: number, y: number, color: number | string): void;

/// sets the grid color (a.k.a. the backlight color)

function backlight(color: number | string): void;

/// fills the screen with the given rgb hex color

function fill(color: number | string): void;

```

- Colors are usually hex numbers like `0xFF0000` or strings like `"#FF0000"`.

- You may use the `fetch` api along with top-level `await`, to get data from the internet.

- Some js features like timers and intervals are not available due to macOS widget restrictions.

- You may store persisting user data using `localStorage`.