DeviceGetSchema

Kind

• kind: string (Required)
  The kind of record.

Metadata

• metadata: object MetadataSchema (Required)
  Device metadata.

Properties

• created: string (Optional)
  format: date-time
  The time when the resource was created
• createdBy: string (Optional)
  format: uuid
  ID of the user who created the resource
• createdByEmail: string (Optional)
  Email of the user who created the resource
• displayName: string (Optional)
  The display name of the resource
• id: string (Required)
  format: uuid
  The ID of the resource
• labels: map from strings to string (Optional)
  A dictionary of labels associated with the resource
• name: string (Optional)
  The name of the resource
• updated: string (Optional)
  format: date-time
  The time when the resource was last updated
• updatedBy: string (Optional)
  format: uuid
  ID of the user who last updated the resource
• updatedByEmail: string (Optional)
  Email of the user who last updated the resource
• spec: object DeviceBodySpec (Required)
  Device specification.

Specification Properties

• autoPreloadLatestSoftware: boolean (Optional)
  Defaults to false
  Whether the device should automatically preload the latest available software version.
• availableNetworks: list of objects AvailableNetworkFragment (Required)
  The list of networks available to the device and, optionally, the interfaces they are connected to.
  • interfaceName: string (Required)
    pattern: [^\s/] {1,16}
    The name of the device interface that will be connected to the network.
  • networkName: string (Required)
    pattern: ^a-z0-9?$
    The name of the network that will be made available to this device.
• desiredSoftwareVersion: string (Optional)
  <=255 characters
  The desired version of software that should be running on the device.
• geolocation: object GeolocationFragment (Optional)
  • coordinates: list of doubles (Required)
    An array of two floating point numbers [latitude(North - South), longitude(East - West)]. Set an empty array to clear the geolocation.
  • locationId: string (Optional)
    pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    The location id is the identity of the actual device associated with this record.
• preloadSoftwareVersion: string (Optional)
  <=255 characters
  A version of the software that should be preloaded on the device.
• shortCode: string (Optional)
  8-8 characters
  The short code from a device's web user interface, used to onboard the device.
• siteName: string (Optional)
  pattern: ^(a-z0-9?)?$
  The name of the site where the device is located.
• status: object DeviceStatusGetSchema (Required)
  Device status.

Status Properties

• alarmSeverity: enum (Optional)
  The most severe alarm level last reported by the device.
  • 0 - Clear
  • 1 - Info
  • 2 - Warning
  • 3 - Error
  • 4 - Critical
• assignedFlows: list of objects AssignedFlowGetSchema (Optional)
  The list of the flow names assigned to the device.
  • name: string (Required)
    pattern: ^a-z0-9?$
    The name of a flow assigned to the device.
• beamHA: object BeamHASchema (Optional)
  Information about the beamHA the device is connected to.
  • activeControllerDeviceName: string (Optional)
    1-64 characters
    The name of the active controller device in the beamHA.
  • roles: list of strings (Required)
    The roles of the device in the beamHA group.
  • status: string (Optional)
    The status of the beamHA group.
  • unregisteredDevices: list of strings (Optional)
    List of location IDs of devices that are part of the beamHA but not registered.
• capabilities: object DeviceCapabilitiesSchema (Optional)
  Device capabilities based on software version and hardware.
  • configurationBackup: boolean (Optional)
    Whether the device supports configuration backup.
  • currentSoftwareVersion: string or null (Optional)
    <=255 characters
    The current software version running on the device.
  • geolocation: object GeolocationFragment (Optional)
    • coordinates: list of doubles (Required)
      Co-ordinates that describe the geolocation.
  • interfaces: list of objects DeviceInterfaceSchema (Optional)
    A list of the physical and virtual interfaces reported by the device.
• lastContact: string or null (Optional)
  The last time the device contacted the system.
• locationId: string or null (Optional)
  pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
  The location id is the identity of the actual device associated with this record.
• preloadedSoftware: list of objects or null PreloadSoftwareInfo (Optional)
  The preloaded software present on the device.