Please enable JavaScript to view this site.

HsM Reference Manual

Navigation:  Neutral backend infrastructure > Catalog Service

Device-types

A device-type in HsM serves as the fundamental blueprint for digital twins of a particular group of physically produced devices. Just as a car model (like a Toyota Corolla) represents a specific design and function within a brand's lineup, a device-type represents a specific category and features within HsM.

Amongst other things, a device-type defines the framework for a device by specifying placeholders for components, indicating which component-types can be integrated. Each physical device of a specific device-type may be produced with different components from the outset, and those components can also be replaced with others of other component-types at a later stage. As a result, the physical, electronic, and digital characteristics of a device are determined by the actual components used, meaning they are not necessarily fixed or derivable solely from the device-type.

When a digital twin is created in the Digital Twin Service the device-type of that digital twin is set and is immutable thereafter.

Device-types are not sales items, as multiple sales items can actually represent the same device-type.

The device-type Id is not printed on devices but can only be inferred via the Digital Twin Service using an identifying characteristic of a component of the device.

Attribute

Description

Device-type ID

UUID, mandatory.

The unique identifier of this device-type.

Name

Multilingual string, mandatory

A human-readable name for the device-type, provided in multiple languages. E.g. Disinfect dispenser.

Version

Date-time, mandatory.

The version equals the date when the device-type definition in the Catalog Service was last changed. This can be used for clients to invalidate local cached catalog information.

Date-time is given in UTC.

Tags

Device-types can be tagged. One device-type can have multiple tags.

Image

A symbolic image for the device-type. This image is actually the image of the default device-type variant.

The image images stored and delivered in different resolutions.

Variants

A list of device-type variants for a device-type. Each device-type has at least one variant.

Table 3:  Attributes of device-type stored with the Catalog Service