Class MatterDevice

constructor

• new MatterDevice(sessionStorage, fabricStorage, getCommissioningConfig, minimumCaseSessionsPerFabricAndNode, commissioningChangedCallback, sessionChangedCallback, sessionParameters?): MatterDevice

• Parameters

  • sessionStorage: StorageContext<any>
  • fabricStorage: StorageContext<any>
  • getCommissioningConfig: (() => Configuration)
    • • (): Configuration

      • Returns Configuration

  • minimumCaseSessionsPerFabricAndNode: number
  • commissioningChangedCallback: ((fabricIndex: FabricIndex, fabricAction: FabricAction) => void)
    • • (fabricIndex, fabricAction): void

      • Parameters

        • fabricIndex: FabricIndex
        • fabricAction: FabricAction

        Returns void

  • sessionChangedCallback: ((fabricIndex: FabricIndex) => void)
    • • (fabricIndex): void

      • Parameters

        • fabricIndex: FabricIndex

        Returns void

  • sessionParameters: Partial<SessionParameters> = {}

  Returns MatterDevice

ReadonlyfabricStorage

ReadonlysessionStorage

advertiser

• get advertiser(): DeviceAdvertiser

• Returns DeviceAdvertiser

commissioner

• get commissioner(): DeviceCommissioner

• Returns DeviceCommissioner

construction

• get construction(): Construction<MatterDevice>

• Returns Construction<MatterDevice>

exchangeManager

• get exchangeManager(): ExchangeManager

• Returns ExchangeManager

fabricManager

• get fabricManager(): FabricManager

• Returns FabricManager

failsafeContext

• get failsafeContext(): FailsafeContext

• Returns FailsafeContext

isClosing

• get isClosing(): boolean

• Returns boolean

sessionManager

• get sessionManager(): SessionManager

• Returns SessionManager

addBroadcaster

• addBroadcaster(broadcaster): MatterDevice

• Parameters

  • broadcaster: InstanceBroadcaster

  Returns MatterDevice

addProtocolHandler

• addProtocolHandler(protocol): MatterDevice

• Parameters

  • protocol: ProtocolHandler

  Returns MatterDevice

addTransportInterface

• addTransportInterface(transport): MatterDevice

• Parameters

  • transport: TransportInterface

  Returns MatterDevice

allowBasicCommissioning

• allowBasicCommissioning(commissioningEndCallback?): Promise<void>

• Parameters

  • OptionalcommissioningEndCallback: (() => void)
    • • (): void

      • Returns void

  Returns Promise<void>

allowEnhancedCommissioning

• allowEnhancedCommissioning(discriminator, paseServer, commissioningEndCallback): Promise<void>

• Parameters

  • discriminator: number
  • paseServer: PaseServer
  • commissioningEndCallback: (() => void)
    • • (): void

      • Returns void

  Returns Promise<void>

announce

• announce(announceOnce?): Promise<void>

• Parameters

  • announceOnce: boolean = false

  Returns Promise<void>

assertFailSafeArmed

• assertFailSafeArmed(message?): void

• Parameters

  • Optionalmessage: string

  Returns void

beginTimed

• beginTimed(failsafeContext): Promise<void>

• Parameters

  • failsafeContext: FailsafeContext

  Returns Promise<void>

close

• close(): Promise<void>

• Returns Promise<void>

deleteBroadcaster

• deleteBroadcaster(broadcaster): Promise<void>

• Parameters

  • broadcaster: InstanceBroadcaster

  Returns Promise<void>

deleteTransportInterface

• deleteTransportInterface(transport): Promise<void>

• Parameters

  • transport: TransportInterface

  Returns Promise<void>

endCommissioning

• endCommissioning(): Promise<void>

• Returns Promise<void>

existsOpenPaseSession

• existsOpenPaseSession(): boolean

• Returns boolean

findFabricFromDestinationId

• findFabricFromDestinationId(destinationId, peerRandom): Fabric

• Parameters

  • destinationId: Uint8Array
  • peerRandom: Uint8Array

  Returns Fabric

getActiveSessionInformation

• getActiveSessionInformation(): {
      fabric: undefined | ExposedFabricInformation;
      isPeerActive: boolean;
      lastActiveTimestamp: undefined | number;
      lastInteractionTimestamp: undefined | number;
      name: string;
      nodeId: NodeId;
      numberOfActiveSubscriptions: number;
      peerNodeId: NodeId;
      secure: boolean;
  }[]

• Returns {
      fabric: undefined | ExposedFabricInformation;
      isPeerActive: boolean;
      lastActiveTimestamp: undefined | number;
      lastInteractionTimestamp: undefined | number;
      name: string;
      nodeId: NodeId;
      numberOfActiveSubscriptions: number;
      peerNodeId: NodeId;
      secure: boolean;
  }[]

getFabricByIndex

• getFabricByIndex(fabricIndex): undefined | Fabric

• Parameters

  • fabricIndex: FabricIndex

  Returns undefined | Fabric

getFabrics

• getFabrics(): Fabric[]

• Returns Fabric[]

hasBroadcaster

• hasBroadcaster(broadcaster): boolean

• Parameters

  • broadcaster: InstanceBroadcaster

  Returns boolean

hasProtocolHandler

• hasProtocolHandler(protocolId): boolean

• Parameters

  • protocolId: number

  Returns boolean

initiateExchange

• initiateExchange(address, protocolId): MessageExchange

• Parameters

  • address: PeerAddress
  • protocolId: number

  Returns MessageExchange

isCommissioned

• isCommissioned(): boolean

• Returns boolean

isFailsafeArmed

• isFailsafeArmed(): boolean

• Returns boolean

reAnnounceAsCommissionable

• reAnnounceAsCommissionable(): void

• Returns void

sendFabricAnnouncements

• sendFabricAnnouncements(fabrics, expireCommissioningAnnouncement?): Promise<void>

• Parameters

  • fabrics: Fabric[]
  • expireCommissioningAnnouncement: boolean = false

  Returns Promise<void>

start

• start(): Promise<void>

• Returns Promise<void>

startAnnouncement

• startAnnouncement(): Promise<void>

• Returns Promise<void>

Staticcreate

• create(sessionStorage, fabricStorage, getCommissioningConfig, minimumCaseSessionsPerFabricAndNode?, commissioningChangedCallback, sessionChangedCallback, sessionParameters?): Promise<MatterDevice>

• Parameters

  • sessionStorage: StorageContext<any>
  • fabricStorage: StorageContext<any>
  • getCommissioningConfig: (() => Configuration)
    • • (): Configuration

      • Returns Configuration

  • minimumCaseSessionsPerFabricAndNode: number = 3
  • commissioningChangedCallback: ((fabricIndex: FabricIndex, fabricAction: FabricAction) => void)
    • • (fabricIndex, fabricAction): void

      • Parameters

        • fabricIndex: FabricIndex
        • fabricAction: FabricAction

        Returns void

  • sessionChangedCallback: ((fabricIndex: FabricIndex) => void)
    • • (fabricIndex): void

      • Parameters

        • fabricIndex: FabricIndex

        Returns void

  • OptionalsessionParameters: Partial<SessionParameters>

  Returns Promise<MatterDevice>

Staticof

• of(session): MatterDevice

• Parameters

  • session: undefined | Session

  Returns MatterDevice