|
|
||
|---|---|---|
| .forgejo/workflows | ||
| .vscode | ||
| gicisky_app | ||
| gicisky_lib | ||
| README.md | ||
Gicisky Flutter Project
A comprehensive Flutter project for interacting with Gicisky BLE Electronic Labels (e-paper and TFT displays).
Gicisky is a manufacturer of cheap Electronic Shelf Labels (ESLs) which communicate with Bluetooth Low Energy. They sell under various brands, including Picksmart. Their official app is known to be cumbersome to use, hard to obtain, and it requires an online account, even though the device can work completely offline.
With this alternative implementation, you can send arbitrary images to Gicisky ESLs from an easy-to-use app, no internet connection required.
This turns Gicisky ESLs into very cost-effective e-paper screens, that can be controlled from any Bluetooth Low Energy device, and can be used, for example, as an alternative to the Badger 2040.
🛍 If you don't own a Gicisky ESL yet and plan to get one, please check my affiliate link. I will get a small commission from the sale, but it won't cost you anything. Thanks for your help!
📋 Project Structure
This project consists of two main components: a full-featured application and a reusable Dart library.
📲 gicisky_app/
A fully featured, cross-platform Flutter application to interact with Gicisky devices. It provides a complete user interface for scanning, connecting to, and uploading images to Gicisky devices.
For installation instructions, usage guide, and development details, see the gicisky_app README.md.
📦 gicisky_lib/
A backend-agnostic Flutter library that provides all the functionality needed to interact with Gicisky BLE devices. This library can be used in any Flutter project to add Gicisky device support.
For detailed documentation, API reference, and usage examples, see the gicisky_lib README.md.
🚀 Quick Start
Using the Library
To use the gicisky_lib in your own Flutter project:
-
Add the dependency to your
pubspec.yaml:dependencies: gicisky_lib: ^0.1.0 -
Run
flutter pub get -
Follow the gicisky_lib README.md for detailed usage instructions
Running the Application
For other download options and platforms, check the releases page!
For self-building instructions and more details, see the gicisky_app README.md.
📝 Legal
The application and library are distributed under different licenses. Check out the LICENSE files in the relative folders to learn more.
Gicisky is a trademark of Wuhan Hi-Link Electronic Co.,Ltd. This project is a third-party implementation of their protocol, released as-is, without any kind of warranty to the fullest extent of applicable law. Neither the developers of this project nor Wuhan Hi-Link Electronic Co.,Ltd. are to be held responsible for damages caused by this software.
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request or open an Issue. If you want to contribute financially, please check out the Donate page. Thanks!
❤️ Thanks to
- For much of the original work on the protocol: atc1441/ATC_GICISKY_ESL
- For most of the advertisement parsing logic: eigger/hass-gicisky
📧 Support
For issues, questions, or contributions, please visit the project repository.