Function discoverAdapter

  • discoverAdapter(
        adapter?: Adapter,
        path?: string,
    ): Promise<[adapter: Adapter, path: string]>

  • Discover adapter using mDNS, TCP or USB.

    Parameters

    • Optionaladapter: Adapter

      The adapter type.

      • mDNS: Unused.
      • TCP: Required, cannot discover at this time.
      • USB: Optional, limits the discovery to the specified adapter type.
    • Optionalpath: string

      The path to the adapter.

      • mDNS: Required, serves to initiate the discovery.
      • TCP: Required, cannot discover at this time.
      • USB: Optional, limits the discovery to the specified path.

    Returns Promise<[adapter: Adapter, path: string]>

    adapter An adapter type supported by Z2M. While result is TS-typed, this should be validated against actual values before use.

Settings

Member Visibility