Skip to content
View as Markdown

Device

IRI: https://w3id.org/altium/cdm/ota/Device

GRID: grid:workspace:{workspace-id}:ota:device/{id}

Device represents a physical unit registered for OTA updates. A device consists of one primary ECU and optional secondary ECUs, and may belong to fleets.

In the product

No product documentation linked yet.

Diagram

---
  config:
    layout: elk
    class:
      hideEmptyMembersBox: true
---
 classDiagram
    direction LR


  class ota_Device["Device"]






      style ota_Device fill:#d29292,stroke:#885f5f,color:#14181f,stroke-width:2.5px

    click ota_Device href "../../classes/ota_Device/"






          ota_Device : name



          ota_Device : description



          ota_Device : device id



          ota_Device : hardware id








      ota_Device --> "0..1" ota_DeviceStatus : status
      click ota_DeviceStatus href "../../enums/ota_DeviceStatus/"


  class ota_DeviceStatus["Device Status"]






      style ota_DeviceStatus fill:#d29292,stroke:#885f5f,color:#14181f,stroke-width:1px





          ota_Device : last seen at



          ota_Device : created at



          ota_Device : activated at



          ota_Device : last updated at



          ota_Device : hibernated








      ota_Device --> "*" ota_Package : packages
      click ota_Package href "../../classes/ota_Package/"


  class ota_Package["Package"]






      style ota_Package fill:#d29292,stroke:#885f5f,color:#14181f,stroke-width:1px





          ota_Device : id










  class ota_Fleet["Fleet"]






      style ota_Fleet fill:#d29292,stroke:#885f5f,color:#14181f,stroke-width:1px

          ota_Fleet --> "*" ota_Device: devices 
          click ota_Fleet href "../../classes/ota_Fleet/"






  class ota_Deployment["Deployment"]






      style ota_Deployment fill:#d29292,stroke:#885f5f,color:#14181f,stroke-width:1px

          ota_Deployment --> "0..1" ota_Device: target device 
          click ota_Deployment href "../../classes/ota_Deployment/"






  class ota_DeploymentResult["Deployment Result"]






      style ota_DeploymentResult fill:#d29292,stroke:#885f5f,color:#14181f,stroke-width:1px

          ota_DeploymentResult --> "1" ota_Device: device 
          click ota_DeploymentResult href "../../classes/ota_DeploymentResult/"



Inheritance

Fields

Name Cardinality Type Description Inheritance
id 1 GRID Globally unique identifier across the whole platform. Entity
name 0..1 string A short name of the entity. direct
description 0..1 string Free-form notes associated with the device. direct
device id 0..1 string The device-side identifier provided at provisioning. direct
hardware id 0..1 string The hardware type of the device as a whole (for example the product or board type), as reported by the provider, when provided. It is independent of the hardware identifiers of the device's ECUs, which Package.hardwareIds and DeploymentAssignment.hardwareId are matched against. direct
status 0..1 Device Status The current status of the device, set by the provider. direct
last seen at 0..1 datetime The date and time the device last connected, in UTC, set by the provider. Absent while the device has never connected. direct
created at 0..1 datetime The date and time the device was registered, in UTC, set by the provider. direct
activated at 0..1 datetime The date and time the device first connected, in UTC, set by the provider. Absent while the device has never connected. direct
last updated at 0..1 datetime The date and time the device was last updated, in UTC, set by the provider. Absent while the device has never been updated. direct
hibernated 0..1 boolean Indicates whether the device is hibernated and excluded from updates. direct
packages * Package The registered packages installed on the device, when known, referenced by their GRID. direct

Comments