Extend dump to include full deviceclass object

[marcelveldt]

BREAKING CHANGE

DeviceClass strings tend to change sometimes which is annoying as our discovery scheme in HA depends a lot on these deviceclass id's.

This change replaces the deviceClass to a full object containing both the key and label.

Discussed with @MartinHjelmare that we should do this breaking change before HA beta release (and adjust both integration and the lib for this change).

Closes #76
Closes #75

The dump will look like this after this change:

"deviceClass": {
            "basic": {
              "key": 2,
              "label": "Static Controller"
            },
            "generic": {
              "key": 2,
              "label": "Static Controller"
            },
            "specific": {
              "key": 1,
              "label": "PC Controller"
            },
            "mandatorySupportedCCs": [
              
            ],
            "mandatoryControlledCCs": [
              32
            ]
          },

[MartinHjelmare]

What's the reason for not including the full state as described here?
https://zwave-js.github.io/node-zwave-js/#/api/node?id=deviceclass

[marcelveldt]

Well because we will have to replicate that entire object and no use ?

[marcelveldt]

Like just discussed on discord with @AlCalzone the json serializations of most objects only return the string/label so we need to dump each individual object

[MartinHjelmare]

Ok.

[marcelveldt]

also included the list of supported commandClasses in the dump, this fixes #75

"commandClasses": [
            {
              "id": 48,
              "name": "Binary Sensor",
              "version": 2,
              "isSecure": false
            },
            {
              "id": 89,
              "name": "Association Group Information",
              "version": 1,
              "isSecure": false
            },
            {
              "id": 90,
              "name": "Device Reset Locally",
              "version": 1,
              "isSecure": false
            },
            {
              "id": 94,
              "name": "Z-Wave Plus Info",
              "version": 2,
              "isSecure": false
            },
            {
              "id": 112,
              "name": "Configuration",
              "version": 1,
              "isSecure": false
            },
            {
              "id": 113,
              "name": "Notification",
              "version": 8,
              "isSecure": false
            },
            {
              "id": 114,
              "name": "Manufacturer Specific",
              "version": 2,
              "isSecure": false
            },
            {
              "id": 128,
              "name": "Battery",
              "version": 1,
              "isSecure": false
            },
            {
              "id": 132,
              "name": "Wake Up",
              "version": 2,
              "isSecure": false
            },
            {
              "id": 133,
              "name": "Association",
              "version": 2,
              "isSecure": false
            },
            {
              "id": 134,
              "name": "Version",
              "version": 2,
              "isSecure": false
            }
          ],

[marcelveldt]

If we miss any values we can add it to the (custom) state object too.

[AlCalzone]

I guess whether this CC is secure or not is of no interest to HA, but it could be useful for debugging.

[marcelveldt]

I guess whether this CC is secure or not is of no interest to HA, but it could be useful for debugging.

I can add it. How to access it from the CommandClass instance ?

[marcelveldt]

nvm, got it

[AlCalzone]

The empty interfaces look a bit weird (I'd use plain types for that). Otherwise LGTM

[marcelveldt]

The empty interfaces look a bit weird (I'd use plain types for that). Otherwise LGTM

Yeah, we tend to override/extend from the original interfaces so it will break (intentionally) when upstream changes so we keep up with the changes instead of things silently breaking. But if you have any good ideas to deal with it, let me know!

[AlCalzone]

I mean instead of

interface Foo extends SomeGeneric<Bar> {}

I'd do

type Foo = SomeGeneric<Bar>

[marcelveldt]

@AlCalzone adjusted it.