added onyx note air 2 and onyx sdk light control #342

bezmi · 2021-11-29T14:22:41Z

I've adapted code found at calin-darie/gentle-glow-onyx to create a LightsInterface using the onyx SDK. I've tested and confirmed that it is working for my Boox Note Air 2.

The interface adapts (more intuitive) brightness/warmth values to the warm/cold values that onyx uses, whilst maintaining perceptually uniform brightness across the entire range. A caveat of this is that maximum brightness is limited.

I've also added the Note Air 2 to the EPDFactory as I have confirmed that full refresh works using the OnyxEPDController.

Had to bump minSDK to 19 for compatibility with the Onyx SDK packages.

This change is

pazos · 2021-11-29T14:39:09Z

Thanks for the patch. We cannot accept it because the minSdk bump.

First try the controller used for other onyx devices. See koreader/koreader#8482 (comment). You'll need the last nightly to run the new test activity.

If that doesn't work or works worse than this implementation you're welcome to submit a patch. Instead of using the sdk onyx provides you need to RE the calls used to get/set light levels and use these calls directly.

bezmi · 2021-11-29T15:26:06Z

I tried the tests in latest nightly before writing this up. The existing onyx controller does not work at all, unfortunately.

I can override the minSDK change by setting tools:overrideLibrary="com.onyx.android.sdk.device and wrap OnyxSDKCoolWarmCcontroller with a check of the android build version to ensure safety. Would that be acceptable?

I've never decompiled/reverse engineered on the android platform, so would like to avoid it if possible.

pazos · 2021-11-29T15:39:44Z

I can override the minSDK change by setting tools:overrideLibrary="com.onyx.android.sdk.device and wrap OnyxSDKCoolWarmCcontroller with a check of the android build version to ensure safety. Would that be acceptable?

Indeed. Please don't add the check within the controller class. Just wrap methods inside try-catch blocks.

I would expect:

the app works on 4.0+
the test app would work with the new class in all android versions. On versions below onyx sdk minApi all posible exceptions are catched.

pazos · 2021-11-29T15:41:08Z

app/src/main/AndroidManifest.xml

@@ -28,6 +28,7 @@
        android:name=".MainApp"
        android:icon="@mipmap/icon"
        android:banner="@mipmap/banner"
+        tools:replace="android:label,android:allowBackup"


There is a manifest merge conflict without these tags, is there an alternative way of handling this?

Galunid · 2021-11-29T23:26:26Z

There is no need to include the onyx-sdk as dependency at all. I already have it decompiled, so I can just look up the methods you need and we can use reflection to call them. That's what onyx-sdk does anyway. @bezmi Would that be acceptable for you?

Also does the previous controller not work at all, or just not work in the way you want it?

bezmi · 2021-11-29T23:40:20Z

I've decompiled the SDK now as well (easier than I though) and they're just using reflection to call methods in android.onyx.hardware.DeviceController.

The file locations are the same; /sys/class/backlight/white/brightness for the cold light and /sys/class/backlight/warm/brightness for the warm light. When running OnyxWarmthController, access permission is not granted and it throws a FileNotFoundException.

bezmi · 2021-11-30T08:15:02Z

I've removed the onyx sdk dependency and used reflection to call the api directly. The note air 2 falls under the SDMDevice file in the SDK, so that's what I've named the controller.

pazos · 2021-11-30T12:34:46Z

@bezmi: could you add the new driver to https://github.com/koreader/android-luajit-launcher/blob/master/app/src/main/java/org/koreader/launcher/TestActivity.kt?

pazos · 2021-11-30T12:35:46Z

app/src/main/AndroidManifest.xml

@@ -34,7 +34,7 @@
        android:usesCleartextTraffic="true"
        android:requestLegacyExternalStorage="true"
        android:supportsRtl="true"
-        android:extractNativeLibs="true" >
+        android:extractNativeLibs="true">


Please remove. If you want to make style changes do it in a separate PR :)

My bad, this one just snuck in

pazos · 2021-11-30T12:36:21Z

app/src/main/java/org/koreader/launcher/device/DeviceInfo.kt

@@ -50,13 +50,15 @@ object DeviceInfo {
        ONYX_C67,
        ONYX_KON_TIKI2,
        ONYX_NOVA2,
+        ONYX_NOTEAIR2,


nit: NOTE_AIR2

pazos · 2021-11-30T12:36:29Z

app/src/main/java/org/koreader/launcher/device/DeviceInfo.kt

        TOLINO
    }

    enum class LightsDevice {
        NONE,
        ONYX_C67,
        ONYX_NOVA2,
+        ONYX_NOTEAIR2,


^^

nit: NOTE_AIR2

pazos · 2021-11-30T12:38:45Z

The new driver looks ok. It should be compatible with devices supported by our previous controller. If @Galunid wants to try and works for him we can have a single driver for all devices. If not we keep both and call it a day :)

Galunid · 2021-11-30T13:48:03Z

That's my thoughts as well. It should work, but I have some stuff to deal with. I'll test it in the evening/tomorrow, and if it's good, we'll get rid of the previous one.

Galunid · 2021-11-30T16:14:23Z

I tested it and it works on Nova 2, but it handles the brightness/warmth differently from what we do now. What I mean is that 100% brightness + 100% warmth sliders result in 100% warmth LEDs and none of the white ones. Reducing warmth (when brigntness is 100%) increases whiteness.

This may work in unexpected ways with Autowarmth plugin. Personally I'm not a huge fan of the new behavior, because it's different from every other warmth device. I'd rather make it behave like the old one, but working on Note Air 2 too.

bezmi · 2021-11-30T22:26:21Z

@pazos I'll make all of the requested changes and add to TestActivity.kt.

@Galunid I personally don't like the brightness=cold/white and warmth=warm LED approach. Instead of manual mixing of two colours, it makes more sense for brightness to be related to the combined illuminance and warmth to be related to the colour temperature. Use of the autowarmth plugin is what drove me to write this as I wanted to change colour temperature without perceptual variation in brightness.

Is the current default behaviour specific to onyx, or do the other e-reader devices also behave the same way?

Nevertheless, I'm happy revert to the default brightness behaviour for this pull request and remove the WarmColdToWarmthBrightness stuff. I may see if it's possible write a script for KOReader that will allow toggling to my preferred mode of operation in future.

pazos · 2021-11-30T22:48:48Z

Is the current default behaviour specific to onyx, or do the other e-reader devices also behave the same way?

It is the same behaviour on all devices in all platforms :)

frontlight controls white leds. "natural light" controls orange leds (rgb leds in a few devices).
A bunch of things rely on this behaviour, including vertical swipe gestures (left for brightness/ right for warmth).

Nevertheless, I'm happy revert to the default brightness behaviour for this pull request and remove the WarmColdToWarmthBrightness stuff

That would be awesome :)

I may see if it's possible write a script for KOReader that will allow toggling to my preferred mode of operation in future.

It is doable but requires a few tweaks here and there. Currently epd and lights are hardcoded based on device properties. We need to add stuff to ignore detected drivers and let the users to push their own. It is actually useful to have it implemented but needs a few hours of free time.

All starts here:

https://github.com/koreader/android-luajit-launcher/blob/master/app/src/main/java/org/koreader/launcher/MainActivity.kt#L104

Which leads to https://github.com/koreader/android-luajit-launcher/blob/master/app/src/main/java/org/koreader/launcher/device/Device.kt#L8-L9

All of this starts before we run the LuaJIT vm so there's no way to change that as-is. We might need to declare both drivers mutable and add setters for them.

The EPD driver is a bit more tricky since there're a few constants that we retrieve once: https://github.com/koreader/koreader-base/blob/master/ffi/framebuffer_android.lua#L15 and those constants are tied to a specific driver.

The lights driver should be way easier because it is self-contained.

I would like to help you with the implementation as a mid-term task. I'm very busy and my to-do list keeps growing :/

bezmi · 2021-11-30T23:46:56Z

I was thinking more along the lines of adjusting the functionality of koreader/frontend/device/android/powerd.lua such that the device driver can remain the same.

The user will toggle a setting which will convert the behaviour from mixing of cold/warm LEDs to brightness=combined brightness of both LEDs and warmth=requested colour temperature. This will run an extra step in powerd.lua that changes the requested total brightness + colour temperature into the expected cold/warm values for the device driver.

It will require some device specific information, such as the light output and colour temperature of the warm and cold LEDs for the math to ensure that brightness remains perceptually uniform as colour temperature is altered. Users should be able to tweak these values to get it just right for their device.

Currently, the light output and colour temperatures are pretty much hard coded in the driver I wrote. The values work okay for the Note Air 2, but probably won't be perfect for other devices unless Onyx keeps their choice of warm/cold LEDs identical over the product lines.

Do you think the approach I've outlined above is do-able?

P.s. happy to be pinged whenever testing is required for my device.

pazos · 2021-12-01T00:21:50Z

Do you think the approach I've outlined above is do-able?

if android.setScreenWarmth + android.setScreenBrightness are enough to fullfit your needs all the rest can be written in the frontend.

But check first if it behaves as you expected. Actions, gestures and plugins use powerd functions. The dialog does not use them.

There's no easy way to fix that without:

a) reverting back to the good-old frontlight widget, used on the rest of platforms, while keeping android's device abstraction in place.

or

b) writting your custom driver as part of this repo and enable it on runtime based on a flag

Keep in mind device abstraction is a PITA and time is limited.
Any patch that makes the code easier to maintain is welcome :)

bezmi · 2021-12-01T07:11:41Z

~~I've tested and pushed the requested changes.~~ Just realised I forgot the test activity. Will push it through soon.

Galunid · 2021-12-02T04:42:31Z

Great, thanks! I haven't tested it yet, but I will do it later today. Could you try to fix the Codacy Static Code Analysis issues? Those are just styling changes.

bezmi · 2021-12-02T05:04:57Z

No problem, took me a couple of goes, but that's what squashing is for :). I'm not sure about the current naming, if you guys remove the old OnyxWarmthController then I guess this can take over the name.

a) reverting back to the good-old frontlight widget, used on the rest of platforms, while keeping android's device abstraction in place.

@pazos, I was able to get this working with the alternative brightness implementation after some trivial changes. However, I don't think it's a change that anyone would enjoy. I certainly prefer the style of the native dialog. I think I'll put a pin in it for now and keep a patch for myself with the other (better!) driver. Don't really see anyone else complaining about the warmth implementation on these devices anyway.

Galunid · 2021-12-02T05:58:00Z

app/src/main/java/org/koreader/launcher/device/lights/OnyxSDMController.kt

+}
+
+object FrontLight {
+


Redundant new line

Galunid · 2021-12-03T05:02:06Z

app/src/main/java/org/koreader/launcher/device/lights/OnyxSDMController.kt

+
+object FrontLight {
+
+    private val fLController = forName("android.onyx.hardware.DeviceController")


I would prefer flController, since afaik we use Frontlight, not FrontLight

Galunid · 2021-12-03T05:04:31Z

I tested it and it works on Nova 2! Feel free to nuke the old one and replace it with this one. Not sure if @pazos has any comments, but it looks ready to merge, after fixing those nits I mentioned in the review.

…Controller

bezmi · 2021-12-04T02:03:31Z

Apologies for the multiple commits, I missed a few changes when removing the OnyxSDMController references. OnyxWarmthController has been updated with the new driver code.

pazos · 2021-12-05T19:34:07Z

@Galunid: please merge when ready. Looks quite good :)

Galunid · 2021-12-06T08:33:47Z

@Frenzie Please give me permission to merge ^_^

I'll build and test it in a few hours code is looking alright

Frenzie · 2021-12-06T08:52:10Z

@Galunid I was going to say @pazos' permission suffices but then I realized you must mean GitHub user groups. I'll look into it.

reverts #342 fixes koreader/koreader#8584

pazos · 2021-12-26T13:01:18Z

@bezmi: this PR got reverted because koreader/koreader#8584.

Feel free to submit the PR again with the following changes:

The driver shouldn't override OnyxWarmthController, use another name.
Just move your own tested devices to the new driver
All the methods of the new class must be protected (ie: calling those methods won't make the VM crash even when invoked from an unsupported device). The best way to test this is asign your new driver to the emulator and check that everything behaves fine (ie: stacktraces printed for each attempt to call an unsupported method, no crashes)

sorry for the inconvenience

* revert koreader/android-luajit-launcher#342 * store apks in private dir and remove them after update

bezmi · 2022-02-22T11:56:46Z

I'm happy to rename it back to the old OnyxSDKController and update the error catching. At least if the controller is available, people whose device doesn't work with the standard onyx controller will be able to try with the SDK based one instead.

added note air 2 and onyx sdk light control

8320444

pazos reviewed Nov 29, 2021

View reviewed changes

removed onyxsdk dependency, using direct api calls

a077399

pazos reviewed Nov 30, 2021

View reviewed changes

removed WarmthBrightnessToWarmCold adapter

881a8fa

added OnyxSDMController to TestActivity.kt

28b8f86

bezmi added 2 commits December 2, 2021 14:48

fixed minor style issues

1749031

minor style fix

bf59b7e

Galunid reviewed Dec 3, 2021

View reviewed changes

Removed OnyxWarmthController, renamed OnyxSDMController to OnyxWarmth…

10d05c9

…Controller

bezmi added 2 commits December 4, 2021 11:52

missed commiting LightsFactory.kt

231f006

Removed references to OnyxSDMController in TestActivity.kt

46081ac

fixed formatting in EPDFactory.kt

1434e95

pazos approved these changes Dec 5, 2021

View reviewed changes

AsukaLangleyfag mentioned this pull request Dec 5, 2021

Android eink e-readers to add koreader/koreader#4551

Closed

Galunid merged commit f7d8112 into koreader:master Dec 6, 2021

pazos added a commit to pazos/android-luajit-launcher that referenced this pull request Dec 26, 2021

revert koreader#342

b042620

pazos mentioned this pull request Dec 26, 2021

revert #342 #347

Merged

Frenzie pushed a commit that referenced this pull request Dec 26, 2021

revert #342 (added onyx note air 2 and onyx sdk light control) (#347)

f58fe01

reverts #342 fixes koreader/koreader#8584

pazos mentioned this pull request Dec 26, 2021

bump android-luajit-launcher koreader/koreader#8593

Merged

Frenzie pushed a commit to koreader/koreader that referenced this pull request Dec 26, 2021

bump android-luajit-launcher (#8593)

d92e9c7

* revert koreader/android-luajit-launcher#342 * store apks in private dir and remove them after update

metivett mentioned this pull request Jan 2, 2022

Android: support for new e-ink devices koreader/koreader#8482

Open

bb010g mentioned this pull request Jun 12, 2022

Add Onyx SDK lights controller, Onyx Note Air2, & Onyx Nova Air C #372

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added onyx note air 2 and onyx sdk light control #342

added onyx note air 2 and onyx sdk light control #342

bezmi commented Nov 29, 2021 •

edited by Frenzie

Loading

pazos commented Nov 29, 2021 •

edited

Loading

bezmi commented Nov 29, 2021

pazos commented Nov 29, 2021

pazos Nov 29, 2021

bezmi Nov 29, 2021

Galunid commented Nov 29, 2021

bezmi commented Nov 29, 2021

bezmi commented Nov 30, 2021

pazos commented Nov 30, 2021

pazos Nov 30, 2021

bezmi Nov 30, 2021

pazos Nov 30, 2021

pazos Nov 30, 2021

pazos commented Nov 30, 2021

Galunid commented Nov 30, 2021

Galunid commented Nov 30, 2021

bezmi commented Nov 30, 2021

pazos commented Nov 30, 2021 •

edited

Loading

bezmi commented Nov 30, 2021

pazos commented Dec 1, 2021

bezmi commented Dec 1, 2021 •

edited

Loading

Galunid commented Dec 2, 2021

bezmi commented Dec 2, 2021

Galunid Dec 2, 2021

Galunid Dec 3, 2021

Galunid commented Dec 3, 2021

bezmi commented Dec 4, 2021

pazos commented Dec 5, 2021

Galunid commented Dec 6, 2021

Frenzie commented Dec 6, 2021

pazos commented Dec 26, 2021

bezmi commented Feb 22, 2022


		object FrontLight {

		private val fLController = forName("android.onyx.hardware.DeviceController")

added onyx note air 2 and onyx sdk light control #342

added onyx note air 2 and onyx sdk light control #342

Conversation

bezmi commented Nov 29, 2021 • edited by Frenzie Loading

pazos commented Nov 29, 2021 • edited Loading

bezmi commented Nov 29, 2021

pazos commented Nov 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Galunid commented Nov 29, 2021

bezmi commented Nov 29, 2021

bezmi commented Nov 30, 2021

pazos commented Nov 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pazos commented Nov 30, 2021

Galunid commented Nov 30, 2021

Galunid commented Nov 30, 2021

bezmi commented Nov 30, 2021

pazos commented Nov 30, 2021 • edited Loading

bezmi commented Nov 30, 2021

pazos commented Dec 1, 2021

bezmi commented Dec 1, 2021 • edited Loading

Galunid commented Dec 2, 2021

bezmi commented Dec 2, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Galunid commented Dec 3, 2021

bezmi commented Dec 4, 2021

pazos commented Dec 5, 2021

Galunid commented Dec 6, 2021

Frenzie commented Dec 6, 2021

pazos commented Dec 26, 2021

bezmi commented Feb 22, 2022

bezmi commented Nov 29, 2021 •

edited by Frenzie

Loading

pazos commented Nov 29, 2021 •

edited

Loading

pazos commented Nov 30, 2021 •

edited

Loading

bezmi commented Dec 1, 2021 •

edited

Loading