2.8 KiB
		
	
	
	
	
	
	
	
			
		
		
	
	
			2.8 KiB
		
	
	
	
	
	
	
	
🏷 Gicisky Python Library
A Python library for interacting with Gicisky electronic ink display tags via Bluetooth Low Energy (BLE).
ℹ️ Features
- Advertisement parsing: Discover compatible devices and get their info (battery level, model, hardware and software version)
 - Image uploading: Upload images to your ESL, with all the features it supports (including third color and compression!)
 - Bluetooth library independent: Use the provided Bleak backend or implement the BLE Interface to use any other Bluetooth library.
 - Image conversion: Provide any image and let the library convert it for you to the device's format.
 
📱 Supported Devices
- EPD 2.1" BWR (0x0B)
 - EPD 2.9" BWR (0x33)
 - EPD 4.2" BWR (0x4B)
 - EPD 7.5" BWR (0x2B)
 - TFT 2.1" BW (0xA0)
 
⬇️ Installation
pip install gicisky
Or install from source:
git clone https://git.massive.box/massivebox/gicisky
cd gicisky
pip install -r requirements.txt
▶️ Quick Start
Check out the examples!
python3 examples/send_bleak.py ~/path/to/image.png
python3 examples/send_bleak.py --no-optimize ~/path/to/image.png # Without dithering
⚙️ Components
- BLE Interface (ble/): Handles Bluetooth Low Energy communication
 - Core Protocol (core/): Implements the Gicisky communication protocol, independent of the Bluetooth library
 - Image Processing (image/): 
conversionformats images to the Gicisky format,optimizer(optional) uses dithering and letterboxing for better results - Logging (logger/): Provides detailed logging capabilities
 
🧱 Requirements
- Python 3.7+
 - bleak (for BLE communication)
 - PIL/Pillow (for image processing)
 - numpy (for image manipulation)
 
Install all requirements:
pip install -r requirements.txt
❤️ Credits
- For much of the original work on the protocol: atc1441/ATC_GICISKY_ESL
 - For most of the advertisement parsing logic: eigger/hass-gicisky
 
🤝 Support the Project
Thanks for your interest in supporting the project.
- Help me by opening issues and creating pull requests: all contributions are welcome!
 - If you want to contribute financially, take a look here. Thanks a lot!
 - If you haven't bought your Gigisky ESL yet, please buy it through my AliExpress affiliate link. I will earn a small commission from your order, but it will not cost you anything. Thanks!
 
📚 License
MIT License