{
  "name": "Cloud Adapter",
  "status": "experimental",
  "shortId": "cloudadapter",
  "camelName": "cloudAdapter",
  "shortName": "cloudAdapter",
  "extends": [
    "_base"
  ],
  "notes": {
    "short": "Supports cloud connections to upload and download data.\nNote that `f64` values following a label are not necessarily aligned."
  },
  "classIdentifier": 341864092,
  "enums": {},
  "constants": {},
  "packets": [
    {
      "kind": "report",
      "name": "command_not_implemented",
      "identifier": 3,
      "description": "This report may be emitted by a server in response to a command (action or register operation)\nthat it does not understand.\nThe `service_command` and `packet_crc` fields are copied from the command packet that was unhandled.\nNote that it's possible to get an ACK, followed by such an error report.",
      "fields": [
        {
          "name": "service_command",
          "type": "u16",
          "storage": 2,
          "isSimpleType": true
        },
        {
          "name": "packet_crc",
          "type": "u16",
          "storage": 2,
          "isSimpleType": true
        }
      ],
      "identifierName": "command_not_implemented",
      "packFormat": "u16 u16",
      "derived": "_base"
    },
    {
      "kind": "const",
      "name": "instance_name",
      "identifier": 265,
      "description": "A friendly name that describes the role of this service instance in the device.\nIt often corresponds to what's printed on the device:\nfor example, `A` for button A, or `S0` for servo channel 0.\nWords like `left` should be avoided because of localization issues (unless they are printed on the device).",
      "fields": [
        {
          "name": "_",
          "type": "string",
          "storage": 0
        }
      ],
      "optional": true,
      "identifierName": "instance_name",
      "packFormat": "s",
      "derived": "_base"
    },
    {
      "kind": "ro",
      "name": "status_code",
      "identifier": 259,
      "description": "Reports the current state or error status of the device. ``code`` is a standardized value from \nthe Jacdac status/error codes. ``vendor_code`` is any vendor specific error code describing the device\nstate. This report is typically not queried, when a device has an error, it will typically\nadd this report in frame along with the announce packet. If a service implements this register,\nit should also support the ``status_code_changed`` event defined below.",
      "fields": [
        {
          "name": "code",
          "type": "u16",
          "storage": 2,
          "isSimpleType": true
        },
        {
          "name": "vendor_code",
          "type": "u16",
          "storage": 2,
          "isSimpleType": true
        }
      ],
      "optional": true,
      "identifierName": "status_code",
      "packFormat": "u16 u16",
      "derived": "_base"
    },
    {
      "kind": "rw",
      "name": "client_variant",
      "identifier": 9,
      "description": "An optional register in the format of a URL query string where the client can provide hints how\nthe device twin should be rendered. If the register is not implemented, the client library can simulate the register client side.",
      "fields": [
        {
          "name": "_",
          "type": "string",
          "storage": 0
        }
      ],
      "optional": true,
      "identifierName": "client_variant",
      "packFormat": "s",
      "derived": "_base"
    },
    {
      "kind": "event",
      "name": "status_code_changed",
      "identifier": 4,
      "description": "Notifies that the status code of the service changed.",
      "fields": [
        {
          "name": "code",
          "type": "u16",
          "storage": 2,
          "isSimpleType": true
        },
        {
          "name": "vendor_code",
          "type": "u16",
          "storage": 2,
          "isSimpleType": true
        }
      ],
      "optional": true,
      "identifierName": "status_code_changed",
      "packFormat": "u16 u16",
      "derived": "_base"
    },
    {
      "kind": "command",
      "name": "upload_json",
      "identifier": 128,
      "description": "Upload a JSON-encoded message to the cloud.",
      "fields": [
        {
          "name": "topic",
          "type": "string0",
          "storage": 0
        },
        {
          "name": "json",
          "type": "string",
          "storage": 0
        }
      ],
      "packFormat": "z s"
    },
    {
      "kind": "command",
      "name": "upload_binary",
      "identifier": 129,
      "description": "Upload a binary message to the cloud.",
      "fields": [
        {
          "name": "topic",
          "type": "string0",
          "storage": 0
        },
        {
          "name": "payload",
          "type": "bytes",
          "storage": 0,
          "isSimpleType": true
        }
      ],
      "packFormat": "z b"
    },
    {
      "kind": "ro",
      "name": "connected",
      "identifier": 384,
      "description": "Indicate whether we're currently connected to the cloud server.\nWhen offline, `upload` commands are queued.",
      "fields": [
        {
          "name": "_",
          "type": "bool",
          "storage": 1
        }
      ],
      "packFormat": "u8"
    },
    {
      "kind": "ro",
      "name": "connection_name",
      "identifier": 385,
      "description": "User-friendly name of the connection, typically includes name of the server\nand/or type of cloud service (`\"something.cloud.net (Provider IoT)\"`).",
      "fields": [
        {
          "name": "_",
          "type": "string",
          "storage": 0
        }
      ],
      "packFormat": "s"
    },
    {
      "kind": "event",
      "name": "on_json",
      "identifier": 128,
      "description": "Emitted when cloud send us a JSON message.",
      "fields": [
        {
          "name": "topic",
          "type": "string0",
          "storage": 0
        },
        {
          "name": "json",
          "type": "string",
          "storage": 0
        }
      ],
      "packFormat": "z s"
    },
    {
      "kind": "event",
      "name": "on_binary",
      "identifier": 129,
      "description": "Emitted when cloud send us a binary message.",
      "fields": [
        {
          "name": "topic",
          "type": "string0",
          "storage": 0
        },
        {
          "name": "payload",
          "type": "bytes",
          "storage": 0,
          "isSimpleType": true
        }
      ],
      "packFormat": "z b"
    },
    {
      "kind": "event",
      "name": "change",
      "identifier": 3,
      "description": "Emitted when we connect or disconnect from the cloud.",
      "fields": [],
      "identifierName": "change"
    }
  ],
  "tags": [
    "infrastructure",
    "devicescript"
  ],
  "group": "Iot",
  "restricted": true
}