zigbee-herdsman/test/adapter/zboss/fixZdoResponse.test.ts

An open source ZigBee gateway solution with node.js.

import {CommandId} from "../../../src/adapter/zboss/enums";
import {FrameType, type ZBOSSFrame, readZBOSSFrame} from "../../../src/adapter/zboss/frame";
import * as Zdo from "../../../src/zspec/zdo";
import type * as ZdoTypes from "../../../src/zspec/zdo/definition/tstypes";

describe("ZBOSS fix non-standard ZDO response payloads", () => {
    it("No fix needed FrameType.RESPONSE", () => {
        expect(readZBOSSFrame(Buffer.from("0001010211000088776655443322113412", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.RESPONSE,
            commandId: CommandId.ZDO_NWK_ADDR_REQ,
            tsn: 17,
            payload: {
                category: 0,
                zdoClusterId: Zdo.ClusterId.NETWORK_ADDRESS_RESPONSE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0x1234,
                        eui64: "0x1122334455667788",
                        startIndex: 0,
                        assocDevList: [],
                    } as ZdoTypes.NetworkAddressResponse,
                ],
            },
        } as ZBOSSFrame);
    });

    it("No fix needed FrameType.INDICATION", () => {
        expect(readZBOSSFrame(Buffer.from("00020c020cda603602602bd5b3708e", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.INDICATION,
            commandId: CommandId.ZDO_DEV_ANNCE_IND,
            tsn: 0,
            payload: {
                category: undefined,
                zdoClusterId: Zdo.ClusterId.END_DEVICE_ANNOUNCE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0xda0c,
                        eui64: "0x70b3d52b60023660",
                        capabilities: Zdo.Utils.getMacCapFlags(0x8e),
                    } as ZdoTypes.EndDeviceAnnounce,
                ],
            },
        } as ZBOSSFrame);
    });

    it("NODE_DESCRIPTOR_RESPONSE", () => {
        expect(readZBOSSFrame(Buffer.from("000104021100000000000000000000432c0000003412", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.RESPONSE,
            commandId: CommandId.ZDO_NODE_DESC_REQ,
            tsn: 17,
            payload: {
                category: 0,
                zdoClusterId: Zdo.ClusterId.NODE_DESCRIPTOR_RESPONSE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0x1234,
                        logicalType: 0,
                        fragmentationSupported: undefined,
                        apsFlags: 0,
                        frequencyBand: 0,
                        capabilities: {
                            alternatePANCoordinator: 0,
                            deviceType: 0,
                            powerSource: 0,
                            rxOnWhenIdle: 0,
                            reserved1: 0,
                            reserved2: 0,
                            securityCapability: 0,
                            allocateAddress: 0,
                        },
                        manufacturerCode: 0,
                        maxBufSize: 0,
                        maxIncTxSize: 0,
                        serverMask: Zdo.Utils.getServerMask(0x2c43),
                        maxOutTxSize: 0,
                        deprecated1: 0,
                        tlvs: [],
                    } as ZdoTypes.NodeDescriptorResponse,
                ],
            },
        } as ZBOSSFrame);
    });

    it("POWER_DESCRIPTOR_RESPONSE", () => {
        expect(readZBOSSFrame(Buffer.from("0001030211000001023412", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.RESPONSE,
            commandId: CommandId.ZDO_POWER_DESC_REQ,
            tsn: 17,
            payload: {
                category: 0,
                zdoClusterId: Zdo.ClusterId.POWER_DESCRIPTOR_RESPONSE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0x1234,
                        currentPowerMode: 1,
                        availPowerSources: 0,
                        currentPowerSource: 2,
                        currentPowerSourceLevel: 0,
                    } as ZdoTypes.PowerDescriptorResponse,
                ],
            },
        } as ZBOSSFrame);
    });

    it("MATCH_DESCRIPTORS_RESPONSE", () => {
        expect(readZBOSSFrame(Buffer.from("0001070211000002f2013412", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.RESPONSE,
            commandId: CommandId.ZDO_MATCH_DESC_REQ,
            tsn: 17,
            payload: {
                category: 0,
                zdoClusterId: Zdo.ClusterId.MATCH_DESCRIPTORS_RESPONSE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0x1234,
                        endpointList: [242, 1],
                    } as ZdoTypes.MatchDescriptorsResponse,
                ],
            },
        } as ZBOSSFrame);
    });

    it("ACTIVE_ENDPOINTS_RESPONSE", () => {
        expect(readZBOSSFrame(Buffer.from("0001060211000002f2013412", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.RESPONSE,
            commandId: CommandId.ZDO_ACTIVE_EP_REQ,
            tsn: 17,
            payload: {
                category: 0,
                zdoClusterId: Zdo.ClusterId.ACTIVE_ENDPOINTS_RESPONSE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0x1234,
                        endpointList: [242, 1],
                    } as ZdoTypes.ActiveEndpointsResponse,
                ],
            },
        } as ZBOSSFrame);
    });

    it("SIMPLE_DESCRIPTOR_RESPONSE", () => {
        expect(readZBOSSFrame(Buffer.from("0001050211000001040100000301022c2ffefebcbc3412", "hex"))).toStrictEqual({
            version: 0,
            type: FrameType.RESPONSE,
            commandId: CommandId.ZDO_SIMPLE_DESC_REQ,
            tsn: 17,
            payload: {
                category: 0,
                zdoClusterId: Zdo.ClusterId.SIMPLE_DESCRIPTOR_RESPONSE,
                zdo: [
                    Zdo.Status.SUCCESS,
                    {
                        nwkAddress: 0x1234,
                        length: 14,
                        endpoint: 1,
                        profileId: 0x0104,
                        deviceId: 0x0000,
                        deviceVersion: 3,
                        inClusterList: [0x2f2c],
                        outClusterList: [0xfefe, 0xbcbc],
                    } as ZdoTypes.SimpleDescriptorResponse,
                ],
            },
        } as ZBOSSFrame);
    });
});