Missing support for devices without getSupportedApiInfo (Sony BDV-N5200, HAP-S1, BDV-N9200W)

[wouzzie]

Hi,

For the past few days, i'm trying to get your project to control my Sony BDV-N5200. But somehow, i can't get it to work. Installation on my Raspberry Pi and discovering the endpoint was all straightforward, but actually trying to control my device got me stuck on an error message i can't figure out:

Setting debug level to 3
DEBUG:root:Using endpoint http://192.168.2.189:10000/sony
DEBUG:songpal.device:Endpoint: http://192.168.2.189:10000/sony
DEBUG:songpal.device:Guide endpoint: http://192.168.2.189:10000/sony/guide
DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): 192.168.2.189:10000
DEBUG:urllib3.connectionpool:http://192.168.2.189:10000 "POST /sony/guide HTTP/1.1" 200 43
DEBUG:songpal.device:Got getSupportedApiInfo: {'error': [12, 'getSupportedApiInfo'], 'id': 1}
Traceback (most recent call last):
  File "/usr/local/bin/songpal", line 11, in <module>
    sys.exit(cli())
  File "/home/pi/.local/lib/python3.5/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/home/pi/.local/lib/python3.5/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/home/pi/.local/lib/python3.5/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/pi/.local/lib/python3.5/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/pi/.local/lib/python3.5/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/home/pi/.local/lib/python3.5/site-packages/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args[1:], **kwargs)
  File "/home/pi/.local/lib/python3.5/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/home/pi/.local/lib/python3.5/site-packages/songpal/main.py", line 29, in wrapper
    return loop.run_until_complete(f(*args, **kwargs))
  File "/usr/lib/python3.5/asyncio/base_events.py", line 466, in run_until_complete
    return future.result()
  File "/usr/lib/python3.5/asyncio/futures.py", line 293, in result
    raise self._exception
  File "/usr/lib/python3.5/asyncio/tasks.py", line 239, in _step
    result = coro.send(None)
  File "/home/pi/.local/lib/python3.5/site-packages/songpal/main.py", line 372, in sysinfo
    click.echo(await dev.get_system_info())
  File "/home/pi/.local/lib/python3.5/site-packages/songpal/device.py", line 174, in get_system_info
    return Sysinfo.make(**await self.services["system"]["getSystemInformation"]())
KeyError: 'system'

Whichever command i try, i get the same error message. Any help or a guide in the right direction is highly appreciated!

[rytilahti]

The error code (12) indicates a non-existing method which is documented here: https://developer.sony.com/develop/audio-control-api/api-references/api-overview-2#_getsupportedapiinfo_v1_0 -- Unfortunately I don't really have a quick solution for that at this point, as this call is used to locate what services is being provided and where their endpoints are.

Maybe it is using websockets also instead of xhrpost? What is the output from discovery? Does it list services? You could try songpal -dd discover (or fetch the description file otherwise) to see if the XML file contains some extra hints how to command the device.

I think you best bet would be capturing the network traffic and trying to see how the songpal app is calling that method.

[wouzzie]

Thanks for your fast reply! Discovery is listing some services, i recall at least audio and system tot be among them. i'll post the full output and XML-code when i'm back home tomorrow.

[wouzzie]

Hi,

Bit later than expected, but i managed to pull some info from my home cinema system. The output of songpal discover is as follows:

Discovering for 3 seconds

Found BDV-N5200W - BDV-2014
* API version: 1.0
* Endpoint: http://192.168.2.189:10000/sony
* Services:
  - Service: guide
  - Service: system
  - Service: illumination
  - Service: audio

Below are the output of songpal -dd discover and the XML-file i pulled from my system:
bdv-nv-ms-xml.txt
songpal-discover.txt

I tried to use Wireshark to get more info on the system control trough songpal, but it didn't gave any clues yet. But i'll keep digging!

[rytilahti]

Ok, those look perfectly fine to me. So I suppose you'll really need to do some wireshark sniffing to see what the official app does to find out what's wrong there. Btw, could you also run songpal dump_devinfo BDV-N5200.json and create a PR for that file (inside devinfos/)?

[toams]

hello, I've got the same problem with this BDV-N5200 device. But running songpal dump_devinfo BDV-N5200.json doesnt create a file, it just outputs:

Traceback (most recent call last):
  File "/usr/local/bin/songpal", line 11, in <module>
    sys.exit(cli())
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 1134, in invoke
    Command.invoke(self, ctx)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/decorators.py", line 17, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/songpal/main.py", line 29, in wrapper
    return loop.run_until_complete(f(*args, **kwargs))
  File "/usr/lib/python3.6/asyncio/base_events.py", line 468, in run_until_complete
    return future.result()
  File "/usr/local/lib/python3.6/dist-packages/songpal/main.py", line 110, in cli
    await x.get_supported_methods()
  File "/usr/local/lib/python3.6/dist-packages/songpal/device.py", line 82, in get_supported_methods
    response = await self.request_supported_methods()
  File "/usr/local/lib/python3.6/dist-packages/songpal/device.py", line 75, in request_supported_methods
    return await self.create_post_request("getSupportedApiInfo", {})
  File "/usr/local/lib/python3.6/dist-packages/songpal/device.py", line 56, in create_post_request
    prepreq = req.prepare()
  File "/usr/lib/python3/dist-packages/requests/models.py", line 259, in prepare
    hooks=self.hooks,
  File "/usr/lib/python3/dist-packages/requests/models.py", line 305, in prepare
    self.prepare_url(url, params)
  File "/usr/lib/python3/dist-packages/requests/models.py", line 379, in prepare_url
    raise MissingSchema(error)
requests.exceptions.MissingSchema: Invalid URL '/sony/guide': No schema supplied. Perhaps you meant http:///sony/guide?

I'll see if i can find some more clues using wireshark

[rytilahti]

What does the discovery say or is this coming from it? Looks like there is no URL at all, so that's why it fails.

[toams]

I used following command: songpal --endpoint 192.168.0.100 dump-devinfo BDV-N5200.json
songpal discover gives:

Discovering for 3 seconds
Found BDV-N5200W - BDV-2014
* API version: 1.0
* Endpoint: http://192.168.0.100:10000/sony
* Services:
  - Service: guide
  - Service: system
  - Service: illumination
  - Service: audio

as output

[rytilahti]

You have to use the endpoint URL as shown by discover. So songpal --endpoint http://192.168.0.100:10000/sony dump-devinfo BDV-N5200.json would be the correct command.

[toams]

running songpal --endpoint http://192.168.0.100:10000/sony dump-devinfo BDV-N5200.json gives: Error: Got unexpected extra argument (BDV-N5200.json).

running the same command without BDV-N5200.json gives following output:

Traceback (most recent call last):
  File "/usr/local/bin/songpal", line 11, in <module>
    sys.exit(cli())
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/songpal/main.py", line 29, in wrapper
    return loop.run_until_complete(f(*args, **kwargs))
  File "/usr/lib/python3.6/asyncio/base_events.py", line 473, in run_until_complete
    return future.result()
  File "/usr/local/lib/python3.6/dist-packages/songpal/main.py", line 577, in dump_devinfo
    res = {'supported_methods': {k: v.asdict() for k, v in methods.items()},
AttributeError: 'NoneType' object has no attribute 'items'

[rytilahti]

You can try to run it with -d flag (it willd isplay a lot of debug output), but the problem is that for some reason it cannot download the list of available actions. So in order to debug this someone needs to use wireshark (filter with tcp port 10000) to see how the app itself communicates with the device, to find a clue why it isn't working (maybe the device requires a header we are missing?).

[toams]

Running with the -d flag doesnt give many useful output, so I tried running the app while logging with wireshark. I attached the resulting pcapng file.
songpal2.pcapng.zip

[toams]

After looking into the sourcecode I noticed there is a higher debug lvl, so I tried running with -dd flag. Now I got more useful debug output:

songpal -dd --endpoint http://192.168.0.100:10000/sony/guide dump-devinfo
Setting debug level to 2

DEBUG:root:Using endpoint http://192.168.0.100:10000/sony/guide
DEBUG:songpal.device:Endpoint: http://192.168.0.100:10000/sony/guide
DEBUG:songpal.device:Guide endpoint: http://192.168.0.100:10000/sony/guide
DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): 192.168.0.100
DEBUG:urllib3.connectionpool:http://192.168.0.100:10000 "POST /sony/guide HTTP/1.1" 200 43
DEBUG:songpal.device:Got getSupportedApiInfo: {'error': [12, 'getSupportedApiInfo'], 'id': 1}
DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): 192.168.0.100
DEBUG:urllib3.connectionpool:http://192.168.0.100:10000 "POST /sony/guide HTTP/1.1" 200 43
DEBUG:songpal.device:Got getSupportedApiInfo: {'error': [12, 'getSupportedApiInfo'], 'id': 2}
Traceback (most recent call last):
  File "/usr/local/bin/songpal", line 11, in <module>
    sys.exit(cli())
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/decorators.py", line 64, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/songpal/main.py", line 29, in wrapper
    return loop.run_until_complete(f(*args, **kwargs))
  File "/usr/lib/python3.6/asyncio/base_events.py", line 473, in run_until_complete
    return future.result()
  File "/usr/local/lib/python3.6/dist-packages/songpal/main.py", line 577, in dump_devinfo
    res = {'supported_methods': {k: v.asdict() for k, v in methods.items()},
AttributeError: 'NoneType' object has no attribute 'items'

According to sony's api reference error code 12 means "no such method". So it looks like this device doesnt support the "getSupportedApiInfo" call.