Control class 1.3.1.json

{
  "description": "NcDeviceManager class descriptor",
  "classId": [
    1,
    3,
    1
  ],
  "name": "NcDeviceManager",
  "fixedRole": "DeviceManager",
  "properties": [
    {
      "description": "Version of MS-05-02 that this device uses",
      "id": {
        "level": 3,
        "index": 1
      },
      "name": "ncVersion",
      "typeName": "NcVersionCode",
      "isReadOnly": true,
      "isNullable": false,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Manufacturer descriptor",
      "id": {
        "level": 3,
        "index": 2
      },
      "name": "manufacturer",
      "typeName": "NcManufacturer",
      "isReadOnly": true,
      "isNullable": false,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Product descriptor",
      "id": {
        "level": 3,
        "index": 3
      },
      "name": "product",
      "typeName": "NcProduct",
      "isReadOnly": true,
      "isNullable": false,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Serial number",
      "id": {
        "level": 3,
        "index": 4
      },
      "name": "serialNumber",
      "typeName": "NcString",
      "isReadOnly": true,
      "isNullable": false,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Asset tracking identifier (user specified)",
      "id": {
        "level": 3,
        "index": 5
      },
      "name": "userInventoryCode",
      "typeName": "NcString",
      "isReadOnly": false,
      "isNullable": true,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Name of this device in the application. Instance name, not product name.",
      "id": {
        "level": 3,
        "index": 6
      },
      "name": "deviceName",
      "typeName": "NcString",
      "isReadOnly": false,
      "isNullable": true,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Role of this device in the application.",
      "id": {
        "level": 3,
        "index": 7
      },
      "name": "deviceRole",
      "typeName": "NcString",
      "isReadOnly": false,
      "isNullable": true,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Device operational state",
      "id": {
        "level": 3,
        "index": 8
      },
      "name": "operationalState",
      "typeName": "NcDeviceOperationalState",
      "isReadOnly": true,
      "isNullable": false,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Reason for most recent reset",
      "id": {
        "level": 3,
        "index": 9
      },
      "name": "resetCause",
      "typeName": "NcResetCause",
      "isReadOnly": true,
      "isNullable": false,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    },
    {
      "description": "Arbitrary message from dev to controller",
      "id": {
        "level": 3,
        "index": 10
      },
      "name": "message",
      "typeName": "NcString",
      "isReadOnly": true,
      "isNullable": true,
      "isSequence": false,
      "isDeprecated": false,
      "constraints": null
    }
  ],
  "methods": [],
  "events": []
}

Documentation built at 04:52:22 CDT on 2024-08-29.
(c) AMWA 2024. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.