Mod Web API - Get Current Pedalboard State

jtemple967 · November 27, 2022, 8:56pm

Thought I would try this here before I post on Mod’s website. I’ve been looking at the APIs available as a part of the MOD host and am looking for an API that would give me the curren pedal board’s state, if possible. So I can get the current pedalboard AND that pedalboard’s info. What I can’t seem to find is an API to get the current pedalboard’s state. For example, if the chorus plugin is “off” by default, can I, through an API determine if it’s currently “on”?

Giedrius · November 28, 2022, 8:27am

Sometimes the best documentation (the one which actually shows what’s going on) is the source code. The mod-ui has its own http API endpoints, see the list here:

github.com

BlokasLabs/mod-ui/blob/modep-1.12-ps/mod/webserver.py#L2298


      
          
          
        self.write({
                      'ok': True,
                      'files': tuple(retfiles[fn] for fn in fullnames),
                  })
          
          
settings = {'log_function': lambda handler: None} if not LOG else {}
          
          
application = web.Application(
                  EffectInstaller.urls('effect/install') +
                  [
                      (r"/system/info", SystemInfo),
                      (r"/system/prefs", SystemPreferences),
                      (r"/system/exechange", SystemExeChange),
                      (r"/system/cleanup", SystemCleanup),
          
          
            (r"/update/download/", UpdateDownload),
                      (r"/update/begin", UpdateBegin),
          
          
            (r"/apt/check", APTCheck),
                      (r"/apt/upgrade", APTUpgrade),

jtemple967 · November 28, 2022, 2:48pm

@Giedrius yep, that’s what I’ve been using so far. I don’t see any API that gives me current state.

Giedrius · November 29, 2022, 7:59am

When you said you’re using Mod Host API I thought you were using the direct communication with mod-host process through its socket API: mod-host/mod-host.h at master · BlokasLabs/mod-host · GitHub

I don’t think it’s capable of having multiple connections open, so only mod-ui can access it, but I may be wrong though.

jtemple967 · November 30, 2022, 12:52am

@Giedrius interesting. I’ve never looked at the socket API. So if I’m not running the browser interface could I theoretically connect to this from another program?

Giedrius · November 30, 2022, 7:27am

Yes, if you stop mod-ui service, you can connect to mod host from another process and work with it. Or just run another mod-host on different ports.

Avijit_Mondal · November 15, 2023, 12:52pm

sir, how to connect with mod-host socket with python ? and how to set mod-host environments path ?

jtemple967 · November 15, 2023, 8:15pm

@Avijit_Mondal I’ve been doing some work on connecting to MODEP via the web API and the lilv.py package. What are you trying to accomplish? Maybe I can help with the answer.

Avijit_Mondal · November 16, 2023, 12:20pm

I’m trying to make an python based graphical ui for mod-host . which can control mod-host without mod-ui . So, I need to connect with mod-host first . But, can’t understand how to connect with mod-host through socket .

I check in webserver.py file , there are parameters for add , remove effects etc .
(r"/effect/add/(/[A-Za-z0-9_/]+[^/])/?“, EffectAdd),
(r”/effect/remove/(/[A-Za-z0-9_/]+[^/])/?", EffectRemove),

but dont know how to use them with python request . please help me .
Thank you

jtemple967 · November 17, 2023, 1:54pm

@Avijit_Mondal what you found there is the MOD web API. With these you have to do a Python web request to get the API results.

One suggestion: get Postman and use that to work out the particulars of using the MOD web API. Then you’ll know how to correctly make the call in Python.