Connecting to a Reader

[arope]

In the latest version of the stripe-terminal-react-native it mentions all connectReaders methods have been conslidated to connectReader

• To ensure a consistent integration pattern across reader discovery and connection, we consolidated all previous reader connection methods (connectBluetoothReader, connectInternetReader, connectLocalMobileReader) into connectReader. The exact connection type is still determined by the passed in connection configuration.
  https://docs.stripe.com/terminal/references/sdk-migration-guide.md
  However, for mobile readers, we need to use the locationId to register the reader to a specific location.
  https://docs.stripe.com/terminal/fleet/register-readers?terminal-sdk-platform=react-native#bluetooth-readers

When utilizing the connectReader method

const { error, reader: newlyConnectedReader } = await connectReader(
  {
    reader: { ...reader },
  },
  'bluetoothScan'
);

The result is Invalid location. Verify the location ID and try again.

[arope]

Just as a trial, attaching the locationId while discovering readers throws the same error

await discoverReaders({
        discoveryMethod: 'bluetoothScan',
        locationId: locationID,
      });

[dmatthews-stripe]

@arope we have this planned for a release in the next couple of weeks that will pick up the native SDK changes including consolidation of the connect reader function. The discover readers call does not support filtering on location ID when it comes to mPOS readers. We suggest to remove the location ID.

[davidrichey]

@dmatthews-stripe thanks for the response! (I work with @arope) Just want to confirm what you are saying from my understanding:

1. The current version (0.0.1-beta.23) does not include the ability to connect to a reader with a location ID

We suggest to remove the location ID.

2. We use only bluetooth readers, and to connect to a bluetooth reader a reader needs to be attached to locations, so this would prevent new readers being able to be connected, right?
3. Future versions will include the ability to connect to a bluetooth reader with a location ID

We have downgraded to 0.0.1-beta.22 in the meantime

[xiaoshen-stripe]

the latest version of the Terminal RN SDK is b24. It does support connecting to mPOS reader with the location ID, matter of fact the location ID can only be passed in during the reader connection phase, not reader discover.
You need to use the right connectParams for bluetooth connection - please see link below for details:

stripe-terminal-react-native/src/types/index.ts

Lines 42 to 66 in e21ac2b

	export interface ConnectBluetoothReaderParams extends ConnectReaderParams {
	locationId?: string;
	autoReconnectOnUnexpectedDisconnect?: boolean;
	}
	export interface ConnectUsbReaderParams extends ConnectReaderParams {
	locationId?: string;
	autoReconnectOnUnexpectedDisconnect?: boolean;
	}
	export interface ConnectTapToPayParams extends ConnectReaderParams {
	locationId?: string;
	onBehalfOf?: string;
	merchantDisplayName?: string;
	tosAcceptancePermitted?: boolean;
	autoReconnectOnUnexpectedDisconnect?: boolean;
	}
	export interface ConnectHandoffParams extends ConnectReaderParams {
	locationId?: string;
	}
	export interface ConnectInternetReaderParams extends ConnectReaderParams {
	failIfInUse?: boolean;
	}

Thank you

[arope]

@xiaoshen-stripe appreciate the response. Just to get more clarity, for SDK beta.22, we could do this

  const { error, reader: newlyConnectedReader } = await connectBluetoothReader({
          reader: { ...reader },
          locationId: locationID,
        });

are you saying with SDK beta.24 we can now do this

  const { error, reader: newlyConnectedReader } = await connectReader({
          reader: { ...reader },
          locationId: locationID,
        });

since beta.23 doesn't allow it yet. If that's the case thank you for prompt fix on this issue

[tim-lin-bbpos]

@arope Yes, we can pass ConnectBluetoothReaderParams as the 1 parameter of connectReader which has locationId.

 export interface ConnectBluetoothReaderParams extends ConnectReaderParams { 
   locationId?: string; 
   autoReconnectOnUnexpectedDisconnect?: boolean; 
 } 

[jmatelli]

@xiaoshen-stripe is there a plan to update the documentation or the example app to reflect the new connectReader API and how to use it, especially with typescript? Because I tried and it keeps telling me that locationId is not a valid parameter of type ConnectReaderParams.

[xiaoshen-stripe]

Hi @jmatelli
We've updated our technical documentation with the latest implementation, including connectReader:
e.g. https://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=react-native&reader-type=bluetooth#connect-reader

We are also making interface updates to the connectReader method to clearly communicate the different parameter types it can accept [0] - this will become available in the upcoming release next week.

[0] #921