Previous Topic

Next Topic

Book Contents

Book Index

API Constants Mapping

This section provides information about the mapping between API constants for the HomeDevice and Device interfaces.

HomeDevice Constant

Device Constant

Notes

UID

UID

Mapped to the FunctionalItem's UID predefined property and as a FI global unique identifier in the system.

NAME

NAME

Mapped to the FunctionalItem's name predefined property.

STATUS

STATUS

The concrete device status constants are grouped into the enum DeviceStatus that contains as enum values of all possible device statuses.

VENDOR

HARDWARE_VENDOR

 

VERSION

HARDWARE_VERSION

 

TIMESTAMP_ADDED

TIMESTAMP_CREATED

Defined as a Functional Item property with access 'R'.

ADAPTER

ADAPTER_NAME

Used as a Functional Item registration property and an attribute of the Functional Item attributes of the device.

DEVICE_CLASSES

N/A

This HDM constant has no representation in the Device interface. The functionalities of a device are represented as Functional Items.

PARENT_UID

N/A

This HDM constant has no representation in the Device interface. The new device representation structure is a flat model without parent-child hierarchy.

TYPE

N/A

This HDM constant has no representation in the Device interface. The device type can be represented as a Functional Item attribute.

MODEL

MODEL

 

CONTROLLER

N/A

This HDM constant has no representation in the Device interface.

CONTROLLER_ID

N/A

This HDM constant has no representation in the Device interface.

SECURE

SECURE

The type of the value in the Device interface is changed to Boolean.

SERIAL_NUMBER

SERIAL_NUMBER

 

FIRMWARE_VENDOR

FIRMWARE_VENDOR

 

FIRMWARE_VERSION

FIRMWARE_VERSION

 

ERROR_CORE

N/A

The HDM error code along with the error message are mapped to the Device ERROR property. It holds both of them and is defined as a device functional items property.

ERROR_MESSAGE

N/A

The HDM error message along with the error code are mapped to the Device ERROR property. It holds the both of them and it is defined as a device Functional Item property.