@project-chip/matter.js
Advanced tools
Implementation of Matter protocol in typescript with no native dependencies (and very limited dependencies).
This is the JavaScript only Core of the Matter protocol. It is used by other projects to implement Matter Nodes and Clients and add the relevant specific implementations for Network and other elements.
The following features are abstracted away to allow to be implemented environment specific:
This library exports the Matter protocol functionality as well as some helper functions as named exports:
| Export | Description |
|---|---|
@project-chip/matter.js | Exports the API to implement a Device or a Controller. |
@project-chip/matter.js/behavior | Exports Behavior classes (New API) as framework to implement all relevant Logic for clusters and internal logic. Contains auto-generated class structures and also Cluster default implementations. |
@project-chip/matter.js/certificate | Exports Certificate (Root-/PAA/PAI/IAC/DA-Certificates) related functionality |
@project-chip/matter.js/cluster | Exports Matter Cluster definitions and Default Cluster-Handlers |
@project-chip/matter.js/codec | Exports Codecs for e.g. Matter-Messages |
@project-chip/matter.js/common | Exports certain common functionalities |
@project-chip/matter.js/crypto | Exports Crypto related abstract functionality that needs to be implemented platform specific! |
@project-chip/matter.js/datatype | Exports Matter Data types |
@project-chip/matter.js/device | Exports Matter Device relevant classes (Legacy API!) |
@project-chip/matter.js/devices | Exports Matter Device type classes (NEW API!) |
@project-chip/matter.js/endpoint | Exports Matter Endpoint structure classes (NEW API!) |
@project-chip/matter-.js/environment | Exports environment functionalities, which handes central functions like MDNS and configuration |
@project-chip/matter.js/fabric | Exports Matter-Fabric functionality |
@project-chip/matter.js/interaction | Exports Matter Interaction protocol functionality |
@project-chip/matter.js/log | Exports Logging functionality (based on "console") |
@project-chip/matter.js/math | Exports Math functionality used by Matter |
@project-chip/matter.js/mdns | Exports Basic MDNS functionality (uses Network implementation) |
@project-chip/matter.js/model | Exports a JavaScript version of the Matter data model |
@project-chip/matter.js/net | Exports Basic Network abstract functionality that needs to be implemented platform specific! |
@project-chip/matter.js/node | Exports Matter Node functionality which is used as basis for a device or controller (NEW API!). It also contains Matter Interaction model abstractions for the new API. |
@project-chip/matter.js/protocol | Exports Basic Matter protocol functionality |
@project-chip/matter.js/schema | Exports Schema definitions and functionality |
@project-chip/matter.js/securechannel | Exports Secure Channel functionality |
@project-chip/matter.js/session | Exports Session and Secure-Session functionality |
@project-chip/matter.js/spec | Exports Matter Specification References |
@project-chip/matter.js/storage | Exports Basic Storage abstract functionality that needs to be implemented platform specific! |
@project-chip/matter.js/time | Exports Basic Time/Timer abstract functionality that needs to be implemented platform specific! |
@project-chip/matter.js/tlv | Exports Matter TLV type definitions |
@project-chip/matter.js/util | Exports Basic Utility functionality |
Both exports and the typings are exported as CommonJS and ES6 modules.
For more details please refer to the API Documentation.
Each cluster that has commands also needs to have them implemented based on the chosen feature set.
Matter.js provides a specification-compliant implementation of all Matter 1.1 clusters. For many clusters our implementations perform high-level business logic. For other clusters you provide the needed business logic by extending the Matter.js implementation. In all cases Matter.js takes care of details like the Matter protocol, input and output validation and persistence. The developer can then decide if own functionality needs to be developed and can overwrite and extend these implementations or just use them.
Matter.js allows the following clusters to be used directly with a default implementation for all relevant commands - or the clusters do not need any commands and so the standard feature set of Matter.js for attributes is sufficient.
| Cluster name | Features | Matter-Version | Additional Information |
|---|---|---|---|
| Access Control | None | 1.1 | No command implementations needed, but ACL checks still pending in matter.js |
| Administrator Commissioning | None, Basic | 1.1 | Internal Root cluster implemented, no need to customize |
| Application Basic | None | 1.1 | No command implementations needed |
| Ballast Configuration | None | 1.1 | No command implementations needed |
| Basic Information | None | 1.1 | Internal Root cluster implemented, no need to customize, events are automatically emitted by matter.js |
| Binary Input Basic | None | 1.1 | No command implementations needed |
| Binding | None | 1.1 | No command implementations needed, support of defined bindings pending in matter.js |
| Boolean State | None | 1.1 | No command implementations needed |
| Bridged Device Basic Information | None | 1.1 | Internal Root cluster implemented, no need to customize, events automatically emitted by matter.js |
| Descriptor | None | 1.1 | Internal Root cluster implemented, no need to customize, data are automatically manabed by matter.js |
| Ethernet Network Diagnostics | None | 1.1 | No command implementations needed when used without any features |
| Fan Control | None | 1.1 | No command implementations needed |
| Fixed Label | None | 1.1 | No command implementations needed |
| Flow Measurement | None | 1.1 | No command implementations needed |
| General Commissioning | None | 1.1 | Internal Root cluster implemented, no need to customize |
| General Diagnostics | None | 1.1 | No command implementations needed when used without test event triggers, else implement as needed |
| Identify | None, IdentifyQuery | 1.1 | |
| Illuminance Measurement | None | 1.1 | No command implementations needed |
| Leaf Wetness Measurement | None | 1.1 | No command implementations needed |
| Localization Configuration | None | 1.1 | No command implementations needed |
| Network Commissioning | None | 1.1 | No command implementations needed when using with Ethernet network, needs custom implementation for Wi-Fi or Thread, see examples |
| Occupancy Sensing | None | 1.1 | No command implementations needed |
| OnOff | None, LevelControl-For-Lighting | 1.1 | LevelControl-For-Lighting feature is exposed automatically when added to a device |
| OnOff Switch Configuration | None | 1.1 | No command implementations needed |
| Operational Credentials | None | 1.1 | Internal Root cluster implemented, no need to customize |
| Power Source | None | 1.1 | No command implementations needed |
| Power Source Configuration | None | 1.1 | No command implementations needed |
| Pressure Measurement | None | 1.1 | No command implementations needed |
| Proxy Configuration | None | 1.1 | No command implementations needed |
| Pump Configuration and Control | None | 1.1 | No command implementations needed |
| Relative Humidity Measurement | None | 1.1 | No command implementations needed |
| Software Diagnostics | None | 1.1 | No command implementations needed when used without Watermark feature |
| Soil Moisture Measurement | None | 1.1 | No command implementations needed |
| Switch | None | 1.1 | No command implementations needed |
| Temperature Measurement | None | 1.1 | No command implementations needed |
| Thermostat User Interface | None | 1.1 | No command implementations needed |
| Time Format Localization | None | 1.1 | No command implementations needed |
| Unit Localization | None | 1.1 | No command implementations needed |
| User Label | None | 1.1 | No command implementations needed |
| WakeOnLan | None | 1.1 | No command implementations needed |
More will come over time and can also be contributed by the community!
To have Typescript and your IDE know all the relevant exported functionality you need to use the following in your tsconfig.json:
{
"compilerOptions": {
"moduleResolution": "node16", // Required to support package.json exports
"module": "node16" // Required to make sure all imports are js
}
}
matter.js is used at the core of those two projects:
npm run build: Build all code and create CommonJS and ES6 variants in dist directory. This will built incrementally and only build the changed files.npm run build-clean: Clean the dist directory and build all code from scratchnpm run test-node: Run tests in node.jsnpm run test-web: Run tests in the browsernpm run test: Run all teststest-web will create a /coverage directory containing the test code coverage
FAQs
Matter protocol in pure js
The npm package @project-chip/matter.js receives a total of 2,387 weekly downloads. As such, @project-chip/matter.js popularity was classified as popular.
We found that @project-chip/matter.js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.