JSON/YAML/ENV incorrect output

[p3lim]

Description

When I query headsetcontrol -b I get the correct output:

Found 1 supported device(s):
 Audeze Maxwell (Audeze Maxwell Dongle) [0x3329:0x4b19]
Battery:
        Status: BATTERY_AVAILABLE
        Level: 86%

When I query headsetcontrol -o yaml (or json or env) I get an incorrect battery reading:

---
name: "HeadsetControl"
version:
api_version: "1.3"
hidapi_version: "0.14.0"
device_count: 1
devices:
  - status: "success"
    device: "Audeze Maxwell"
    vendor: "Audeze LLC"
    product: "Audeze Maxwell Dongle"
    id_vendor: "0x3329"
    id_product: "0x4b19"
    capabilities:
      - CAP_SIDETONE
      - CAP_BATTERY_STATUS
      - CAP_INACTIVE_TIME
      - CAP_EQUALIZER_PRESET
      - CAP_VOLUME_LIMITER
    capabilities_str:
      - sidetone
      - battery
      - inactive time
      - equalizer preset
      - volume limiter
    battery:
      status: "BATTERY_UNAVAILABLE"
      level: -1

This in turn makes the Gnome extension unable to function.

Running 3.1.0 from nixpkgs with the following override:

    (pkgs.headsetcontrol.overrideAttrs (old: {
      src = pkgs.fetchFromGitHub {
        owner = "Sapd";
        repo = "HeadsetControl";
        rev = "3.1.0";
        sha256 = "sha256-9LUqYV0MMTtlFYZCEn81kML5F46GDYWYwoKpO0UORcQ=";
      };
      # disable patch that was applied for 3.0.0 since it's been merged in 3.1.0
      patches = [];
    }))

I'd be more than happy to test PRs.

On which OS does the problem happen?

Linux

[ModoloDev]

I’ve opened a PR, fixing this problem.
Could you please test it?

[p3lim]

@ModoloDev -o yaml still reporting "BATTERY_UNAVAILABLE", but it might be affected by the following.

Now when querying with -b the battery status is "BATTERY_UNAVAILABLE" for the first query, correct on the second, and "BATTERY_UNAVAILABLE" for any subsequent queries:

> headsetcontrol -b
Found 1 supported device(s):
 Audeze Maxwell (Audeze Maxwell Dongle) [0x3329:0x4b19]
Battery:
        Status: BATTERY_UNAVAILABLE

> headsetcontrol -b
Found 1 supported device(s):
 Audeze Maxwell (Audeze Maxwell Dongle) [0x3329:0x4b19]
Battery:
        Status: BATTERY_AVAILABLE
        Level: 58%

> headsetcontrol -b
Found 1 supported device(s):
 Audeze Maxwell (Audeze Maxwell Dongle) [0x3329:0x4b19]
Battery:
        Status: BATTERY_UNAVAILABLE

> headsetcontrol -b
Found 1 supported device(s):
 Audeze Maxwell (Audeze Maxwell Dongle) [0x3329:0x4b19]
Battery:
        Status: BATTERY_UNAVAILABLE

[ModoloDev]

@p3lim
I'm dropping a new update soon with a different way to request the headset status.
hope it'll fix it.
I'll let you know.

[ModoloDev]

@p3lim
I just dropped a new update. Could you please test it?

[p3lim]

Querying hangs for about a second or two, but it consistently reports correctly both for -b and -o now 👍

Edit: spoke too soon, it will still randomly report as unavailable, most notably with the gnome extension as it queries very frequently.

[ModoloDev]

Querying hangs for about a second or two, but it consistently reports correctly both for -b and -o now 👍

Well... better slow than wrong I guess hahaha
The problem is, when -o is used, it queries each info twice

[ModoloDev]

Querying hangs for about a second or two, but it consistently reports correctly both for -b and -o now 👍

Edit: spoke too soon, it will still randomly report as unavailable, most notably with the gnome extension as it queries very frequently.

Oh, I posted just before you edited your message. That's weird, it shouldn't behave like that. I'm getting the correct info every time in my tests.

[ModoloDev]

@p3lim
Do you have the Audeze HQ app open?

[p3lim]

No, wasn't aware of any app that worked on Linux.

[ModoloDev]

I'm testing on Windows, so Idk.

Ok, so could you help me to debug it?

On line 182 in audeze_maxwell.c file, add this code and send me what gets printed, please:

for (int i = 0; i < 5; ++i) {
        for (int j = 0; j < MSG_SIZE; ++j) {
            printf("%02x", status_buffs[i][j]);
            if (j < MSG_SIZE - 1) {
                printf(" ");
            }
        }
        printf("\n");
    }
    printf("=========================================================================================================================================================================================\n");

[p3lim]

I'll test after work, but in the mean time could you provide this as a patch file (maybe in a gist)? That way I can just plug it directly into my nix config along with the PR.

[ModoloDev]

Yeah, ofc.

https://gist.github.com/ModoloDev/5b064a592f87b31a441074d1e5ee6735

Oh, and I was thinking... How frequently does your gnome extension query? That could be the problem.

[p3lim]

https://gist.github.com/ModoloDev/5b064a592f87b31a441074d1e5ee6735

I'm sorry, I did mean an actual patch file, i.e. from git diff.
The patch file I use for the PR is https://patch-diff.githubusercontent.com/raw/Sapd/HeadsetControl/pull/412.patch, just for reference.

This is how I install the software using nix:

  home.packages = with pkgs; [
    (headsetcontrol.overrideAttrs (old: {
      # bump version to 3.1.0, latest in nix repos = 3.0.0
      src = pkgs.fetchFromGitHub {
        owner = "Sapd";
        repo = "HeadsetControl";
        rev = "3.1.0";
        sha256 = "sha256-9LUqYV0MMTtlFYZCEn81kML5F46GDYWYwoKpO0UORcQ=";
      };
      # disable patch that was applied for 3.0.0 since it's been merged in 3.1.0
      patches = [
        # add new patch for our headphones
        (pkgs.fetchpatch {
          url = "https://patch-diff.githubusercontent.com/raw/Sapd/HeadsetControl/pull/412.patch";
          hash = "sha256-yi8jCs7lJuHSfwgodlt5yHBwoAWBWCwWNl6sOm1Nn6o=";
        })
      ];
    }))
  ];

How frequently does your gnome extension query?

Looks like it's every 5 minutes, and every time the gnome menu/panel is opened/modified (the latter here is probably what's causing too frequent updates), and it queries multiple times when it does a query (but I'm no expert when it comes to gnome extensions). It's this one: https://github.com/ChrisLauinger77/gnome-shell-extension-HeadsetControl