Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RELEASE] v6.0.0 #285

Merged
merged 401 commits into from
Mar 1, 2021
Merged

[RELEASE] v6.0.0 #285

merged 401 commits into from
Mar 1, 2021

Conversation

Sharparam
Copy link
Member

Sixth major release of Colore!

This is very long overdue and it includes a lot of changes.

Much of the API has been completely re-organized and is not backwards compatible, users of the library will need to update their code. The new locations should hopefully feel more logical though.

Major changes

API restructuring

The organization of the API felt off in many places, and has been adjusted to feel more natural. Hopefully everything should feel logical to our users. If there are any questions about this after the changes, don't be afraid to voice your concerns! Another breaking change would be unlikely very soon, but we will take any feedback into consideration.

Removal of WPF and WinForms extensions

As part of upgrading the project to support the SDK REST API and be async, the old extensions to enable integration with WPF and WinForms data classes were dropped. We will likely update these in the future to support the new version of Colore, but for now we felt like focusing on the main library.

Support for the SDK REST API

Colore v6.0 brings support for Razer's REST API for the Chroma SDK.

Async support

All APIs in Colore have been reworked to support the async/await pattern. This was partly done in order to better support the REST API. If there is a need, we may look into adding back the synchronous versions of the APIs, mainly for use with the native SDK.

Et.c...

Apart from the major points above, we have of course done bug fixes in general and added support for new things that have appeared in the SDK.


This is a big change, but we know a fair amount of people have been using the release candidates of 6.0 for a while so hopefully most of our core users are familiar with the changes.

Again, if you have any concerns, all feedback is appreciated! You may create an issue if you have bugs or feature requests, or visit the discussions for more general questions and concerns.


Fixes #284.

Sharparam added 16 commits June 18, 2020 21:29
The old boolean "Connected" field in the SDK has been changed
to a DWORD specifying how many devices are connected.
The SdkDeviceInfo struct in Colore has been updated to reflect this change.

The field for the device count is renamed to "ConnectedCount" in Colore
with a new helper property "Connected" to retain the old behaviour.
This effect is called CHROMA_CUSTOM2 in the SDK.
It apparently supports newer keyboard models that presumably have a larger grid of keys.

Updates #281.
 * Upgrade Cake to 1.0.0
 * Upgrade GitVersion to 5.6.6
 * Remove unnecessary helper scripts
 * Upgrade other packages used in build script
 * Fix bug with ambiguous call in build script
Previously it was pointing to an external image URL,
which is not as reliable.
If the SDK returns the ERROR_DEVICE_NOT_CONNECTED error when calling
the QueryDevice API, do not throw a NativeCallException but instead
detect this error and return a device info struct where the connected
count is set to zero.

A new enum member "Unknown" is added to the DeviceType enumeration
to cover this use case.

Fixes #284.
@Sharparam Sharparam added this to the v6.0 milestone Mar 1, 2021
@AppVeyorBot
Copy link

Issue with GitVersion when building PRs.

See: GitTools/GitVersion#2554
@AppVeyorBot
Copy link

@AppVeyorBot
Copy link

@codecov
Copy link

codecov bot commented Mar 1, 2021

Codecov Report

❗ No coverage uploaded for pull request base (master@ad27da8). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #285   +/-   ##
=========================================
  Coverage          ?   64.43%           
=========================================
  Files             ?       74           
  Lines             ?     1625           
  Branches          ?        0           
=========================================
  Hits              ?     1047           
  Misses            ?      578           
  Partials          ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ad27da8...9d82666. Read the comment docs.

@Sharparam
Copy link
Member Author

This looks good to me, me.

Thanks me, I'll merge this.

@Sharparam Sharparam merged commit 1aa47d0 into master Mar 1, 2021
@Sharparam Sharparam deleted the release/6.0.0 branch March 1, 2021 19:47
Sharparam pushed a commit that referenced this pull request Mar 1, 2021
Updates to project documentation and coverage data.

Timestamp: 2021-03-01 19:53:12+00
From commit 1aa47d0 - Merge pull request #285 from chroma-sdk/release/6.0.0
Target: docs
Coverage target: coverage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

QueryDevice fails with error code 1167 (0x48F, ERROR_DEVICE_NOT_CONNECTED)
4 participants