HMI Widgets documentation?

AndyCap · October 4, 2022, 6:48am

Hi Guys,

Is there any documentation on the HMI Widgets, I can’t seem to find any.

Cheers

Andy

falkTX · October 4, 2022, 8:34am

For developers, documentation is directly on the API.

github.com

moddevices/mod-lv2-extensions/blob/main/mod-hmi.lv2/mod-hmi.h

/*
  LV2 HMI integration extension
  Copyright 2021-2022 Filipe Coelho <falktx@falktx.com>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

/**
   @file lv2-hmi.h
   C header for the LV2 HMI integration, as used in MOD Devices.

This file has been truncated. show original

Let us know if anything is unclear

looperlative · October 5, 2022, 8:03pm

Hi,

There was an interface that I wasn’t using to report back changes to something. Unfortunately, my slack was lost in events of MOD. Can you provide what it was that I was supposed to do?

falkTX · October 5, 2022, 8:24pm

That one is LV2-Extensions/control-input-port-change-request.h at master · KXStudio/LV2-Extensions · GitHub

It allows a plugin to request a change to its own input control ports, which not allowed by default on LV2.

AndyCap · October 6, 2022, 8:30am

I am a bit confused here, do I need to set something on the dwarf to enable this functionality, I am running 1.12.0.2934-RC3

I have the examples from here loaded up: GitHub - moddevices/plugin-examples: Repository that contains examples of LV2 plugins

Neither “mod-hmi-widgets” or “hmi-widgets-individual-tests” seem to do much at all.

Have I got the wrong end of the stick, does HMI allow the plugin to “take over” the display and LEDs of the dwarf?

falkTX · October 6, 2022, 10:23am

You need to address/map a parameter to the HMI first.

AndyCap · October 6, 2022, 3:26pm

Thanks, it isn’t quite what I was thinking then, I hoped you could possibly take control of the front panel and dynamically change the parameters being controlled.

Even so I ran through the “mod-hmi-widgets” and “hmi-widgets-individual-tests” with mapping the controls and not much seems to work.

mod-hmi-widgets:

Linear Test knob - Bottom value always (NULL), so missing out a word while it loops.
Toggle Test button - Mapping this to HMI causes HMI to hang, can get it back with: hmi-reset; killall mod-ui

hmi-widgets-individual-tests:

Knob Label Test - Not setting anything
Knob Indicator Test - Not setting anything
Knob Value Test - Setting top row (label) to X-VALUE-X rather than value
Knob Unit test - Setting 3rd row (value) to X-UNIT-X rather than the unit.
Foot Led Test - Blinks LED, looks good.
Foot Label Test - Mapping this to HMI causes HMI to hang, can get it back with: hmi-reset; killall mod-ui

Also on mod-ui getting some errors:

Should these examples be working?

falkTX · October 6, 2022, 7:53pm

I wouldnt 100% count on it.
We started them when developing the feature, but they became unnecessary at some point.
I dont recall the details now, but seeing as the hmi widgets header file has no comments tells me it is old so there might be some incompatibilities there.
First step here would be to replace the header file with the one from mod-host and rebuilding. Likely the function parameters changed and thus this creates the breakage you see here.

AndyCap · October 7, 2022, 7:03am

Ah Ok, thanks.