feat: Source routing

.github/workflows/ci.yaml

@@ -2,7 +2,6 @@ name: CI
 
 on:
   push:
-  pull_request:
 
 jobs:
   checks:
@@ -14,15 +13,11 @@ jobs:
         with:
           node-version-file: 'package.json'
 
-      - uses: biomejs/setup-biome@v2
-        with:
-          version: latest
-
       - run: npm ci
 
       - run: npm run build:prod
 
-      - run: biome ci
+      - run: npm run check:ci
 
   tests:
     strategy:

.gitignore

@@ -128,3 +128,6 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# ZoH
+*.save

README.md

@@ -39,23 +39,20 @@ Some quick guidelines to keep the codebase maintainable:
   - [ ] FULLENCR & auth tag checking codepaths
 - [x] Encoding/decoding of ZigBee NWK APS frames
 - [x] Network forming
-- [~] Network state saving (de facto backups)
-  - [ ] Deal with frame counters (avoiding too many writes, but preventing mismatch issues)
-  - [ ] Runtime changing of network parameters (ZDO channel, PAN ID...)
-- [~] Joining/Rejoining
+- [x] Network state saving (de facto backups)
+- [x] Joining/Rejoining
   - [x] APS TC link key update mechanism (global)
   - [x] Direct child router
   - [x] Direct child end device
-  - [ ] Nested device
+  - [x] Nested device
 - [x] Indirect transmission mechanism
   - _Crude implementation_
   - [ ] Deal with devices lying on `rxOnWhenIdle` property (bad firmware, resulting in transmission type mismatch)
 - [ ] Routing
-  - [ ] Source routing
+  - [x] Source routing
   - [?] Regular routing
-- [ ] Coordinator binding
 - [ ] InterPAN / Touchlink
-- [ ] LQI reporting in messages
+- [ ] LQI reporting in messages (currently showing RSSI - in dBm)
 - [ ] Install codes
 - [?] APS APP link keys
 - [ ] R23 (need reference sniffs...)

biome.json

@@ -25,7 +25,15 @@
             "recommended": true,
             "style": {
                 "noNonNullAssertion": "off",
-                "noParameterAssign": "off"
+                "noParameterAssign": "off",
+                "useNamingConvention": {
+                    "level": "error",
+                    "options": {
+                        "strictCase": false,
+                        "requireAscii": true,
+                        "enumMemberCase": "CONSTANT_CASE"
+                    }
+                }
             },
             "correctness": {
                 "noUnusedImports": "error",
@@ -39,7 +47,8 @@
                 "noReExportAll": "error"
             },
             "suspicious": {
-                "noConstEnum": "off"
+                "noConstEnum": "off",
+                "useAwait": "error"
             }
         }
     },

package.json

@@ -14,7 +14,8 @@
         "test": "vitest run --config ./test/vitest.config.mts",
         "test:cov": "vitest run --config ./test/vitest.config.mts --coverage",
         "bench": "vitest bench --run --config ./test/vitest.config.mts",
-        "check": "npx @biomejs/biome check --write .",
+        "check": "biome check --write .",
+        "check:ci": "biome check .",
         "clean": "rm -rf dist *.tsbuildinfo",
         "dev:cli": "node dist/dev/cli.js"
     },
@@ -31,10 +32,10 @@
     "homepage": "https://github.com/Nerivec/zigbee-on-host#readme",
     "devDependencies": {
         "@biomejs/biome": "1.9.4",
-        "@types/node": "^22.10.7",
-        "@vitest/coverage-v8": "^3.0.2",
-        "serialport": "^12.0.0",
+        "@types/node": "^22.13.4",
+        "@vitest/coverage-v8": "^3.0.6",
+        "serialport": "^13.0.0",
         "typescript": "^5.7.3",
-        "vitest": "^3.0.2"
+        "vitest": "^3.0.6"
     }
 }

src/dev/minimal-adapter.ts

@@ -60,7 +60,7 @@ export class MinimalAdapter {
         this.closing = false;
 
         if (sendMACToZEP) {
-            this.driver.on("MAC_FRAME", (payload, rssi) => {
+            this.driver.on("macFrame", (payload, rssi) => {
                 const wsZEPFrame = createWiresharkZEPFrame(this.driver.netParams.channel, 1, 0, rssi ?? 0, this.nextWiresharkSeqNum(), payload);
 
                 this.wiresharkSocket.send(wsZEPFrame, this.wiresharkPort, this.wiresharkAddress);
@@ -182,7 +182,7 @@ export class MinimalAdapter {
      * Handle port closing
      * @param err A boolean for Socket, an Error for serialport
      */
-    private async onPortClose(error: boolean | Error): Promise<void> {
+    private onPortClose(error: boolean | Error): void {
         if (error) {
             logger.error("Port closed unexpectedly.", NS);
         } else {
@@ -194,7 +194,7 @@ export class MinimalAdapter {
      * Handle port error
      * @param error
      */
-    private async onPortError(error: Error): Promise<void> {
+    private onPortError(error: Error): void {
         logger.error(`Port ${error}`, NS);
 
         throw new Error("Port error");
@@ -223,10 +223,10 @@ export class MinimalAdapter {
         // allow joins on start for 254 seconds
         this.driver.allowJoins(0xfe, true);
 
-        this.driver.on("FRAME", this.onFrame.bind(this));
-        this.driver.on("DEVICE_JOINED", this.onDeviceJoined.bind(this));
-        this.driver.on("DEVICE_REJOINED", this.onDeviceRejoined.bind(this));
-        this.driver.on("DEVICE_LEFT", this.onDeviceLeft.bind(this));
+        this.driver.on("frame", this.onFrame.bind(this));
+        this.driver.on("deviceJoined", this.onDeviceJoined.bind(this));
+        this.driver.on("deviceRejoined", this.onDeviceRejoined.bind(this));
+        this.driver.on("deviceLeft", this.onDeviceLeft.bind(this));
     }
 
     public async stop(): Promise<void> {

src/drivers/endpoints.ts → src/drivers/descriptors.ts

@@ -10,7 +10,7 @@ const MAC_CAPABILITIES =
     ((0 << 5) & 0x20) | // reserved2
     ((0 << 6) & 0x40) | // securityCapability
     ((1 << 7) & 0x80); // allocateAddress
-const MANUFACTURER_CODE = 0xffff;
+const MANUFACTURER_CODE = 0xc5a0; // CONNECTIVITY_STANDARDS_ALLIANCE
 const SERVER_MASK =
     (1 & 0x01) | // primaryTrustCenter
     ((0 << 1) & 0x02) | // backupTrustCenter
@@ -97,7 +97,7 @@ export function encodeCoordinatorDescriptors(eui64: bigint): [address: Buffer, n
     offset += 1;
     node.writeUInt16LE(MANUFACTURER_CODE, offset);
     offset += 2;
-    node.writeUInt8(0xff, offset);
+    node.writeUInt8(0x7f, offset);
     offset += 1;
     node.writeUInt16LE(ZigbeeMACConsts.FRAME_MAX_SIZE, offset);
     offset += 2;