struct Matter::MDNS::CommissionableServiceDescription

• Matter::MDNS::CommissionableServiceDescription
• Struct
• Value
• Object

Overview

Service description for a commissionable Matter device

Contains all information needed to advertise the device via mDNS

Defined in:

Constructors

• .new(name : String, device_type : UInt32, vendor_id : UInt16, product_id : UInt16, discriminator : UInt16, mode : Matter::MDNS::CommissioningMode, pairing_hint : Matter::MDNS::PairingHint | Nil = nil, pairing_instructions : Nil | String = nil, session_idle_interval_ms : UInt32 | Nil = nil, session_active_interval_ms : UInt32 | Nil = nil, session_active_threshold_ms : UInt16 | Nil = nil, tcp_supported : Bool = false, icd_operating_mode : UInt8 | Nil = nil)

Instance Method Summary

• #device_type : UInt32

  Device type (DT field) - e.g., 1 for Light, 2 for Switch

• #device_type=(device_type : UInt32)

  Device type (DT field) - e.g., 1 for Light, 2 for Switch

• #discriminator : UInt16

  Discriminator (D field) - 12-bit value (0-4095)

• #discriminator=(discriminator : UInt16)

  Discriminator (D field) - 12-bit value (0-4095)

• #icd_operating_mode : UInt8 | Nil

  ICD (Intermittently Connected Device) operating mode - optional

• #icd_operating_mode=(icd_operating_mode : UInt8 | Nil)

  ICD (Intermittently Connected Device) operating mode - optional

• #long_discriminator : UInt16

  Get long discriminator (full 12-bit value)

• #mode : CommissioningMode

  Commissioning mode (CM field)

• #mode=(mode : CommissioningMode)

  Commissioning mode (CM field)

• #name : String

  Device name (DN field)

• #name=(name : String)

  Device name (DN field)

• #pairing_hint : PairingHint | Nil

  Pairing hint (PH field) - optional

• #pairing_hint=(pairing_hint : PairingHint | Nil)

  Pairing hint (PH field) - optional

• #pairing_instructions : String | Nil

  Pairing instructions (PI field) - optional, required if PH has certain bits

• #pairing_instructions=(pairing_instructions : String | Nil)

  Pairing instructions (PI field) - optional, required if PH has certain bits

• #product_id : UInt16

  Product ID (part of VP field)

• #product_id=(product_id : UInt16)

  Product ID (part of VP field)

• #session_active_interval_ms : UInt32 | Nil

  Session Active Interval in milliseconds (SAI field) - optional

• #session_active_interval_ms=(session_active_interval_ms : UInt32 | Nil)

  Session Active Interval in milliseconds (SAI field) - optional

• #session_active_threshold_ms : UInt16 | Nil

  Session Active Threshold in milliseconds (SAT field) - optional

• #session_active_threshold_ms=(session_active_threshold_ms : UInt16 | Nil)

  Session Active Threshold in milliseconds (SAT field) - optional

• #session_idle_interval_ms : UInt32 | Nil

  Session Idle Interval in milliseconds (SII field) - optional

• #session_idle_interval_ms=(session_idle_interval_ms : UInt32 | Nil)

  Session Idle Interval in milliseconds (SII field) - optional

• #short_discriminator : UInt8

  Get short discriminator (upper 4 bits of 12-bit discriminator)

• #tcp_supported : Bool

  TCP support (T field) - optional

• #tcp_supported=(tcp_supported : Bool)

  TCP support (T field) - optional

• #vendor_id : UInt16

  Vendor ID (part of VP field)

• #vendor_id=(vendor_id : UInt16)

  Vendor ID (part of VP field)

• #vendor_product : String

  Generate VP field value (vendor+product ID)

Constructor Detail

Instance Method Detail