struct

Matter::MDNS::CommissionableServiceDescription

Inherits Struct < Value < Object

Service description for a commissionable Matter device

Contains all information needed to advertise the device via mDNS

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)
Source

Instance methods

device_type

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

Source
device_type=(device_type : UInt32)

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

Source
discriminator

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

Source
discriminator=(discriminator : UInt16)

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

Source
icd_operating_mode

ICD (Intermittently Connected Device) operating mode - optional

Source
icd_operating_mode=(icd_operating_mode : UInt8 | Nil)

ICD (Intermittently Connected Device) operating mode - optional

Source
long_discriminator

Get long discriminator (full 12-bit value)

Source
mode

Commissioning mode (CM field)

Source
mode=(mode : CommissioningMode)

Commissioning mode (CM field)

Source
name

Device name (DN field)

Source
name=(name : String)

Device name (DN field)

Source
pairing_hint

Pairing hint (PH field) - optional

Source
pairing_hint=(pairing_hint : PairingHint | Nil)

Pairing hint (PH field) - optional

Source
pairing_instructions

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

Source
pairing_instructions=(pairing_instructions : String | Nil)

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

Source
product_id

Product ID (part of VP field)

Source
product_id=(product_id : UInt16)

Product ID (part of VP field)

Source
session_active_interval_ms

Session Active Interval in milliseconds (SAI field) - optional

Source
session_active_interval_ms=(session_active_interval_ms : UInt32 | Nil)

Session Active Interval in milliseconds (SAI field) - optional

Source
session_active_threshold_ms

Session Active Threshold in milliseconds (SAT field) - optional

Source
session_active_threshold_ms=(session_active_threshold_ms : UInt16 | Nil)

Session Active Threshold in milliseconds (SAT field) - optional

Source
session_idle_interval_ms

Session Idle Interval in milliseconds (SII field) - optional

Source
session_idle_interval_ms=(session_idle_interval_ms : UInt32 | Nil)

Session Idle Interval in milliseconds (SII field) - optional

Source
short_discriminator

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

Source
tcp_supported=(tcp_supported : Bool)

TCP support (T field) - optional

Source
tcp_supported?

TCP support (T field) - optional

Source
vendor_id

Vendor ID (part of VP field)

Source
vendor_id=(vendor_id : UInt16)

Vendor ID (part of VP field)

Source
vendor_product

Generate VP field value (vendor+product ID)

Source