diff --git a/examples/connect-app/README.md b/examples/connect-app/README.md index 84d8fcd4b..a6a4b701a 100644 --- a/examples/connect-app/README.md +++ b/examples/connect-app/README.md @@ -6,4 +6,4 @@ This example demonstrates how to connect to the Viam app and make calls to it. Run `npm run dev` and visit `localhost:5137` in a browser. Press the button to execute the logic defined in `src/main.ts`. -Edit `src/main.ts` to change the robot logic being run. Edit `index.html` to change the layout of the app. \ No newline at end of file +Edit `src/main.ts` to change the logic being run. Edit `index.html` to change the layout of the app. \ No newline at end of file diff --git a/examples/connect-app/src/main.ts b/examples/connect-app/src/main.ts index c59feb901..49100d9d0 100644 --- a/examples/connect-app/src/main.ts +++ b/examples/connect-app/src/main.ts @@ -4,10 +4,10 @@ import * as VIAM from '@viamrobotics/sdk'; async function connect(): Promise { // You can remove this block entirely if your robot is not authenticated. // Otherwise, replace with an actual secret. - const secret = ''; + // const secret = ''; const credential = { payload: secret, - type: 'api-key', + type: 'robot-location-secret', }; // Replace with the host of your actual robot running Viam. diff --git a/src/main.ts b/src/main.ts index d8d604f5f..b94fb31aa 100644 --- a/src/main.ts +++ b/src/main.ts @@ -20,6 +20,10 @@ export { createRobotClient, } from './robot'; +/** + * @deprecated Use {@link RobotClient} instead. + * @group Clients + */ export { RobotClient as Client } from './robot'; export { ViamClient } from './app/viam-client'; diff --git a/src/robot/dial.ts b/src/robot/dial.ts index f5a206958..351998db0 100644 --- a/src/robot/dial.ts +++ b/src/robot/dial.ts @@ -195,11 +195,10 @@ export const createRobotClient = async ( }; /** - * Get a Viam Transport Factory by getting the accessToken. + * Get a Viam Transport Factory after getting the accessToken. * * In dialOpts.credentials, the credential type cannot be a robot secret. The - * credential type can be a robot location secret or, preferably, the org API - * key. + * credential type can be a robot location secret. */ export const createViamTransportFactory = async ( serviceHost: string,