Where can I find the CLI documentation?

[mherger]

> Am I correct in concluding that there is not much of an error handler
> for the jsonrpc interface? If, for example, I request the *status* of a

I think that's correct, yes.

[mherger]

Where can I find the CLI documentation?

On your LMS: http://localhost:9000/html/docs/cli-api.html (replace "localhost" with your server's address).

Don't have LMS running? What are you doing here then, anyway? The documentation is on github, of course. Read it online. It's not nicely laid out, but hey, it's available!

[d6jg]

On your LMS: http://localhost:9000/html/docs/cli-api.html (replace "localhost" with your server's address).

Don't have LMS running? What are you doing here then, anyway? The documentation is on github, of course. Read it online. It's not nicely laid out, but hey, it's available!

Is there similar documentation for the JSON interface somewhere?

[karlek]

It's basically the same.
You'll have to put the command JSON formatted to LMS-IP:9000/jsonrpc.js

To set the volume to 25 (CLI: "04:20:00:12:23:45 mixer volume 25<LF>" )you could POST it like this:

curl -X POST -d '{ "method": "slim.request", "params":["00:04:20:xx:xx:xx", ["mixer", "volume", "25"]]}' 192.168.178.37:9000/jsonrpc.js

The JSON part ist embraced by ' followed by {. The latter for handling it as a dictionary.
The command itself is a list consisting of the player ID (MAC) and another list with the parameters p0 to p5.

see also here for a good overview:

https://gist.github.com/samtherussell/335bf9ba75363bd167d2470b8689d9f2

[d6jg]

It's basically the same.
You'll have to put the command JSON formatted to LMS-IP:9000/jsonrpc.js

To set the volume to 25 (CLI: "04:20:00:12:23:45 mixer volume 25<LF>" )you could POST it like this:

curl -X POST -d '{ "method": "slim.request", "params":["00:04:20:xx:xx:xx", ["mixer", "volume", "25"]]}' 192.168.178.37:9000/jsonrpc.js

The JSON part ist embraced by ' followed by {. The latter for handling it as a dictionary.
The command itself is a list consisting of the player ID (MAC) and another list with the parameters p0 to p5.

see also here for a good overview:
https://gist.github.com/samtherussel...d2470b8689d9f2

Thanks

[eradicatore]

a general command to jsonrpc.js

Thanks all for sharing! This really helped me get started. I was having some trouble figuring out how to send some other commands though until I saw somewhere that if you want to send a "general" command for example you still need to give a mac address for some reason? So I got this to work for example. Not sure also if/why the "id":0 is needed but I put that in there too

{
    "method": "slim.request",
    "params": [
        "FF:FF:FF:FF",
        [
            "player",
            "count",
            "?"
        ]
    ],
    "id": 0
}

Question, does anyone know how to interact with apps? Such as spotify or pandora? I got the list to work:

{
    "method": "slim.request",
    "params": [
        "FF:FF:FF:FF",
        [
            "apps",
            "0",
            "15"
        ]
    ],
    "id": 0
}

And I get something like this:

{
    "method": "slim.request",
    "id": 0,
    "result": {
        "count": 13,
        "appss_loop": [
            {
                "type": "xmlbrowser",
                "icon": "plugins/Spotty/html/images/93aac68fb06348598c1e67734dfaceee.png",
                "weight": 1,
                "cmd": "spotty",
                "name": "Spotty"
            },
            {
                "icon": "plugins/Pandora/html/images/icon.png",
                "type": "xmlbrowser",
                "weight": 10,
                "cmd": "pandora",
                "name": "Pandora"
            },
...

[eradicatore]

I think I found it here:

https://forums.slimdevices.com/showthread.php?82985-JSON-help

I just got this to work (have to talk to one specific player...)

{
    "method": "slim.request",
    "params": [
        "aa:bb:eb:zz:yy:xx",
        [
        	"myapps",
        	"items",
        	"0",
        	"9"
        ]
    ],
    "id": 0
}

Then, you get an item id in the response and use it like this to go down that path:

{
    "method": "slim.request",
    "params": [
        "aa:bb:eb:zz:yy:xx",
        [
        	"myapps",
        	"items",
        	"0",
        	"9",
        	"item_id:xyz859.0"
        ]
    ],
    "id": 0
}

[philchillbill]

Am I correct in concluding that there is not much of an error handler for the jsonrpc interface? If, for example, I request the status of a player but provide an incorrect playerid, instead of a nice JSON response error string along the lines of 'unknown playerid' or 'player offline', all I get is a http disconnect. If accessing LMS via ngrok then it's a 502 Proxy Error I see with "The proxy server received an invalid response from an upstream server". Any way to get 'nicer' error responses from jsonrpc.js ?

[daksol]

CLI documentation is now available in the lyrion.org repository.

Migration:

• This was migrated from the legacy /HTML/DOCS/cli-api.html which was bundled with the LMS Distro.
• Original very long HTML page now divided up into about 9 files.
• Legacy Sections "plugins", "deprecated" were not migrated.

New Location

• Start here https://lyrion.org/reference/cli/using-the-cli/
• Or go to https://lyrion.org and navigate via LH sidebar: Reference -> Development -> Command Line Interface (JSON/RPC) ->

Further Work

Some further work should be done on this content over next month or so. Should include:-

• method by which you can navigate from the documentation for a given Command over to the relevant source code
  • will be based on info already available
    • locate pm source xxx/Slim/Control/Request.pm
      • https://github.com/LMS-Community/sli...rol/Request.pm
    • search for for sub init{} which has a line for 90%+ of the CLI commands
    • info in addDispatch() function calls give info for the command on parameters, source code filename, related Perl function name
• more examples in JSON format for the complex queries
• some sample Python code for using the CLI via the jsonrpc.js functionality
• pointers to the relevant namespaces which are used for certain input parameter

Feedback

• Please provide feedback if you see opportunities for improvement of existing content, plus where it could be usefully extended,

[Anwen]

daksol
Feedback: I just very briefly started looking at the CLI documentation and noticed a typo under CLI Introduction in the Supported Commands section: “Compound” is incorrectly shown as “Coumpound”. Thanks for all your work on the new documentation!

[mherger]

daksol
Feedback: I just very briefly started looking at the CLI documentation and noticed a typo under CLI Introduction in the Supported Commands section: “Compound” is incorrectly shown as “Coumpound”. Thanks for all your work on the new documentation!

Thanks, fixed.

[daksol]

daksol
Feedback: I just very briefly started looking at the CLI documentation and noticed a typo under CLI Introduction in the Supported Commands section: “Compound” is incorrectly shown as “Coumpound”. Thanks for all your work on the new documentation!

Thanks - if that is as bad as it gets, we are doing great!