Skip to content

Commit 4e4b61b

Browse files
authored
Update Viam app to just Viam (viamrobotics#931)
1 parent 12d0043 commit 4e4b61b

File tree

7 files changed

+43
-43
lines changed

7 files changed

+43
-43
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To create a client application, to navigate to [app.viam.com](https://app.viam.c
7272
2. Create a robot (for example `arduino`)
7373
3. Follow the steps on the setup tab:
7474

75-
1. Setup Viam App Config on Single Board Computer (SBC)
75+
1. Setup machine cloud credentials on Single Board Computer (SBC)
7676
2. Download and Install Viam Server
7777
3. Wait until the robot shows as connected. If this doesn't happen try restarting the viam-server:
7878

docs/examples/example.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@
528528
"### 5. Configure a modular resource\n",
529529
"**NOTE:** *If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n",
530530
"\n",
531-
"[Configure your new module](https://docs.viam.com/extend/modular-resources/#configure-your-module) on your robot by navigating to the **Config** tab of the robot's page on the Viam app, then click on the **Modules** subtab. Add the name of your module and the executable path. For our example, the path would be `<path-on-your-filesystem>/linux-wifi/run.sh`.\n",
531+
"[Configure your new module](https://docs.viam.com/extend/modular-resources/#configure-your-module) on your robot by navigating to the **Config** tab of the machine's page, then click on the **Modules** subtab. Add the name of your module and the executable path. For our example, the path would be `<path-on-your-filesystem>/linux-wifi/run.sh`.\n",
532532
"\n",
533533
"Once you have configured a module as part of your robot configuration, [configure your modular resource](https://docs.viam.com/extend/modular-resources/#configure-your-modular-resource) made available by that module by adding new components or services configured with your modular resources' new type or model. To instantiate a new resource from your module, specify the `type`, `model`, and `name` of your modular resource. The aforementioned `type`, `model`, and `name` should be the same as those in the `MODEL` class attribute defined in your [component class](#register-the-custom-component). This is a JSON example:\n",
534534
"\n",
@@ -1100,7 +1100,7 @@
11001100
"\n",
11011101
"Follow the steps outlined in the section [Make the module executable](https://python.viam.dev/examples/example.html#make-the-module-executable) in the directory of the component.\n",
11021102
"\n",
1103-
"The custom remote component is now a custom module component. To use the component on the Viam app, follow the steps to [configure the new modular resource](https://python.viam.dev/examples/example.html#configure-a-modular-resource).\n",
1103+
"The custom remote component is now a custom module component. To use the component in the web UI, follow the steps to [configure the new modular resource](https://python.viam.dev/examples/example.html#configure-a-modular-resource).\n",
11041104
"\n",
11051105
"For easy visualization, the differences in the configuration JSONs and code are below.\n",
11061106
"\n",

src/viam/app/app_client.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -786,7 +786,7 @@ async def delete_organization(self, org_id: str) -> None:
786786
787787
Args:
788788
org_id (str): The ID of the organization.
789-
You can obtain your organization ID from the Viam app's organization settings page.
789+
You can obtain your organization ID from the organization settings page.
790790
791791
For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#deleteorganization>`_.
792792
"""
@@ -802,7 +802,7 @@ async def list_organization_members(self, org_id: str) -> Tuple[List[Organizatio
802802
803803
Args:
804804
org_id (str): The ID of the organization to list members of.
805-
You can obtain your organization ID from the Viam app's organization settings page.
805+
You can obtain your organization ID from the organization settings page.
806806
807807
Returns:
808808
Tuple[List[viam.proto.app.OrganizationMember], List[viam.proto.app.OrganizationInvite]]: A tuple containing two lists; the first
@@ -829,7 +829,7 @@ async def create_organization_invite(
829829
830830
Args:
831831
org_id (str): The ID of the organization to create an invite for.
832-
You can obtain your organization ID from the Viam app's organization settings page.
832+
You can obtain your organization ID from the organization settings page.
833833
email (str): The email address to send the invite to.
834834
authorizations (Optional[List[viam.proto.app.Authorization]]): Specifications of the
835835
authorizations to include in the invite. If not provided, full owner permissions will
@@ -887,7 +887,7 @@ async def update_organization_invite_authorizations(
887887
888888
Args:
889889
org_id (str): The ID of the organization that the invite is for.
890-
You can obtain your organization ID from the Viam app's organization settings page.
890+
You can obtain your organization ID from the organization settings page.
891891
email (str): Email of the user the invite was sent to.
892892
add_authorizations (Optional[List[viam.proto.app.Authorization]]): Optional list of authorizations to add to the invite.
893893
remove_authorizations (Optional[List[viam.proto.app.Authorization]]): Optional list of authorizations to remove from the invite.
@@ -921,7 +921,7 @@ async def delete_organization_member(self, org_id: str, user_id: str) -> None:
921921
922922
Args:
923923
org_id (str): The ID of the org to remove the user from.
924-
You can obtain your organization ID from the Viam app's organization settings page.
924+
You can obtain your organization ID from the organization settings page.
925925
user_id (str): The ID of the user to remove.
926926
927927
For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#deleteorganizationmember>`_.
@@ -938,7 +938,7 @@ async def delete_organization_invite(self, org_id: str, email: str) -> None:
938938
939939
Args:
940940
org_id (str): The ID of the organization that the invite to delete was for.
941-
You can obtain your organization ID from the Viam app's organization settings page.
941+
You can obtain your organization ID from the organization settings page.
942942
email (str): The email address the pending invite was sent to.
943943
944944
Raises:
@@ -958,7 +958,7 @@ async def resend_organization_invite(self, org_id: str, email: str) -> Organizat
958958
959959
Args:
960960
org_id (str): The ID of the organization that the invite to resend was for.
961-
You can obtain your organization ID from the Viam app's organization settings page.
961+
You can obtain your organization ID from the organization settings page.
962962
email (str): The email address associated with the invite.
963963
964964
Raises:
@@ -982,7 +982,7 @@ async def create_location(self, org_id: str, name: str, parent_location_id: Opti
982982
983983
Args:
984984
org_id (str): The ID of the organization to create the location under.
985-
You can obtain your organization ID from the Viam app's organization settings page.
985+
You can obtain your organization ID from the organization settings page.
986986
name (str): Name of the location.
987987
parent_location_id (Optional[str]): Optional parent location to put the location under. Defaults to a root-level location if no
988988
location ID is provided.
@@ -1094,7 +1094,7 @@ async def list_locations(self, org_id: str) -> List[Location]:
10941094
10951095
Args:
10961096
org_id (str): The ID of the org to list locations for.
1097-
You can obtain your organization ID from the Viam app's organization settings page.
1097+
You can obtain your organization ID from the organization settings page.
10981098
10991099
Returns:
11001100
List[viam.proto.app.Location]: The list of locations.
@@ -1241,7 +1241,7 @@ async def get_rover_rental_robots(self, org_id: str) -> List[RoverRentalRobot]:
12411241
12421242
Args:
12431243
org_id (str): The ID of the organization to list rover rental robots for.
1244-
You can obtain your organization ID from the Viam app's organization settings page.
1244+
You can obtain your organization ID from the organization settings page.
12451245
12461246
Returns:
12471247
List[viam.proto.app.RoverRentalRobot]: The list of rover rental robots.
@@ -1744,7 +1744,7 @@ async def list_fragments(
17441744
17451745
Args:
17461746
org_id (str): The ID of the organization to list fragments for.
1747-
You can obtain your organization ID from the Viam app's organization settings page.
1747+
You can obtain your organization ID from the organization settings page.
17481748
show_public (bool): Optional boolean specifying whether or not to only show public fragments. If True, only public fragments
17491749
will return. If False, only private fragments will return. Defaults to True.
17501750
@@ -1800,7 +1800,7 @@ async def create_fragment(self, org_id: str, name: str, config: Optional[Mapping
18001800
18011801
Args:
18021802
org_id (str): The ID of the organization to create the fragment within.
1803-
You can obtain your organization ID from the Viam app's organization settings page.
1803+
You can obtain your organization ID from the organization settings page.
18041804
name (str): Name of the fragment.
18051805
config (Optional[Mapping[str, Any]]): Optional Dictionary representation of new config to assign to specified fragment. Can be
18061806
assigned by updating the fragment.
@@ -1942,7 +1942,7 @@ async def add_role(
19421942
19431943
Args:
19441944
org_id (str): The ID of the organization to create the role in.
1945-
You can obtain your organization ID from the Viam app's organization settings page.
1945+
You can obtain your organization ID from the organization settings page.
19461946
identity_id (str): ID of the entity the role belongs to (for example, a user ID).
19471947
role (Union[Literal["owner"], Literal["operator"]]): The role to add.
19481948
resource_type (Union[Literal["organization"], Literal["location"], Literal["robot"]]): Type of the resource to add role to.
@@ -1987,7 +1987,7 @@ async def remove_role(
19871987
19881988
Args:
19891989
org_id (str): The ID of the organization the role exists in.
1990-
You can obtain your organization ID from the Viam app's organization settings page.
1990+
You can obtain your organization ID from the organization settings page.
19911991
identity_id (str): ID of the entity the role belongs to (for example, a user ID).
19921992
role (Union[Literal["owner"], Literal["operator"]]): The role to remove.
19931993
resource_type (Union[Literal["organization"], Literal["location"], Literal["robot"]]): Type of the resource the role is being
@@ -2290,7 +2290,7 @@ async def create_module(self, org_id: str, name: str) -> Tuple[str, str]:
22902290
22912291
Args:
22922292
org_id (str): The ID of the organization to create the module under.
2293-
You can obtain your organization ID from the Viam app's organization settings page.
2293+
You can obtain your organization ID from the organization settings page.
22942294
name (str): The name of the module. Must be unique within your organization.
22952295
22962296
Raises:
@@ -2431,7 +2431,7 @@ async def list_modules(self, org_id: str) -> List[Module]:
24312431
24322432
Args:
24332433
org_id (str): The ID of the organization to list modules for.
2434-
You can obtain your organization ID from the Viam app's organization settings page.
2434+
You can obtain your organization ID from the organization settings page.
24352435
24362436
Returns:
24372437
List[viam.proto.app.Module]: The list of modules.
@@ -2465,7 +2465,7 @@ async def create_key(self, org_id: str, authorizations: List[APIKeyAuthorization
24652465
24662466
Args:
24672467
org_id (str): The ID of the organization to create the key for.
2468-
You can obtain your organization ID from the Viam app's organization settings page.
2468+
You can obtain your organization ID from the organization settings page.
24692469
authorizations (List[viam.proto.app.Authorization]): A list of authorizations to associate
24702470
with the key.
24712471
name (Optional[str]): A name for the key. If None, defaults to the current timestamp.
@@ -2531,7 +2531,7 @@ async def list_keys(self, org_id: str) -> List[APIKeyWithAuthorizations]:
25312531
25322532
Args:
25332533
org_id (str): The ID of the organization to list API keys for.
2534-
You can obtain your organization ID from the Viam app's organization settings page.
2534+
You can obtain your organization ID from the organization settings page.
25352535
25362536
Returns:
25372537
List[viam.proto.app.APIKeyWithAuthorizations]: The existing API keys and authorizations.
@@ -2570,7 +2570,7 @@ async def get_organization_metadata(self, org_id: str) -> Mapping[str, Any]:
25702570
25712571
Args:
25722572
org_id (str): The ID of the organization with which the user-defined metadata is associated.
2573-
You can obtain your organization ID from the Viam app's organization settings page.
2573+
You can obtain your organization ID from the organization settings page.
25742574
25752575
Returns:
25762576
Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary
@@ -2588,7 +2588,7 @@ async def update_organization_metadata(self, org_id: str, metadata: Mapping[str,
25882588
25892589
Args:
25902590
organization_id (str): The ID of the organization with which to associate the user-defined metadata.
2591-
You can obtain your organization ID from the Viam app's organization settings page.
2591+
You can obtain your organization ID from the organization settings page.
25922592
metadata (Mapping[str, Any]): The user-defined metadata to upload as a Python dictionary.
25932593
"""
25942594
request = UpdateOrganizationMetadataRequest(organization_id=org_id, data=dict_to_struct(metadata))
@@ -2603,7 +2603,7 @@ async def get_location_metadata(self, location_id: str) -> Mapping[str, Any]:
26032603
26042604
Args:
26052605
location_id (str): The ID of the location with which the user-defined metadata is associated.
2606-
You can obtain your location ID from the Viam app's locations page.
2606+
You can obtain your location ID from the locations page.
26072607
26082608
Returns:
26092609
Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary.
@@ -2621,7 +2621,7 @@ async def update_location_metadata(self, location_id: str, metadata: Mapping[str
26212621
26222622
Args:
26232623
location_id (str): The ID of the location with which to associate the user-defined metadata.
2624-
You can obtain your location ID from the Viam app's locations page.
2624+
You can obtain your location ID from the locations page.
26252625
metadata (Mapping[str, Any]): The user-defined metadata converted from JSON to a Python dictionary.
26262626
"""
26272627
request = UpdateLocationMetadataRequest(location_id=location_id, data=dict_to_struct(metadata))
@@ -2636,7 +2636,7 @@ async def get_robot_metadata(self, robot_id: str) -> Mapping[str, Any]:
26362636
26372637
Args:
26382638
robot_id (str): The ID of the robot with which the user-defined metadata is associated.
2639-
You can obtain your robot ID from the Viam app's machine page.
2639+
You can obtain your robot ID from the machine page.
26402640
26412641
Returns:
26422642
Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary.
@@ -2654,7 +2654,7 @@ async def update_robot_metadata(self, robot_id: str, metadata: Mapping[str, Any]
26542654
26552655
Args:
26562656
robot_id (str): The ID of the robot with which to associate the user-defined metadata.
2657-
You can obtain your robot ID from the Viam app's machine page.
2657+
You can obtain your robot ID from the machine page.
26582658
metadata (Mapping[str, Any]): The user-defined metadata converted from JSON to a Python dictionary.
26592659
"""
26602660
request = UpdateRobotMetadataRequest(id=robot_id, data=dict_to_struct(metadata))
@@ -2669,7 +2669,7 @@ async def get_robot_part_metadata(self, robot_part_id: str) -> Mapping[str, Any]
26692669
26702670
Args:
26712671
robot_part_id (str): The ID of the robot part with which the user-defined metadata is associated.
2672-
You can obtain your robot part ID from the Viam app's machine page.
2672+
You can obtain your robot part ID from the machine page.
26732673
26742674
Returns:
26752675
Mapping[str, Any]: The user-defined metadata converted from JSON to a Python dictionary.
@@ -2687,7 +2687,7 @@ async def update_robot_part_metadata(self, robot_part_id: str, metadata: Mapping
26872687
26882688
Args:
26892689
robot_id (str): The ID of the robot part with which to associate the user-defined metadata.
2690-
You can obtain your robot part ID from the Viam app's machine page.
2690+
You can obtain your robot part ID from the machine page.
26912691
metadata (Mapping[str, Any]): The user-defined metadata converted from JSON to a Python dictionary.
26922692
"""
26932693
request = UpdateRobotPartMetadataRequest(id=robot_part_id, data=dict_to_struct(metadata))

0 commit comments

Comments
 (0)