Skip to content

Adds a bridgedDevice script to add several sockets or lights #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Apollon77 wants to merge 1 commit into
base: endpointstructure-usage
Choose a base branch
from
Open

Adds a bridgedDevice script to add several sockets or lights #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,28 @@ For instance, on a Raspberry Pi, this will turn on / off the red LED:
matter -on "echo 255 > /sys/class/leds/led1/brightness" -off "echo 0 > /sys/class/leds/led1/brightness"
```

Or to offer a socket:
```bash
matter -type socket -on "echo 255 > /sys/class/leds/led1/brightness" -off "echo 0 > /sys/class/leds/led1/brightness"
```

### Matter Bridged Device Usage

A Bridge is used to expose multiple devices at once.
The usage is as above but with modified parameters:
* **-num X**: number of devices to expose (default 2)
* **-typeX socket**: type of the devices to expose as device number X (default Light bulb)
* **-onX "script"**: script to run when the device number X is turned on
* **-offX "script"**: script to run when the device number X is turned off

```bash
matter-bridge -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
```

The above command exposes two devices under the bridge, one as light, one as socket and executes the respective commands when the devices are turned on or off.


### Matter Controller Usage
**Experimental**

```bash
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
"types": "build/index.d.ts",
"bin": {
"matter": "./build/Device.js",
"matter-bridge": "./build/BridgedDevice.js",
"matter-controller": "./build/Controller.js"
}
}
218 changes: 218 additions & 0 deletions src/BridgedDevice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
#!/usr/bin/env node

/**
* @license
* Copyright 2022 The node-matter Authors
* SPDX-License-Identifier: Apache-2.0
*/

import { singleton } from "./util/Singleton";
import { Time } from "./time/Time";
import { TimeNode } from "./time/TimeNode";

Time.get = singleton(() => new TimeNode());

import { MatterDevice } from "./matter/MatterDevice";
import { UdpInterface } from "./net/UdpInterface";
import { SecureChannelProtocol } from "./matter/session/secure/SecureChannelProtocol";
import { PaseServer } from "./matter/session/secure/PaseServer";
import { Crypto } from "./crypto/Crypto";
import { CaseServer } from "./matter/session/secure/CaseServer";
import { ClusterServer, InteractionServer } from "./matter/interaction/InteractionServer";
import { BasicInformationCluster } from "./matter/cluster/BasicInformationCluster";
import { GeneralCommissioningCluster, RegulatoryLocationType } from "./matter/cluster/GeneralCommissioningCluster";
import { OperationalCredentialsCluster } from "./matter/cluster/OperationalCredentialsCluster";
import { DEVICE } from "./matter/common/DeviceTypes";
import { MdnsBroadcaster } from "./matter/mdns/MdnsBroadcaster";
import { Network } from "./net/Network";
import { NetworkNode } from "./net/node/NetworkNode";
import { getParameter, getIntParameter, commandExecutor } from "./util/CommandLine";
import { OnOffCluster } from "./matter/cluster/OnOffCluster";
import { GeneralCommissioningClusterHandler } from "./matter/cluster/server/GeneralCommissioningServer";
import { OperationalCredentialsClusterHandler } from "./matter/cluster/server/OperationalCredentialsServer";
import { MdnsScanner } from "./matter/mdns/MdnsScanner";
import packageJson from "../package.json";
import { Logger } from "./log/Logger";
import { VendorId } from "./matter/common/VendorId";
import { OnOffClusterHandler } from "./matter/cluster/server/OnOffServer";
import { ByteArray} from "@project-chip/matter.js";
import { CommissionningFlowType, DiscoveryCapabilitiesSchema, ManualPairingCodeCodec, QrPairingCodeCodec } from "./codec/PairingCode.js";
import { QrCode } from "./codec/QrCode.js";
import { NetworkCommissioningCluster, NetworkCommissioningStatus } from "./matter/cluster/NetworkCommissioningCluster";
import { AdminCommissioningCluster, CommissioningWindowStatus } from "./matter/cluster/AdminCommissioningCluster";
import { AdminCommissioningHandler } from "./matter/cluster/server/AdminCommissioningServer";
import { NetworkCommissioningHandler } from "./matter/cluster/server/NetworkCommissioningServer";
import { Endpoint } from "./matter/interaction/Endpoint";
import { BridgedDeviceBasicInformationCluster } from "./matter/cluster/BridgedDeviceBasicInformationCluster";
import { FabricIndex } from "./matter/common/FabricIndex";
import {capitalize} from "./util/String";

// From Chip-Test-DAC-FFF1-8000-0007-Key.der
const DevicePrivateKey = ByteArray.fromHex("727F1005CBA47ED7822A9D930943621617CFD3B79D9AF528B801ECF9F1992204");

// From Chip-Test-DAC-FFF1-8000-0007-Cert.der
const DeviceCertificate = ByteArray.fromHex("308201e83082018fa0030201020208143c9d1689f498f0300a06082a8648ce3d04030230463118301606035504030c0f4d617474657220546573742050414931143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04383030303020170d3231303632383134323334335a180f39393939313233313233353935395a304b311d301b06035504030c144d6174746572205465737420444143203030303731143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04383030303059301306072a8648ce3d020106082a8648ce3d0301070342000462e2b6e1baff8d74a6fd8216c4cb67a3363a31e691492792e61aee610261481396725ef95e142686ba98f339b0ff65bc338bec7b9e8be0bdf3b2774982476220a360305e300c0603551d130101ff04023000300e0603551d0f0101ff040403020780301d0603551d0e04160414ee95ad96983a9ea95bcd2b00dc5e671727690383301f0603551d23041830168014af42b7094debd515ec6ecf33b81115225f325288300a06082a8648ce3d040302034700304402202f51cf53bf7777df7318094b9db595eebf2fa881c8c572847b1e689ece654264022029782708ee6b32c7f08ff63dbe618e9a580bb14c183bc288777adf9e2dcff5e6");

// From Chip-Test-PAI-FFF1-8000-Cert.der
const ProductIntermediateCertificate = ByteArray.fromHex("308201d43082017aa00302010202083e6ce6509ad840cd300a06082a8648ce3d04030230303118301606035504030c0f4d617474657220546573742050414131143012060a2b0601040182a27c02010c04464646313020170d3231303632383134323334335a180f39393939313233313233353935395a30463118301606035504030c0f4d617474657220546573742050414931143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04383030303059301306072a8648ce3d020106082a8648ce3d0301070342000480ddf11b228f3e31f63bcf5798da14623aebbde82ef378eeadbfb18fe1abce31d08ed4b20604b6ccc6d9b5fab64e7de10cb74be017c9ec1516056d70f2cd0b22a366306430120603551d130101ff040830060101ff020100300e0603551d0f0101ff040403020106301d0603551d0e04160414af42b7094debd515ec6ecf33b81115225f325288301f0603551d230418301680146afd22771f511fecbf1641976710dcdc31a1717e300a06082a8648ce3d040302034800304502210096c9c8cf2e01886005d8f5bc72c07b75fd9a57695ac4911131138bea033ce50302202554943be57d53d6c475f7d23ebfcfc2036cd29ba6393ec7efad8714ab718219");

// From DeviceAttestationCredsExample.cpp
const CertificateDeclaration = ByteArray.fromHex("3082021906092a864886f70d010702a082020a30820206020103310d300b06096086480165030402013082017106092a864886f70d010701a08201620482015e152400012501f1ff3602050080050180050280050380050480050580050680050780050880050980050a80050b80050c80050d80050e80050f80051080051180051280051380051480051580051680051780051880051980051a80051b80051c80051d80051e80051f80052080052180052280052380052480052580052680052780052880052980052a80052b80052c80052d80052e80052f80053080053180053280053380053480053580053680053780053880053980053a80053b80053c80053d80053e80053f80054080054180054280054380054480054580054680054780054880054980054a80054b80054c80054d80054e80054f80055080055180055280055380055480055580055680055780055880055980055a80055b80055c80055d80055e80055f80056080056180056280056380182403162c04135a494732303134325a423333303030332d32342405002406002507942624080018317d307b020103801462fa823359acfaa9963e1cfa140addf504f37160300b0609608648016503040201300a06082a8648ce3d04030204473045022024e5d1f47a7d7b0d206a26ef699b7c9757b72d469089de3192e678c745e7f60c022100f8aa2fa711fcb79b97e397ceda667bae464e2bd3ffdfc3cced7aa8ca5f4c1a7c");

Network.get = singleton(() => new NetworkNode());

const logger = Logger.get("Device");

class Device {
async start() {
logger.info(`node-matter@${packageJson.version}`);

const deviceName = "Matter test device";
const deviceType = DEVICE.AGGREGATOR.code;
const vendorName = "node-matter";
const passcode = 20202021;
const discriminator = 3840;
// product name / id and vendor id should match what is in the device certificate
const vendorId = new VendorId(0xFFF1);
const productName = "Matter Test DAC 0007";
const productId = 0X8000;

const numDevices = getIntParameter("num") || 2;
// Barebone implementation of the On/Off cluster

const aggregatorEndpoints = new Endpoint(1, [ DEVICE.AGGREGATOR ], [ ]);
for (let i = 1; i <= numDevices; i++) {
const onOffCluster = new ClusterServer(
OnOffCluster,
{ lightingLevelControl: false },
{ onOff: false }, // Off by default
OnOffClusterHandler()
);
// We listen to the attribute update to trigger an action. This could also have been done in the method invokations in the server.
onOffCluster.attributes.onOff.addListener(on => commandExecutor(on ? `on${i}` : `off${i}`)?.());

const userDeviceType = getParameter(`type${i}`) === "socket" ? DEVICE.ON_OFF_PLUGIN_UNIT : DEVICE.ON_OFF_LIGHT;

aggregatorEndpoints.addEndpoint(10 + i, [ userDeviceType, DEVICE.BRIDGED_DEVICE ], [
new ClusterServer(BridgedDeviceBasicInformationCluster, {}, {
nodeLabel: `${capitalize(userDeviceType.name.replace("MA-", ""))} ${i}`,
serialNumber: `node-matter-${packageJson.version}-${i}`,
reachable: true
}, {}),
onOffCluster
]);
}


const secureChannelProtocol = new SecureChannelProtocol(
await PaseServer.fromPin(passcode, { iterations: 1000, salt: Crypto.getRandomData(32) }),
new CaseServer(),
);

(new MatterDevice(deviceName, deviceType, vendorId, productId, discriminator))
.addNetInterface(await UdpInterface.create(5540, "udp4"))
.addNetInterface(await UdpInterface.create(5540, "udp6"))
.addScanner(await MdnsScanner.create())
.addBroadcaster(await MdnsBroadcaster.create())
.addProtocolHandler(secureChannelProtocol)
.addProtocolHandler(new InteractionServer()
.addRootEndpoint([
new ClusterServer(BasicInformationCluster, {}, {
dataModelRevision: 1,
vendorName,
vendorId,
productName,
productId,
nodeLabel: "",
hardwareVersion: 0,
hardwareVersionString: "0",
location: "US",
localConfigDisabled: false,
softwareVersion: 1,
softwareVersionString: "v1",
capabilityMinima: {
caseSessionsPerFabric: 3,
subscriptionsPerFabric: 3,
},
serialNumber: `node-matter-${packageJson.version}`,
}, {}),
new ClusterServer(GeneralCommissioningCluster, {}, {
breadcrumb: BigInt(0),
commissioningInfo: {
failSafeExpiryLengthSeconds: 60 /* 1min */,
maxCumulativeFailsafeSeconds: 900 /* Recommended according to Specs */,
},
regulatoryConfig: RegulatoryLocationType.Indoor,
locationCapability: RegulatoryLocationType.IndoorOutdoor,
supportsConcurrentConnections: true,
}, GeneralCommissioningClusterHandler),
new ClusterServer(OperationalCredentialsCluster, {}, {
nocs: [],
fabrics: [],
supportedFabrics: 254,
commissionedFabrics: 0,
trustedRootCertificates: [],
currentFabricIndex: FabricIndex.NO_FABRIC,
},
OperationalCredentialsClusterHandler({
devicePrivateKey: DevicePrivateKey,
deviceCertificate: DeviceCertificate,
deviceIntermediateCertificate: ProductIntermediateCertificate,
certificateDeclaration: CertificateDeclaration,
}),
),
new ClusterServer(NetworkCommissioningCluster,
{
wifi: false,
thread: false,
ethernet: true,
},
{
maxNetworks: 1,
connectMaxTimeSeconds: 20,
interfaceEnabled: true,
lastConnectErrorValue: 0,
lastNetworkId: Buffer.alloc(32),
lastNetworkingStatus: NetworkCommissioningStatus.Success,
networks: [{ networkId: Buffer.alloc(32), connected: true }],
scanMaxTimeSeconds: 5,
},
NetworkCommissioningHandler(),
),
new ClusterServer(AdminCommissioningCluster,
{
basic: true,
},
{
windowStatus: CommissioningWindowStatus.WindowNotOpen,
adminFabricIndex: null,
adminVendorId: null,
},
AdminCommissioningHandler(secureChannelProtocol),
)
], [ aggregatorEndpoints ])
)
.start()

logger.info("Listening");

const qrPairingCode = QrPairingCodeCodec.encode({
version: 0,
vendorId: vendorId.id,
productId,
flowType: CommissionningFlowType.Standard,
discriminator,
passcode,
discoveryCapabilities: DiscoveryCapabilitiesSchema.encode({
ble: false,
softAccessPoint: false,
onIpNetwork: true,
}),
});
console.log(QrCode.encode(qrPairingCode));
console.log(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
console.log(`Manual pairing code: ${ManualPairingCodeCodec.encode({ discriminator, passcode })}`);
}
}

new Device().start();