Skip to content

CuminAndPotato/pxl-clock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PXL Clock

Welcome to the PXL Clock repository! This repo serves as a central hub for:

  • Resources for creating custom PXL Clock applications
  • Issue tracking and idea proposals (hardware, software, use cases, features)

We’re excited to see what the community will build around the PXL Clock. Below you’ll find everything you need to get started.

image


Quick-Start Development of PXL Clock Apps

Getting Started:

  1. Run ./start.sh in the terminal (or use VSCode task: PXL :: Start C# (Simulator + C# Watcher))
  2. Open the simulator at http://localhost:5001
  3. Edit apps/Program.cs and save to see changes

Examples: Check out the example apps in apps/Apps/ directory


Order Your PXL Clock!

Exciting news: ordering the PXL Clock will soon be possible! 🎉 You can find more information and updates on our official website: pxlclock.com

We’re currently working on the first 100 units, the MK1 edition! We’re in the certification and refining all the little details that make this a fine product. We’re fully committed to delivering something amazing, and we’ll keep you updated every step of the way.

Stay in the loop by following the #pxlclock hashtag on our channels for the latest news and progress updates.

Thank you for your patience and support! 💡


Get In Touch

Discord

Get in touch with us and others on our Discord Server

Join the PXL Clock Community on Discord

Join Our Discord

Bluesky

Follow the #pxlclock hashtag on Bluesky for getting news and see what others do!


Table of Contents

  1. Order Your PXL Clock
  2. Get In Touch
  3. About PXL Clock
  4. Releases
  5. Filing Issues and Ideas
  6. Developing Your Own Apps
  7. Contributing
  8. License

About PXL Clock

The PXL Clock is a device designed to display various fun clocks, animations, short stories, visuals and other creative things - all on a 24x24 pixel display. Whether you want to keep track of the current time in a futuristic manner or develop your own mini-apps to run on the clock, this project provides a flexible platform for creativity.


Releases

You’ll find our official firmware and software packages under the Releases section. The PXL Clock updates itself over-the-air, so no manual steps required.


Filing Issues and Ideas

Have an idea for a new feature or discovered a bug? Help us improve the PXL Clock by creating a new issue in this repository. We welcome:

  • Hardware-related feedback or design modifications
  • Software feature requests, improvements, or bug reports
  • Use case suggestions or creative ways to integrate PXL Clock into your projects

Just head over to the Issues tab and click New Issue to get started.


Developing Your Own Apps

NuGet NuGet Downloads

Prerequisites

Getting Started

  1. Start the simulator:

    ./start.sh

    Or use VSCode task: Ctrl+Shift+BPXL :: Start C# (Simulator + C# Watcher)

  2. Open simulator: Navigate to http://localhost:5001 in your browser

  3. Edit and code: Modify apps/Program.cs and save to see changes automatically

  4. Examples: Check out apps/Apps/ for example applications

Use Your PXL Clock for Development

  1. In the PXL-App, go to the "Settings" tab of your connected PXL Clock, and "Turn Off Display".

  2. In Program.cs, set the target device to your connected PXL Clock.

  3. Start as usual (see above).

Quick API Example

Look at the example apps located in the apps/Apps/ directory.


Contributing

Contributions from the community are highly encouraged. If you want to help make PXL Clock better, you can:

  1. Create an Issue: File a new issue for suggestions, bug reports, or feature requests.
  2. Submit a Pull Request: Fork this repo, make your changes, and submit a pull request. Make sure to include a clear description of what you’ve changed or fixed.

Before contributing, please review our Code of Conduct (if available) to ensure a positive experience for everyone.


see: LICENSE.md


Thank you for your interest in the PXL Clock! We look forward to seeing your ideas and contributions. If you have any questions or suggestions, feel free to open an issue or start a discussion. Let’s make time more fun—together!

About

The official PXL-Clock Repo

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •