Skip to content

API Stablisation #4

Open
Open
@bahorn

Description

@bahorn

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:

  • 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.
  • 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.
  • Make the methods support passing down a ORGBDevice for device_id

Welcome to any suggestions for other things to fix!

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions