Class SwitchBotBLE

constructor

• new SwitchBotBLE(params?: Params): SwitchBotBLE

• Constructor

  Parameters

  • Optionalparams: Params

    Optional parameters

  Returns SwitchBotBLE

noble

Optionalonadvertisement

Optionalondiscover

ready

discover

• discover(params?: Params): Promise<SwitchbotDevice[]>

• Discovers Switchbot devices.

  Parameters

  • params: Params = {}

    The discovery parameters.

  Returns Promise<SwitchbotDevice[]>

  A Promise that resolves with an array of discovered Switchbot devices.

log

• log(level: string, message: string): Promise<void>

• Emits a log event with the specified log level and message.

  Parameters

  • level: string

    The severity level of the log (e.g., 'info', 'warn', 'error').
  • message: string

    The log message to be emitted.

  Returns Promise<void>

startScan

• startScan(params?: Params): Promise<void>

• Starts scanning for SwitchBot devices.

  Parameters

  • Optionalparams: Params = {}

    Optional parameters.

  Returns Promise<void>

  • Resolves when scanning starts successfully.

stopScan

• stopScan(): Promise<void>

• Stops scanning for SwitchBot devices.

  Returns Promise<void>

  • Resolves when scanning stops successfully.

validate

• validate(params: Params, schema: Record<string, unknown>): Promise<void>

• Validates the parameters.

  Parameters

  • params: Params

    The parameters to validate.
  • schema: Record<string, unknown>

    The schema to validate against.

  Returns Promise<void>

  • Resolves if parameters are valid, otherwise throws an error.

wait

• wait(msec: number): Promise<void>

• Waits for the specified time.

  Parameters

  • msec: number

    The time to wait in milliseconds.

  Returns Promise<void>

  • Resolves after the specified time.