https://github.com/leso-kn/epaper-central
A lightweight image sender library for ZigBee USB sticks running the cc2531-OEPL OpenEPaperLink station firmware.
https://github.com/leso-kn/epaper-central
cc2531 epaper openepaperlink zigbee
Last synced: about 2 months ago
JSON representation
A lightweight image sender library for ZigBee USB sticks running the cc2531-OEPL OpenEPaperLink station firmware.
- Host: GitHub
- URL: https://github.com/leso-kn/epaper-central
- Owner: leso-kn
- License: mit
- Created: 2023-10-20T23:43:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-05T17:07:26.000Z (over 1 year ago)
- Last Synced: 2024-12-09T00:14:40.295Z (6 months ago)
- Topics: cc2531, epaper, openepaperlink, zigbee
- Language: C
- Homepage: https://epaper-central.readthedocs.io
- Size: 87.9 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# `libepaper-central`
_A lightweight image sender library for ZigBee USB sticks running the cc2531-OEPL OpenEPaperLink station firmware._
## About
This C library acts as a serial-driver for CC2531-based ZigBee USB sticks. It can be used to transmit bi-color images to hacked supermarket price-tags via the [OpenEPaperLink](https://openepaperlink.de/) protocol (tested with OpenEPaperLink v1.9.0).
The data-source are generic rgb pixel-arrays, which could be fully generated in memory with no need for intermediate files.
## API
To integrate libepaper-central in your project, head over to the [docs](https://epaper-central.readthedocs.io/).
## Usage (command-line)
The library comes with a standalone reference-program "epaperd" which picks up [PPM images (P6)](https://en.wikipedia.org/wiki/Netpbm#Description) from a folder and sends them to nearby OpenEPaperLink displays.
The program will check for files named after tag mac addresses (e.g. 00112233aabbccdd.ppm for a tag with mac address `00:11:22:33:aa:bb:cc:dd`) and falls back to `default.ppm` if no specific image exists for a tag – in this case the mac address will be visible on the display in addition until an applicable .ppm-file becomes available in the cache folder.
```bash
> epaperd [/cache/directory]
```
## Compatible Hardware
The library is compatible with CC2531-based ZigBee USB sticks running the cc2531-OEPL station firmware.
The firmware can be obtained from [Jonas Niesners OpenEPaperLink repository](https://github.com/jonasniesner/OpenEPaperLink/blob/4aaffbacd4ebee760c0c4088e069e5ba60e4a219/ARM_Tag_FW/cc2531_OEPL/cc2531_OEPL_beta.hex) – for flashing there's several options available:
1. Using a proprietary [CC Debugger](https://www.ti.com/tool/CC-DEBUGGER) adapter
2. Using a Raspberry Pi (or other single-board computer) via [cc2531-flasher-pi](https://github.com/leso-kn/cc2531-flasher-pi)
3. Using an esp32 (see [https://youtu.be/98fOzZs__fc](https://youtu.be/98fOzZs__fc?t=170))
## License
libepaper-central is licensed under the MIT License.
## Changelog
### v0.2.0
* Pixmap format optimizations (Improved refresh speed)
* epaperd: Added command line option "`-D`" to specify ZigBee radio device
* epaperd: Display error message if serial device cannot be opened
* Fix: Fixed minor offset between black and red pixels
### v0.1.1
* Fix: Added fallback install dirs in CMake configuration ([#1](https://github.com/leso-kn/epaper-central/issues/1))
* Docs: Added build instructions page
### v0.1.0
* Initial version of the library
* Transmit images from generic rgb pixel-arrays
* Simple "epaperd" reference-program to load .ppm-images from a folder and transmit them to price-tags
---
Created by [Lesosoftware](https://github.com/leso-kn) in 2023