Improvements

viamrobotics · Oct 31, 2023 · 6baefd0 · 6baefd0
1 parent 3f5a636
commit 6baefd0
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 54 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -117,4 +117,4 @@ jobs:
         run: python3 .github/workflows/get_modular_resources.py
         env:
           TYPESENSE_API_KEY_MR: ${{ secrets.TYPESENSE_API_KEY_MR }}
-          VIAM_LOCATION_SECRET: ${{ secrets.VIAM_LOCATION_SECRET }}
+          VIAM_API_KEY: ${{ secrets.VIAM_API_KEY }}
diff --git a/.github/workflows/get_modular_resources.py b/.github/workflows/get_modular_resources.py
@@ -9,12 +9,10 @@
 
 async def connect() -> ViamClient:
     dial_options = DialOptions(
-        # The URL of any robot in the location.
-        auth_entity='divine-voice-main.b5luvepsyg.viam.cloud',
+        auth_entity='744b0c18-f6fd-4c8d-a707-d3f261b353cc'
         credentials=Credentials(
-            type='robot-location-secret',
-            # The location secret
-            payload=os.environ['VIAM_LOCATION_SECRET']
+            type='api-key',
+            payload=os.environ['VIAM_API_KEY']
         )
     )
     return await ViamClient.create_from_dial_options(dial_options)

diff --git a/docs/components/input-controller/_index.md b/docs/components/input-controller/_index.md
@@ -838,11 +838,8 @@ cmd = {}
 
 async def connect_robot(host, api_key, api_key_id):
     opts = RobotClient.Options.with_api_key(
-      # Replace "<API-KEY>" (including brackets) with your robot's api key
-      api_key='<API-KEY>',
-      # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
-      api_key_id='<API-KEY-ID>',
-      refresh_interval=0,
+      api_key=api_key,
+      api_key_id=api_key_id
     )
     return await RobotClient.at_address(host, opts)
 

diff --git a/docs/program/apis/cloud.md b/docs/program/apis/cloud.md
@@ -33,10 +33,7 @@ Cloud app API methods are only available in the Python SDK.
 
 To use the Viam cloud app API, you first need to instantiate a [`ViamClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient) and then instantiate an [`AppClient`](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient).
 See the following example for reference.
-To find the api key and secret, go to [Viam app](https://app.viam.com/), and navigate to the bottom of your location's page.
-For the URL, use the address of any of the robots in the location (found on the **Code sample** tab).
-
-TODO
+To find your api key and secret, go to [Viam app](https://app.viam.com/), and navigate to one of your robots' **Security** tab the bottom of your location's page.
 
 ```python {class="line-numbers linkable-line-numbers"}
 import asyncio
@@ -47,13 +44,13 @@ from viam.app.viam_client import ViamClient
 
 async def connect() -> ViamClient:
     dial_options = DialOptions(
-        # The URL of any robot in the location.
-        auth_entity='beepboop-main.YOUR LOCATION ID.viam.cloud',
-        credentials=Credentials(
-            type='robot-location-secret',
-            # The location secret
-            payload='YOUR LOCATION SECRET'
-        )
+      credentials=Credentials(
+        type="api-key",
+        # Replace "<API-KEY>" (including brackets) with your robot's api key
+        payload='<API-KEY>',
+      ),
+      # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
+      auth_entity='<API-KEY-ID>'
     )
     return await ViamClient.create_from_dial_options(dial_options)
 

diff --git a/docs/program/apis/data-client.md b/docs/program/apis/data-client.md
@@ -38,23 +38,21 @@ import asyncio
 from viam.rpc.dial import DialOptions, Credentials
 from viam.app.viam_client import ViamClient
 
-TODO
 
 async def connect() -> ViamClient:
     dial_options = DialOptions(
-        # The URL of any robot in the location.
-        auth_entity='beepboop-main.YOUR LOCATION ID.viam.cloud',
-        credentials=Credentials(
-            type='robot-location-secret',
-            # The location secret
-            payload='YOUR LOCATION SECRET'
-        )
+      credentials=Credentials(
+        type="api-key",
+        # Replace "<API-KEY>" (including brackets) with your robot's api key
+        payload='<API-KEY>',
+      ),
+      # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
+      auth_entity='<API-KEY-ID>'
     )
     return await ViamClient.create_from_dial_options(dial_options)
 
 
 async def main():
-
     # Make a ViamClient
     viam_client = await connect()
     # Instantiate a DataClient to run data client API methods on

diff --git a/docs/tutorials/projects/pet-treat-dispenser.md b/docs/tutorials/projects/pet-treat-dispenser.md
@@ -484,7 +484,7 @@ from viam.services.vision import VisionClient
 
 # these must be set, you can get them from your robot's 'Code sample' tab
 robot_api_key = os.getenv('ROBOT_API_KEY') or ''
-robot_api_key_secret = os.getenv('ROBOT_API_KEY_SECRET') or ''
+robot_api_key_id = os.getenv('ROBOT_API_KEY_ID') or ''
 robot_address = os.getenv('ROBOT_ADDRESS') or ''
 
 # change this if you named your camera differently in your robot configuration
@@ -493,8 +493,8 @@ camera_name = os.getenv('ROBOT_CAMERA') or 'petcam'
 
 async def connect():
     opts = RobotClient.Options.with_api_key(
-      api_key=robot_api_key_secret,
-      api_key_id=robot_api_key
+      api_key=robot_api_key,
+      api_key_id=robot_api_key_id
     )
     return await RobotClient.at_address(robot_address, opts)
 

diff --git a/docs/tutorials/projects/send-security-photo.md b/docs/tutorials/projects/send-security-photo.md
@@ -236,14 +236,14 @@ import yagmail
 
 # These must be set. You can get them from your robot's 'Code sample' tab
 robot_api_key = os.getenv('ROBOT_API_KEY') or ''
-robot_api_key_secret = os.getenv('ROBOT_API_KEY_SECRET') or ''
+robot_api_key_id = os.getenv('ROBOT_API_KEY_ID') or ''
 robot_address = os.getenv('ROBOT_ADDRESS') or ''
 
 
 async def connect():
     opts = RobotClient.Options.with_api_key(
-      api_key=robot_api_key_secret,
-      api_key_id=robot_api_key
+      api_key=robot_api_key,
+      api_key_id=robot_api_key_id
     )
     return await RobotClient.at_address(robot_address, opts)
 

diff --git a/docs/tutorials/projects/tipsy.md b/docs/tutorials/projects/tipsy.md
@@ -629,7 +629,7 @@ Replace these values with your robot’s own location secret and address, which
 
 ```python {class="line-numbers linkable-line-numbers"}
 robot_api_key = os.getenv('ROBOT_API_KEY') or ''
-robot_api_key_secret = os.getenv('ROBOT_API_KEY_SECRET') or ''
+robot_api_key_id = os.getenv('ROBOT_API_KEY_ID') or ''
 robot_address = os.getenv('ROBOT_ADDRESS') or ''
 # change this if you named your base differently in your robot configuration
 base_name = os.getenv('ROBOT_BASE') or 'tipsy-base'

diff --git a/docs/tutorials/services/accessing-and-moving-robot-arm.md b/docs/tutorials/services/accessing-and-moving-robot-arm.md
@@ -343,8 +343,7 @@ async def connect():
       # Replace "<API-KEY>" (including brackets) with your robot's api key
       api_key='<API-KEY>',
       # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
-      api_key_id='<API-KEY-ID>',
-      refresh_interval=0
+      api_key_id='<API-KEY-ID>'
     )
     return await RobotClient.at_address('ADDRESS FROM THE VIAM APP', opts)
 

diff --git a/docs/tutorials/services/color-detection-scuttle.md b/docs/tutorials/services/color-detection-scuttle.md
@@ -191,8 +191,7 @@ async def connect():
         # Replace "<API-KEY>" (including brackets) with your robot's api key
         api_key='<API-KEY>',
         # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
-        api_key_id='<API-KEY-ID>',
-        refresh_interval=0
+        api_key_id='<API-KEY-ID>'
     )
     return await RobotClient.at_address("ADDRESS FROM THE VIAM APP", opts)
 
@@ -331,8 +330,7 @@ async def connect():
         # Replace "<API-KEY>" (including brackets) with your robot's api key
         api_key='<API-KEY>',
         # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
-        api_key_id='<API-KEY-ID>',
-        refresh_interval=0,
+        api_key_id='<API-KEY-ID>'
     )
     return await RobotClient.at_address("ADDRESS FROM THE VIAM APP", opts)
 

diff --git a/docs/tutorials/services/navigate-with-rover-base.md b/docs/tutorials/services/navigate-with-rover-base.md
@@ -626,8 +626,7 @@ async def connect():
         # Replace "<API-KEY>" (including brackets) with your robot's api key
         api_key='<API-KEY>',
         # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
-        api_key_id='<API-KEY-ID>',
-        refresh_interval=0
+        api_key_id='<API-KEY-ID>'
     )
     return await RobotClient.at_address('<INSERT REMOTE ADDRESS>', opts)
 

diff --git a/docs/tutorials/services/plan-motion-with-arm-gripper.md b/docs/tutorials/services/plan-motion-with-arm-gripper.md
@@ -424,8 +424,7 @@ async def connect():
       # Replace "<API-KEY>" (including brackets) with your robot's api key
       api_key='<API-KEY>',
       # Replace "<API-KEY-ID>" (including brackets) with your robot's api key id
-      api_key_id='<API-KEY-ID>',
-      refresh_interval=0,
+      api_key_id='<API-KEY-ID>'
     )
     return await RobotClient.at_address('<ROBOT ADDRESS>', opts)
 

diff --git a/static/include/program/authenticate.md b/static/include/program/authenticate.md
@@ -2,7 +2,7 @@ To authenticate yourself to your robot, you need
 
 1.  The robot's part api key:
 
-    To authenticate, [create an api key [using the UI]() or [using the CLI](/manage/cli/#create-an-organization-api-key).
+    To authenticate, [create a robot api key using the UI]() or [create an organization-wide api key using the CLI](/manage/cli/#create-an-organization-api-key).
     Copy and paste the api key id and the api key into your environment variables or directly into the code:
 
     {{< tabs >}}
@@ -100,16 +100,17 @@ Future<void> connectToViam() async {
 {{< /tabs >}}
 
 {{< alert title="Caution" color="caution" >}}
-Do not share your part api key id, org api key, or robot address publicly.
+Do not share your part api key or robot address publicly.
 Sharing this information could compromise your system security by allowing unauthorized access to your robot, or to the computer running your robot.
 {{< /alert >}}
 
 {{< alert title="Location secret (deprecated)" color="note" >}}
 
 Prior to API keys, Viam used Location secrets for authentication.
-To avoid future issues, start using API keys.
+Location secrets are now deprecated.
+To avoid connection issues, start using API keys.
 
 {{< /alert >}}
 
 2. The robot's remote address: Include the address, which resembles `12345.somerobot-main.viam.cloud`. The robot address is as a public address to connect to your robot.
-   You can find this address at the top of the robot's **Control** tab or in the **Code sample** tab..
+   You can find this address at the top of the robot's **Control** tab or in the **Code sample** tab.
diff --git a/static/include/snippet/secret-share.md b/static/include/snippet/secret-share.md
@@ -1,4 +1,4 @@
 {{< alert title="Caution" color="caution" >}}
-Do not share your part api key id, org api key, or robot address publicly.
+Do not share your api key or robot address publicly.
 Sharing this information could compromise your system security by allowing unauthorized access to your robot, or to the computer running your robot.
 {{< /alert >}}
diff --git a/static/include/snippet/show-secret.md b/static/include/snippet/show-secret.md
@@ -3,7 +3,7 @@ By default, the sample code does not include your robot api key and secret.
 We strongly recommend that you add your api key and secret as an environment variable and import this variable into your development environment as needed.
 
 To show your robot's api key and secret in the sample code, toggle **Include secret** on the **Code sample** tab.
-You can also see your api key and secret on the [locations page](/manage/fleet/locations/).
+You can also see your api key and secret on your robot's **Security** tab.
 {{< /alert >}}
 
 {{% snippet "secret-share.md" %}}