Add application key to ConfigClientModel raise futures.TimeoutError() on await client.add_app_key

[ddovnar]

Hi! I've got an error, when I try add application key to the ConfigClient model. How can I fix this? Thanks

Sampe of python code:

async def configure(self):
   53         client = self.elements[0][ConfigClient]
   54 
   55         print("Configure start")
   56 
   57         status = await client.add_app_key(
   58             self.addr, net_index=0,
   59             app_key_index=0,
   60             net_key_index=0,
   61             app_key=self.app_keys[0]
   62         )
   63 
   64         print("Add app key done")
   65 
   66         assert status == StatusCode.SUCCESS, \
   67             'Cannot add application key: %s' % status

Error trace:

addr= 1
attach invoke before
{}
Configure start
Traceback (most recent call last):
  File "blemesh.py", line 124, in <module>
    main()
  File "blemesh.py", line 120, in main
    loop.run_until_complete(app.run(addr))
  File "/usr/lib/python3.7/asyncio/base_events.py", line 584, in run_until_complete
    return future.result()
  File "blemesh.py", line 88, in run
    await self.configure()
  File "blemesh.py", line 61, in configure
    app_key=self.app_keys[0]
  File "/usr/local/lib/python3.7/dist-packages/bluetooth_mesh/models/models.py", line 446, in add_app_key
    status = await self.query(request, status)
  File "/usr/local/lib/python3.7/dist-packages/bluetooth_mesh/models/base.py", line 389, in query
    await asyncio.wait_for(status, timeout=timeout)
  File "/usr/lib/python3.7/asyncio/tasks.py", line 423, in wait_for
    raise futures.TimeoutError()
concurrent.futures._base.TimeoutError

[michallowasrzechonek-silvair]

Most probably you haven't imported the device key into bluez keyring. See ImportRemoteNode API.

This needs to be done for your own key as well. We had a lengthy discussion about this with bluez maintainers...

[ddovnar]

Thank's for quick answer. Could you please give me some more detail, link to the manual, for example.

[ddovnar]

I found in the mesh-api.txt of bluez. Now, my next question is: How can I use this function from "python-bluetooth-mesh" python library?

[ddovnar]

In the mesh-cfgclient util, I found this command:

node-import <uuid> <net_idx> <primary> <ele_count> <dev_key> Import an externally provisioned remote node

[michallowasrzechonek-silvair]

https://github.com/SilvairGit/python-bluetooth-mesh/blob/master/bluetooth_mesh/interfaces.py#L621

Sorry, we don't provide tech support. The package is open "as is".

[ddovnar]

in the application.py module, method connect..this method call present at the end:

async def connect(
        self,
        join_callback: Optional[Callable[[int], Awaitable[int]]] = None,
        **kwargs,
    ) -> Mapping[int, Dict[Tuple[int, int], Dict[str, Tuple[Any, int]]]]:
        """
        Connect to BlueZ. If a node doesn't exist yet, it gets created via
        Import() call, using self.dev_key, self.primary_net_key, self.address
        and self.iv_index.
        Returns current node configuration, see documentation for Attach()
        method in mesh-api.txt_.
        """
        try:
            configuration = await self.attach(self.token_ring.token, **kwargs)
        except (ValueError, dbus_next.errors.DBusError) as ex:
            self.logger.error("Attach failed: %s, trying to import node", ex)

            token = await self.import_node(
                join_callback=join_callback,
            )
            configuration = await self.attach(token, **kwargs)

        # after attaching, explicitly import own device key to enable
        # communication with local Config Server
        await self.management_interface.import_remote_node(
            self.address, len(self.ELEMENTS), self.dev_key
        )

May be I need set correct "dev_key" in self? All my keys settings:

   40     @property
   41     def dev_key(self):
   42         #return DeviceKey(bytearray.fromhex(""))
   43         return DeviceKey(secrets.token_bytes(16))
   44 
   45     @property
   46     def net_key(self):
   47         return 0, NetworkKey(bytes.fromhex("CE1C1369A3B3389E4C53A961332A1A65")) 
   48         #return 0, NetworkKey(secrets.token_bytes(16))
   49 
   50     @property
   51     def app_keys(self):
   52         return {0: ApplicationKey(bytes.fromhex("93038609EF6622905319935E57457E7C"))} 
   53         #return {0: ApplicationKey(secrets.token_bytes(16))}
   54 

[michallowasrzechonek-silvair]

Ah, yes. With token_bytes, you return a different key each time this property is accessed. The value needs to be stable!

[ddovnar]

So, where I can get actually device key for my node?

[ddovnar]

I found folder with my node in the:

/var/lib/bluetooth/mesh/6f401c7a800551bfa156fa45ec80918f

In this folder, present only dev_keys subfolder
node.json contain device_key info:

"IVindex":0,
  "IVupdate":0,
  "unicastAddress":"0001",
  "token":"2351662141db323c",
  "deviceKey":"21bf680bfc9ce19efb51498f686d6be2",
  "netKeys":[
    {
      "index":0,
      "key":"ce1c1369a3b3389e4c53a961332a1a65",
      "keyRefresh":0
    }
  ],

I set this device_key to my application:

   40     @property
   41     def dev_key(self):
   42         return DeviceKey(bytes.fromhex("21bf680bfc9ce19efb51498f686d6be2"))

After that, I get another error:

<bluetooth_mesh.interfaces.NodeInterface object at 0xb4ca4e10>
DEBUG:Application.Element0.ConfigClient:Dev message received: 0001 [remote False, net_index 0] Container(opcode=<ConfigOpcode.CONFIG_APPKEY_STATUS: 32771>, config_appkey_status=Container(status=<StatusCode.SUCCESS: 0>, app_key_index=0, net_key_index=0))
Add app key done
INFO:Application:Unregistering application
Traceback (most recent call last):
  File "blemesh.py", line 145, in <module>
    main()
  File "blemesh.py", line 140, in main
    loop.run_until_complete(app.run(addr))
  File "/usr/lib/python3.7/asyncio/base_events.py", line 584, in run_until_complete
    return future.result()
  File "blemesh.py", line 107, in run
    await self.configure()
  File "blemesh.py", line 82, in configure
    'Cannot add application key: %s' % status
TypeError: not all arguments converted during string formatting

[ddovnar]

It's work, when I comment check status code:

        status = await client.add_app_key(
   73             self.addr, net_index=0,
   74             app_key_index=0,
   75             net_key_index=0,
   76             app_key=self.app_keys[0]
   77         )
   78 
   79         print("Add app key done:",status)
   80 
   81         #assert status == StatusCode.SUCCESS, \
   82         #    'Cannot add application key: %s' % status

In the status variable, function return AppKeyStatus object, not a code. It seem's that skeleton.py is may be very old version

[michallowasrzechonek-silvair]

Ah, it might be... we haven't updated the documentation in a long time. Happy to accept a PR, though ;)

I'm glad you figured it out!

[ddovnar]

I have another problem. I need create custom VendorModel with id "0x00024321", but this value is more than UINT16.

ERROR:root:An exception ocurred when emitting ObjectManager.InterfacesAdded for org.bluez.mesh.Element1. Some properties will not be included in the signal.
Traceback (most recent call last):
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/message_bus.py", line 227, in get_properties_callback
    raise e
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/service.py", line 539, in get_property_callback
    result[prop.name] = Variant(prop.signature, value)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 409, in __init__
    signature_type.verify(value)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 291, in verify
    self._verify_array(body)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 230, in _verify_array
    child_type.verify(member)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 293, in verify
    self._verify_struct(body)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 244, in _verify_struct
    self.children[i].verify(member)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 271, in verify
    self._verify_uint16(body)
  File "/usr/local/lib/python3.7/dist-packages/dbus_next/signature.py", line 137, in _verify_uint16
    f'DBus UINT16 type "q" must be between {UINT16_MIN} and {UINT16_MAX}')
dbus_next.errors.SignatureBodyMismatchError: DBus UINT16 type "q" must be between 0 and 65535

[diocorreia]

@ddovnar When you declare your custom VendorModel in models.py, you must set MODEL_ID with a tuple (VendorID, ModelID).