Pixel Display Client

control all your 16x16 or 32x32 pixel displays

Explore the docs »

Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

This repository aims to reverse engineer the iDotMatrix Android App for pixel screen displays like this one on Aliexpress. The goal is to be able to control multiple pixel screen displays via a GUI, an Rest API and the command line.

The initial reason for this project was to have a foundation to update one or multiple pixel displays during live streams on Twitch or other platforms where one can use this to further automate interactions with the audience. Please let us know if you're using this to do so :)

Built With

Love for Open Source :D and Python 3.

Getting Started

To get a local copy up and running follow these simple example steps:

Prerequisites

Please install the following for your distribution (Windows may work but it is untested):

• latest Python3
• Python3 Virtual Env

Installation

1. Clone the repo

git clone https://github.com/derkalle4/python3-idotmatrix-client.git

2. Create virtual environment and install all dependencies

./create_venv.sh

Usage

If you used the ./create_venv.sh you should use this command to run the app:

./run_in_venv.sh <YOUR_COMMAND_LINE_ARGUMENTS>

If you do not use a virtual environment the command will look like this:

python3 .\app.py <YOUR_COMMAND_LINE_ARGUMENTS>

command line arguments

--address (required)

Specifies the address of the pixel display device.

Example:

./run_in_venv.sh --address 00:11:22:33:44:ff

Roadmap

If you want to contribute please focus on the reverse-engineering part because my personal skills are not that good. Many thanks for all contributions!

• Reverse Engineering
  • Chronograph
  • Clock
  • Countdown
  • Graffiti Board
  • DIY-Mode
  • Animated Images
  • Cloud-API to download images
  • Cloud-API to upload images to device
  • Cloud-Firmware Update possible?
  • Eco-Mode
  • Fullscreen Color
  • MusicSync
  • Scoreboard
  • bluetooth pasword protection
• build configuration file to manage (multiple) devices
• Build command line interface with all features to interact with the device
• Build RestAPI to interact with the device remotely
• Build GUI to allow non-technical people to use this software
• build search tool to find displays nearby
• make this software compatible with Windows and Linux
• provide executables for Windows

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU GENERAL PUBLIC License. See LICENSE for more information.

Authors

• Kalle Minkner - Project Founder
• Jon-Mailes Graeffe - Co-Founder

Acknowledgements

• Othneil Drew - README Template
• LordRippon - Reverse Engineering for the Displays