neuron/plugins/mqtt/azure-iot.json

{
  "device-id": {
    "name": "Device ID",
    "name_zh": "设备 ID",
    "description": "Azure IoT device ID, used as MQTT client id",
    "description_zh": "Azure IoT 设备 ID，MQTT 客户端 ID",
    "type": "string",
    "attribute": "required",
    "valid": {
      "length": 255
    }
  },
  "qos": {
    "name": "QoS Level",
    "name_zh": "QoS 等级",
    "description": "MQTT QoS level for message delivery",
    "description_zh": "MQTT 消息传输使用的服务质量等级",
    "type": "map",
    "attribute": "optional",
    "default": 0,
    "valid": {
      "map": [
        {
          "key": "QoS 0",
          "value": 0
        },
        {
          "key": "QoS 1",
          "value": 1
        }
      ]
    }
  },
  "format": {
    "name": "Upload Format",
    "name_zh": "上报数据格式",
    "description": "JSON format of the data reported. In values-mode, data are split into `values` and `errors` sub objects. In tags-mode, tag data are put in a single array.",
    "description_zh": "上报数据的 JSON 格式。在 values-format 格式下，数据被分为 `values` 和 `errors` 两个子对象。在 tags-format 格式下，数据被放在一个数组中。",
    "attribute": "required",
    "type": "map",
    "default": 0,
    "valid": {
      "map": [
        {
          "key": "values-format",
          "value": 0
        },
        {
          "key": "tags-format",
          "value": 1
        }
      ]
    }
  },
  "offline-cache": {
    "name": "Offline Data Caching",
    "name_zh": "离线缓存",
    "description": "Offline caching switch. Cache MQTT messages when offline, and sync cached messages when back online.",
    "description_zh": "离线缓存开关。连接断开时缓存 MQTT 消息，连接重建时同步缓存的 MQTT 消息到服务器。",
    "attribute": "optional",
    "type": "bool",
    "default": false,
    "valid": {}
  },
  "cache-mem-size": {
    "name": "Cache Memory Size (MB)",
    "name_zh": "缓存内存大小（MB）",
    "description": "Max in-memory cache size in megabytes when MQTT connection exception occurs. Should be smaller than cache disk size.",
    "description_zh": "当 MQTT 连接异常时，最大的内存缓存大小（单位：MB）。应该小于缓存磁盘大小。",
    "type": "int",
    "attribute": "required",
    "condition": {
      "field": "offline-cache",
      "value": true
    },
    "valid": {
      "min": 1,
      "max": 1024
    }
  },
  "cache-disk-size": {
    "name": "Cache Disk Size (MB)",
    "name_zh": "缓存磁盘大小（MB）",
    "description": "Max in-disk cache size in megabytes when MQTT connection exception occurs. Should be larger than cache memory size. If nonzero, cache memory size should also be nonzero.",
    "description_zh": "当 MQTT 连接异常时，最大的磁盘缓存大小（单位：MB）。应该大于缓存内存大小。如果不为 0，缓存内存大小也应该不为 0。",
    "type": "int",
    "attribute": "required",
    "condition": {
      "field": "offline-cache",
      "value": true
    },
    "valid": {
      "min": 1,
      "max": 10240
    }
  },
  "cache-sync-interval": {
    "name": "Cache Sync Interval (MS)",
    "name_zh": "缓存消息重传间隔（MS）",
    "description": "Interval in milliseconds at which cached messages are synced to the broker once the connection is restored.",
    "description_zh": "连接恢复后缓存消息向服务端重传的时间间隔（单位：毫秒）。",
    "type": "int",
    "attribute": "required",
    "condition": {
      "field": "offline-cache",
      "value": true
    },
    "default": 100,
    "valid": {
      "min": 10,
      "max": 120000
    }
  },
  "host": {
    "name": "IoT Hub Hostname",
    "name_zh": "IoT 中心域名",
    "description": "Azure IoT Hub full CName",
    "description_zh": "Azure IoT 中心域名",
    "attribute": "required",
    "type": "string",
    "valid": {
      "length": 255
    }
  },
  "auth": {
    "name": "Authentication",
    "name_zh": "身份验证",
    "description": "Device authentication method, uses SAS or X.509 certificates",
    "description_zh": "设备身份验证方式",
    "attribute": "required",
    "type": "map",
    "default": 0,
    "valid": {
      "map": [
        {
          "key": "Shared Access Signature",
          "value": 0
        },
        {
          "key": "X.509 Certificates",
          "value": 1
        }
      ]
    }
  },
  "sas": {
    "name": "SAS Token",
    "name_zh": "SAS 令牌",
    "description": "Azure IoT Hub shared access signature (SAS) token",
    "description_zh": "Azure IoT 中心共享访问签名 (SAS) 令牌",
    "attribute": "required",
    "type": "string",
    "condition": {
      "field": "auth",
      "value": 0
    },
    "valid": {
      "length": 255
    }
  },
  "ca": {
    "name": "CA",
    "name_zh": "CA 证书",
    "description": "CA certificate which signs the server certificate",
    "description_zh": "签发服务器证书的 CA 证书",
    "attribute": "required",
    "type": "file",
    "valid": {
      "length": 81960
    }
  },
  "cert": {
    "name": "Device Certificate",
    "name_zh": "设备证书",
    "description": "Client x509 certificate when using two way authentication",
    "description_zh": "使用双向认证时，客户端的 x509 证书",
    "attribute": "required",
    "type": "file",
    "condition": {
      "field": "auth",
      "value": 1
    },
    "valid": {
      "length": 81960
    }
  },
  "key": {
    "name": "Device Private Key",
    "name_zh": "设备私钥",
    "description": "Client private key when using two way authentication",
    "description_zh": "使用双向认证时，客户端的私钥",
    "attribute": "required",
    "type": "file",
    "condition": {
      "field": "auth",
      "value": 1
    },
    "valid": {
      "length": 81960
    }
  }
}