API Stablisation - Githubissues

bahorn commented 4 years ago

Right now, this library has a somewhat awkward interface, mostly to follow as closely to the SDK servers protocol as possible. This ties pretty heavily into the #2 and #3

Some things that I'd like to change to make the UX a bit better:

[x] Iterators for accessing the devices. Seems awkward to require users to call controller_count() when it should be handled by the library.
[ ] A way of searching for devices. e.g, users mostly want to devices with a linear collection of LEDs, or find keyboards/mice, etc.
[x] The current approach is setting multiple LEDs is very awkward. Users need get a LED count for the device, then send a list containing values you want of the right size. Worth expanding on the representation of ORGBDevice to implement this, allowing nice error checking, etc.
[x] Make the methods support passing down a ORGBDevice for device_id

Welcome to any suggestions for other things to fix!

bahorn commented 4 years ago

Just added generator in https://github.com/bahorn/OpenRGB-PyClient/commit/a097331b14e50157251b89b8b8e065c3c62578c2 to avoid the awkward use of controller_count()

bahorn commented 4 years ago

so in 4560be9770cd25d4a4fb27f96b3de282e00a2d9a I made various parts of devices their own classes, which let me implement an active() function for controlling modes.

bahorn commented 4 years ago

v0.1.0 covers most of issues now.

bahorn / OpenRGB-PyClient

API Stablisation #4