Issues with Registering Devices

[craigmulligan]

If I query all devices via /api/protocols/devices

it returns an object like this:

{
    "id": "B0:B4:48:BD:10:85",
    "protocol": "iot.agile.protocol.BLE",
    "name": "CC2650 SensorTag",
    "status": "AVAILABLE"
  }

However it appears to register a device a stream object needs to present. Eg. this doesn't work:

{
"deviceId": "",
"address": "B0:B4:48:BE:7D:83",
"name": "CC2650 SensorTag",
"description": "",
"protocol": "iot.agile.protocol.BLE",
"path": ""
}

In my opinion, you should be able to post back an unregistered device object recieved from /api/protocols/devices but the current registration endpoint requires other attributes like address and a blank deviceId instead of id.

Thoughts?

[cskiraly]

I agree. We have it in the queue. This is how I see it on the long term:

• a method in device menager, that gets the description you get from PM (your first one), and gives you back possible Device TYPES. I.e., it tells you that this could be a SensorTag v1 or a SensorTag v2. If there is only 1 option, you an already create it, just by bumping back the original description and the type. If instead there are more possible types, you should make the user choose, and then create.

Anyway, you, as the API user, should NOT support the streams and the empty ID.

[craigmulligan]

You still need to pass an id attribute and an streams array.

[cskiraly]

I was not overriding the old "POST /devices" , but created a new under "POST /devices/register". We can deprecate the old one, as I think it is not useful and no one is using it anymore, and change "POST /devices" it to the new syntax.

[craigmulligan]

Oh I see, could you clarify what exactly needs to be posted? When I post the following to /devices/register as per the swagger example.

{
  "name": "C2650 SensorTag",
  "protocol": "iot.agile.protocol.BLE",
  "id": "B0:B4:48:BD:10:85",
  "status": "CONNECTED"
}

It returns an 400 err:

Unrecognized field "name" (class iot.agile.http.resource.DeviceManager$RegisterArgs), not marked as ignorable (2 known properties: "overview", "type"])
 at [Source: org.glassfish.jersey.message.internal.ReaderInterceptorExecutor$UnCloseableInputStream@17aaa47; line: 6, column: 2] (through reference chain: iot.agile.http.resource.RegisterArgs["name"])

[cskiraly]

My bad, I still struggle with getting the right syntax out of swagger. What you need is: { "overview": { "name": "C2650 SensorTag", "protocol": "iot.agile.protocol.BLE", "id": "B0:B4:48:BD:10:85", "status": "CONNECTED" } "type": "TI SensorTag" }

The value of type you are supposed to get from /api/devices/typof to which you first pass the overview. This returns an array of possible types. If there is only one, you can use that, if there are more, someone should decide which implementation to use.

[cskiraly]

I think I'm missing a "," above

{ "overview": { "name": "C2650 SensorTag", "protocol": "iot.agile.protocol.BLE", "id": "B0:B4:48:BD:10:85", "status": "CONNECTED" }, "type": "TI SensorTag" }

[craigmulligan]

Ah thanks, Could you elaborate on the /api/devices/typof call, there aren't any docs.

[craigmulligan]

What is the type used for?

[cskiraly]

argh. typo. /api/devices/typeof This is the device type. When you register a device, you should be able to tell what it is, since it cannot always be autodetected. The workflow is:

• ask for possible types using /api/devices/typeof
• select the one you think fits best
• register the device specifying the type

[craigmulligan]

I tried typeof too but still failing - see issue #35

[cskiraly]

The swagger documented version is working now. See: http://petstore.swagger.io/?url=http://agile-iot.github.io/agile-api-spec/docs/swagger/api.swagger.yml#!/DeviceManager/TypeOf http://petstore.swagger.io/?url=http://agile-iot.github.io/agile-api-spec/docs/swagger/api.swagger.yml#!/DeviceManager/Register

Note that:

• we have removed the old way of creating devices
• you should create a device with a simple POST of the DeviceOverview and type to /devices. /devices/register still works, but it is deprecated.
• /typeof is a POST now. GET still works but deprecated.