It is possible to interact with Modulo Player using the WebSocket protocol. Modulo Player will act as a WebSocket server.
We use the JSON-RPC 2.0 protocol.

Tool for testing:

As an example, you can use Google Chrome and install the extension Web Socket Test Client.

Basic API:

Here is one example asking for the list of tasks.

{"jsonrpc":"2.0","method":"get.list.tasks","id": 1}

Will return for example:

{
"id": 1,
"jsonrpc":"2.0",
"result":[
{
"keyword":"",
"name":"Task6",
"objectType":"task",
"taskEnable":true,
"triggerEnable":true,
"uiColor":"",
"uuid":"{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}"
},
{
"keyword":"",
"name":"Task5",
"objectType":"task",
"taskEnable":true,
"triggerEnable":true,
"uiColor":"#d22b36",
"uuid":"{8c62fd31-1570-4b9f-bcab-3b3963031e20} "
}
]
}

Go to the next pages to discover all the available commands.

Need more help with this?
Don’t hesitate to contact us here.

Thanks for your feedback.