mysa-js-sdk 3.1.0 → 3.1.2

package/dist/index.d.cts

@@ -187,8 +187,8 @@ declare class EventEmitter<TEvents extends Record<string, any>> implements NodeJ
     removeAllListeners<TEventName extends keyof TEvents & string>(eventName?: TEventName | undefined): this;
     setMaxListeners(n: number): this;
     getMaxListeners(): number;
-    listeners<TEventName extends keyof TEvents & string>(eventName: TEventName): Function[];
-    rawListeners<TEventName extends keyof TEvents & string>(eventName: TEventName): Function[];
+    listeners<TEventName extends keyof TEvents & string>(eventName: TEventName): ((...args: any[]) => void)[];
+    rawListeners<TEventName extends keyof TEvents & string>(eventName: TEventName): ((...args: any[]) => void)[];
     listenerCount<TEventName extends keyof TEvents & string>(eventName: TEventName, listener?: (...args: TEvents[TEventName]) => void): number;
     prependListener<TEventName extends keyof TEvents & string>(eventName: TEventName, listener: (...args: TEvents[TEventName]) => void): this;
     prependOnceListener<TEventName extends keyof TEvents & string>(eventName: TEventName, listener: (...args: TEvents[TEventName]) => void): this;
@@ -225,6 +225,8 @@ interface SupportedCaps {
         [modeId: string]: {
             /** Array of available temperature setpoints for this mode */
             temperatures: number[];
+            /** Array of supported raw fan speed (fn) values for this mode, if any */
+            fanSpeeds?: number[];
         };
     };
     /** Version string of the capability definition */
@@ -494,6 +496,8 @@ declare enum OutMessageType {
     DEVICE_LOG = 4,
     /** Notification sent when a device completes its boot sequence */
     DEVICE_POST_BOOT = 10,
+    /** Periodic status report from an in-floor heating thermostat (INF-V1-0) */
+    DEVICE_IN_FLOOR_STATUS = 17,
     /** Version 2 device status report with enhanced device information */
     DEVICE_V2_STATUS = 40,
     /** AC device status report with temperature, humidity, setpoint, and AC-specific fields */
@@ -531,6 +535,45 @@ interface DeviceAcStatus extends MsgPayload<OutMessageType.DEVICE_AC_STATUS> {
     };
 }
 
+/**
+ * Interface representing a periodic status report from a Mysa in-floor heating thermostat.
+ *
+ * In-floor units (`INF-V1-0`) publish their telemetry every few seconds as message type 17 rather than the
+ * {@link DeviceV2Status} (type 40) sent by baseboard devices. The body carries the same ambient readings plus the
+ * floor-probe temperature and the binary heating-relay state.
+ */
+interface DeviceInFloorStatus extends MsgPayload<OutMessageType.DEVICE_IN_FLOOR_STATUS> {
+    /** Source information identifying the device sending the status */
+    src: {
+        /** Reference identifier for the device */
+        ref: string;
+        /** Type identifier for the source device */
+        type: number;
+    };
+    /** Status data payload containing current device measurements and settings */
+    body: {
+        /** Ambient temperature reading from the device sensor (°C) */
+        ambTemp: number;
+        /** Floor-probe temperature reading (°C) */
+        flrSnsrTemp?: number;
+        /** Relative humidity percentage */
+        hum: number;
+        /** Current temperature setpoint (°C) */
+        stpt: number;
+        /** Binary heating-relay state (0 = off, 1 = energized) */
+        heatStat?: number;
+        /**
+         * Reported duty cycle. Observed to stay pinned at a constant value regardless of the relay state on this message
+         * type, so {@link heatStat} is the reliable indicator of whether the device is heating.
+         */
+        dutyCycle?: number;
+        /** Which sensor the thermostat regulates against (3 = floor probe, 5 = ambient air) */
+        trackedSnsr?: number;
+        /** Line voltage (V) */
+        lineVtg?: number;
+    };
+}
+
 /**
  * Interface representing a device state change notification from a Mysa device.
  *
@@ -622,7 +665,7 @@ interface DeviceV2Status extends MsgPayload<OutMessageType.DEVICE_V2_STATUS> {
  * This type encompasses payloads where the message type is specified in the `msg` field rather than the `MsgType`
  * field. Includes device status reports and state change notifications.
  */
-type MsgOutPayload = DeviceAcStatus | DeviceV2Status | DeviceStateChange;
+type MsgOutPayload = DeviceAcStatus | DeviceInFloorStatus | DeviceV2Status | DeviceStateChange;
 
 /**
  * Base interface for MQTT message payloads that use the MsgType field.
@@ -1280,4 +1323,4 @@ type MsgTypeInPayload = CheckDeviceSettings | StartPublishingDeviceStatus;
  */
 type InPayload = MsgTypeInPayload | MsgInPayload;
 
-export { type BrandInfo, type ChangeDeviceState, type CheckDeviceSettings, type DeviceAcStatus, type DeviceBase, type DeviceLog, type DevicePostBoot, type DeviceSetpointChange, type DeviceState, type DeviceStateChange, type DeviceStates, type DeviceStatesObj, type DeviceV1Status, type DeviceV2Status, type Devices, type DevicesObj, type FirmwareDevice, type Firmwares, type HomeBase, type Homes, InMessageType, type InPayload, type Logger, type ModeObj, MqttPublishError, type MqttPublishOptions, type MsgBasePayload, type MsgInPayload, type MsgOutPayload, type MsgPayload, type MsgTypeBasePayload, type MsgTypeInPayload, type MsgTypeOutPayload, type MsgTypePayload, MysaApiClient, type MysaApiClientEventTypes, type MysaApiClientOptions, MysaApiError, type MysaCredentials, type MysaDeviceMode, type MysaFanSpeedMode, OutMessageType, type OutPayload, type SetPointChange, type StartPublishingDeviceStatus, type StateChange, type Status, type SupportedCaps, type TimestampedValue, UnauthenticatedError, UnknownDeviceError, UnsupportedFanSpeedError, VoidLogger };
+export { type BrandInfo, type ChangeDeviceState, type CheckDeviceSettings, type DeviceAcStatus, type DeviceBase, type DeviceInFloorStatus, type DeviceLog, type DevicePostBoot, type DeviceSetpointChange, type DeviceState, type DeviceStateChange, type DeviceStates, type DeviceStatesObj, type DeviceV1Status, type DeviceV2Status, type Devices, type DevicesObj, type FirmwareDevice, type Firmwares, type HomeBase, type Homes, InMessageType, type InPayload, type Logger, type ModeObj, MqttPublishError, type MqttPublishOptions, type MsgBasePayload, type MsgInPayload, type MsgOutPayload, type MsgPayload, type MsgTypeBasePayload, type MsgTypeInPayload, type MsgTypeOutPayload, type MsgTypePayload, MysaApiClient, type MysaApiClientEventTypes, type MysaApiClientOptions, MysaApiError, type MysaCredentials, type MysaDeviceMode, type MysaFanSpeedMode, OutMessageType, type OutPayload, type SetPointChange, type StartPublishingDeviceStatus, type StateChange, type Status, type SupportedCaps, type TimestampedValue, UnauthenticatedError, UnknownDeviceError, UnsupportedFanSpeedError, VoidLogger };

package/dist/index.d.ts

@@ -187,8 +187,8 @@ declare class EventEmitter<TEvents extends Record<string, any>> implements NodeJ
     removeAllListeners<TEventName extends keyof TEvents & string>(eventName?: TEventName | undefined): this;
     setMaxListeners(n: number): this;
     getMaxListeners(): number;
-    listeners<TEventName extends keyof TEvents & string>(eventName: TEventName): Function[];
-    rawListeners<TEventName extends keyof TEvents & string>(eventName: TEventName): Function[];
+    listeners<TEventName extends keyof TEvents & string>(eventName: TEventName): ((...args: any[]) => void)[];
+    rawListeners<TEventName extends keyof TEvents & string>(eventName: TEventName): ((...args: any[]) => void)[];
     listenerCount<TEventName extends keyof TEvents & string>(eventName: TEventName, listener?: (...args: TEvents[TEventName]) => void): number;
     prependListener<TEventName extends keyof TEvents & string>(eventName: TEventName, listener: (...args: TEvents[TEventName]) => void): this;
     prependOnceListener<TEventName extends keyof TEvents & string>(eventName: TEventName, listener: (...args: TEvents[TEventName]) => void): this;
@@ -225,6 +225,8 @@ interface SupportedCaps {
         [modeId: string]: {
             /** Array of available temperature setpoints for this mode */
             temperatures: number[];
+            /** Array of supported raw fan speed (fn) values for this mode, if any */
+            fanSpeeds?: number[];
         };
     };
     /** Version string of the capability definition */
@@ -494,6 +496,8 @@ declare enum OutMessageType {
     DEVICE_LOG = 4,
     /** Notification sent when a device completes its boot sequence */
     DEVICE_POST_BOOT = 10,
+    /** Periodic status report from an in-floor heating thermostat (INF-V1-0) */
+    DEVICE_IN_FLOOR_STATUS = 17,
     /** Version 2 device status report with enhanced device information */
     DEVICE_V2_STATUS = 40,
     /** AC device status report with temperature, humidity, setpoint, and AC-specific fields */
@@ -531,6 +535,45 @@ interface DeviceAcStatus extends MsgPayload<OutMessageType.DEVICE_AC_STATUS> {
     };
 }
 
+/**
+ * Interface representing a periodic status report from a Mysa in-floor heating thermostat.
+ *
+ * In-floor units (`INF-V1-0`) publish their telemetry every few seconds as message type 17 rather than the
+ * {@link DeviceV2Status} (type 40) sent by baseboard devices. The body carries the same ambient readings plus the
+ * floor-probe temperature and the binary heating-relay state.
+ */
+interface DeviceInFloorStatus extends MsgPayload<OutMessageType.DEVICE_IN_FLOOR_STATUS> {
+    /** Source information identifying the device sending the status */
+    src: {
+        /** Reference identifier for the device */
+        ref: string;
+        /** Type identifier for the source device */
+        type: number;
+    };
+    /** Status data payload containing current device measurements and settings */
+    body: {
+        /** Ambient temperature reading from the device sensor (°C) */
+        ambTemp: number;
+        /** Floor-probe temperature reading (°C) */
+        flrSnsrTemp?: number;
+        /** Relative humidity percentage */
+        hum: number;
+        /** Current temperature setpoint (°C) */
+        stpt: number;
+        /** Binary heating-relay state (0 = off, 1 = energized) */
+        heatStat?: number;
+        /**
+         * Reported duty cycle. Observed to stay pinned at a constant value regardless of the relay state on this message
+         * type, so {@link heatStat} is the reliable indicator of whether the device is heating.
+         */
+        dutyCycle?: number;
+        /** Which sensor the thermostat regulates against (3 = floor probe, 5 = ambient air) */
+        trackedSnsr?: number;
+        /** Line voltage (V) */
+        lineVtg?: number;
+    };
+}
+
 /**
  * Interface representing a device state change notification from a Mysa device.
  *
@@ -622,7 +665,7 @@ interface DeviceV2Status extends MsgPayload<OutMessageType.DEVICE_V2_STATUS> {
  * This type encompasses payloads where the message type is specified in the `msg` field rather than the `MsgType`
  * field. Includes device status reports and state change notifications.
  */
-type MsgOutPayload = DeviceAcStatus | DeviceV2Status | DeviceStateChange;
+type MsgOutPayload = DeviceAcStatus | DeviceInFloorStatus | DeviceV2Status | DeviceStateChange;
 
 /**
  * Base interface for MQTT message payloads that use the MsgType field.
@@ -1280,4 +1323,4 @@ type MsgTypeInPayload = CheckDeviceSettings | StartPublishingDeviceStatus;
  */
 type InPayload = MsgTypeInPayload | MsgInPayload;
 
-export { type BrandInfo, type ChangeDeviceState, type CheckDeviceSettings, type DeviceAcStatus, type DeviceBase, type DeviceLog, type DevicePostBoot, type DeviceSetpointChange, type DeviceState, type DeviceStateChange, type DeviceStates, type DeviceStatesObj, type DeviceV1Status, type DeviceV2Status, type Devices, type DevicesObj, type FirmwareDevice, type Firmwares, type HomeBase, type Homes, InMessageType, type InPayload, type Logger, type ModeObj, MqttPublishError, type MqttPublishOptions, type MsgBasePayload, type MsgInPayload, type MsgOutPayload, type MsgPayload, type MsgTypeBasePayload, type MsgTypeInPayload, type MsgTypeOutPayload, type MsgTypePayload, MysaApiClient, type MysaApiClientEventTypes, type MysaApiClientOptions, MysaApiError, type MysaCredentials, type MysaDeviceMode, type MysaFanSpeedMode, OutMessageType, type OutPayload, type SetPointChange, type StartPublishingDeviceStatus, type StateChange, type Status, type SupportedCaps, type TimestampedValue, UnauthenticatedError, UnknownDeviceError, UnsupportedFanSpeedError, VoidLogger };
+export { type BrandInfo, type ChangeDeviceState, type CheckDeviceSettings, type DeviceAcStatus, type DeviceBase, type DeviceInFloorStatus, type DeviceLog, type DevicePostBoot, type DeviceSetpointChange, type DeviceState, type DeviceStateChange, type DeviceStates, type DeviceStatesObj, type DeviceV1Status, type DeviceV2Status, type Devices, type DevicesObj, type FirmwareDevice, type Firmwares, type HomeBase, type Homes, InMessageType, type InPayload, type Logger, type ModeObj, MqttPublishError, type MqttPublishOptions, type MsgBasePayload, type MsgInPayload, type MsgOutPayload, type MsgPayload, type MsgTypeBasePayload, type MsgTypeInPayload, type MsgTypeOutPayload, type MsgTypePayload, MysaApiClient, type MysaApiClientEventTypes, type MysaApiClientOptions, MysaApiError, type MysaCredentials, type MysaDeviceMode, type MysaFanSpeedMode, OutMessageType, type OutPayload, type SetPointChange, type StartPublishingDeviceStatus, type StateChange, type Status, type SupportedCaps, type TimestampedValue, UnauthenticatedError, UnknownDeviceError, UnsupportedFanSpeedError, VoidLogger };

package/dist/index.js

@@ -1,6 +1,6 @@
 /*
 mysa-js-sdk
-Copyright (C) 2025 Pascal Bourque
+Copyright (C) 2025-2026 Pascal Bourque
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -227,6 +227,7 @@ var OutMessageType = /* @__PURE__ */ ((OutMessageType2) => {
   OutMessageType2[OutMessageType2["DEVICE_SETPOINT_CHANGE"] = 1] = "DEVICE_SETPOINT_CHANGE";
   OutMessageType2[OutMessageType2["DEVICE_LOG"] = 4] = "DEVICE_LOG";
   OutMessageType2[OutMessageType2["DEVICE_POST_BOOT"] = 10] = "DEVICE_POST_BOOT";
+  OutMessageType2[OutMessageType2["DEVICE_IN_FLOOR_STATUS"] = 17] = "DEVICE_IN_FLOOR_STATUS";
   OutMessageType2[OutMessageType2["DEVICE_V2_STATUS"] = 40] = "DEVICE_V2_STATUS";
   OutMessageType2[OutMessageType2["DEVICE_AC_STATUS"] = 30] = "DEVICE_AC_STATUS";
   OutMessageType2[OutMessageType2["DEVICE_STATE_CHANGE"] = 44] = "DEVICE_STATE_CHANGE";
@@ -260,6 +261,8 @@ var MqttResetMaxDelay = dayjs.duration(30, "seconds");
 var MqttStabilityWindow = dayjs.duration(60, "seconds");
 var CanonicalFanSpeedOrder = ["auto", "low", "medium", "high", "max"];
 var LegacyFanSpeedSendMap = { auto: 1, low: 3, medium: 5, high: 7, max: 8 };
+var CanonicalFanSpeedSendMap = { auto: 1, low: 2, medium: 4, high: 6 };
+var CANONICAL_FAN_SPEED_CODE_NUM = 1117;
 var FanSpeedReceiveMap = {
   1: "auto",
   2: "low",
@@ -280,7 +283,7 @@ function buildFanSpeedSendMap(device) {
   var _a;
   const fanSpeeds = (_a = device.SupportedCaps) == null ? void 0 : _a.fanSpeeds;
   if (!fanSpeeds || fanSpeeds.length === 0) {
-    return LegacyFanSpeedSendMap;
+    return device.CodeNum === CANONICAL_FAN_SPEED_CODE_NUM ? CanonicalFanSpeedSendMap : LegacyFanSpeedSendMap;
   }
   const map = {};
   CanonicalFanSpeedOrder.forEach((name, index) => {
@@ -1210,6 +1213,16 @@ var MysaApiClient = class {
               dutyCycle: parsedPayload.body.dtyCycle
             });
             break;
+          case 17 /* DEVICE_IN_FLOOR_STATUS */:
+            this.emitter.emit("statusChanged", {
+              deviceId: parsedPayload.src.ref,
+              temperature: parsedPayload.body.ambTemp,
+              humidity: parsedPayload.body.hum,
+              setPoint: parsedPayload.body.stpt,
+              dutyCycle: parsedPayload.body.heatStat,
+              floorTemperature: parsedPayload.body.flrSnsrTemp
+            });
+            break;
           case 40 /* DEVICE_V2_STATUS */:
             this.emitter.emit("statusChanged", {
               deviceId: parsedPayload.src.ref,