zigbee-herdsman/dist/adapter/zigate/driver/messageType.js

An open source ZigBee gateway solution with node.js.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ZiGateMessage = void 0;
/* istanbul ignore file */
/* eslint-disable */
const constants_1 = require("./constants");
exports.ZiGateMessage = {
    [constants_1.ZiGateMessageCode.GetTimeServer]: {
        response: [
            { name: 'timestampUTC', parameterType: 'UINT32' }, // <Timestamp UTC: uint32_t> from 2000-01-01 00:00:00
        ]
    },
    [constants_1.ZiGateMessageCode.DeviceAnnounce]: {
        response: [
            { name: 'shortAddress', parameterType: 'UINT16BE' },
            { name: 'ieee', parameterType: 'IEEEADDR' },
            { name: 'MACcapability', parameterType: 'MACCAPABILITY' },
            // MAC capability
            // Bit 0 – Alternate PAN Coordinator
            // Bit 1 – Device Type
            // Bit 2 – Power source
            // Bit 3 – Receiver On when Idle
            // Bit 4,5 – Reserved
            // Bit 6 – Security capability
            // Bit 7 – Allocate Address
            // {name: 'rejoin', parameterType: 'UINT8'},
        ]
    },
    [constants_1.ZiGateMessageCode.Status]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status:uint8_t>
            // 0 = Success
            // 1 = Incorrect parameters
            // 2 = Unhandled command
            // 3 = Command failed
            // eslint-disable-next-line max-len
            // 4 = Busy (Node is carrying out a lengthy operation and is currently unable to handle the incoming command)
            // 5 = Stack already started (no new configuration accepted)
            // 128 – 244 = Failed (ZigBee event codes)
            // Packet Type: The value of the initiating command request.
            { name: 'sequence', parameterType: 'UINT8' }, // <sequence number: uint8_t>
            { name: 'packetType', parameterType: 'UINT16BE' }, // <Packet Type: uint16_t>
            // from 3.1d
            // {name: 'requestSent', parameterType: 'MAYBE_UINT8'},// <requestSent: uint8_t>  - 1 if a request been sent to
            // // a device(aps ack/nack 8011 should be expected) , 0 otherwise
            // {name: 'seqApsNum', parameterType: 'MAYBE_UINT8'},// <seqApsNum: uint8_t>  - sqn of the APS layer - used to
            // // check sqn sent back in aps ack
            //
            // // from 3.1e
            // {name: 'PDUM_u8GetNpduUse', parameterType: 'MAYBE_UINT8'},
            // {name: 'u8GetApduUse', parameterType: 'MAYBE_UINT8'},
            //
            // // debug 3.1e++
            // {name: 'PDUM_u8GetMaxNpduUse', parameterType: 'MAYBE_UINT8'},
            // {name: 'u8GetMaxApduUse', parameterType: 'MAYBE_UINT8'},
        ]
    },
    [constants_1.ZiGateMessageCode.PermitJoinStatus]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status:uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.DataIndication]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            { name: 'profileID', parameterType: 'UINT16BE' }, // <Profile ID: uint16_t>
            { name: 'clusterID', parameterType: 'UINT16BE' }, // <cluster ID: uint16_t>
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, // <source endpoint: uint8_t>
            { name: 'destinationEndpoint', parameterType: 'UINT8' }, // <destination endpoint: uint8_t>
            { name: 'sourceAddressMode', parameterType: 'UINT8' }, // <source address mode: uint8_t>
            { name: 'sourceAddress', parameterType: 'ADDRESS_WITH_TYPE_DEPENDENCY' },
            // <source address: uint16_t or uint64_t>
            { name: 'destinationAddressMode', parameterType: 'UINT8' },
            // <destination address mode: uint8_t>
            { name: 'destinationAddress', parameterType: 'ADDRESS_WITH_TYPE_DEPENDENCY' },
            // <destination address: uint16_t or uint64_t>
            // {name: 'payloadSize', parameterType:'UINT8'}, // <payload size : uint8_t>
            { name: 'payload', parameterType: 'BUFFER_RAW' }, // <payload : data each element is
            // uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.NodeClusterList]: {
        response: [
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, //<source endpoint: uint8_t t>
            { name: 'profileID', parameterType: 'UINT16' }, // <profile ID: uint16_t>
            { name: 'clusterCount', parameterType: 'UINT8' },
            { name: 'clusterList', parameterType: 'LIST_UINT16' }, // <cluster list: data each entry is uint16_t>
        ]
    },
    [constants_1.ZiGateMessageCode.NodeAttributeList]: {
        response: [
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, //<source endpoint: uint8_t t>
            { name: 'profileID', parameterType: 'UINT16' }, // <profile ID: uint16_t>
            { name: 'clusterID', parameterType: 'UINT16' }, // <cluster ID: uint16_t>
            { name: 'attributeCount', parameterType: 'UINT8' },
            { name: 'attributeList', parameterType: 'LIST_UINT16' }, //  <attribute list: data each entry is uint16_t>
        ]
    },
    [constants_1.ZiGateMessageCode.NodeCommandIDList]: {
        response: [
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, //<source endpoint: uint8_t t>
            { name: 'profileID', parameterType: 'UINT16' }, // <profile ID: uint16_t>
            { name: 'clusterID', parameterType: 'UINT16' }, // <cluster ID: uint16_t>
            { name: 'commandIDCount', parameterType: 'UINT8' },
            { name: 'commandIDList', parameterType: 'LIST_UINT8' }, // <command ID list:data each entry is uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.APSDataACK]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            // {name: 'sourceEndpoint', parameterType:'UINT8'}, // <source endpoint: uint8_t>
            // {name: 'destinationAddressMode', parameterType:'UINT8'},
            // // <destination address mode: uint8_t>
            { name: 'destinationAddress', parameterType: 'UINT16BE' },
            { name: 'destinationEndpoint', parameterType: 'UINT8' }, // <destination endpoint: uint8_t>
            { name: 'clusterID', parameterType: 'UINT16BE' },
            // // <destination address: uint16_t or uint64_t>
            { name: 'seqNumber', parameterType: 'UINT8' }, // <seq number: uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.APSDataConfirm]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, // <source endpoint: uint8_t>
            { name: 'destinationAddressMode', parameterType: 'UINT8' },
            { name: 'destinationAddressMode', parameterType: 'UINT8' },
            // <destination address mode: uint8_t>
            { name: 'destinationAddress', parameterType: 'ADDRESS_WITH_TYPE_DEPENDENCY' },
            // <destination address: uint16_t or uint64_t>
            { name: 'seqNumber', parameterType: 'UINT8' }, // <seq number: uint8_t>
            // from 3.1e
            { name: 'PDUM_u8GetNpduUse', parameterType: 'MAYBE_UINT8' },
            { name: 'u8GetApduUse', parameterType: 'MAYBE_UINT8' },
        ]
    },
    [constants_1.ZiGateMessageCode.APSDataConfirmFailed]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, // <src endpoint: uint8_t>
            { name: 'destinationEndpoint', parameterType: 'UINT8' }, // <dst endpoint: uint8_t>
            { name: 'destinationAddressMode', parameterType: 'UINT8' }, // <dst address mode: uint8_t>
            { name: 'destinationAddress', parameterType: 'ADDRESS_WITH_TYPE_DEPENDENCY' },
            // <destination address: uint64_t>
            { name: 'seqNumber', parameterType: 'UINT8' }, // <seq number: uint8_t>
            // from 3.1e
            { name: 'PDUM_u8GetNpduUse', parameterType: 'MAYBE_UINT8' },
            { name: 'u8GetApduUse', parameterType: 'MAYBE_UINT8' },
        ]
    },
    [constants_1.ZiGateMessageCode.NetworkState]: {
        response: [
            { name: 'shortAddress', parameterType: 'UINT16BE' }, // <Short Address: uint16_t>
            { name: 'extendedAddress', parameterType: 'IEEEADDR' }, // <Extended Address: uint64_t>
            { name: 'PANID', parameterType: 'UINT16BE' }, // <PAN ID: uint16_t>
            { name: 'ExtPANID', parameterType: 'IEEEADDR' }, // <Ext PAN ID: uint64_t>
            { name: 'Channel', parameterType: 'UINT8' }, // <Channel: uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.VersionList]: {
        response: [
            { name: 'major', parameterType: 'UINT8' },
            { name: 'minor', parameterType: 'UINT8' },
            { name: 'revision', parameterType: 'UINT16' },
        ]
    },
    [constants_1.ZiGateMessageCode.NetworkJoined]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            // Status:
            // 0 = Joined existing network
            // 1 = Formed new network
            // 128 – 244 = Failed (ZigBee event codes)
            { name: 'shortAddress', parameterType: 'UINT16BE' }, // <short address: uint16_t>
            // {name: 'extendedAddress', parameterType: 'IEEEADDR'}, // <extended address:uint64_t>
            // {name: 'channel', parameterType: 'UINT8'}, // <channel: uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.LeaveIndication]: {
        response: [
            { name: 'extendedAddress', parameterType: 'IEEEADDR' }, // <extended address: uint64_t>
            { name: 'rejoin', parameterType: 'UINT8' }, // <rejoin status: uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.ManagementLeaveResponse]: {
        response: [
            { name: 'sqn', parameterType: 'UINT8' },
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
        ]
    },
    [constants_1.ZiGateMessageCode.RouterDiscoveryConfirm]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            // {name: 'nwkStatus', parameterType: 'UINT8'}, // <nwk status: uint8_t>
            // {name: 'dstAddress', parameterType: 'UINT16BE'}, // <nwk status: uint16_t>
        ]
    },
    [constants_1.ZiGateMessageCode.SimpleDescriptorResponse]: {
        response: [
            { name: 'sourceEndpoint', parameterType: 'UINT8' }, //<source endpoint: uint8_t>
            { name: 'profile ID', parameterType: 'UINT16BE' }, // <profile ID: uint16_t>
            { name: 'clusterID', parameterType: 'UINT16BE' }, // <cluster ID: uint16_t>
            { name: 'attributeList', parameterType: 'LIST_UINT16BE' }, // <attribute list: data each entry is uint16_t>
        ]
    },
    [constants_1.ZiGateMessageCode.ManagementLQIResponse]: {
        response: [
            { name: 'sequence', parameterType: 'UINT8' }, // <Sequence number: uint8_t>
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            { name: 'neighbourTableEntries', parameterType: 'UINT8' }, // <Neighbour Table Entries : uint8_t>
            { name: 'neighbourTableListCount', parameterType: 'UINT8' }, // <Neighbour Table List Count : uint8_t>
            { name: 'startIndex', parameterType: 'UINT8' }, // <Start Index : uint8_t>
            // @TODO list TYPE
            // <List of Entries elements described below :>
            // Note: If Neighbour Table list count is 0, there are no elements in the list.
            { name: 'NWKAddress', parameterType: 'UINT16BE' }, // NWK Address : uint16_t
            { name: 'Extended PAN ID', parameterType: 'UINT64' }, // Extended PAN ID : uint64_t
            { name: 'IEEE Address', parameterType: 'IEEEADR' }, // IEEE Address : uint64_t
            { name: 'Depth', parameterType: 'UINT8' }, // Depth : uint_t
            { name: 'linkQuality', parameterType: 'UINT8' }, // Link Quality : uint8_t
            { name: 'bitMap', parameterType: 'UINT8' }, // Bit map of attributes Described below: uint8_t
            // bit 0-1 Device Type
            // (0-Coordinator 1-Router 2-End Device)
            // bit 2-3 Permit Join status
            // (1- On 0-Off)
            // bit 4-5 Relationship
            // (0-Parent 1-Child 2-Sibling)
            // bit 6-7 Rx On When Idle status
            // (1-On 0-Off)
            { name: 'srcAddress', parameterType: 'UINT16BE' }, // <Src Address : uint16_t> ( only from v3.1a)
        ]
    },
    [constants_1.ZiGateMessageCode.PDMEvent]: {
        response: [
            { name: 'eventStatus', parameterType: 'UINT8' }, // <event status: uint8_t>
            { name: 'recordID', parameterType: 'UINT32BE' }, // <record ID: uint32_t>
        ]
    },
    [constants_1.ZiGateMessageCode.PDMLoaded]: {
        response: [
            { name: 'length', parameterType: 'UINT8' },
        ]
    },
    [constants_1.ZiGateMessageCode.RestartNonFactoryNew]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            //	0 – STARTUP
            // 1 – RUNNING
            // 2 – NFN_START
        ]
    },
    [constants_1.ZiGateMessageCode.RestartFactoryNew]: {
        response: [
            { name: 'status', parameterType: 'UINT8' }, // <status: uint8_t>
            // 0 – STARTUP
            // 2 – NFN_START
            // 6 – RUNNING
            // The node is not yet provisioned.
        ]
    },
    [constants_1.ZiGateMessageCode.ExtendedStatusCallBack]: {
        response: [
            { name: 'status', parameterType: 'UINT8' },
            // https://github.com/fairecasoimeme/ZiGate/blob/aac14153db332eb5b898cba0f57f5999e5cf11eb/Module%20Radio/Firmware/src/sdk/JN-SW-4170/Components/ZPSNWK/Include/zps_nwk_pub.h#L89
        ]
    },
    [0x8001]: {
        response: [
            { name: 'logLevel', parameterType: 'LOG_LEVEL' },
            { name: 'log', parameterType: 'STRING' },
        ]
    },
    [constants_1.ZiGateMessageCode.AddGroupResponse]: {
        response: [
            { name: 'status', parameterType: 'UINT16BE' },
            { name: 'groupAddress', parameterType: 'UINT16BE' },
        ]
    }
};
//# sourceMappingURL=messageType.js.map