@willieee802/zigbee-herdsman 0.48.3 → 0.49.0

package/src/utils/timeService.ts

@@ -0,0 +1,139 @@
+import {tzScan} from "@date-fns/tz";
+import type {TClusterAttributes} from "../zspec/zcl/definition/clusters-types";
+
+const OneJanuary2000 = new Date("January 01, 2000 00:00:00 UTC+00:00").getTime();
+const OneDayInMilliseconds = 24 * 60 * 60 * 1000;
+
+const cachedTimeData: Pick<TClusterAttributes<"genTime">, "timeZone" | "dstStart" | "dstEnd" | "dstShift" | "validUntilTime"> = {
+    timeZone: 0,
+    dstStart: 0,
+    dstEnd: 0,
+    dstShift: 0,
+    validUntilTime: 0,
+};
+
+export function timestampToZigbeeUtcTime(timestamp: number) {
+    return timestamp === 0xffffffff ? timestamp : Math.round((timestamp - OneJanuary2000) / 1000);
+}
+
+function recalculateTimeData(currentDate: Date) {
+    const currentTime = currentDate.getTime();
+    const currentYear = currentDate.getUTCFullYear();
+
+    // Default values considering the time zone has no DST.
+    let timeZoneDifferenceToUtc = currentDate.getTimezoneOffset() !== 0 ? currentDate.getTimezoneOffset() * -1 * 60 : 0;
+    let dstStart = 0xffffffff;
+    let dstEnd = 0xffffffff;
+    let dstShift = 0;
+    const validUntilTime = currentTime + OneDayInMilliseconds;
+
+    const localTimeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+    const dstChangesThisYear = tzScan(localTimeZone, {
+        start: new Date(currentYear, 1),
+        end: new Date(currentYear, 12),
+    });
+
+    // Countries may leave/introduce DST, which isn't supported here.
+    // Therefore, we always have to check that the returned number
+    // of changes is exactly 2.
+    const hasRegularDst = dstChangesThisYear.length === 2;
+
+    if (hasRegularDst) {
+        const isNorthernHemisphere = dstChangesThisYear[0].change > 0;
+
+        if (isNorthernHemisphere) {
+            // getTimezoneOffset() called before includes the DST
+            // offset, so, we can't use it when dstShift !== 0.
+            timeZoneDifferenceToUtc = dstChangesThisYear[1].offset * 60;
+            dstStart = dstChangesThisYear[0].date.getTime();
+            // tzScan returns the first second on which a new shift has to be applied.
+            // This is fine for dstStart, but dstEnd has to be the last second of the
+            // DST period. Otherwise, the following equation copied from the ZCL spec
+            // isn't met anymore:
+            //
+            // Local Time = Standard Time + DstShift (if DstStart <= Time <= DstEnd)
+            //
+            // Therefore, we have to remove one second on all dstEnd times below.
+            dstEnd = dstChangesThisYear[1].date.getTime() - 1000;
+            dstShift = dstChangesThisYear[0].change * 60;
+        } else {
+            const dstStartIsInPreviousYear = currentTime < dstChangesThisYear[0].date.getTime();
+
+            if (dstStartIsInPreviousYear) {
+                const dstChangesLastYear = tzScan(localTimeZone, {
+                    start: new Date(currentYear - 1, 1),
+                    end: new Date(currentYear - 1, 12),
+                });
+                const hadRegularDstLastYear = dstChangesLastYear.length === 2;
+
+                if (hadRegularDstLastYear) {
+                    timeZoneDifferenceToUtc = dstChangesThisYear[0].offset * 60;
+                    dstStart = dstChangesLastYear[1].date.getTime();
+                    dstEnd = dstChangesThisYear[0].date.getTime() - 1000;
+                    dstShift = dstChangesLastYear[1].change * 60;
+                }
+            } else {
+                const dstChangesNextYear = tzScan(localTimeZone, {
+                    start: new Date(currentYear + 1, 1),
+                    end: new Date(currentYear + 1, 12),
+                });
+                const hasRegularDstNextYear = dstChangesNextYear.length === 2;
+
+                if (hasRegularDstNextYear) {
+                    timeZoneDifferenceToUtc = dstChangesThisYear[0].offset * 60;
+                    dstStart = dstChangesThisYear[1].date.getTime();
+                    dstEnd = dstChangesNextYear[0].date.getTime() - 1000;
+                    dstShift = dstChangesThisYear[1].change * 60;
+                }
+            }
+        }
+    }
+
+    cachedTimeData.timeZone = timeZoneDifferenceToUtc;
+    cachedTimeData.dstStart = timestampToZigbeeUtcTime(dstStart);
+    cachedTimeData.dstEnd = timestampToZigbeeUtcTime(dstEnd);
+    cachedTimeData.dstShift = dstShift;
+    cachedTimeData.validUntilTime = timestampToZigbeeUtcTime(validUntilTime);
+}
+
+export function getTimeClusterAttributes(): TClusterAttributes<"genTime"> {
+    const currentDate = new Date();
+    const currentZigbeeUtcTime = timestampToZigbeeUtcTime(currentDate.getTime());
+
+    if (currentZigbeeUtcTime >= cachedTimeData.validUntilTime) {
+        recalculateTimeData(currentDate);
+    }
+
+    const standardTime = currentZigbeeUtcTime + cachedTimeData.timeZone;
+    let localTime = standardTime;
+
+    if (currentZigbeeUtcTime >= cachedTimeData.dstStart && currentZigbeeUtcTime <= cachedTimeData.dstEnd) {
+        localTime = standardTime + cachedTimeData.dstShift;
+    }
+
+    return {
+        time: currentZigbeeUtcTime,
+        // Bit 0: Master clock
+        // Bit 1: Not synchronized (as Master bit is 1)
+        // Bit 2: Master for Time Zone and DST
+        // Bit 3: Time synchronization SHOULD be superseded
+        timeStatus: 0b1101,
+        timeZone: cachedTimeData.timeZone,
+        dstStart: cachedTimeData.dstStart,
+        dstEnd: cachedTimeData.dstEnd,
+        dstShift: cachedTimeData.dstShift,
+        standardTime: standardTime,
+        localTime: localTime,
+        lastSetTime: currentZigbeeUtcTime,
+        validUntilTime: cachedTimeData.validUntilTime,
+    };
+}
+
+/** used by tests */
+export function clearCachedTimeData() {
+    cachedTimeData.timeZone = 0;
+    cachedTimeData.dstStart = 0;
+    cachedTimeData.dstEnd = 0;
+    cachedTimeData.dstShift = 0;
+    cachedTimeData.validUntilTime = 0;
+}

package/src/utils/utils.ts

@@ -0,0 +1,19 @@
+export function isNumberArray(value: unknown): value is number[] {
+    return Array.isArray(value) && value.every((item) => typeof item === "number");
+}
+
+export function isNumberArrayOfLength(value: unknown, length: number): boolean {
+    return isNumberArray(value) && value.length === length;
+}
+
+export function assertString(input: unknown): asserts input is string {
+    if (typeof input !== "string") {
+        throw new Error("Input must be a string!");
+    }
+}
+
+export function isObjectEmpty(object: object): boolean {
+    // much faster than checking `Object.keys(object).length`
+    for (const _k in object) return false;
+    return true;
+}

package/src/utils/wait.ts

@@ -0,0 +1,5 @@
+export function wait(milliseconds: number): Promise<void> {
+    return new Promise((resolve): void => {
+        setTimeout((): void => resolve(), milliseconds);
+    });
+}

package/src/utils/waitress.ts

@@ -0,0 +1,96 @@
+interface Waiter<TPayload, TMatcher> {
+    ID: number;
+    resolve: (payload: TPayload) => void;
+    reject: (error: Error) => void;
+    timer?: NodeJS.Timeout;
+    resolved: boolean;
+    timedout: boolean;
+    matcher: TMatcher;
+}
+
+type Validator<TPayload, TMatcher> = (payload: TPayload, matcher: TMatcher) => boolean;
+type TimeoutFormatter<TMatcher> = (matcher: TMatcher, timeout: number) => string;
+
+export class Waitress<TPayload, TMatcher> {
+    private waiters: Map<number, Waiter<TPayload, TMatcher>>;
+    private readonly validator: Validator<TPayload, TMatcher>;
+    private readonly timeoutFormatter: TimeoutFormatter<TMatcher>;
+    private currentID: number;
+
+    public constructor(validator: Validator<TPayload, TMatcher>, timeoutFormatter: TimeoutFormatter<TMatcher>) {
+        this.waiters = new Map();
+        this.timeoutFormatter = timeoutFormatter;
+        this.validator = validator;
+        this.currentID = 0;
+    }
+
+    public clear(): void {
+        for (const [, waiter] of this.waiters) {
+            clearTimeout(waiter.timer);
+        }
+
+        this.waiters.clear();
+    }
+
+    public resolve(payload: TPayload): boolean {
+        return this.forEachMatching(payload, (waiter) => waiter.resolve(payload));
+    }
+
+    public reject(payload: TPayload, message: string): boolean {
+        return this.forEachMatching(payload, (waiter) => waiter.reject(new Error(message)));
+    }
+
+    public remove(id: number): void {
+        const waiter = this.waiters.get(id);
+        if (waiter) {
+            if (!waiter.timedout && waiter.timer) {
+                clearTimeout(waiter.timer);
+            }
+
+            this.waiters.delete(id);
+        }
+    }
+
+    public waitFor(matcher: TMatcher, timeout: number): {ID: number; start: () => {promise: Promise<TPayload>; ID: number}} {
+        this.currentID += 1;
+        const ID = this.currentID;
+
+        const promise: Promise<TPayload> = new Promise((resolve, reject): void => {
+            const object: Waiter<TPayload, TMatcher> = {matcher, resolve, reject, timedout: false, resolved: false, ID};
+            this.waiters.set(ID, object);
+        });
+
+        const start = (): {promise: Promise<TPayload>; ID: number} => {
+            const waiter = this.waiters.get(ID);
+            if (waiter && !waiter.resolved && !waiter.timer) {
+                // Capture the stack trace from the caller of start()
+                const error = new Error(this.timeoutFormatter(matcher, timeout));
+                Error.captureStackTrace(error);
+                waiter.timer = setTimeout((): void => {
+                    waiter.timedout = true;
+                    waiter.reject(error);
+                }, timeout);
+            }
+
+            return {promise, ID};
+        };
+
+        return {ID, start};
+    }
+
+    private forEachMatching(payload: TPayload, action: (waiter: Waiter<TPayload, TMatcher>) => void): boolean {
+        let foundMatching = false;
+        for (const [index, waiter] of this.waiters.entries()) {
+            if (waiter.timedout) {
+                this.waiters.delete(index);
+            } else if (this.validator(payload, waiter.matcher)) {
+                clearTimeout(waiter.timer);
+                waiter.resolved = true;
+                this.waiters.delete(index);
+                action(waiter);
+                foundMatching = true;
+            }
+        }
+        return foundMatching;
+    }
+}

package/src/zspec/consts.ts

@@ -0,0 +1,89 @@
+import type {ExtendedPanId} from "./tstypes";
+
+/** Current supported Zigbee revision: https://csa-iot.org/wp-content/uploads/2023/04/05-3474-23-csg-zigbee-specification-compressed.pdf */
+export const ZIGBEE_REVISION = 23;
+
+/** The network ID of the coordinator in a Zigbee network is 0x0000. */
+export const COORDINATOR_ADDRESS = 0x0000;
+
+/** Min network address reserved for broadcasting (up to 0xffff) */
+export const BROADCAST_MIN = 0xfff8;
+
+/** Endpoint profile ID for Zigbee 3.0. "Home Automation" */
+export const HA_PROFILE_ID = 0x0104;
+/** Endpoint profile ID for Smart Energy */
+export const SE_PROFILE_ID = 0x0109;
+/** Endpoint profile ID for Green Power */
+export const GP_PROFILE_ID = 0xa1e0;
+/** The touchlink (Zigbee Light Link/ZLL) Profile ID. */
+export const TOUCHLINK_PROFILE_ID = 0xc05e;
+/** The profile ID used to address all the public profiles. */
+export const WILDCARD_PROFILE_ID = 0xffff;
+/** The profile ID used to access Shelly devices custom clusters. */
+export const CUSTOM_SHELLY_PROFILE_ID = 0xc001;
+
+/** The default HA endpoint. */
+export const HA_ENDPOINT = 0x01;
+/** The GP endpoint, as defined in the Zigbee spec. */
+export const GP_ENDPOINT = 0xf2;
+
+export const GP_GROUP_ID = 0x0b84;
+
+/** The maximum 802.15.4 channel number is 26. */
+export const MAX_802_15_4_CHANNEL_NUMBER = 26;
+/** The minimum 2.4GHz 802.15.4 channel number is 11. */
+export const MIN_802_15_4_CHANNEL_NUMBER = 11;
+/** There are sixteen 802.15.4 channels. */
+export const NUM_802_15_4_CHANNELS = MAX_802_15_4_CHANNEL_NUMBER - MIN_802_15_4_CHANNEL_NUMBER + 1;
+/** A bitmask to scan all 2.4 GHz 802.15.4 channels. */
+export const ALL_802_15_4_CHANNELS_MASK = 0x07fff800;
+/** A bitmask of the preferred 2.4 GHz 802.15.4 channels to scan. */
+export const PREFERRED_802_15_4_CHANNELS_MASK = 0x0318c800;
+/** List of all Zigbee channels */
+export const ALL_802_15_4_CHANNELS = [11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26];
+/** List of preferred Zigbee channels */
+export const PREFERRED_802_15_4_CHANNELS = [11, 14, 15, 19, 20, 24, 25];
+
+/** A blank (also used as "wildcard") EUI64 hex string prefixed with 0x */
+export const BLANK_EUI64 = "0xffffffffffffffff";
+/** A blank extended PAN ID. (null/not present) */
+export const BLANK_EXTENDED_PAN_ID: Readonly<ExtendedPanId> = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
+
+/** An invalid profile ID. This is a reserved profileId. */
+export const INVALID_PROFILE_ID = 0xffff;
+/** An invalid cluster ID. */
+export const INVALID_CLUSTER_ID = 0xffff;
+/** An invalid PAN ID. */
+export const INVALID_PAN_ID = 0xffff;
+
+/** A distinguished network ID that will never be assigned to any node. It is used to indicate the absence of a node ID. */
+export const NULL_NODE_ID = 0xffff;
+/** A distinguished binding index used to indicate the absence of a binding. */
+export const NULL_BINDING = 0xff;
+
+/** This key is "ZigBeeAlliance09" */
+export const INTEROPERABILITY_LINK_KEY: readonly number[] = [
+    0x5a, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6c, 0x6c, 0x69, 0x61, 0x6e, 0x63, 0x65, 0x30, 0x39,
+];
+
+export const PERMIT_JOIN_FOREVER = 0xff;
+export const PERMIT_JOIN_MAX_TIMEOUT = 0xfe;
+
+/** Size of EUI64 (an IEEE address) in bytes. */
+export const EUI64_SIZE = 8;
+/** Size of an PAN identifier in bytes. */
+export const PAN_ID_SIZE = 2;
+/** Size of an extended PAN identifier in bytes. */
+export const EXTENDED_PAN_ID_SIZE = 8;
+/** Size of an encryption key in bytes. */
+export const DEFAULT_ENCRYPTION_KEY_SIZE = 16;
+/** Size of a AES-128-MMO (Matyas-Meyer-Oseas) block in bytes. */
+export const AES_MMO_128_BLOCK_SIZE = 16;
+/**
+ * Valid install code sizes, including `INSTALL_CODE_CRC_SIZE`.
+ *
+ * NOTE: 18 is now standard, first for iterations, order after is important (8 before 10)!
+ */
+export const INSTALL_CODE_SIZES: ReadonlyArray<number> = [18, 8, 10, 14];
+/** Size of the CRC appended to install codes. */
+export const INSTALL_CODE_CRC_SIZE = 2;

package/src/zspec/enums.ts

@@ -0,0 +1,22 @@
+/**
+ * Zigbee Broadcast Addresses
+ *
+ * Zigbee specifies three different broadcast addresses that reach different collections of nodes.
+ * Broadcasts are normally sent only to routers.
+ * Broadcasts can also be forwarded to end devices, either all of them or only those that do not sleep.
+ * Broadcasting to end devices is both significantly more resource-intensive and significantly less reliable than broadcasting to routers.
+ */
+export enum BroadcastAddress {
+    // Reserved = 0xfff8,
+    // Reserved = 0xfff9,
+    // Reserved = 0xfffa,
+    /** Low power routers only */
+    LOW_POWER_ROUTERS = 0xfffb,
+    /** All routers and coordinator */
+    DEFAULT = 0xfffc,
+    /** macRxOnWhenIdle = TRUE (all non-sleepy devices) */
+    RX_ON_WHEN_IDLE = 0xfffd,
+    // Reserved = 0xFFFE,
+    /** All devices in PAN (including sleepy end devices) */
+    SLEEPY = 0xffff,
+}

package/src/zspec/index.ts

@@ -0,0 +1,3 @@
+export * from "./consts";
+export * from "./enums";
+export * as Utils from "./utils";

package/src/zspec/tstypes.ts

@@ -0,0 +1,18 @@
+/**
+ * EUI 64-bit ID (IEEE 802.15.4 long address). uint8[EUI64_SIZE]
+ *
+ * NOTE: Expected to contain `0x` prefix
+ */
+export type Eui64 = `0x${string}`;
+/** IEEE 802.15.4 node ID. Also known as short address. uint16 */
+export type NodeId = number;
+/** IEEE 802.15.4 PAN ID. uint16 */
+export type PanId = number;
+/** PAN 64-bit ID (IEEE 802.15.4 long address). uint8[EXTENDED_PAN_ID_SIZE] */
+export type ExtendedPanId = number[];
+/** 16-bit Zigbee multicast group identifier. uint16 */
+export type MulticastId = number;
+/** Refer to the Zigbee application profile ID. uint16 */
+export type ProfileId = number;
+/** Refer to the ZCL cluster ID. uint16 */
+export type ClusterId = number;

package/src/zspec/utils.ts

@@ -0,0 +1,247 @@
+import {createCipheriv} from "node:crypto";
+import {AES_MMO_128_BLOCK_SIZE, ALL_802_15_4_CHANNELS} from "./consts";
+import {BroadcastAddress} from "./enums";
+import type {Eui64} from "./tstypes";
+
+/**
+ * Convert a channels array to a uint32 channel mask.
+ * @param channels
+ * @returns
+ */
+export const channelsToUInt32Mask = (channels: number[]): number => {
+    return channels.reduce((a, c) => a + (1 << c), 0);
+};
+
+/**
+ * Convert a uint32 channel mask to a channels array.
+ * @param mask
+ * @returns
+ */
+export const uint32MaskToChannels = (mask: number): number[] => {
+    const channels: number[] = [];
+
+    for (const channel of ALL_802_15_4_CHANNELS) {
+        if ((2 ** channel) & mask) {
+            channels.push(channel);
+        }
+    }
+
+    return channels;
+};
+
+export const isBroadcastAddress = (address: number): boolean => {
+    return (
+        address === BroadcastAddress.DEFAULT ||
+        address === BroadcastAddress.RX_ON_WHEN_IDLE ||
+        address === BroadcastAddress.SLEEPY ||
+        address === BroadcastAddress.LOW_POWER_ROUTERS
+    );
+};
+
+/**
+ * Represent a little endian buffer in `0x...` form
+ *
+ * NOTE: the buffer is always copied to avoid reversal in reference
+ */
+export const eui64LEBufferToHex = (eui64LEBuf: Buffer): Eui64 => `0x${Buffer.from(eui64LEBuf).reverse().toString("hex")}`;
+
+/**
+ * Represent a big endian buffer in `0x...` form
+ */
+export const eui64BEBufferToHex = (eui64BEBuf: Buffer): Eui64 => `0x${eui64BEBuf.toString("hex")}`;
+
+/**
+ * Calculate the CRC 8, 16 or 32 for the given data.
+ *
+ * @see https://www.crccalc.com/
+ *
+ * @param data
+ * @param length CRC Length
+ * @param poly Polynomial
+ * @param crc Initialization value
+ * @param xorOut Final XOR value
+ * @param refIn Reflected In
+ * @param refOut Reflected Out
+ * @returns The calculated CRC
+ *
+ * NOTE: This is not exported for test coverage reasons (large number of combinations possible, many unused).
+ *       Specific, needed, algorithms should be defined as exported wrappers below, and coverage added for them.
+ */
+function calcCRC(
+    data: number[] | Uint8Array | Buffer,
+    length: 8 | 16 | 32,
+    poly: number,
+    crc = 0,
+    xorOut = 0,
+    refIn = false,
+    refOut = false,
+): number {
+    // https://web.archive.org/web/20150226083354/http://leetcode.com/2011/08/reverse-bits.html
+    const reflect = (x: number, size: 8 | 16 | 32): number => {
+        if (size === 8) {
+            x = ((x & 0x55) << 1) | ((x & 0xaa) >> 1);
+            x = ((x & 0x33) << 2) | ((x & 0xcc) >> 2);
+            x = ((x & 0x0f) << 4) | ((x & 0xf0) >> 4);
+        } else if (size === 16) {
+            x = ((x & 0x5555) << 1) | ((x & 0xaaaa) >> 1);
+            x = ((x & 0x3333) << 2) | ((x & 0xcccc) >> 2);
+            x = ((x & 0x0f0f) << 4) | ((x & 0xf0f0) >> 4);
+            x = ((x & 0x00ff) << 8) | ((x & 0xff00) >> 8);
+            /* v8 ignore start */
+        } /* if (size === 32) */ else {
+            x = ((x & 0x55555555) << 1) | ((x & 0xaaaaaaaa) >> 1);
+            x = ((x & 0x33333333) << 2) | ((x & 0xcccccccc) >> 2);
+            x = ((x & 0x0f0f0f0f) << 4) | ((x & 0xf0f0f0f0) >> 4);
+            x = ((x & 0x00ff00ff) << 8) | ((x & 0xff00ff00) >> 8);
+            x = ((x & 0x0000ffff) << 16) | ((x & 0xffff0000) >> 16);
+        }
+        /* v8 ignore stop */
+
+        return x;
+    };
+
+    poly = (1 << length) | poly;
+
+    for (let byte of data) {
+        if (refIn) {
+            byte = reflect(byte, 8);
+        }
+
+        crc ^= byte << (length - 8);
+
+        for (let i = 0; i < 8; i++) {
+            crc <<= 1;
+
+            if (crc & (1 << length)) {
+                crc ^= poly;
+            }
+        }
+    }
+
+    if (refOut) {
+        crc = reflect(crc, length);
+    }
+
+    return crc ^ xorOut;
+}
+
+/**
+ * CRC-16/X-25
+ * aka CRC-16/IBM-SDLC
+ * aka CRC-16/ISO-HDLC
+ * aka CRC-16/ISO-IEC-14443-3-B
+ * aka CRC-B
+ * aka X-25
+ *
+ * Shortcut for `calcCRC(data, 16, 0x1021, 0xFFFF, 0xFFFF, true, true)`
+ *
+ * Used for Install Codes - see Document 13-0402-13 - 10.1
+ */
+export function crc16X25(data: number[] | Uint8Array | Buffer): number {
+    return calcCRC(data, 16, 0x1021, 0xffff, 0xffff, true, true);
+}
+
+/**
+ * CRC-16/XMODEM
+ * aka CRC-16/ACORN
+ * aka CRC-16/LTE
+ * aka CRC-16/V-41-MSB
+ * aka XMODEM
+ * aka ZMODEM
+ *
+ * Shortcut for `calcCRC(data, 16, 0x1021)`
+ *
+ * Used for XMODEM transfers, often involved in Zigbee environments
+ */
+export function crc16XMODEM(data: number[] | Uint8Array | Buffer): number {
+    return calcCRC(data, 16, 0x1021);
+}
+
+/**
+ * CRC-16/CCITT
+ * aka CRC-16/KERMIT
+ * aka CRC-16/BLUETOOTH
+ * aka CRC-16/CCITT-TRUE
+ * aka CRC-16/V-41-LSB
+ * aka CRC-CCITT
+ * aka KERMIT
+ *
+ * Shortcut for `calcCRC(data, 16, 0x1021, 0x0000, 0x0000, true, true)`
+ */
+export function crc16CCITT(data: number[] | Uint8Array | Buffer): number {
+    return calcCRC(data, 16, 0x1021, 0x0000, 0x0000, true, true);
+}
+
+/**
+ * CRC-16/CCITT-FALSE
+ * aka CRC-16/IBM-3740
+ * aka CRC-16/AUTOSAR
+ *
+ * Shortcut for `calcCRC(data, 16, 0x1021, 0xffff)`
+ */
+export function crc16CCITTFALSE(data: number[] | Uint8Array | Buffer): number {
+    return calcCRC(data, 16, 0x1021, 0xffff);
+}
+
+function aes128MmoHashUpdate(result: Buffer, data: Buffer, dataSize: number): void {
+    while (dataSize >= AES_MMO_128_BLOCK_SIZE) {
+        const cipher = createCipheriv("aes-128-ecb", result, null);
+        const block = data.subarray(0, AES_MMO_128_BLOCK_SIZE);
+        const encryptedBlock = Buffer.concat([cipher.update(block), cipher.final()]);
+
+        // XOR encrypted and plaintext
+        for (let i = 0; i < AES_MMO_128_BLOCK_SIZE; i++) {
+            result[i] = encryptedBlock[i] ^ block[i];
+        }
+
+        data = data.subarray(AES_MMO_128_BLOCK_SIZE);
+        dataSize -= AES_MMO_128_BLOCK_SIZE;
+    }
+}
+
+/**
+ * AES-128-MMO (Matyas-Meyer-Oseas) hashing (using node 'crypto' built-in with 'aes-128-ecb')
+ *
+ * Used for Install Codes - see Document 13-0402-13 - 10.1
+ */
+export function aes128MmoHash(data: Buffer): Buffer {
+    const hashResult = Buffer.alloc(AES_MMO_128_BLOCK_SIZE);
+    const temp = Buffer.alloc(AES_MMO_128_BLOCK_SIZE);
+    let remainingLength = data.length;
+    let position = 0;
+
+    for (position; remainingLength >= AES_MMO_128_BLOCK_SIZE; ) {
+        const chunk = data.subarray(position, position + AES_MMO_128_BLOCK_SIZE);
+
+        aes128MmoHashUpdate(hashResult, chunk, chunk.length);
+
+        position += AES_MMO_128_BLOCK_SIZE;
+        remainingLength -= AES_MMO_128_BLOCK_SIZE;
+    }
+
+    for (let i = 0; i < remainingLength; i++) {
+        temp[i] = data[position + i];
+    }
+
+    // per the spec, concatenate a 1 bit followed by all zero bits
+    temp[remainingLength] = 0x80;
+
+    // if appending the bit string will push us beyond the 16-byte boundary, hash that block and append another 16-byte block
+    if (AES_MMO_128_BLOCK_SIZE - remainingLength < 3) {
+        aes128MmoHashUpdate(hashResult, temp, AES_MMO_128_BLOCK_SIZE);
+        temp.fill(0);
+    }
+
+    temp[AES_MMO_128_BLOCK_SIZE - 2] = (data.length >> 5) & 0xff;
+    temp[AES_MMO_128_BLOCK_SIZE - 1] = (data.length << 3) & 0xff;
+
+    aes128MmoHashUpdate(hashResult, temp, AES_MMO_128_BLOCK_SIZE);
+
+    const result = Buffer.alloc(AES_MMO_128_BLOCK_SIZE);
+
+    for (let i = 0; i < AES_MMO_128_BLOCK_SIZE; i++) {
+        result[i] = hashResult[i];
+    }
+
+    return result;
+}