class Matter::Cluster::TimeFormatLocalizationCluster

Overview

Time Format Localization Cluster (0x002C)

Provides attributes for determining and configuring time and date formatting information that a node uses when conveying values to a user. This cluster supports both hour format (12hr/24hr) and calendar format preferences.

Features:

Specification: Matter 1.4 § 11.4

Defined in:

matter/cluster/time_format_localization_cluster.cr

Constant Summary

ATTR_ACTIVE_CALENDAR_TYPE = 1_u32
ATTR_HOUR_FORMAT = 0_u32

Attributes

ATTR_SUPPORTED_CALENDAR_TYPES = 2_u32
CLUSTER_ID = 44_u32

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Matter::Cluster::Base

apply_scene_extension_field_set(field_set : ScenesManagementCluster::ExtensionFieldSet) : Bool apply_scene_extension_field_set, attributes : Array(AttributeMetadata) attributes, cluster_id : DataType::ClusterId cluster_id, cluster_id=(cluster_id : DataType::ClusterId) cluster_id=, commands : Array(CommandMetadata) commands, data_version : UInt32 data_version, data_version=(data_version : UInt32) data_version=, endpoint_id : DataType::EndpointNumber endpoint_id, endpoint_id=(endpoint_id : DataType::EndpointNumber) endpoint_id=, events : Array(EventMetadata) events, get_attribute_metadata(attribute_id : UInt32) : AttributeMetadata | Nil get_attribute_metadata, get_command_metadata(command_id : UInt32) : CommandMetadata | Nil get_command_metadata, invoke_command(command_id : UInt32, fields : Bytes = Bytes.new(0), session_id : UInt64 | Nil = nil, is_case_session : Bool = false, fabric_index : UInt8 | Nil = nil) : InteractionModel::Status | CommandResponse invoke_command, name : String name, on_attribute_changed : Proc(UInt16, UInt32, UInt32, Nil) | Nil on_attribute_changed, on_attribute_changed=(on_attribute_changed : Proc(UInt16, UInt32, UInt32, Nil) | Nil) on_attribute_changed=, persistence_key : String persistence_key, read_attribute(attribute_id : UInt32, fabric_index : UInt8 | Nil = nil) : InteractionModel::Status | Bytes read_attribute, request_fabric_index : UInt8 | Nil request_fabric_index, request_fabric_index=(request_fabric_index : UInt8 | Nil) request_fabric_index=, request_is_case_session=(request_is_case_session : Bool) request_is_case_session=, request_is_case_session? : Bool request_is_case_session?, request_peer_node_id : UInt64 | Nil request_peer_node_id, request_peer_node_id=(request_peer_node_id : UInt64 | Nil) request_peer_node_id=, request_session_id : UInt64 | Nil request_session_id, request_session_id=(request_session_id : UInt64 | Nil) request_session_id=, restore_state(json : String) : Nil restore_state, save_state : String | Nil save_state, store_scene_extension_field_set : ScenesManagementCluster::ExtensionFieldSet | Nil store_scene_extension_field_set, write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status write_attribute

Constructor methods inherited from class Matter::Cluster::Base

new(endpoint_id : DataType::EndpointNumber, cluster_id : DataType::ClusterId) new

Constructor Detail

def self.new(endpoint_id : DataType::EndpointNumber, feature_map : Feature = Feature::None, hour_format : HourFormat = HourFormat::Hr24, active_calendar_type : CalendarType | Nil = nil, supported_calendar_types : Array(CalendarType) | Nil = nil) #

[View source]

Class Method Detail

def self.cluster_id #

Time Format Localization Cluster (0x002C)

Provides attributes for determining and configuring time and date formatting information that a node uses when conveying values to a user. This cluster supports both hour format (12hr/24hr) and calendar format preferences.

Features:

  • CalendarFormat (CALFMT): Calendar format support

Specification: Matter 1.4 § 11.4


[View source]

Instance Method Detail

def active_calendar_type : CalendarType | Nil #

Active calendar type (writable, optional - requires CalendarFormat feature)


[View source]
def active_calendar_type=(active_calendar_type : CalendarType | Nil) #

Active calendar type (writable, optional - requires CalendarFormat feature)


[View source]
def attributes : Array(AttributeMetadata) #
Description copied from class Matter::Cluster::Base

Get all attribute metadata


[View source]
def calendar_format_enabled? : Bool #

Check if CalendarFormat feature is enabled


[View source]
def commands : Array(CommandMetadata) #
Description copied from class Matter::Cluster::Base

Get all command metadata


[View source]
def feature_map : Feature #

Feature map


[View source]
def feature_map=(feature_map : Feature) #

Feature map


[View source]
def hour_format : HourFormat #

Hour format preference (writable)


[View source]
def hour_format=(hour_format : HourFormat) #

Hour format preference (writable)


[View source]
def name : String #
Description copied from class Matter::Cluster::Base

Get cluster name


[View source]
def on_calendar_changed(&block : CalendarType | Nil, CalendarType -> Nil) #

[View source]
def on_hour_format_changed(&block : HourFormat, HourFormat -> Nil) #

[View source]
def read_attribute(attribute_id : UInt32, fabric_index : UInt8 | Nil = nil) : Bytes | InteractionModel::Status #
Description copied from class Matter::Cluster::Base

Read an attribute value The fabric_index parameter is optional and used for fabric-scoped attributes like CurrentFabricIndex in OperationalCredentialsCluster


[View source]
def supported_calendar_types : Array(CalendarType) | Nil #

Supported calendar types (fixed, optional - requires CalendarFormat feature)


[View source]
def supported_calendar_types=(supported_calendar_types : Array(CalendarType) | Nil) #

Supported calendar types (fixed, optional - requires CalendarFormat feature)


[View source]
def write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status #
Description copied from class Matter::Cluster::Base

Write an attribute value


[View source]