forked from project-chip/matter.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DummyWifiNetworkCommissioningClusterServer.ts
181 lines (157 loc) · 7.42 KB
/
DummyWifiNetworkCommissioningClusterServer.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/**
* @license
* Copyright 2022 The node-matter Authors
* SPDX-License-Identifier: Apache-2.0
*/
import {
ClusterServer,
ClusterServerObjForCluster,
GeneralCommissioningCluster,
NetworkCommissioning,
} from "@project-chip/matter-node.js/cluster";
import { ByteArray, getParameter } from "@project-chip/matter-node.js/util";
const firstNetworkId = new ByteArray(32);
const WifiNetworkCluster = NetworkCommissioning.Cluster.with(NetworkCommissioning.Feature.WiFiNetworkInterface);
/**
* This represents a Dummy version of a Wifi Network Commissioning Cluster Server without real Wifi related logic, beside
* returning some values provided as CLI parameters. This dummy implementation is only there for tests/as showcase for BLE
* commissioning of a device.
*/
export default ClusterServer(
NetworkCommissioning.Cluster.with(NetworkCommissioning.Feature.WiFiNetworkInterface),
{
maxNetworks: 1,
interfaceEnabled: true,
lastConnectErrorValue: 0,
lastNetworkId: null,
lastNetworkingStatus: null,
networks: [{ networkId: firstNetworkId, connected: false }],
scanMaxTimeSeconds: 3,
connectMaxTimeSeconds: 3,
},
{
scanNetworks: async ({ request: { ssid, breadcrumb }, attributes: { lastNetworkingStatus }, endpoint }) => {
console.log(`---> scanNetworks called on NetworkCommissioning cluster: ${ssid?.toHex()} ${breadcrumb}`);
// Simulate successful scan
if (breadcrumb !== undefined) {
const generalCommissioningCluster = endpoint.getClusterServer(GeneralCommissioningCluster);
generalCommissioningCluster?.setBreadcrumbAttribute(breadcrumb);
}
const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
lastNetworkingStatus?.setLocal(networkingStatus);
return {
networkingStatus,
wiFiScanResults: [
{
security: {
unencrypted: false,
wep: false,
wpaPersonal: false,
wpa2Personal: true,
wpa3Personal: true,
},
ssid: ssid || ByteArray.fromString(getParameter("ble-wifi-scan-ssid") ?? "TestSSID"), // Set a valid existing local Wi-Fi SSID here
bssid: ByteArray.fromString(getParameter("ble-wifi-scan-bssid") ?? "00:00:00:00:00:00"),
channel: 1,
},
],
};
},
addOrUpdateWiFiNetwork: async ({
request: { ssid, credentials, breadcrumb },
attributes: { lastNetworkingStatus, lastNetworkId },
endpoint,
session,
}) => {
console.log(
`---> addOrUpdateWiFiNetwork called on NetworkCommissioning cluster: ${ssid.toHex()} ${credentials.toHex()} ${breadcrumb}`,
);
session.getContext().assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
// Simulate successful add or update
if (breadcrumb !== undefined) {
const generalCommissioningCluster = endpoint.getClusterServer(GeneralCommissioningCluster);
generalCommissioningCluster?.setBreadcrumbAttribute(breadcrumb);
}
const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
lastNetworkingStatus?.setLocal(networkingStatus);
lastNetworkId?.setLocal(firstNetworkId);
return {
networkingStatus: NetworkCommissioning.NetworkCommissioningStatus.Success,
networkIndex: 0,
};
},
removeNetwork: async ({
request: { networkId, breadcrumb },
attributes: { lastNetworkingStatus, lastNetworkId },
endpoint,
session,
}) => {
console.log(
`---> removeNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`,
);
session.getContext().assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
// Simulate successful add or update
if (breadcrumb !== undefined) {
const generalCommissioningCluster = endpoint.getClusterServer(GeneralCommissioningCluster);
generalCommissioningCluster?.setBreadcrumbAttribute(breadcrumb);
}
const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
lastNetworkingStatus?.setLocal(networkingStatus);
lastNetworkId?.setLocal(firstNetworkId);
return {
networkingStatus: NetworkCommissioning.NetworkCommissioningStatus.Success,
networkIndex: 0,
};
},
connectNetwork: async ({
request: { networkId, breadcrumb },
attributes: { lastNetworkingStatus, lastNetworkId, lastConnectErrorValue, networks },
endpoint,
session,
}) => {
console.log(
`---> connectNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`,
);
session.getContext().assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
// Simulate successful connection
if (breadcrumb !== undefined) {
const generalCommissioningCluster = endpoint.getClusterServer(GeneralCommissioningCluster);
generalCommissioningCluster?.setBreadcrumbAttribute(breadcrumb);
}
const networkList = networks.getLocal();
networkList[0].connected = true;
networks.setLocal(networkList);
const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
lastNetworkingStatus?.setLocal(networkingStatus);
lastNetworkId?.setLocal(firstNetworkId);
lastConnectErrorValue?.setLocal(null);
// Announce operational in IP network
const device = session.getContext();
await device.startAnnouncement();
return {
networkingStatus: NetworkCommissioning.NetworkCommissioningStatus.Success,
errorValue: null,
};
},
reorderNetwork: async ({
request: { networkId, networkIndex, breadcrumb },
attributes: { lastNetworkingStatus },
endpoint,
}) => {
console.log(
`---> reorderNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${networkIndex} ${breadcrumb}`,
);
// Simulate successful connection
if (breadcrumb !== undefined) {
const generalCommissioningCluster = endpoint.getClusterServer(GeneralCommissioningCluster);
generalCommissioningCluster?.setBreadcrumbAttribute(breadcrumb);
}
const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
lastNetworkingStatus?.setLocal(networkingStatus);
return {
networkingStatus: NetworkCommissioning.NetworkCommissioningStatus.Success,
networkIndex: 0,
};
},
},
) as ClusterServerObjForCluster<typeof WifiNetworkCluster>;