mqtt-discovery-types/src/ButtonDiscovery.d.ts

Typescript Types For HomeAssistant MQTT Discovery

import type { CommandComponentDiscovery } from "./BaseEntityDiscovery.ts";
import { MakeEntity } from './utils';

/**
 * @see https://www.home-assistant.io/integrations/button.mqtt/
 */

export interface ButtonComponentDiscovery extends CommandComponentDiscovery {
    platform : 'button';

    /**
     * The payload To send to trigger the button.
     * Default: PRESS
     */
    payload_press?: string;

    device_class?: "identify" | "restart" | "update";
}

export type ButtonDiscovery = MakeEntity<ButtonComponentDiscovery>;