jooby-codec 1.15.0 → 2.1.0

package/dist/analog/Command.d.ts

@@ -0,0 +1,29 @@
+import { IHexFormatOptions } from '../config.js';
+export interface ICommandExample {
+    name: string;
+    parameters?: object;
+    config?: {
+        hardwareType?: number;
+    };
+    hex: {
+        header: string;
+        body: string;
+    };
+}
+export type TCommandExampleList = Array<ICommandExample>;
+declare abstract class Command {
+    static id: number;
+    static directionType: unknown;
+    static title: string;
+    static examples: TCommandExampleList;
+    static hasParameters: boolean;
+    parameters: unknown;
+    config: unknown;
+    static getId(): string;
+    static toBytes(id: number, commandData?: Uint8Array): Uint8Array;
+    getParameters(): unknown;
+    toBytes(): Uint8Array;
+    toHex(options?: IHexFormatOptions): string;
+    toJson(): string;
+}
+export default Command;

package/dist/analog/Command.js

@@ -0,0 +1,34 @@
+import * as header from './header.js';
+import getHexFromBytes from '../utils/getHexFromBytes.js';
+import getHexFromNumber from '../utils/getHexFromNumber.js';
+class Command {
+    static getId() {
+        return getHexFromNumber(this.id);
+    }
+    static toBytes(id, commandData) {
+        const commandLength = commandData?.length ?? 0;
+        const headerData = header.toBytes(id, commandLength);
+        if (commandData && commandLength) {
+            const resultData = new Uint8Array(headerData.length + commandLength);
+            resultData.set(headerData);
+            resultData.set(commandData, headerData.length);
+            return resultData;
+        }
+        return headerData;
+    }
+    getParameters() {
+        return this.parameters;
+    }
+    toBytes() {
+        throw new Error('not implemented!');
+    }
+    toHex(options = {}) {
+        return getHexFromBytes(this.toBytes(), options);
+    }
+    toJson() {
+        return JSON.stringify(this.getParameters());
+    }
+}
+Command.hasParameters = false;
+export default Command;
+//# sourceMappingURL=Command.js.map

package/dist/analog/Command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../src/analog/Command.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAqB5D,MAAe,OAAO;IAoBlB,MAAM,CAAC,KAAK;QACR,OAAO,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IA+CD,MAAM,CAAC,OAAO,CAAG,EAAU,EAAE,WAAwB;QACjD,MAAM,aAAa,GAAG,WAAW,EAAE,MAAM,IAAI,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QAErD,IAAK,WAAW,IAAI,aAAa,EAAG;YAChC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;YAErE,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC3B,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;YAE/C,OAAO,UAAU,CAAC;SACrB;QAGD,OAAO,UAAU,CAAC;IACtB,CAAC;IAGD,aAAa;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAGD,OAAO;QACH,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAG,UAA6B,EAAE;QACnC,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAOD,MAAM;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IAChD,CAAC;;AAlGM,qBAAa,GAAG,KAAK,CAAC;AAsGjC,eAAe,OAAO,CAAC"}

package/dist/{CommandBinaryBuffer.d.ts → analog/CommandBinaryBuffer.d.ts}

@@ -1,299 +1,129 @@
-import BinaryBuffer from './BinaryBuffer.js';
-import { TTime2000 } from './utils/time.js';
+import BinaryBuffer from '../utils/BinaryBuffer.js';
+import { TTime2000 } from '../utils/time.js';
 export interface IBatteryVoltage {
-    /**
-     * battery voltage value at low consumption, in mV
-     *
-     * `4095` - unknown value and becomes `undefined`
-     */
     low: number | undefined;
-    /**
-     * battery voltage value at hight consumption, in mV
-     *
-     * `4095` - unknown value and becomes `undefined`
-     */
     high: number | undefined;
 }
 export interface IChannel {
-    /** channel number */
     index: number;
 }
 export interface IChannelValue extends IChannel {
-    /** pulse counter or absolute value of device channel */
     value: number;
 }
 export interface IChannelHours extends IChannelValue {
-    /** values differences between hours */
     diff: Array<number>;
 }
 export interface IChannelHourAbsoluteValue extends IChannelHours {
-    /** channel pulse coefficient */
     pulseCoefficient: number;
 }
 export interface IChannelDays extends IChannel {
     dayList: Array<number>;
 }
 export interface IChannelAbsoluteValue extends IChannelValue {
-    /** channel pulse coefficient */
     pulseCoefficient: number;
 }
 export interface IChannelArchiveDaysAbsolute extends IChannel {
-    /** values by days */
     dayList: Array<number>;
-    /** Channel pulse coefficient */
     pulseCoefficient: number;
 }
 export interface IChannelArchiveDays extends IChannel {
-    /** values by days */
     dayList: Array<number>;
 }
 export interface IEventGasStatus {
-    /** the battery voltage has dropped below the set threshold */
     isBatteryLow?: boolean;
-    /** there is a magnetic field influence */
     isMagneticInfluence?: boolean;
-    /** button is release (device is unmounted) */
     isButtonReleased?: boolean;
-    /** the device has detected a loss of connection to the server */
     isConnectionLost?: boolean;
 }
 export interface IEvent2ChannelStatus {
-    /** the battery voltage has dropped below the set threshold */
     isBatteryLow?: boolean;
-    /** the device has detected a loss of connection to the server */
     isConnectionLost?: boolean;
-    /** the first channel is not active */
     isFirstChannelInactive?: boolean;
-    /** the second channel is not active */
     isSecondChannelInactive?: boolean;
 }
 export interface IEventElimpStatus {
-    /** the device has detected a loss of connection to the server */
     isConnectionLost?: boolean;
 }
 export interface IEvent4ChannelStatus {
-    /** the battery voltage has dropped below the set threshold */
     isBatteryLow?: boolean;
-    /** the device has detected a loss of connection to the server */
     isConnectionLost?: boolean;
-    /** the first channel is not active */
     isFirstChannelInactive?: boolean;
-    /** the second channel is not active */
     isSecondChannelInactive?: boolean;
-    /** the third channel is not active */
     isThirdChannelInactive?: boolean;
-    /** the forth channel is not active */
     isForthChannelInactive?: boolean;
 }
 export interface IEventMtxStatus {
-    /** meter case is open */
     isMeterCaseOpen?: boolean;
-    /** there is a magnetic field influence */
     isMagneticInfluence?: boolean;
-    /** parameters set remotely */
     isParametersSetRemotely?: boolean;
-    /** parameters set locally */
     isParametersSetLocally?: boolean;
-    /** meter program restart */
     isMeterProgramRestarted?: boolean;
-    /** incorrect password and lockout */
     isLockedOut?: boolean;
-    /** time set */
     isTimeSet?: boolean;
-    /** time correction */
     isTimeCorrected?: boolean;
-    /** meter failure */
     isMeterFailure?: boolean;
-    /** meter terminal box is open */
     isMeterTerminalBoxOpen?: boolean;
-    /** meter module compartment is open */
     isModuleCompartmentOpen?: boolean;
-    /** tariff plan changed */
     isTariffPlanChanged?: boolean;
-    /** new tariff plan received */
     isNewTariffPlanReceived?: boolean;
 }
-/**
- * Device send data periodically using this interval.
- * deviceParameters.REPORTING_DATA_INTERVAL = `1`.
- */
 interface IParameterReportingDataInterval {
-    /**
-     * Minimal interval for data sending from device (in seconds).
-     * Real value = value + pseudo-random value which is not more than `255` * `4`.
-     */
     value: number;
 }
-/**
- * The parameter defines the hour of the day by which the daily consumption is calculated.
- * deviceParameters.DAY_CHECKOUT_HOUR = `4`.
- */
 interface IParameterDayCheckoutHour {
     value: number;
 }
-/**
- * Type of data from device.
- * deviceParameters.REPORTING_DATA_TYPE = `5`.
- */
 interface IParameterReportingDataType {
-    /**
-     * `0` - hour, by default
-     * `1` - day
-     * `2` - current
-     * `3` - hour + day
-     */
     type: number;
 }
-/**
- * Delivery type of priority data, with or without acknowledgment.
- * Priority data - frames from uplink/NewEvent command.
- * deviceParameters.PRIORITY_DATA_DELIVERY_TYPE = `8`.
- */
 interface IParameterDeliveryTypeOfPriorityData {
-    /**
-     * `0` - delivery with confirmation
-     * `1` - delivery without confirmation
-     */
     value: number;
 }
-/**
- * Device activation method in LoRaWAN network.
- * deviceParameters.ACTIVATION_METHOD = `9`.
- */
 interface IParameterActivationMethod {
-    /**
-     * `0` - OTAA, by default
-     * `1` - ABP
-     *
-     * @see https://www.thethingsindustries.com/docs/devices/abp-vs-otaa/
-     */
     type: number;
 }
-/**
- * Channels config, only for universal 4-channels devices
- * deviceParameters.CHANNELS_CONFIG = `13`.
- */
 interface IParameterChannelsConfig {
-    /**
-     * value from 0 to 18, [values description](https://github.com/jooby-dev/jooby-docs/blob/main/docs/parameter-types.md#channels-config)
-     */
     value: number;
 }
-/**
- * RX2 configuration.
- * deviceParameters.RX2_CONFIG = `18`.
- *
- * @see https://www.thethingsindustries.com/docs/reference/glossary/
- */
 interface IParameterRx2Config {
-    /**
-     * The transmission speed or Data Rate of a LoRaWAN message, ranging from `SF7` (highest Data Rate) to `SF12` (lowest Data Rate).
-     * Making the spreading factor `1` step lower (from `SF10` to `SF9`) allows you to roughly send the same amount of data use half the time on air.
-     * Lowering the spreading factor makes it more difficult for the gateway to receive a transmission, as it will be more sensitive to noise.
-     *
-     * @see https://www.thethingsnetwork.org/docs/lorawan/spreading-factors/
-     */
     spreadFactor: number;
-    /**
-     * RX2 data rate frequency.
-     * The second receive window (RX2) uses a fixed frequency and data rate.
-     * This value configures the frequency to use in RX2.
-     * Changing the desired value makes the Network Server transmit the RXParamSetupReq MAC command.
-     */
     frequency: number;
 }
-/**
- * Device battery depassivation information.
- * deviceParameters.BATTERY_DEPASSIVATION_INFO = `10`.
- */
 interface IParameterBatteryDepassivationInfo {
-    /** battery load time in milliseconds */
     loadTime: number;
-    /** battery internal resistance, in mΩ */
     internalResistance: number;
-    /** battery low voltage, in mV  */
     lowVoltage: number;
 }
-/**
- * Device battery minimum required battery load time per day to prevent passivation.
- * deviceParameters.BATTERY_MINIMAL_LOAD_TIME = `11`.
- */
 interface IParameterBatteryMinimalLoadTime {
     value: number;
 }
-/**
- * Absolute data for pulse devices.
- * deviceParameters.ABSOLUTE_DATA = `23`.
- */
 interface IParameterAbsoluteData {
-    /** 4 byte int BE */
     value: number;
-    /** 4 byte int BE */
     meterValue: number;
     pulseCoefficient: number;
 }
-/**
- * Data type sending from device - absolute or not.
- * deviceParameters.ABSOLUTE_DATA_ENABLE = `24`
- */
 interface IParameterAbsoluteDataEnable {
-    /**
-     * `1` - absolute data enabled
-     * `0` - absolute data disabled, device send pulse counter
-     */
     state: number;
 }
-/**
- * Device serial number.
- * deviceParameters.SERIAL_NUMBER = `25`
- */
 interface IParameterSerialNumber {
-    /**
-     * hex string, 6 bytes
-     */
     value: string;
 }
-/**
- * Device geolocation.
- * deviceParameters.GEOLOCATION = `26`
- */
 interface IParameterGeolocation {
     latitude: number;
     longitude: number;
     altitude: number;
 }
-/**
- * Absolute data for multi-channel devices.
- * deviceParameters.ABSOLUTE_DATA_MULTI_CHANNEL = `29`.
- */
 interface IParameterAbsoluteDataMC extends IParameterAbsoluteData {
-    /** set data for specific channel */
     channel: number;
 }
-/**
- * Data type sending from device - absolute or not, multi-channel devices.
- * deviceParameters.ABSOLUTE_DATA_STATUS_MULTI_CHANNEL = `30`
- */
 interface IParameterAbsoluteDataEnableMC extends IParameterAbsoluteDataEnable {
-    /** channel that accept status changing */
     channel: number;
 }
-/**
- * Channels scan config for pulse devices.
- * deviceParameters.PULSE_CHANNELS_SCAN_CONFIG = `31`
- */
 interface IParameterPulseChannelsScanConfig {
-    /** channels to set configuration */
     channelList: Array<number>;
-    /** channel pull up time in microseconds */
     pullUpTime: number;
-    /** channel scan time in microseconds */
     scanTime: number;
 }
-/**
- * Set channels for pulse devices.
- * deviceParameters.PULSE_CHANNELS_SET_CONFIG = `32`
- */
 interface IParameterPulseChannelsSetConfig {
     channel1: boolean;
     channel2: boolean;
@@ -306,22 +136,7 @@ export interface IParameter {
 }
 export type TEventStatus = IEventGasStatus | IEvent2ChannelStatus | IEventElimpStatus | IEvent4ChannelStatus | IEventMtxStatus;
 type TParameterData = IParameterReportingDataInterval | IParameterReportingDataType | IParameterDayCheckoutHour | IParameterDeliveryTypeOfPriorityData | IParameterActivationMethod | IParameterBatteryDepassivationInfo | IParameterBatteryMinimalLoadTime | IParameterChannelsConfig | IParameterRx2Config | IParameterAbsoluteData | IParameterAbsoluteDataEnable | IParameterSerialNumber | IParameterGeolocation | IParameterAbsoluteDataMC | IParameterAbsoluteDataEnableMC | IParameterPulseChannelsScanConfig | IParameterPulseChannelsSetConfig;
-/**
- * Command specific byte array manipulation.
- */
 declare class CommandBinaryBuffer extends BinaryBuffer {
-    /**
-     * Get the number of bytes necessary to store an extended value.
-     *
-     * @param bits - the number of bits of original value
-     *
-     * @example
-     * ```js
-     * const bits = (16384).toString(2).length;
-     * const bytes = CommandBinaryBuffer.getExtendedValueSize(bits);
-     * // 16384 normally is stored in 2 bytes but for extended value 3 bytes are required
-     * ```
-     */
     static getExtendedValueSize(bits: number): number;
     static getParameterSize(parameter: IParameter): number;
     setInt12(value: number, isLittleEndian?: boolean): void;
@@ -330,34 +145,10 @@ declare class CommandBinaryBuffer extends BinaryBuffer {
     getUint12(isLittleEndian?: boolean): number;
     getExtendedValue(): number;
     setExtendedValue(value: number): void;
-    /**
-     * Get array of channel indexes.
-     */
     getChannels(): Array<number>;
-    /**
-     * Set array of channel indexes.
-     */
     setChannels(channelList: Array<IChannel>): void;
-    /**
-     * Retrieve device time from byte array.
-     *
-     * @example
-     * ['00101111', '10010111'] -> [47, 151] will be '2023-12-23'
-     *
-     * @returns Date object instance
-     */
     getDate(): Date;
-    /**
-     * Convert date or seconds to bytes.
-     * '2023-12-23' will be 0010111-1100-10111, so bytes: ['00101111', '10010111'] -> [47, 151]
-     */
     setDate(dateOrTime: Date | TTime2000): void;
-    /**
-     * Retrieve device time from byte array.
-     *
-     * @example
-     * 0xb8 = 0b10111000 will be {hours: 0b101, hour: 0b11000} i.e. {hours: 5, hour: 24}
-     */
     getHours(): {
         hours: number;
         hour: number;
@@ -369,10 +160,10 @@ declare class CommandBinaryBuffer extends BinaryBuffer {
     setBatteryVoltage(batteryVoltage: IBatteryVoltage): void;
     getChannelsValuesWithHourDiff(): {
         hours: number;
-        startTime: TTime2000;
+        startTime2000: TTime2000;
         channelList: Array<IChannelHours>;
     };
-    setChannelsValuesWithHourDiff(hours: number, startTime: TTime2000, channelList: Array<IChannelHours>): void;
+    setChannelsValuesWithHourDiff(hours: number, startTime2000: TTime2000, channelList: Array<IChannelHours>): void;
     getChannelsWithAbsoluteValues(): Array<IChannelAbsoluteValue>;
     setChannelsWithAbsoluteValues(channelList: Array<IChannelAbsoluteValue>): void;
     static getEventStatusSize(hardwareType: number): number;