Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WLEDClientOptions

Options used to configure the WLED Client instance

Hierarchy

  • WLEDClientOptions

Index

Properties

debug?: boolean

Device is in debug mode and has access to an extended API.

host: string

IP or hostname of the device.

immediate: boolean

Immediately initiates a context refresh and ws connection

init?: { config?: boolean; presets?: boolean }

Choose what information to fetch on initialization

Type declaration

  • Optional config?: boolean

    Fetch device config on init

  • Optional presets?: boolean

    Fetch device presets on init

port?: number

Port used to connect to the WLED APIs.

secure: boolean

Device requires a secure connection.

websocket: boolean | { reconnect?: boolean }

If boolean, this will enable or disable the WebSocket API.

Otherwise pass an object to configure the WebSocket connection.

Generated using TypeDoc