Class MatterServer

Main Matter server class that represents the process on the host allowing to commission and pair multiple devices by reusing MDNS scanner and broadcaster

Index

Constructors

constructor

new MatterServer(storageManager, options?): MatterServer
Create a new Matter server instance
Parameters
- storageManager: StorageManager<SyncStorage>
  Storage manager instance to use for all nodes
- Optionaloptions: MatterServerOptions
  Optional MatterServer options
Returns MatterServer
- Defined in packages/matter.js/src/MatterServer.ts:65

Accessors

ipv4Disabled

get ipv4Disabled(): boolean
Returns boolean
- Defined in packages/matter.js/src/MatterServer.ts:70

Methods

addCommissioningController

addCommissioningController(commissioningController, nodeOptions?): Promise<void>
Add a Controller node to the server
Parameters
- commissioningController: CommissioningController
  Controller node to add
- OptionalnodeOptions: NodeOptions
  Optional options for the node (e.g. unique node id)
Returns Promise<void>
- Defined in packages/matter.js/src/MatterServer.ts:174

addCommissioningServer

addCommissioningServer(commissioningServer, nodeOptions?): Promise<void>
Add a CommissioningServer node to the server
Parameters
- commissioningServer: CommissioningServer
  CommissioningServer node to add
- OptionalnodeOptions: NodeOptions
  Optional options for the node (e.g. unique node id)
Returns Promise<void>
- Defined in packages/matter.js/src/MatterServer.ts:123

close

close(): Promise<void>
Close the server and all nodes

Returns Promise<void>
- Defined in packages/matter.js/src/MatterServer.ts:262

removeCommissioningController

removeCommissioningController(commissioningController, destroyStorage?): Promise<void>
Remove a Controller node from the server, close the Controller and optionally destroy the storage context.
Parameters
- commissioningController: CommissioningController
  Controller node to remove
- destroyStorage: boolean = false
  If true the storage context will be destroyed
Returns Promise<void>
- Defined in packages/matter.js/src/MatterServer.ts:198

removeCommissioningServer

removeCommissioningServer(commissioningServer, destroyStorage?): Promise<void>
Remove a CommissioningServer node from the server, close the CommissioningServer and optionally destroy the storage context.
Parameters
- commissioningServer: CommissioningServer
  CommissioningServer node to remove
- destroyStorage: boolean = false
  If true the storage context will be destroyed
Returns Promise<void>
- Defined in packages/matter.js/src/MatterServer.ts:142

start

start(): Promise<void>
Start the server and all nodes. If the nodes do not have specified a delayed announcement or pairing they will be announced/paired immediately.

Returns Promise<void>
- Defined in packages/matter.js/src/MatterServer.ts:222

Class MatterServer

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MatterServer

Accessors

ipv4Disabled

Returns boolean

Methods

addCommissioningController

Parameters

Returns Promise<void>

addCommissioningServer

Parameters

Returns Promise<void>

close

Returns Promise<void>

removeCommissioningController

Parameters

Returns Promise<void>

removeCommissioningServer

Parameters

Returns Promise<void>

start

Returns Promise<void>

Settings

On This Page