diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index faf47d5..cf6d36e 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,11 @@ python3 examples/send_bleak.py --no-optimize ~/path/to/image.png # Without dithe ## ⚙️ Components -1. **BLE Interface** ([ble/](file:///home/massive/Dev/gicisky/ble/)): Handles Bluetooth Low Energy communication -2. **Core Protocol** ([core/](file:///home/massive/Dev/gicisky/core/)): Implements the Gicisky communication protocol, independent of the Bluetooth library -3. **Image Processing** ([image/](file:///home/massive/Dev/gicisky/image/)): `conversion` formats images to the Gicisky format, `optimizer` (optional) uses +1. **BLE Interface** ([ble/](ble)): Handles Bluetooth Low Energy communication +2. **Core Protocol** ([core/](core)): Implements the Gicisky communication protocol, independent of the Bluetooth library +3. **Image Processing** ([image/](image)): `conversion` formats images to the Gicisky format, `optimizer` (optional) uses dithering and letterboxing for better results -4. **Logging** ([logger/](file:///home/massive/Dev/gicisky/logger/)): Provides detailed logging capabilities +4. **Logging** ([logger/](logger)): Provides detailed logging capabilities ## 🧱 Requirements diff --git a/__init__.py b/__init__.py index 8f9d0eb..71a6837 100644 --- a/__init__.py +++ b/__init__.py @@ -3,5 +3,18 @@ Gicisky - A Python library for interacting with Gicisky electronic ink display t """ __version__ = "0.1.0" -__author__ = "Your Name" -__email__ = "your.email@example.com" \ No newline at end of file +__author__ = "MassiveBox" +__email__ = "box@massive.box" + +# Import all public APIs +from ble import * +from core import * +from image import * +from logger import * + +# Define what gets imported with "from gicisky import *" +__all__ = [] +__all__.extend(ble.__all__) +__all__.extend(core.__all__) +__all__.extend(image.__all__) +__all__.extend(logger.__all__) \ No newline at end of file diff --git a/ble/__init__.py b/ble/__init__.py index e69de29..b7002c5 100644 --- a/ble/__init__.py +++ b/ble/__init__.py @@ -0,0 +1,8 @@ +from .bleak import BleakBackend +from .interface import BLEInterface, Advertisement + +__all__ = [ + "BleakBackend", + "BLEInterface", + "Advertisement" +] \ No newline at end of file diff --git a/core/__init__.py b/core/__init__.py index e69de29..8293114 100644 --- a/core/__init__.py +++ b/core/__init__.py @@ -0,0 +1,11 @@ +from .advertisement import parse_advertisement, DeviceData +from .protocol import GiciskyProtocol, SERVICE_UUID, CHAR_CMD_UUID, CHAR_IMG_UUID + +__all__ = [ + "parse_advertisement", + "DeviceData", + "GiciskyProtocol", + "SERVICE_UUID", + "CHAR_CMD_UUID", + "CHAR_IMG_UUID" +] \ No newline at end of file diff --git a/image/__init__.py b/image/__init__.py index 9bbd5ac..54149ea 100644 --- a/image/__init__.py +++ b/image/__init__.py @@ -1,3 +1,10 @@ from .optimizer import optimize +from .conversion import convert_to_gicisky_bytes, DEVICE_SPECS, DeviceSpec, ModelId -__all__ = ["optimize"] \ No newline at end of file +__all__ = [ + "optimize", + "convert_to_gicisky_bytes", + "DEVICE_SPECS", + "DeviceSpec", + "ModelId" +] \ No newline at end of file diff --git a/logger/__init__.py b/logger/__init__.py index e69de29..d33fb4e 100644 --- a/logger/__init__.py +++ b/logger/__init__.py @@ -0,0 +1,6 @@ +from .logger import GiciskyLogger, LogCategory + +__all__ = [ + "GiciskyLogger", + "LogCategory" +] \ No newline at end of file