EA to public

[CasperH2O]

Summary by CodeRabbit

• New Features

  • Implemented new classes for handling axis, button, gyro, keyboard, mouse, special, and trigger actions in handheld devices.
  • Introduced a new DualSenseController class for DualSense® Wireless Controller support.
  • Added new GordonController and LegionController classes for specific game controller support.
  • Created new ProController class for Nintendo Pro Controller support.
  • Updated user interface components for controller management.
  • Enhanced controller state representation to include cloning functionality.
  • Integrated new settings for controller management, HID mode, and display toggles.

• Improvements

  • Improved input handling for DS4Controller by inheriting from JSController.
  • Enhanced NeptuneController with new communication protocols and haptic feedback control.
  • Streamlined DInputController by removing unused elements and refining methods.

• Bug Fixes

  • Fixed issues related to input handling across various controller classes.
  • Addressed UI update mechanisms for better user experience.

• Documentation

  • Updated comments and documentation for clarity and consistency.

• Refactor

  • Removed "ControllerService" and "ControllerCommon" projects.
  • Renamed "neptune-hidapi.net" project to "steam-hidapi.net".

• Style

  • Updated styles and layout in App.xaml for improved visual presentation.

• Chores

  • Adjusted build process to utilize .NET 8 SDK.
  • Removed offline installer creation and unnecessary build steps.

• Localization

  • Added support for "ru-RU" culture.

[coderabbitai]

Walkthrough

The software underwent a significant overhaul, with a focus on improving controller support and input handling. Projects related to controller services were removed, while new classes were introduced for various action types like axis, buttons, gyro, and special inputs. The controller classes were restructured for better integration and new controller types were added, enhancing the capabilities for different devices. Configuration changes were made to streamline the build process and adjust application settings for the updated functionality.

Changes

File(s)	Summary of Changes
.github/workflows/publish-hc.yml	Set up .NET 8 SDK, switched to dotnet restore, removed steps for rebuilding ControllerService and creating an offline installer.
HandheldCompanion.sln	Removed "ControllerService" and "ControllerCommon" projects, renamed "neptune-hidapi.net" to "steam-hidapi.net".
HandheldCompanion/Actions/...	Introduced new classes for handling different input actions such as Axis, Button, Gyro, Keyboard, Mouse, Special, and Trigger actions.
HandheldCompanion/Controllers/...	Added new controller classes (DualSenseController, GordonController, LegionController, JSController, ProController), updated existing ones, and removed platform-specific features.
HandheldCompanion/App.config, App.xaml, App.xaml.cs	Updated configuration and namespaces, added new settings for controller management, and included new culture case in App.xaml.cs.
HandheldCompanion/Controllers/IController.xaml, IController.xaml.cs	Defined UI layout for controller components and introduced methods for UI and controller input management.

🐇
In code we hop, with changes anew,
Controllers dance, to inputs so true.
With every key press, and gyro's swift turn,
We celebrate code, that's been deftly churned. 🌟
🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 13

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c93e725 and ce45fef.

Files ignored due to filter (6)

• ControllerCommon/Resources/devcon.exe
• ControllerService/ControllerService.json
• HandheldCompanion/ADLX_3DSettings.dll
• HandheldCompanion/ADLX_DisplaySettings.dll
• HandheldCompanion/HandheldCompanion.json
• HandheldCompanion/JoyShockLibrary.dll

Files selected for processing (26)

• .github/workflows/publish-hc.yml (2 hunks)
• HandheldCompanion.iss (1 hunks)
• HandheldCompanion.sln (2 hunks)
• HandheldCompanion/Actions/AxisActions.cs (1 hunks)
• HandheldCompanion/Actions/ButtonActions.cs (1 hunks)
• HandheldCompanion/Actions/GyroActions.cs (1 hunks)
• HandheldCompanion/Actions/IActions.cs (1 hunks)
• HandheldCompanion/Actions/KeyboardActions.cs (1 hunks)
• HandheldCompanion/Actions/MouseActions.cs (1 hunks)
• HandheldCompanion/Actions/SpecialActions.cs (1 hunks)
• HandheldCompanion/Actions/TriggerActions.cs (1 hunks)
• HandheldCompanion/App.config (5 hunks)
• HandheldCompanion/App.xaml (3 hunks)
• HandheldCompanion/App.xaml.cs (2 hunks)
• HandheldCompanion/AssemblyInfo.cs (1 hunks)
• HandheldCompanion/Controllers/ControllerState.cs (1 hunks)
• HandheldCompanion/Controllers/DInputController.cs (3 hunks)
• HandheldCompanion/Controllers/DS4Controller.cs (6 hunks)
• HandheldCompanion/Controllers/DualSenseController.cs (1 hunks)
• HandheldCompanion/Controllers/GordonController.cs (1 hunks)
• HandheldCompanion/Controllers/IController.xaml (1 hunks)
• HandheldCompanion/Controllers/IController.xaml.cs (1 hunks)
• HandheldCompanion/Controllers/JSController.cs (1 hunks)
• HandheldCompanion/Controllers/LegionController.cs (1 hunks)
• HandheldCompanion/Controllers/NeptuneController.cs (10 hunks)
• HandheldCompanion/Controllers/ProController.cs (1 hunks)

Files not summarized due to errors (1)

• HandheldCompanion.iss: Error: Message exceeds token limit

Files skipped from review due to trivial changes (1)

• HandheldCompanion/AssemblyInfo.cs

Additional comments: 71

HandheldCompanion/Controllers/DInputController.cs (1)

• 1-1:

#!/bin/bash
# The previous attempt to filter commit messages did not work because the variable 'commits' was not defined.
# We need to directly use the JSON output from the 'gh pr view' command to filter the commit messages.
# Let's try to filter the commit messages again, this time using the correct JSON data.

# The JSON data is stored in a variable named 'commits' in the provided context.
# We will parse this JSON to extract commit messages and then filter for those related to 'DInputController' or 'controller'.

# Extract commit messages from the JSON output and filter for relevant terms.
commits=$(cat <<'EOF'
{"commits":[{"authoredDate":"2023-10-27T12:43:31Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-10-27T12:43:31Z","messageBody":"* implement fan chart (wip)\r\n\r\n* improve UI\r\n\r\n* implement Performance page\r\n\r\n* rename PowerProfile to PowerScheme\r\n\r\n* implementing PowerProfileManager (wip)\r\n\r\n* simplify GetType() comparison\r\n\r\n* more work\r\n\r\n* more work\r\n\r\n* trying to wire cpu temp to fan speed (wip, dirty)\r\n\r\n* introduce fanmode, average and aggressivity logic to fanprofile\r\n\r\n* add support for vangogh cpu fan\r\n\r\n* oups\r\n\r\n* UI fan chart is now linked to profile fanspeeds array\r\n\r\n* more work, won't compile yet\r\n\r\n* more work, it compiles now\r\n\r\n* more work, migrating more settings to power profile\r\n\r\n* more work on UI\r\n\r\n* more work\r\n\r\n* quick profiles page is almost done\r\n\r\n* misc\r\n\r\n* leverage PowerMode enum for PowerProfile Guid also\r\n\r\n* Show tooltip on keyboard focus\r\n\r\n* add idevice Tjmax var\r\n\r\n* we shouldn't allow users to modify some of default profile settings\r\n\r\n* fix painful behavior where gamepad focus manager would force switch for first navigation view item\r\n\r\n* more work\r\n\r\n* better\r\n\r\n* avoid infinite profile update loop\r\n\r\n* add Name field to pages\r\n\r\n* update logo\r\n\r\n* fix UI issue when removing power profile\r\n\r\n* improve gamepad navigation experience\r\n\r\n* update UI (wip)\r\n\r\n* fix an issue with actions on quick profiles page\r\n\r\n* more work on UI and resx\r\n\r\n* fixed an issue with locks on quickhomepage\r\n\r\n* (re)enable hardware rendering on quicktools (temp)\r\n\r\n* implement wifi/bluetooth toggles on Quick Settings page\r\n\r\n* fix\r\n\r\n* fix\r\n\r\n* more work on UI\r\n\r\n* update quick performance page based on power profile name\r\n\r\n* implement OpenHardwareMonitor platform\r\n\r\n* more work on UI, focusing on Performance and Quick Performance pages\r\n\r\n* more work on performance and quick performance pages\r\n\r\n* migrate MotionInput enums\r\n\r\n* implement IDevice power profile fan presets\r\n\r\n* prevent crash on null asusACPI\r\n\r\nwe might want to add it to IsReady() ?\r\n\r\n* improve VirtualControllerForceOrder\r\n\r\nwe might want to add a fail-safe\r\n\r\n* fix asusACPI checks\r\n\r\n* fix fan preset\r\n\r\n* fix touch experience with fan control\r\n\r\n* improve SetFanControl() on RogAlly\r\n\r\n* improve Chart Touch experience\r\n\r\n* backport https://github.com/Valkirie/HandheldCompanion/commit/455a73ae696ea0d67c088839d3428f9e9bb0b78c\r\n\r\n* prevent crash by using IsOpen on IDevice\r\n\r\n* use IsOpen on RogAlly","messageHeadline":"Implement power profile, fan control and new UI (#53)","oid":"dab64174c7bc74458947e85130dc38e69892e6bb"},{"authoredDate":"2023-10-31T07:55:07Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjE0MzMwODM0","login":"CasperH2O","name":"CasperH2O"},{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"},{"email":"[email protected]","id":"U_kgDOCG0RVA","login":"MrCivsteR","name":"MrCivsteR"}],"committedDate":"2023-10-31T07:55:07Z","messageBody":"* Functional Bias Lighting.\r\n\r\n* Color, move away from HEX (bugged)\r\n\r\n* Tweaks\r\n\r\n* Remove SetLedStatus in favor of more simplicity\r\n\r\n* Fix unintentional temporary settings\r\n\r\n* use true screen size to prevent crash when accessing device var\r\n\r\n* Fix left LED average color area. Bias lighting frequency tweak.\r\n\r\n* slight logic update\r\n\r\n* fix crash\r\n\r\n* fix manager start order\r\n\r\n* Add try catch for \"device\". Cleanup.\r\n\r\n* Rework LED settings level into dropdown.\r\n\r\n* Add enum, fix color reset biaslighting, use device capability.\r\n\r\n* Cleanup, add GetColor to SettingsManager\r\n\r\n* Add localization and commentary.\r\n\r\n* Make Ayaneo2S based on Ayaneo2.\r\n\r\n* Introduce AyaneoLED class for multi device usage.\r\n\r\n* Initial port of LEDControl prototype for Ayaneo, does not compile.\r\n\r\n* Use OpenLibSys temporarily.\r\n\r\n* Add LED device capabilities for Ayaneo.\r\n\r\n* Create new object, add control functions where applicable.\r\n\r\n* Improve AyaneoLED, split LED color and brightness device capability\r\n\r\n* Update AYANEOLED.cs\r\n\r\n* LED Control, add disabled option (default), no HC control over LEDs.\r\n\r\n* Hide or show LED options based on mode selection.\r\n\r\n* Swap zone and RGB component for loop order\r\n\r\n* Tweak visibility for designer.\r\n\r\n* Disable Ayaneo Air Plus LED control for now.\r\n\r\n* Prepare for Battery status changes in Ayaneo LED\r\n\r\n* Update ECDetails naming, add Ayaneo Air Plus LED Control support.\r\n\r\n* that's better\r\n\r\n* Ayn initial LED and fan control code.\r\n\r\n* fix? AYN\r\n\r\n* improve AYANEOAir speed\r\n\r\nstill not enough for ambilight\r\n\r\n* Ayn Loki LED Control do update request after updating RGB values\r\n\r\n* Ayn LED Rework EC and LED control\r\n\r\n* AynLoki read and compare different value\r\n\r\n* Ayn EC cleanup\r\n\r\n* Ayn EC even more cleanup\r\n\r\n* Ayaneo prototype battery change LED update (does not compile)\r\n\r\n* AyaneoLED, fix power line and add debug logging.\r\n\r\n* Fix uninitialized previous power info.\r\n\r\n* prevPowerStatus null check and Thread.Sleep(1)\r\n\r\n* Ayaneo LED, remove unnecessary null check and add todo's.\r\n\r\n* Bias lighting vertical black bar detection settings and GUI work\r\n\r\n* Biaslighting functional vertical black bar detection, needs improvement.\r\n\r\n* Bias lighting update to use IsBlack function with color threshold.\r\n\r\n* start refactoring\r\n\r\n* more work\r\n\r\n* improve UI\r\n\r\n- todo: implement LEDSpeed\r\n- todo: implement LEDDirection\r\n\r\n* more work\r\n\r\n- support live accent color changes\r\n- migrate Dynamic Lighting timer to said class\r\n\r\n* add missing LEDSettingsUseAccentColor setting\r\n\r\n* remove redundant code\r\n\r\n* more work (doesn't compile yet)\r\n\r\n* more work\r\n\r\n* implement SetLedStatus()\r\n\r\n* Fix\r\n\r\n* fix\r\n\r\n* fix\r\n\r\n* that's better.. right ?\r\n\r\n* a few qol fixes\r\n\r\n* fix SetLedStatus on AYANEO\r\n\r\n* more work\r\n\r\n* fix AYN\r\n\r\n* Revert \"fix AYN\"\r\n\r\nThis reverts commit 5ece741c52a7b64f1e7426d285c1f13ad243188f.\r\n\r\n* Revert \"more work\"\r\n\r\nThis reverts commit 75957f2d158f6b04af0307e9e8709a662ac3b646.\r\n\r\n* Revert \"fix SetLedStatus on AYANEO\"\r\n\r\nThis reverts commit a88263ebf9f70921a2245d01aa566b6dde88d285.\r\n\r\n* Revert \"a few qol fixes\"\r\n\r\nThis reverts commit 1072f1316345a24c419e4fdfea1b1382e4e1321e.\r\n\r\n* Revert \"that's better.. right ?\"\r\n\r\nThis reverts commit 5ed82a60181639c9cda1808cd359b0052f5b16ed.\r\n\r\n* remove duplicated code from AYN\r\n\r\n* more work\r\n\r\n- remove AYANEOLED\r\n- rename AYANEO to AYANEODevice\r\n- implement IDevice PowerStatusChanged event\r\n\r\n* prevent crash with SharpDX Device on resolution changes\r\n\r\n---------\r\n\r\nCo-authored-by: Lesueur Benjamin <[email protected]>\r\nCo-authored-by: MrCivsteR <[email protected]>","messageHeadline":"Functional Bias Lighting. (#51)","oid":"aa0197e38ad27a26d10aba954b0987ee2d395bce"},{"authoredDate":"2023-10-31T08:10:13Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-10-31T08:10:13Z","messageBody":"","messageHeadline":"fix merge errors and remvoe unused imports/usings","oid":"dd97e0b291c6def72c74ab5077bcc78d375e6eb2"},{"authoredDate":"2023-10-31T18:16:51Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-10-31T18:16:51Z","messageBody":"","messageHeadline":"improve gamepad navigation experience with tooltip display on sliders","oid":"9a3e78ea97b5da74bc1b31c23d7fe54b11b062c5"},{"authoredDate":"2023-11-01T13:03:26Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-01T13:03:26Z","messageBody":"* tentative\r\n\r\n* improve ROGAlly OEM buttons reading","messageHeadline":"Improve ROGAlly OEM buttons support (#54)","oid":"2ef7c446eaaabfc03bc2b5f8b0b546b647a38fe4"},{"authoredDate":"2023-11-01T14:31:32Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-01T14:31:32Z","messageBody":"- implement LEDSpeed\n- improve HidDevice logic on ROGAlly\n- removed LED Direction until figured on ROGAlly\n- removed LEDLevel.Wave from ROGAlly until figured","messageHeadline":"improve DynamicLighting","oid":"affc341ab253dd13470e76f16d842fde6cc8b0f1"},{"authoredDate":"2023-11-01T14:36:11Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-01T14:36:11Z","messageBody":"","messageHeadline":"set OSPowerMode on default PowerProfiles","oid":"be1fc6033b5015315d2ffa7ce57064ed39cb636f"},{"authoredDate":"2023-11-01T14:51:43Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-01T14:51:43Z","messageBody":"","messageHeadline":"restore net8","oid":"006929d3c0d4a914ef841cc514503547ab3f7688"},{"authoredDate":"2023-11-03T08:33:06Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-03T08:33:06Z","messageBody":"","messageHeadline":"build 0.19.0.1","oid":"d914815f242e1893c13be5d0afb4d7819352cfd7"},{"authoredDate":"2023-11-05T09:56:05Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-05T09:56:05Z","messageBody":"* remove Ambilight logError\r\n\r\n* fix an issue with Power profile settings dialog not being visible\r\n\r\n* fix issues with a few settings values not being applied when toggled\r\n\r\n- fix TDPOverrideValues\r\n- fix GPUOverrideValue\r\n- fix CPUCoreCount\r\n\r\n* fix formatting issue\r\n\r\n* add power profile creation button on quick profiles page\r\n\r\n* give ability to delete power profile from quick menu\r\n\r\n* improve threading and speedup loading time\r\n\r\n- loading time reduced by 10 seconds on i7-1195G7\r\n- we need to improve threading on this application\r\n\r\n* improve MotherboardInfo class\r\n\r\n- processorSearcher.Get() is slow (about 1 sec). Let's make sure we don't execute it more than once.\r\n\r\n* migrate a few more calls to MotherboardInfo\r\n\r\n* update iNKORE.UI.WPF.Modern\r\n\r\n* Revert \"update iNKORE.UI.WPF.Modern\"\r\n\r\nThis reverts commit fcd1f20c2814c816ec768560c3a84870b3d7bf02.\r\n\r\n* Revert \"Revert \"update iNKORE.UI.WPF.Modern\"\"\r\n\r\nThis reverts commit 0007c3313dda2f33eb44063c2ff1f1a8158ac9fb.\r\n\r\n* Revert \"Revert \"Revert \"update iNKORE.UI.WPF.Modern\"\"\"\r\n\r\nThis reverts commit bda0588b39a4d87f8788fec2163f40f0c77e8dfd.\r\n\r\n* prevent crash on null sensor value\r\n\r\n* move improve virtual detection to controller page\r\n\r\n* misc UI fix\r\n\r\n* build 0.19.0.2","messageHeadline":"Hotfixes based on Patreons feedbacks (#55)","oid":"a83d2b58c7a17fa62a7314716195267720d62260"},{"authoredDate":"2023-11-05T12:20:51Z","authors":[{"email":"[email protected]","id":"MDQ6VXNlcjkzNDc1Nw==","login":"Valkirie","name":"Lesueur Benjamin"}],"committedDate":"2023-11-05T12:20:51Z","messageBody":"","messageHeadline":"implement backup method to detect and resume stalled controllers","oid":"fc8d1b1bc47ea2a4695f

</blockquote></details>
<details><summary>HandheldCompanion/Actions/KeyboardActions.cs (1)</summary><blockquote>

* 1-66: The `KeyboardActions` class has been modified with significant changes to the logic and control flow. The `Execute` method now handles key events and toggling behavior.

Ensure that the changes to the `Execute` method are correct and that the new logic is thoroughly tested. The class also lacks XML documentation comments, which should be added for clarity.







</blockquote></details>
<details><summary>.github/workflows/publish-hc.yml (1)</summary><blockquote>

* 63-89: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-106]

The `publish-hc.yml` GitHub Actions workflow file has been updated to include the setup of the .NET 8 SDK, replacing NuGet restore with dotnet restore, and removing steps related to rebuilding a service and creating an offline installer.

Ensure that the new SDK setup and dotnet restore work as expected and that the removed steps do not affect the build and release process.






<details>
<summary>Verification successful</summary>



---

<!--Monologue:
The script results confirm the presence of the .NET 8 SDK setup and the dotnet restore command in the `.github/workflows/publish-hc.yml` file. The absence of output for the NuGet restore, rebuild, and offline installer commands suggests that these steps are not present in the file, which aligns with the changes described in the review comment.
-->

The verification process has confirmed the following:

- The `.NET 8 SDK` setup is present in the workflow file, as indicated by the use of `actions/setup-dotnet@v3`.
- The `dotnet restore` command is present, replacing the NuGet restore.
- There is no mention of a NuGet restore, rebuild of ControllerService, or creation of an offline installer in the workflow file, which aligns with the intended removal of these steps.

Based on the script results, the changes in the `.github/workflows/publish-hc.yml` file reflect the updates mentioned in the review comment accurately.



</details>

<details>
<summary>Scripts Executed</summary>

The following scripts were executed for the analysis:



---

Script:
```shell
#!/bin/bash
# Verify that the new SDK setup and dotnet restore work correctly in the CI environment.
# This would typically be done by checking the output of the GitHub Actions run.
# Verify that the removed steps for rebuilding a service and creating an offline installer are intentional and do not cause issues.

Length of output: 0

---

---

Script:

#!/bin/bash
# Verify the changes in the .github/workflows/publish-hc.yml file
# Check for the presence of the .NET 8 SDK setup and dotnet restore
rg "setup-dotnet@v3" .github/workflows/publish-hc.yml
rg "dotnet restore" .github/workflows/publish-hc.yml
# Check for the absence of NuGet restore, rebuild of ControllerService, and creation of an offline installer
rg "nuget restore" .github/workflows/publish-hc.yml
rg "rebuild" .github/workflows/publish-hc.yml
rg "offline installer" .github/workflows/publish-hc.yml

Length of output: 361

HandheldCompanion/App.xaml.cs (1)

• 1-1: The App.xaml.cs file has been updated with new import statements and a new case for the "ru-RU" culture in a switch statement.

Ensure that the new imports are used within the file and that the addition of the "ru-RU" culture is handled correctly throughout the application.

Verification successful

---

The verification scripts have successfully located the App.xaml.cs file and provided the information needed to address the review comment.

1. The import statements in App.xaml.cs include various namespaces such as HandheldCompanion.Managers, HandheldCompanion.Utils, HandheldCompanion.Views, and others related to system functionality. This confirms that new imports have been added to the file.

2. The "ru-RU" culture is indeed handled in a switch statement within App.xaml.cs, as indicated by the presence of the case "ru-RU":. This suggests that the addition of the "ru-RU" culture is being recognized in the application's culture handling logic.

Based on the provided script outputs, the new imports are used within the App.xaml.cs file, and the addition of the "ru-RU" culture is handled correctly within the same file.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the new imports are used in the file.
rg --type cs "using" App.xaml.cs
# Verify that the "ru-RU" culture addition is consistent with the application's culture handling.
rg --type cs "ru-RU"

Length of output: 270

---

---

Script:

#!/bin/bash
# Correcting the file path issue and verifying the usage of new imports in App.xaml.cs
fd "App.xaml.cs" --exec rg --type cs "using"
# Verifying the "ru-RU" culture addition is consistent with the application's culture handling in App.xaml.cs
fd "App.xaml.cs" --exec rg --type cs "ru-RU"

Length of output: 498

HandheldCompanion/Controllers/IController.xaml (1)

• 1-93: The IController.xaml file has been updated, but no specific changes are annotated with line numbers. Without specific changes to review, no action can be taken.

HandheldCompanion/Controllers/DS4Controller.cs (1)

• 1-1: The DS4Controller class has been updated to inherit from JSController and includes changes to the constructor, additional source and target buttons and axis flags, and updated methods.

Ensure that the inheritance change and the new constructor signature are correctly implemented and that the additional buttons and axis flags are handled properly in the application.

Verification successful

---

The verification scripts have confirmed that the DS4Controller class now inherits from JSController and that the additional buttons and axis flags such as ButtonFlags.LeftPadClick and AxisLayoutFlags.LeftPad are being used throughout the application. The references to these flags in various parts of the codebase suggest that the changes have been integrated and are being handled properly.

Based on the provided output, the inheritance change and the new constructor signature are correctly implemented, and the additional buttons and axis flags are handled properly in the application.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the inheritance from JSController is correctly implemented.
rg --type cs "DS4Controller : JSController"
# Verify that the additional buttons and axis flags are correctly used in the application.
rg --type cs "ButtonFlags.LeftPadClick"
rg --type cs "AxisLayoutFlags.LeftPad"

Length of output: 12919

HandheldCompanion/Controllers/DualSenseController.cs (1)

• 1-176: The DualSenseController class has been added, inheriting from JSController. It includes methods for updating inputs and handling touchpad interactions.

Ensure that the class is correctly integrated into the application and that the touchpad interactions are working as expected.

HandheldCompanion/Actions/MouseActions.cs (6)

• 1-6: The usage of namespaces seems appropriate for the functionality of the MouseActions class. However, it's important to ensure that the WindowsInput.Events namespace is still required after the changes.

• 10-28: The MouseActionsType enum has been modified with new values. It's crucial to verify that all references to this enum throughout the codebase have been updated to reflect these changes.

• 31-58: The MouseActions class has several new class variables and constants. It's important to ensure that these are used appropriately and that their visibility is as restrictive as possible (e.g., private if they are not accessed outside the class).

• 60-67: The constructor MouseActions() initializes several variables and sets up a filter. It's good practice to ensure that all necessary initializations are performed here to maintain object consistency.

• 75-103: The Execute method has been modified with additional logic. It's important to ensure that the changes do not introduce any regressions and that the method's behavior is consistent with its intended functionality.

• 116-203: A new Execute method has been added with different parameters. It's important to ensure that this method is called correctly and that its implementation is consistent with the expected behavior for mouse actions.

HandheldCompanion/App.config (1)

• 185-256: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-253]

The App.config file has seen several changes, including the removal and addition of settings. It's important to ensure that all references to these settings in the codebase are updated accordingly and that the new settings are being used correctly.

Verification successful

---

The search results from the executed scripts indicate that the settings mentioned in the AI-generated summary, such as SteamControllerMute, ControllerManagement, HIDmode, HIDstatus, LegionControllerPassthrough, and OnScreenDisplayToggle, are indeed being referenced in various parts of the codebase. This includes C# files where the settings are being accessed or modified, such as Settings.Designer.cs, ControllerPage.xaml.cs, and other related files.

Given this information, it can be concluded that the settings that were supposed to be removed or added as per the pull request have been correctly updated in the codebase, and the references to these settings are consistent with the changes made in the App.config file.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for references to the removed settings to ensure they are no longer being used.
rg --type xml 'setting name="RemovedSettingName"'
# Search for references to the new settings to ensure they are being used correctly.
rg --type xml 'setting name="NewSettingName"'

Length of output: 397

---

---

Script:

#!/bin/bash
# Search for references to the specific removed settings in the codebase.
# The names of the removed settings should be derived from the AI-generated summary and the review comment.
# Since the exact names are not provided, we will use a pattern that matches the general structure of the setting names.
rg --type xml --type cs 'setting name=".*"'

# Search for references to the specific new settings in the codebase.
# The names of the new settings should be derived from the AI-generated summary and the review comment.
# Since the exact names are not provided, we will use a pattern that matches the general structure of the setting names.
rg --type xml --type cs 'setting name=".*"'

Length of output: 91

---

---

Script:

#!/bin/bash
# Search for references to the removed and new settings in the codebase.
# The names of the settings should be derived from the AI-generated summary and the review comment.
# We will use a pattern that matches the general structure of the setting names and includes both XML and C# files.

# First, let's find all the setting names in the App.config file to identify the removed and new settings.
rg --type xml '<setting name=' HandheldCompanion/App.config

# Next, we will search for references to these settings in the codebase within XML and C# files.
# This will be done in two steps after identifying the specific setting names.

Length of output: 4969

---

---

Script:

#!/bin/bash
# Now that we have the current setting names, we need to search for references to these settings in the codebase.
# We will search for a few specific settings that were mentioned in the AI-generated summary as removed or added.
# For example, settings related to the Steam controller were renamed, and settings for controller management and HID mode were added.

# Search for references to renamed Steam controller settings.
rg 'SteamControllerMute' --type xml --type cs
rg 'SteamController.*' --type xml --type cs

# Search for references to new settings for controller management and HID mode.
rg 'ControllerManagement' --type xml --type cs
rg 'HIDmode' --type xml --type cs
rg 'HIDstatus' --type xml --type cs
rg 'LegionControllerPassthrough' --type xml --type cs
rg 'OnScreenDisplayToggle' --type xml --type cs

Length of output: 28396

HandheldCompanion/Controllers/JSController.cs (1)

• 12-223: The JSController class has been updated with new logic and methods. It's important to ensure that the class's functionality is consistent with the expected behavior for a controller and that the new methods are used correctly.

HandheldCompanion/Actions/IActions.cs (1)

• 73-378: The IActions class has been updated with new properties and methods. It's important to ensure that these changes are consistent with the intended functionality of actions within the application and that they are used correctly throughout the codebase.

HandheldCompanion/Controllers/GordonController.cs (1)

• 15-310: The GordonController class has been updated with new logic and methods. It's important to ensure that the class's functionality is consistent with the expected behavior for a controller and that the new methods are used correctly.

Verification successful

---

The ast-grep search has identified two instances where the GordonController class is instantiated within the ControllerManager.cs file. This indicates that the GordonController class is being used in the codebase, specifically within the ControllerManager class, which likely manages the various controller types for the application.

Given this information, it can be inferred that the GordonController class is integrated into the system through the ControllerManager and is instantiated when needed, presumably when a Gordon type controller is connected or identified.

Based on the information gathered, the GordonController class is being used in the context of the ControllerManager, which is consistent with the expected behavior for a controller class within a software system that handles multiple types of controllers.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for usages of the GordonController class to ensure it is being used correctly with the new logic.
ast-grep --lang csharp --pattern $'GordonController.$_'

Length of output: 56

---

---

Script:

#!/bin/bash
# Search for usages of the GordonController class more broadly to ensure it is being used correctly with the new logic.
ast-grep --lang csharp --pattern $'$_.$_(GordonController $$$)'

Length of output: 64

---

---

Script:

#!/bin/bash
# Search for instantiations of the GordonController class and references to it in variable declarations.
ast-grep --lang csharp --pattern $'new GordonController($$$)'

Length of output: 346

HandheldCompanion/Controllers/LegionController.cs (13)

• 15-46: The LegionController class inherits from XInputController and defines several enums and a DllImport for system parameters. The enums FrontEnum, BackEnum, and ControllerState are well-defined with appropriate flag attributes where necessary. The DllImport for SystemParametersInfo is correctly defined with the appropriate attributes for marshaling return types and setting errors.

• 48-53: The private fields for device handling (hidDevice) and constants for data indices are well-defined. It's good to see constants used for magic numbers, which improves readability and maintainability.

• 60-68: The IsReady property is correctly implemented to check if the controller is in a ready state. It uses the READY_STATES HashSet for this purpose, which is efficient.

• 70-78: The IsWireless property is implemented to check the wireless state of the controller. It uses the ControllerState enum correctly to compare the state bytes. This is a good implementation.

• 97-118: The constructor LegionController correctly initializes the controller with additional source buttons and axes. It also retrieves the long press time from system settings using SystemParametersInfo, which is a good example of using native methods to configure the controller behavior based on the system's configuration.

• 121-127: The AttachDetails method correctly initializes the hidDevice if it's not null and opens the device. This is a standard approach for HID device interaction.

• 130-142: The GetHidDevice method is well-implemented, iterating over HID devices and returning the first one that matches the expected input report length. This is a common pattern for HID device selection.

• 145-155: The GetStatus method is a simple and effective way to read a status byte from the HID report. It checks for null and returns a default value if the device is not available, which is good practice for error handling.

• 157-176: The Plug method correctly sets up the hidDevice and starts a data thread if necessary. It's good to see that the thread is set as a background thread, which will not prevent the application from exiting.

• 179-196: The Unplug method properly handles the stopping of the data thread and the disposal of the hidDevice. It's good to see that the thread is joined before being set to null, ensuring that it has finished executing before the method completes.

• 248-266: The dataThreadLoop method is an asynchronous loop that reads data from the HID device and updates the Data array if the packet is considered safe. This is a good implementation of a data reading loop for a HID device.

• 268-283: The GetGlyph method provides a way to get a string representation of a button's glyph. It uses Unicode characters to represent the buttons, which is a common approach for displaying controller buttons in a UI.

• 391-395: The SetPassthrough method is a simple setter that also calls SetTouchPadStatus. It's not clear what SetTouchPadStatus does as it's not included in the provided code. Assuming it's a method that correctly handles the touchpad status, this method is fine.

HandheldCompanion/Controllers/NeptuneController.cs (6)

• 1-45: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [14-64]

The NeptuneController class inherits from SteamController and initializes a private NeptuneController object from steam_hidapi.net. It also defines constants for trackpad inner radius and haptic feedback intensity. The constructor initializes the controller with additional source buttons and axes, which is appropriate for the controller's capabilities.

• 67-74: The AttachDetails method correctly initializes the Controller object with vendor and product IDs and opens the controller for communication. This is a standard approach for device initialization.

• 79-79: The ToString method is overridden to return a string representation of the controller. It's a simple and effective way to provide a meaningful name for the controller.

• 266-337: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [256-389]

The Open, Close, Hide, Unhide, OnControllerInputReceived, Plug, and Unplug methods are all related to the lifecycle management of the controller. They handle opening and closing the controller, hiding and unhiding it from the system, and plugging and unplugging it from the virtual driver. These methods are correctly implemented and follow best practices for resource management.

• 366-376: The RumbleThreadLoop method is an asynchronous loop that handles haptic feedback based on the intensity of the large and small motors. It uses the GetHapticIntensity method to calculate the intensity and then sets the haptic feedback on the controller. This is a good implementation of a background task for handling haptic feedback.

• 380-389: The SetHaptic method sets haptic feedback strength based on the provided strength and button. It uses a switch statement to determine the value to send to the controller. This is a good implementation of a method that abstracts the haptic feedback functionality.

HandheldCompanion/Controllers/IController.xaml.cs (22)

• 17-22: The ControllerCapabilities enum is well-defined with the [Flags] attribute, allowing for a bitwise combination of its members. This is a standard approach for defining capabilities.

• 27-34: The IController class is a partial class and a UserControl. It defines a list of target buttons and axes that can be mapped to, which is a good practice for encapsulating the mapping capabilities of the controller.

• 48-53: The Capabilities field and ColoredAxis and ColoredButtons dictionaries are used to store controller capabilities and UI-related properties. The use of a SortedDictionary for ColoredAxis and ColoredButtons ensures that the keys are sorted, which can be useful for UI rendering where order matters.

• 57-62: The InjectedButtons and Inputs fields are used to store the state of injected buttons and controller inputs. The IsReady property is a simple getter that returns true, which can be overridden by derived classes to provide a more complex readiness check.

• 64-79: The IsBusy property is a wrapper around the IsEnabled property of the UserControl, with additional UI logic to show or hide a progress bar. This is a good example of encapsulating UI logic within a property.

• 81-102: The SourceAxis and SourceButtons lists define the buttons and axes that all controllers have and that can be mapped. This is a good practice for defining the base capabilities of controllers.

• 104-134: The UserIndex property is used to store and notify changes to the user index of the controller. The event invocation and UI update logic are correctly placed within a dispatcher invoke to ensure they run on the UI thread.

• 136-141: The constructor of IController is empty, which is acceptable for a partial class where the initialization logic may be defined elsewhere. However, if there is no additional logic required in the constructor, it can be omitted entirely for clarity.

• 143-147: The AttachDetails method sets the Details field and marks the controller as hooked. This is a straightforward implementation for attaching details to the controller.

• 149-152: The UpdateInputs method invokes the InputsUpdated event with the current inputs. This is a standard pattern for notifying subscribers of input updates.

• 154-157: The HasMotionSensor method checks if the controller has motion sensor capabilities using the Capabilities flag. This is a good use of the enum flags pattern.

• 159-168: The IsPhysical, IsVirtual, and IsGaming methods are simple checks on the Details field to determine the nature of the controller. These methods are clear and concise.

• 178-188: The GetInstancePath and GetContainerInstancePath methods return paths from the Details field. These methods are simple getters and are implemented correctly.

• 197-202: The overridden ToString method returns the name of the controller from the Details field. This is a standard and effective way to provide a string representation of an object.

• 204-211: The DrawUI method updates the controller name and visibility based on whether it's a virtual controller. This is a good example of encapsulating UI logic within a method.

• 214-222: The UpdateUI method updates the UI elements asynchronously using the dispatcher. It correctly checks the controller capabilities and updates the visibility of the calibration button accordingly.

• 240-250: The InjectState and InjectButton methods allow for the injection of button states into the controller. These methods are well-implemented with appropriate logging.

• 263-267: The SetVibrationStrength method sets the vibration strength and optionally triggers a rumble. This is a good implementation of a method that allows for the configuration of haptic feedback intensity.

• 269-271: The SetVibration method is virtual and empty, which suggests it's meant to be overridden by derived classes to implement vibration functionality. This is a standard pattern for providing an extensible method in a base class.

• 274-310: The SetHaptic method provides a way to trigger haptic feedback based on button presses. It uses a delay to determine the duration of the feedback. This is a good implementation of a method that abstracts the haptic feedback functionality.

• 312-331: The Rumble method is a task-based implementation for triggering vibration. It ensures that any ongoing vibration is stopped before starting a new one. This is a good example of using asynchronous programming to handle time-based operations.

• 334-344: The Plug method sets the vibration strength and clears any injected button states. It also updates the UI to reflect the plugged state. This is a good implementation of a method that handles the plugging in of a controller.

HandheldCompanion.iss (13)

• 23-47: The Dependency_Add procedure is well-structured and adds a new dependency to the list. Ensure that all dependencies added by this procedure are necessary for the application and that the URLs provided are valid and point to the correct resources.

• 54-151: The Dependency_PrepareToInstall function handles the installation of dependencies. It includes error handling and user prompts, which is good practice. However, ensure that the error messages are clear and informative for the end-user. Also, verify that the dependencies are installed in the correct order, especially if any dependencies rely on others.

• 153-180: The Dependency_UpdateReadyMemo function updates the installation memo with dependency information. It's important to check that the memo is displayed correctly to the user and contains all necessary information about the installation process and dependencies.

• 207-216: The Dependency_IsNetCoreInstalled function checks for the presence of the .NET Core runtime. It's crucial to ensure that the version string passed to this function matches the required .NET Core version for the application.

• 218-228: The Dependency_AddDotNet80Desktop procedure adds the .NET Desktop Runtime 8.0.0 as a dependency. Verify that the URLs provided are correct and that the runtime is a necessary component for the application.

• 231-240: The Dependency_AddVC2005 procedure adds the Visual C++ 2005 Service Pack 1 Redistributable as a dependency. Ensure that this older version of the Visual C++ Redistributable is still required for the application and that the URLs are valid.

• 303-311: The Dependency_AddDirectX procedure adds the DirectX Runtime as a dependency. Confirm that DirectX is required for the application to function correctly and that the provided URL is the official source for the DirectX Runtime installer.

• 313-320: The Dependency_AddHideHide procedure adds the HidHide Drivers as a dependency. Verify that the version of HidHide specified is compatible with the application and that the URL points to the official release.

• 322-329: The Dependency_AddViGem procedure adds the ViGEmBus Setup as a dependency. Ensure that ViGEmBus is necessary for the application's controller emulation features and that the URL is correct.

• 331-338: The Dependency_AddRTSS procedure adds the RTSS Setup as a dependency. Confirm that RTSS (RivaTuner Statistics Server) is required for the application and that the URL provided is from a trusted and official source.

• 344-580: The setup configuration defines various constants and flags for the installer. Ensure that all defined constants are used correctly throughout the script and that the flags are set appropriately for the installer's requirements.

• 448-515: The CurUninstallStepChanged procedure handles the uninstallation steps. It includes conditional checks for user preferences on what to keep or remove. Verify that all paths and registry keys targeted for deletion are correct and that no user data is unintentionally removed.

• 518-581: The InitializeWizard, PrepareToInstall, NeedRestart, and UpdateReadyMemo functions are hooks into the Inno Setup process. Ensure that these functions are called at the correct times during the installation process and that they perform their tasks correctly.

[coderabbitai]

The GyroActions class has been added, implementing the IActions interface. It includes public fields for motion input, motion mode, toggle status, and constants for default values. The class is marked as [Serializable], which is appropriate for data that may be serialized for configuration or state persistence.

The class lacks XML documentation comments, which are important for maintainability and understanding the purpose and usage of the class and its members. Additionally, the use of public fields instead of properties is not a best practice in C# as it exposes the fields for direct manipulation, which can lead to a lack of encapsulation and potential misuse.

+        /// <summary>
+        /// Initializes a new instance of the <see cref="GyroActions"/> class.
+        /// </summary>
         public GyroActions()
         {
         }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public class GyroActions : IActions
	{
	public MotionInput MotionInput = MotionInput.JoystickCamera;
	public MotionMode MotionMode = MotionMode.Off;
	public bool MotionToggleStatus = false;
	public bool MotionTogglePressed = false; // for debouncing
	public ButtonState MotionTrigger = new();
	public float gyroWeight = DefaultGyroWeight;
	// const vars
	public const int DefaultAxisAntiDeadZone = 15;
	public const AxisLayoutFlags DefaultAxisLayoutFlags = AxisLayoutFlags.RightStick;
	public const MouseActionsType DefaultMouseActionsType = MouseActionsType.Move;
	public const int DefaultSensivity = 33;
	public const int DefaultDeadzone = 10;
	public const float DefaultGyroWeight = 1.2f;
	public GyroActions()
	{
	}
	}
	}
	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public class GyroActions : IActions
	{
	public MotionInput MotionInput = MotionInput.JoystickCamera;
	public MotionMode MotionMode = MotionMode.Off;
	public bool MotionToggleStatus = false;
	public bool MotionTogglePressed = false; // for debouncing
	public ButtonState MotionTrigger = new();
	public float gyroWeight = DefaultGyroWeight;
	// const vars
	public const int DefaultAxisAntiDeadZone = 15;
	public const AxisLayoutFlags DefaultAxisLayoutFlags = AxisLayoutFlags.RightStick;
	public const MouseActionsType DefaultMouseActionsType = MouseActionsType.Move;
	public const int DefaultSensivity = 33;
	public const int DefaultDeadzone = 10;
	public const float DefaultGyroWeight = 1.2f;
	/// <summary>
	/// Initializes a new instance of the <see cref="GyroActions"/> class.
	/// </summary>
	public GyroActions()
	{
	}
	}
	}

[coderabbitai]

The TriggerActions class has been added, implementing the IActions interface. It includes settings for axis dead zones and a method Execute to apply these settings to a given value.

Similar to GyroActions, this class also lacks XML documentation comments and uses public fields instead of properties. The same recommendations apply here for improving maintainability and encapsulation.

+        /// <summary>
+        /// Initializes a new instance of the <see cref="TriggerActions"/> class.
+        /// </summary>
+        /// <param name="axis">The axis layout flags to be used for trigger actions.</param>
         public TriggerActions(AxisLayoutFlags axis) : this()
         {
             this.Axis = axis;
         }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public class TriggerActions : IActions
	{
	public AxisLayoutFlags Axis;
	// settings
	public int AxisAntiDeadZone = 0;
	public int AxisDeadZoneInner = 0;
	public int AxisDeadZoneOuter = 0;
	public TriggerActions()
	{
	this.actionType = ActionType.Trigger;
	this.Value = (short)0;
	}
	public TriggerActions(AxisLayoutFlags axis) : this()
	{
	this.Axis = axis;
	}
	public void Execute(AxisFlags axis, short value)
	{
	// Apply inner and outer deadzone adjustments
	value = (short)InputUtils.InnerOuterDeadzone(value, AxisDeadZoneInner, AxisDeadZoneOuter, byte.MaxValue);
	value = (short)InputUtils.ApplyAntiDeadzone(value, AxisAntiDeadZone, byte.MaxValue);
	this.Value = value;
	}
	public short GetValue()
	{
	return (short)this.Value;
	}
	}
	/// <summary>
	/// Initializes a new instance of the <see cref="TriggerActions"/> class.
	/// </summary>
	/// <param name="axis">The axis layout flags to be used for trigger actions.</param>
	public TriggerActions(AxisLayoutFlags axis) : this()
	{
	this.Axis = axis;
	}

[coderabbitai]

The ControllerState class has been added, implementing the ICloneable interface. It includes states for buttons, axes, and gyro, along with a static dictionary mapping axis layout flags to button flags.

The use of ICloneable is generally discouraged in .NET due to its lack of type safety and ambiguity (it does not specify whether cloning is deep or shallow). It would be better to provide a more explicit cloning mechanism. Additionally, the class lacks XML documentation comments.

+        /// <summary>
+        /// Creates a new object that is a copy of the current instance.
+        /// </summary>
+        /// <returns>A new object that is a copy of this instance.</returns>
         public object Clone()
         {
             return new ControllerState()
             {
                 ButtonState = this.ButtonState.Clone() as ButtonState,
                 AxisState = this.AxisState.Clone() as AxisState,
                 GyroState = this.GyroState.Clone() as GyroState,
             };
         }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	namespace HandheldCompanion.Controllers
	{
	[Serializable]
	public class ControllerState : ICloneable
	{
	public ButtonState ButtonState = new();
	public AxisState AxisState = new();
	public GyroState GyroState = new();
	[JsonIgnore]
	public static readonly SortedDictionary<AxisLayoutFlags, ButtonFlags> AxisTouchButtons = new()
	{
	{ AxisLayoutFlags.RightStick, ButtonFlags.RightStickTouch },
	{ AxisLayoutFlags.LeftStick, ButtonFlags.LeftStickTouch },
	{ AxisLayoutFlags.RightPad, ButtonFlags.RightPadTouch },
	{ AxisLayoutFlags.LeftPad, ButtonFlags.LeftPadTouch },
	};
	public ControllerState()
	{ }
	public object Clone()
	{
	return new ControllerState()
	{
	ButtonState = this.ButtonState.Clone() as ButtonState,
	AxisState = this.AxisState.Clone() as AxisState,
	GyroState = this.GyroState.Clone() as GyroState,
	};
	}
	}
	/// <summary>
	/// Creates a new object that is a copy of the current instance.
	/// </summary>
	/// <returns>A new object that is a copy of this instance.</returns>
	public object Clone()
	{
	return new ControllerState()
	{
	ButtonState = this.ButtonState.Clone() as ButtonState,
	AxisState = this.AxisState.Clone() as AxisState,
	GyroState = this.GyroState.Clone() as GyroState,
	};
	}

[coderabbitai]

The ButtonActions class has been added, implementing the IActions interface. It includes a method Execute to handle button press actions and haptic feedback.

The class lacks XML documentation comments and uses private fields for runtime variables. It would be beneficial to add comments and consider if these runtime variables should be exposed through properties for better encapsulation.

+        /// <summary>
+        /// Executes the button action based on the provided button flags and value.
+        /// </summary>
+        /// <param name="button">The button flags indicating which button is being acted upon.</param>
+        /// <param name="value">The value indicating the button's state.</param>
         public override void Execute(ButtonFlags button, bool value)
         {
             // Implementation...
         }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	{
	[Serializable]
	public class ButtonActions : IActions
	{
	public ButtonFlags Button;
	// runtime variables
	private bool IsKeyDown = false;
	public ButtonActions()
	{
	this.actionType = ActionType.Button;
	this.Value = false;
	this.prevValue = false;
	}
	public ButtonActions(ButtonFlags button) : this()
	{
	this.Button = button;
	}
	public override void Execute(ButtonFlags button, bool value)
	{
	base.Execute(button, value);
	switch (this.Value)
	{
	case true:
	{
	if (IsKeyDown)
	return;
	IsKeyDown = true;
	SetHaptic(button, false);
	}
	break;
	case false:
	{
	if (!IsKeyDown)
	return;
	IsKeyDown = false;
	SetHaptic(button, true);
	}
	break;
	}
	}
	public bool GetValue()
	{
	return (bool)this.Value;
	}
	}
	{
	[Serializable]
	public class ButtonActions : IActions
	{
	public ButtonFlags Button;
	// runtime variables
	private bool IsKeyDown = false;
	public ButtonActions()
	{
	this.actionType = ActionType.Button;
	this.Value = false;
	this.prevValue = false;
	}
	public ButtonActions(ButtonFlags button) : this()
	{
	this.Button = button;
	}
	/// <summary>
	/// Executes the button action based on the provided button flags and value.
	/// </summary>
	/// <param name="button">The button flags indicating which button is being acted upon.</param>
	/// <param name="value">The value indicating the button's state.</param>
	public override void Execute(ButtonFlags button, bool value)
	{
	base.Execute(button, value);
	switch (this.Value)
	{
	case true:
	{
	if (IsKeyDown)
	return;
	IsKeyDown = true;
	SetHaptic(button, false);
	}
	break;
	case false:
	{
	if (!IsKeyDown)
	return;
	IsKeyDown = false;
	SetHaptic(button, true);
	}
	break;
	}
	}
	public bool GetValue()
	{
	return (bool)this.Value;
	}
	}
	}

[coderabbitai]

The READY_STATES HashSet is used to store controller states that are considered ready. This is a good use of a HashSet for quick lookups. However, it's not clear what the numbers 25 and 60 represent. It would be beneficial to have these magic numbers replaced with named constants to improve code readability.

- private HashSet<int> READY_STATES = new HashSet<int>() {25, 60};
+ private const int STATE_ONE_READY = 25; // Replace with meaningful name
+ private const int STATE_TWO_READY = 60; // Replace with meaningful name
+ private HashSet<int> READY_STATES = new HashSet<int>() {STATE_ONE_READY, STATE_TWO_READY};

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	private HashSet<int> READY_STATES = new HashSet<int>() {25, 60};
	private Thread dataThread;
	private bool dataThreadRunning;
	private const int STATE_ONE_READY = 25; // Replace with meaningful name
	private const int STATE_TWO_READY = 60; // Replace with meaningful name
	private HashSet<int> READY_STATES = new HashSet<int>() {STATE_ONE_READY, STATE_TWO_READY};
	private Thread dataThread;
	private bool dataThreadRunning;

[coderabbitai]

Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [81-246]

The UpdateInputs method is extensive and updates the controller inputs based on the received input state. It handles button and axis states, including special cases like trackpad and stick touches. The method is well-structured and follows a clear logic for updating the state. However, there are TODO comments regarding the implementation of inner/outer ring button mappings for sticks, which suggests that this feature is not yet implemented. It's important to address these TODOs or remove them if they are no longer relevant.

+ // TODO: Implement Inner/Outer Ring button mappings for sticks
+ // https://github.com/Havner/HandheldCompanion/commit/e1124ceb6c59051201756d5e95b2eb39a3bb24f6

[coderabbitai]

The SpecialActions class has been added, implementing the IActions interface. It includes a method Execute to handle special actions like flick stick.

The class lacks XML documentation comments, and the Execute method could benefit from comments explaining the logic behind the flick stick handling.

+        /// <summary>
+        /// Executes the special action based on the provided axis layout.
+        /// </summary>
+        /// <param name="layout">The axis layout containing vector information for the action.</param>
         public void Execute(AxisLayout layout)
         {
             // Implementation...
         }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	using System.ComponentModel;
	using System.Numerics;
	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public enum SpecialActionsType
	{
	[Description("Flick Stick")]
	FlickStick = 0,
	}
	[Serializable]
	public class SpecialActions : IActions
	{
	public SpecialActionsType SpecialType;
	// runtime variables
	private FlickStick flickStick = new();
	private float remainder = 0;
	// settings
	public float FlickSensitivity = 5.0f;
	public float SweepSensitivity = 5.0f;
	public float FlickThreshold = 0.75f;
	public int FlickSpeed = 100;
	public int FlickFrontAngleDeadzone = 15;
	public SpecialActions()
	{
	this.actionType = ActionType.Special;
	}
	public SpecialActions(SpecialActionsType type) : this()
	{
	this.SpecialType = type;
	}
	public void Execute(AxisLayout layout)
	{
	if (layout.vector == Vector2.Zero)
	return;
	float delta = flickStick.Handle(layout.vector, FlickSensitivity, SweepSensitivity,
	FlickThreshold, FlickSpeed, FlickFrontAngleDeadzone);
	delta += remainder;
	int intDelta = (int)Math.Truncate(delta);
	remainder = delta - intDelta;
	MouseSimulator.MoveBy(intDelta, 0);
	}
	}
	using System.ComponentModel;
	using System.Numerics;
	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public enum SpecialActionsType
	{
	[Description("Flick Stick")]
	FlickStick = 0,
	}
	[Serializable]
	public class SpecialActions : IActions
	{
	public SpecialActionsType SpecialType;
	// runtime variables
	private FlickStick flickStick = new();
	private float remainder = 0;
	// settings
	public float FlickSensitivity = 5.0f;
	public float SweepSensitivity = 5.0f;
	public float FlickThreshold = 0.75f;
	public int FlickSpeed = 100;
	public int FlickFrontAngleDeadzone = 15;
	public SpecialActions()
	{
	this.actionType = ActionType.Special;
	}
	public SpecialActions(SpecialActionsType type) : this()
	{
	this.SpecialType = type;
	}
	/// <summary>
	/// Executes the special action based on the provided axis layout.
	/// </summary>
	/// <param name="layout">The axis layout containing vector information for the action.</param>
	public void Execute(AxisLayout layout)
	{
	if (layout.vector == Vector2.Zero)
	return;
	float delta = flickStick.Handle(layout.vector, FlickSensitivity, SweepSensitivity,
	FlickThreshold, FlickSpeed, FlickFrontAngleDeadzone);
	delta += remainder;
	int intDelta = (int)Math.Truncate(delta);
	remainder = delta - intDelta;
	MouseSimulator.MoveBy(intDelta, 0);
	}
	}
	}

[coderabbitai]

The AxisActions class has been added, inheriting from GyroActions. It includes methods for executing axis actions with various settings like dead zones and circularity improvement.

The class lacks XML documentation comments, and the Execute method could benefit from comments explaining the complex logic for axis manipulation.

+        /// <summary>
+        /// Executes the axis action based on the provided axis layout.
+        /// </summary>
+        /// <param name="layout">The axis layout containing vector information for the action.</param>
         public void Execute(AxisLayout layout)
         {
             // Implementation...
         }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	using System.Windows.Forms;
	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public class AxisActions : GyroActions
	{
	public AxisLayoutFlags Axis;
	// Axis to axis
	public bool ImproveCircularity = false;
	public int AxisAntiDeadZone = 0;
	public int AxisDeadZoneInner = 0;
	public int AxisDeadZoneOuter = 0;
	public bool AxisRotated = false;
	public bool AxisInverted = false;
	public AxisActions()
	{
	this.actionType = ActionType.Joystick;
	this.Value = new Vector2();
	}
	public AxisActions(AxisLayoutFlags axis) : this()
	{
	this.Axis = axis;
	}
	public void Execute(AxisLayout layout)
	{
	layout.vector = InputUtils.ThumbScaledRadialInnerOuterDeadzone(layout.vector, AxisDeadZoneInner, AxisDeadZoneOuter);
	layout.vector = InputUtils.ApplyAntiDeadzone(layout.vector, AxisAntiDeadZone);
	if (ImproveCircularity)
	layout.vector = InputUtils.ImproveCircularity(layout.vector);
	if (AutoRotate)
	layout.vector = ((Orientation & ScreenOrientation.Angle90) == ScreenOrientation.Angle90
	? new Vector2(layout.vector.Y, -layout.vector.X)
	: layout.vector)
	* ((Orientation & ScreenOrientation.Angle180) == ScreenOrientation.Angle180 ? -1.0f : 1.0f);
	else
	layout.vector = (AxisRotated ? new Vector2(layout.vector.Y, -layout.vector.X) : layout.vector)
	* (AxisInverted ? -1.0f : 1.0f);
	this.Value = (AxisRotated ? new(layout.vector.Y, -layout.vector.X) : layout.vector) * (AxisInverted ? -1.0f : 1.0f);
	}
	public Vector2 GetValue()
	{
	return (Vector2)this.Value;
	}
	}
	using System.Windows.Forms;
	namespace HandheldCompanion.Actions
	{
	[Serializable]
	public class AxisActions : GyroActions
	{
	public AxisLayoutFlags Axis;
	// Axis to axis
	public bool ImproveCircularity = false;
	public int AxisAntiDeadZone = 0;
	public int AxisDeadZoneInner = 0;
	public int AxisDeadZoneOuter = 0;
	public bool AxisRotated = false;
	public bool AxisInverted = false;
	public AxisActions()
	{
	this.actionType = ActionType.Joystick;
	this.Value = new Vector2();
	}
	public AxisActions(AxisLayoutFlags axis) : this()
	{
	this.Axis = axis;
	}
	/// <summary>
	/// Executes the axis action based on the provided axis layout.
	/// </summary>
	/// <param name="layout">The axis layout containing vector information for the action.</param>
	public void Execute(AxisLayout layout)
	{
	layout.vector = InputUtils.ThumbScaledRadialInnerOuterDeadzone(layout.vector, AxisDeadZoneInner, AxisDeadZoneOuter);
	layout.vector = InputUtils.ApplyAntiDeadzone(layout.vector, AxisAntiDeadZone);
	if (ImproveCircularity)
	layout.vector = InputUtils.ImproveCircularity(layout.vector);
	if (AutoRotate)
	layout.vector = ((Orientation & ScreenOrientation.Angle90) == ScreenOrientation.Angle90
	? new Vector2(layout.vector.Y, -layout.vector.X)
	: layout.vector)
	* ((Orientation & ScreenOrientation.Angle180) == ScreenOrientation.Angle180 ? -1.0f : 1.0f);
	else
	layout.vector = (AxisRotated ? new Vector2(layout.vector.Y, -layout.vector.X) : layout.vector)
	* (AxisInverted ? -1.0f : 1.0f);
	this.Value = (AxisRotated ? new(layout.vector.Y, -layout.vector.X) : layout.vector) * (AxisInverted ? -1.0f : 1.0f);
	}
	public Vector2 GetValue()
	{
	return (Vector2)this.Value;
	}
	}
	}

[coderabbitai]

The verification process has confirmed that the projects "ControllerService" and "ControllerCommon" are not referenced in the solution, aligning with the PR's objectives. However, the old project name "neptune-hidapi.net" is still mentioned in the steam-hidapi.net/README.md file, which may need to be updated to reflect the new project name.

Analysis chain

Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [1-1]

The HandheldCompanion.sln solution file has been modified to remove two projects and rename another. Ensure that the removal and renaming of projects are reflected in the solution and that there are no broken references or dependencies.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the removed projects are not referenced anywhere in the solution.
rg --type sln "ControllerService"
rg --type sln "ControllerCommon"
# Verify that the renamed project has been updated everywhere it is referenced.
rg --type sln "neptune-hidapi.net"

Length of output: 185

---

---

Script:

#!/bin/bash
# Verify that the removed projects are not referenced anywhere in the solution.
rg "ControllerService"
rg "ControllerCommon"
# Verify that the renamed project has been updated everywhere it is referenced.
rg "neptune-hidapi.net"

Length of output: 116

[coderabbitai]

The verification process has provided the following insights:

1. The namespace URL http://schemas.inkore.net/lib/ui/wpf/modern is not correct or the resource is not available at that location, as indicated by the 404 Not Found error returned by the curl command.

2. The DefaultColorPickerStyle is indeed used within the application, as shown by its presence in App.xaml and other XAML files like OverlayPage.xaml and DevicePage.xaml.

3. The term Expander is widely used throughout the application, as evidenced by its occurrence in various XAML files, including App.xaml, which suggests that the new Style for Expander is likely to be applied correctly within the application.

Based on these findings, the review comment has been partially verified. The new namespace URL is incorrect, but the new resources and style for Expander are applied correctly within the application.

Analysis chain

Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [1-1]

The App.xaml file has been updated with a new namespace URL, a new ResourceDictionary Source, and a new Style for Expander.

Ensure that the new namespace URL is correct and that the new resources and style are applied correctly within the application.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the new namespace URL is correct and accessible.
curl -I "http://schemas.inkore.net/lib/ui/wpf/modern"
# Verify that the new resources and style are used correctly in the application.
rg --type xaml "DefaultColorPickerStyle"
rg --type xaml "Expander"

Length of output: 886

---

---

Script:

#!/bin/bash
# Since 'xaml' is not recognized as a file type by rg, we will search without specifying the file type.
# Search for the usage of "DefaultColorPickerStyle" in any file, which may include XAML files.
rg "DefaultColorPickerStyle"
# Search for the usage of "Expander" in any file, which may include XAML files.
rg "Expander"

Length of output: 32805

[coderabbitai]

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ce45fef and 5ebcf59.

Files selected for processing (4)

• HandheldCompanion/Devices/AOKZOE/AOKZOEA1.cs (1 hunks)
• HandheldCompanion/Devices/AYANEO/AYANEO2021.cs (1 hunks)
• HandheldCompanion/Devices/GPD/GPDWinMax2.cs (1 hunks)
• HandheldCompanion/Devices/OneXPlayer/OneXPlayerMini.cs (1 hunks)

[coderabbitai]

The implementation of the GetGlyph method in the GPDWinMax2 class correctly overrides the base class method and provides Unicode glyphs for the given ButtonFlags. The method appears to be logically sound and syntactically correct. However, there is a duplicate definition of the GetGlyph method which should be removed to avoid confusion and potential compilation errors.

-    public override string GetGlyph(ButtonFlags button)
-    {
-        switch (button)
-        {
-            case ButtonFlags.OEM2:
-                return "\u220E";
-            case ButtonFlags.OEM3:
-                return "\u220F";
-        }
-
-        return defaultGlyph;
-    }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	public override string GetGlyph(ButtonFlags button)
	{
	switch (button)
	{
	case ButtonFlags.OEM2:
	return "\u220E";
	case ButtonFlags.OEM3:
	return "\u220F";
	}
	return defaultGlyph;

[coderabbitai]

The GetGlyph method added to the AYANEO2021 class is correctly overriding the base class method and provides Unicode glyphs for the specified ButtonFlags. The method is logically consistent and syntactically correct. However, similar to the previous file, there is a duplicate definition of the GetGlyph method which should be removed.

-    public override string GetGlyph(ButtonFlags button)
-    {
-        switch (button)
-        {
-            case ButtonFlags.OEM1:
-                return "\uE008";
-            case ButtonFlags.OEM2:
-                return "\u242F";
-            case ButtonFlags.OEM3:
-                return "\u243D";
-        }
-
-        return defaultGlyph;
-    }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	public override string GetGlyph(ButtonFlags button)
	{
	switch (button)
	{
	case ButtonFlags.OEM1:
	return "\uE008";
	case ButtonFlags.OEM2:
	return "\u242F";
	case ButtonFlags.OEM3:
	return "\u243D";
	}
	return defaultGlyph;

[coderabbitai]

The GetGlyph method in the OneXPlayerMini class is correctly implemented, overriding the base class method and returning the appropriate Unicode glyphs for the given ButtonFlags. The method is logically consistent and syntactically correct. However, there is a duplicate definition of the GetGlyph method which should be removed.

-    public override string GetGlyph(ButtonFlags button)
-    {
-        switch (button)
-        {
-            case ButtonFlags.OEM1:
-                return "\u2219";
-            case ButtonFlags.OEM2:
-                return "\u2210";
-            case ButtonFlags.OEM3:
-                return "\u2218";
-        }
-
-        return defaultGlyph;
-    }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	public override string GetGlyph(ButtonFlags button)
	{
	switch (button)
	{
	case ButtonFlags.OEM1:
	return "\u2219";
	case ButtonFlags.OEM2:
	return "\u2210";
	case ButtonFlags.OEM3:
	return "\u2218";
	}
	return defaultGlyph;

[coderabbitai]

The GetGlyph method in the AOKZOEA1 class is correctly overriding the base class method and provides Unicode glyphs for the specified ButtonFlags. The method is logically consistent and syntactically correct. However, there is a duplicate definition of the GetGlyph method which should be removed.

-    public override string GetGlyph(ButtonFlags button)
-    {
-        switch (button)
-        {
-            case ButtonFlags.OEM1:
-                return "\u220C";
-            case ButtonFlags.OEM2:
-                return "\u2210";
-            case ButtonFlags.OEM3:
-                return "\u2211";
-        }
-
-        return defaultGlyph;
-    }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	public override string GetGlyph(ButtonFlags button)
	{
	switch (button)
	{
	case ButtonFlags.OEM1:
	return "\u220C";
	case ButtonFlags.OEM2:
	return "\u2210";
	case ButtonFlags.OEM3:
	return "\u2211";
	}
	return defaultGlyph;