mysa-js-sdk
    Preparing search index...

    Type Alias MysaApiClientEventTypes

    Defines the event types and their parameters for the MysaApiClient.

    This type maps event names to their corresponding parameter arrays, providing type safety for event subscription and emission in the Mysa API client's event system.

    type MysaApiClientEventTypes = {
        rawRealtimeMessageReceived: [message: OutPayload];
        sessionChanged: [session: MysaSession | undefined];
        setPointChanged: [change: SetPointChange];
        stateChanged: [change: StateChange];
        statusChanged: [status: Status];
    }
    Index

    Properties

    rawRealtimeMessageReceived sessionChanged setPointChanged stateChanged statusChanged

    Properties

    rawRealtimeMessageReceived: [message: OutPayload]

    Event emitted when a raw MQTT message is received from devices.

    This low-level event provides access to the unprocessed MQTT payload for advanced use cases that require direct access to the raw device data.

    The raw outgoing MQTT payload from the device

    sessionChanged: [session: MysaSession | undefined]

    Event emitted when the session changes.

    You should subscribe to this event and persist the session object whenever it changes.

    The new session object or undefined if session was cleared.

    setPointChanged: [change: SetPointChange]

    Event emitted when a device's temperature setpoint is changed.

    This event is triggered when the target temperature for a device is modified, either through user interaction or programmatic control.

    Details about the setpoint change including old and new values

    stateChanged: [change: StateChange]

    Event emitted when a device's operational state changes.

    This event is triggered when device parameters such as mode, brightness, or other operational settings are modified.

    Details about the state change including affected parameters

    statusChanged: [status: Status]

    Event emitted when a device's status information is updated.

    This event provides comprehensive status information including temperature readings, operational state, and device health data.

    The updated device status information

    Settings

    Member Visibility

    On This Page

    Properties