Comodule SDK/com.comodule.bluetooth.property/CmPropertyInfo

CmPropertyInfo

sealed interface CmPropertyInfo

Defines the metadata for a module property, including its identifier, variant, and the type of access permitted.

Inheritors

Types

Link copied to clipboard
data class Range : CmPropertyInfo

Represents metadata for a property with a numerical range value.

Link copied to clipboard
data class Raw : CmPropertyInfo

Represents metadata for a property with a raw bytes value.

Link copied to clipboard
data class States : CmPropertyInfo

Represents metadata for a property with predefined states.

Properties

Link copied to clipboard
abstract val accessType: CmAccessType

The CmAccessType, defining whether the property is read-only, write-only or read-write. Comes with associated relevant read and/or write data for the property type.

Link copied to clipboard
abstract val identifier: String

A unique string identifying the property.

Link copied to clipboard
abstract val variant: String?

An optional string providing additional differentiation between properties. In case of multiple vehicle types, variant is used to distinguish between same properties of multiple vehicles that are handled differently. The value is usually agreed between implementer and Comodule.