mysa-js-sdk
    Preparing search index...

    Interface representing a version 2 device status report from a Mysa device.

    This enhanced status message provides comprehensive information about the device's current operational state, including environmental readings and system parameters. Version 2 status reports include additional data compared to version 1 reports.

    interface DeviceV2Status {
        body: {
            ambTemp: number;
            dtyCycle?: number;
            flrSnsrTemp?: number;
            heatStat?: number;
            hum: number;
            lineVtg?: number;
            stpt: number;
            trackedSnsr?: number;
        };
        id: number;
        msg: DEVICE_V2_STATUS;
        src: { ref: string; type: number };
        time: number;
        ver: string;
    }

    Hierarchy (View Summary)

    Index
    body: {
        ambTemp: number;
        dtyCycle?: number;
        flrSnsrTemp?: number;
        heatStat?: number;
        hum: number;
        lineVtg?: number;
        stpt: number;
        trackedSnsr?: number;
    }

    Status data payload containing current device measurements and settings

    Type Declaration

    • ambTemp: number

      Ambient temperature reading from the device sensor

    • OptionaldtyCycle?: number

      Current duty cycle of the heating element, as a fraction between 0.0 and 1.0. Reported by baseboard V2 devices; absent on in-floor heating thermostats (INF-V1-0), which report heatStat instead.

    • OptionalflrSnsrTemp?: number

      Floor-probe temperature reading (°C) from in-floor heating thermostats. Absent on baseboard V2 devices.

    • OptionalheatStat?: number

      Binary heating-relay state (0 = off, 1 = energized) reported by in-floor heating thermostats (INF-V1-0) in place of dtyCycle. Absent on baseboard V2 devices.

    • hum: number

      Relative humidity percentage reading from the device sensor

    • OptionallineVtg?: number

      Line voltage (V) reported by in-floor heating thermostats. Absent on baseboard V2 devices.

    • stpt: number

      Current temperature setpoint setting

    • OptionaltrackedSnsr?: number

      Which sensor the in-floor thermostat regulates against (3 = floor probe, 5 = ambient air). Absent on baseboard V2 devices.

    id: number

    Unique identifier for the device or message source

    The strongly-typed message type identifier

    src: { ref: string; type: number }

    Source information identifying the device sending the status

    Type Declaration

    • ref: string

      Reference identifier for the device

    • type: number

      Type identifier for the source device

    time: number

    Unix timestamp when the message was created

    ver: string

    Version string of the message format