mysa-js-sdk
    Preparing search index...

    Interface DeviceBase

    Base interface for all Mysa device types.

    Defines the common properties and configuration parameters shared across different types of Mysa devices, including thermostats, switches, and AC controllers. This interface encompasses both required core properties and optional features that may vary depending on the specific device model and capabilities.

    interface DeviceBase {
        AllowedUsers?: string[];
        Animation?: string;
        Brand?: BrandInfo;
        ButtonAVE?: number;
        ButtonDI?: number;
        ButtonLowPower?: number;
        ButtonPolling?: number;
        ButtonRepeatDelay?: number;
        ButtonRepeatStart?: number;
        ButtonState?: string;
        ButtonThreshold?: number;
        CodeNum?: number;
        DutyCycleOpt?: number;
        ecoMode?: number;
        Format?: string;
        HeaterType?: string;
        Home?: string;
        Id: string;
        IsThermostatic?: boolean;
        LastPaired?: number;
        MaxBrightness?: number;
        MaxCurrent?: string;
        MaxSetpoint?: number;
        MeasuredVoltage?: number;
        MinBrightness?: number;
        MinSetpoint?: number;
        Mode?: ModeObj;
        Model: string;
        Name?: string;
        Owner?: string;
        SetupRequired?: boolean;
        SupportedCaps?: SupportedCaps;
        TimeZone?: string;
        Voltage?: number;
        Zone?: string;
    }
    Index

    Properties

    AllowedUsers? Animation? Brand? ButtonAVE? ButtonDI? ButtonLowPower? ButtonPolling? ButtonRepeatDelay? ButtonRepeatStart? ButtonState? ButtonThreshold? CodeNum? DutyCycleOpt? ecoMode? Format? HeaterType? Home? Id IsThermostatic? LastPaired? MaxBrightness? MaxCurrent? MaxSetpoint? MeasuredVoltage? MinBrightness? MinSetpoint? Mode? Model Name? Owner? SetupRequired? SupportedCaps? TimeZone? Voltage? Zone?

    Properties

    AllowedUsers?: string[]

    Array of user IDs allowed to control this device

    Animation?: string

    Display animation style setting

    Brand?: BrandInfo

    Optional brand information for AC devices

    ButtonAVE?: number

    Button average value configuration

    ButtonDI?: number

    Button digital input configuration value

    ButtonLowPower?: number

    Button low power mode configuration

    ButtonPolling?: number

    Button polling interval configuration

    ButtonRepeatDelay?: number

    Button repeat delay configuration in milliseconds

    ButtonRepeatStart?: number

    Button repeat start delay configuration in milliseconds

    ButtonState?: string

    Current button state indicator

    ButtonThreshold?: number

    Button sensitivity threshold configuration

    CodeNum?: number

    Optional device code number

    DutyCycleOpt?: number

    Optional duty cycle optimization setting

    ecoMode?: number

    Optional eco mode configuration

    Format?: string

    Data format version used by the device

    HeaterType?: string

    Type of heater controlled by the device

    Home?: string

    Home identifier that this device belongs to

    Id: string

    Unique device identifier

    IsThermostatic?: boolean

    Optional flag indicating if device has thermostatic control

    LastPaired?: number

    Unix timestamp of when device was last paired

    MaxBrightness?: number

    Maximum brightness level (0-100)

    MaxCurrent?: string

    Maximum current rating as a string value

    MaxSetpoint?: number

    Maximum temperature setpoint allowed

    MeasuredVoltage?: number

    Optional measured voltage reading from the device

    MinBrightness?: number

    Minimum brightness level (0-100)

    MinSetpoint?: number

    Minimum temperature setpoint allowed

    Mode?: ModeObj

    Current operating mode of the device

    Model: string

    Device model identifier string

    Name?: string

    User-assigned device name

    Owner?: string

    User ID of the device owner

    SetupRequired?: boolean

    Optional flag indicating if device requires setup

    SupportedCaps?: SupportedCaps

    Optional supported capabilities for AC devices

    TimeZone?: string

    Time zone setting for the device

    Voltage?: number

    Operating voltage of the device

    Zone?: string

    Optional zone assignment for the device

    Settings

    Member Visibility

    On This Page

    Properties