akp02 1.0.0__tar.gz

akp02-1.0.0/.gitignore

@@ -0,0 +1,25 @@
+# Virtual environment
+.venv/
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Testing / linting / type-checking caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editor / IDE
+.vscode/
+.idea/
+*.swp
+
+# OS artifacts
+.DS_Store

akp02-1.0.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

akp02-1.0.0/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: akp02
+Version: 1.0.0
+Summary: Linux library for the Ajazz AKP02 9.2" 1920x462 USB HID display
+Project-URL: Homepage, https://github.com/deonspengler/akp02
+Project-URL: Issues, https://github.com/deonspengler/akp02/issues
+Project-URL: Changelog, https://github.com/deonspengler/akp02/releases
+Author-email: Deon Spengler <deon@spengler.co.za>
+License-Expression: MPL-2.0
+License-File: LICENSE
+Keywords: ajazz,akp02,display,hid,linux,panel,usb
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: hidapi>=0.14
+Requires-Dist: pillow>=9.1
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-randomly>=3.12; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-randomly>=3.12; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# akp02
+
+[![PyPI](https://img.shields.io/pypi/v/akp02)](https://pypi.org/project/akp02/)
+[![Python](https://img.shields.io/pypi/pyversions/akp02)](https://pypi.org/project/akp02/)
+[![License: MPL-2.0](https://img.shields.io/badge/license-MPL--2.0-blue)](LICENSE)
+
+Linux library for the **Ajazz AKP02** 9.2" (1920x462) USB
+secondary display. The AKP02 officially ships with Windows-only
+software; this project is the result of reverse engineering its USB HID
+protocol so the panel can be driven natively from Linux.
+
+Confirmed on real hardware: full-screen frames, partial (region)
+updates including correct color rendering, brightness, screen on/off,
+clear, firmware version query, boot/display orientation, and sustained
+keepalive operation.
+
+## Install
+
+### Arch Linux
+
+Available in the AUR as
+[`python-akp02`](https://aur.archlinux.org/packages/python-akp02):
+
+```bash
+paru -S python-akp02      # or yay, or makepkg -si
+```
+
+The package installs the udev rule for you. Replug the panel afterwards
+and you're done -- skip the rest of this section.
+
+### Other distributions
+
+```bash
+pip install akp02
+```
+
+Then install the udev rule so the device is usable without root. The
+rule ships inside the package, so there's no need to clone the repo:
+
+```bash
+sudo cp "$(python -c 'from importlib.resources import files; print(files("akp02") / "udev" / "99-akp02.rules")')" /etc/udev/rules.d/
+sudo udevadm control --reload-rules && sudo udevadm trigger
+```
+
+**Replug the device after installing the rule** -- udev only applies it
+on the next connect.
+
+### From a checkout
+
+```bash
+git clone https://github.com/deonspengler/akp02
+cd akp02
+pip install .
+sudo cp udev/99-akp02.rules /etc/udev/rules.d/
+sudo udevadm control --reload-rules && sudo udevadm trigger
+```
+
+### Verify
+
+With the panel connected:
+
+```python
+from akp02 import AKP02
+
+with AKP02() as panel:
+    panel.set_brightness(30)
+```
+
+The backlight should visibly dim. A permissions error here almost always
+means the udev rule isn't active yet -- confirm the file is in
+`/etc/udev/rules.d/` and that you replugged the device.
+
+### Note on `hidapi`
+
+Most Linux users get a prebuilt `hidapi` wheel and need nothing extra.
+If pip falls back to building it from source -- unusual architecture, or
+a Python version newer than the available wheels -- install the headers
+first:
+
+```bash
+sudo apt install libhidapi-dev libudev-dev     # Debian/Ubuntu
+sudo dnf install hidapi-devel systemd-devel    # Fedora
+sudo pacman -S hidapi                          # Arch
+```
+
+## Library
+
+```python
+from akp02 import AKP02
+
+with AKP02() as panel:
+    panel.start_keepalive()            # device sleeps without heartbeats
+    panel.set_brightness(80)
+    panel.set_boot_orientation("vertical")  # live + persists across power cycles
+    panel.show(pil_image)              # full screen, letterboxed if needed
+    panel.show(widget, at=(1600, 16))  # partial update, rest preserved
+```
+
+All public methods are thread-safe: a single lock is held across whole
+multi-report image transfers so the keepalive thread can never
+interleave with or corrupt a frame. Image composition and JPEG encoding
+happen outside the lock, so the keepalive thread isn't blocked by them.
+
+A region update sent immediately after a full-frame draw needs a brief
+settling delay first, or the full frame can silently fail to render at
+all -- this is tracked and applied automatically; callers don't need to
+do anything.
+
+Region placement is also corrected automatically: the device renders a
+region with the wrong color unless its position satisfies a specific,
+confirmed alignment rule (see Protocol notes below). `show()` nudges
+the position by a few pixels when needed and warns when it does, so
+`at=(x, y)` always renders correctly without the caller having to know
+about this.
+
+## Tests
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+105 tests, 100% line and branch coverage, run entirely against a fake
+HID device -- no physical hardware or `hidapi` installation required.
+Covers protocol byte-exactness pinned against real captures, the
+region color-alignment correction with real hardware-confirmed data
+points, and concurrency behavior: dead-thread recovery after a
+disconnect, bounded shutdown against a wedged device, and
+lock-interleaving prevention verified under real contention.
+
+For linting and type checking as well:
+
+```bash
+pip install -e ".[dev]"
+ruff check .
+mypy
+```
+
+## Protocol notes (reverse engineered)
+
+Plain USB HID, no encryption. VID:PID `0300:3017`. Output reports are
+1024 bytes (EP1 OUT), input reports 512 bytes (EP2 IN).
+
+**Commands** are one zero-padded report:
+`"CRT" + 00 00 + <mnemonic> + 00 00 + <params>`
+
+| Mnemonic  | Action                                                |
+| --------- | ----------------------------------------------------- |
+| `HAN`     | screen off                                            |
+| `DIS`     | screen on                                             |
+| `LIG`     | brightness (1 param byte, 0-100)                      |
+| `CONNECT` | heartbeat (device sleeps without periodic heartbeats) |
+| `STP`     | commit / render buffered image data                   |
+| `SET`     | boot/display orientation (see below)                  |
+
+Layout exceptions: `CLE` (clear) uses a 3-byte gap plus a literal `0xFF`
+trailer instead of the usual 2-byte gap; `VER` (firmware version) has a
+leading `0x00` device-context byte before `CRT`, no gap after the
+mnemonic, and returns its answer via a synchronous `GET_REPORT` on the
+IN endpoint. Gap sizes are **not** universal across commands -- verify
+per command when adding new ones.
+
+**Image transfers**: a 32-byte `CRT..DRA` header (big-endian length =
+payload + 0x20, then width/height/x/y as big-endian uint16, all zero
+for a full-panel draw) followed immediately by JPEG bytes, chunked into
+1024-byte reports, then `STP`. The JPEG is 462x1920 **portrait** --
+landscape content rotated 90 degrees **clockwise** (confirmed on
+hardware; rotating the other way renders the panel upside down).
+Non-zero header coordinates draw a partial region (portrait space);
+content outside it is preserved.
+
+**Region color alignment** (confirmed empirically on real hardware): a
+region update renders with the wrong color -- not a placement shift --
+unless the position that actually lands in the header
+(`portrait_x = 462 - y - height`, in landscape terms) satisfies
+`portrait_x % 8 == 2`. Root cause understood, not just observed: 462
+(the axis this applies to) doesn't divide evenly into 8- or 16-pixel
+JPEG blocks the way 1920 (the other axis, which shows no equivalent
+sensitivity) does, so the device's firmware evidently pads its buffer
+on that axis with a fixed internal offset. The library corrects this
+automatically rather than requiring callers to pick special
+coordinates.
+
+**Settling delay**: a region update sent immediately after a
+full-frame draw can fail to render the full frame at all unless a
+brief delay (confirmed: 4ms is sufficient, 0ms fails; the library uses
+20ms for margin) separates them. Region-after-region and
+full-after-full both need no delay. Likely cause: a full-frame draw is
+a clean buffer replace, but a region draw is a read-modify-write
+against the current framebuffer; if that read starts before the
+previous commit has actually finished settling internally, the
+in-flight commit can apparently be corrupted or aborted.
+
+**Boot/display orientation** (confirmed on real hardware):
+`"CRT" + 00,00 + "SET" + 00,00 + 0x00 + <orientation byte>`, where the
+orientation byte is `0x00` for horizontal or `0x01` for vertical.
+Found by comparing two real captures of the same action with different
+outcomes -- the first capture only ever showed the default value
+(indistinguishable from "no parameter"), a second capture with actual
+mode switches revealed the real byte. Confirmed to both apply
+immediately to the live display *and* persist as the boot-time
+default: verified by physically power-cycling the device after setting
+each value and observing the boot splash orientation match.
+
+hidapi note: `write()` needs a leading `0x00` report-ID placeholder per
+report; the kernel strips it before the wire (captures show no
+report-ID byte on the wire itself).
+
+## License
+
+MPL-2.0