Skip to content

Commit

Permalink
DOCS-1188: Add namespace and match order to app JSON (#1983)
Browse files Browse the repository at this point in the history
  • Loading branch information
@JessamyT
JessamyT authored Oct 6, 2023
1 parent 34da4a7 commit 88f36da
Show file tree
Hide file tree
Showing 32 changed files with 154 additions and 77 deletions.
12 changes: 8 additions & 4 deletions docs/appendix/local-configuration-file.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,9 @@ This file contains some basic example [component](/components/) and [service](/s
"components": [
{
"name": "arm1",
"type": "arm",
"model": "fake",
"type": "arm",
"namespace": "rdk",
"attributes": {
"arm-model": "xArm6"
}
Expand All @@ -96,8 +97,9 @@ This file contains some basic example [component](/components/) and [service](/s
},
{
"name": "board1",
"type": "board",
"model": "fake",
"type": "board",
"namespace": "rdk",
"attributes": {
"analogs": [
{
Expand All @@ -120,8 +122,9 @@ This file contains some basic example [component](/components/) and [service](/s
},
{
"name": "encoder1",
"type": "encoder",
"model": "fake",
"type": "encoder",
"namespace": "rdk",
"attributes": {
"update_rate_msec": 200
}
Expand All @@ -148,8 +151,9 @@ This file contains some basic example [component](/components/) and [service](/s
},
{
"name": "motor1",
"type": "motor",
"model": "fake",
"type": "motor",
"namespace": "rdk",
"attributes": {
"encoder": "encoder1",
"pins": {
Expand Down
3 changes: 2 additions & 1 deletion docs/components/arm/eva.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Configure an `eva` arm as follows:
```json {class="line-numbers linkable-line-numbers"}
{
"name": "<arm_name>",
"type": "arm",
"model": "eva",
"type": "arm",
"namespace": "rdk",
"attributes": {}
}
```
Expand Down
3 changes: 2 additions & 1 deletion docs/components/arm/yahboom-dofbot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": "myarm",
"type": "arm",
"model": "yahboom-dofbot",
"type": "arm",
"namespace": "rdk",
"attributes": {},
"depends_on": []
}
Expand Down
3 changes: 2 additions & 1 deletion docs/components/base/boat.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": "base",
"type": "base",
"model": "boat",
"type": "base",
"namespace": "rdk",
"attributes": {
"drive_mode": "<a_drive_mode_option>",
"serial_path": "</dev/ttyXXXX>"
Expand Down
3 changes: 2 additions & 1 deletion docs/components/camera/calibrate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ The following is a full example config:
"components": [
{
"name": "color",
"type": "camera",
"model": "webcam",
"type": "camera",
"namespace": "rdk",
"attributes": {
"intrinsic_parameters": {
"fy": 940.2928257873841,
Expand Down
3 changes: 2 additions & 1 deletion docs/components/camera/transform.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -388,8 +388,9 @@ For further information, please refer to the [OpenCV docs](https://docs.opencv.o
```json {class="line-numbers linkable-line-numbers"}
{
"name": "camera_name",
"type": "camera",
"model": "transform",
"type": "camera",
"namespace": "rdk",
"attributes": {
"source": "physical_cam",
"pipeline": [
Expand Down
6 changes: 4 additions & 2 deletions docs/components/component/model1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": <arm_name>,
"type": "arm",
"model": "model1",
"type": "arm",
"namespace": "rdk",
"attributes": {
"board": <string>,
"i2c_bus": <string>
Expand All @@ -53,8 +54,9 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": "myArm",
"type": "arm",
"model": "model1",
"type": "arm",
"namespace": "rdk",
"attributes": {
"board": "local",
"i2c_bus": "1"
Expand Down
3 changes: 2 additions & 1 deletion docs/components/encoder/incremental.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ Fill in and edit the attributes as applicable.
},
{
"name": "myEncoder",
"type": "encoder",
"model": "incremental",
"type": "encoder",
"namespace": "rdk",
"attributes": {
"board": "local",
"pins": {
Expand Down
3 changes: 2 additions & 1 deletion docs/components/gantry/multi-axis.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,9 @@ Then remove and fill in the attributes as applicable to your gantry, according t
},
{
"name": "yaxis",
"type": "gantry",
"model": "single-axis",
"type": "gantry",
"namespace": "rdk",
"attributes": {
"length_mm": 1000,
"board": "local",
Expand Down
3 changes: 2 additions & 1 deletion docs/components/generic/fake.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Enter a name for your generic component and click **Create**.
```json {class="line-numbers linkable-line-numbers"}
{
"name": "<your-fake-generic-component-name>",
"type": "generic",
"model": "fake",
"type": "generic",
"namespace": "rdk",
"attributes": {}
}
```
Expand Down
9 changes: 6 additions & 3 deletions docs/components/movement-sensor/cameramono.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": "<your-sensor-name>",
"type": "movement_sensor",
"model": "camera_mono",
"type": "movement_sensor",
"namespace": "rdk",
"attributes": {
"camera": "<your-camera-name>",
"motion_estimation_config": {
Expand All @@ -60,17 +61,19 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": "myCamera",
"type": "camera",
"model": "webcam",
"type": "camera",
"namespace": "rdk",
"attributes": {
"video_path": "video0"
},
"depends_on": []
},
{
"name": "movementCamera",
"type": "movement_sensor",
"model": "camera_mono",
"type": "movement_sensor",
"namespace": "rdk",
"attributes": {
"camera": "myCamera",
"motion_estimation_config": {
Expand Down
3 changes: 2 additions & 1 deletion docs/components/movement-sensor/gps/gps-nmea-rtk-pmtk.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,9 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
"components": [
{
"name": "my_GPS",
"type": "movement_sensor",
"model": "gps-nmea-rtk-pmtk",
"type": "movement_sensor",
"namespace": "rdk",
"attributes": {
"board": "local",
"i2c_addr": 66,
Expand Down
6 changes: 4 additions & 2 deletions docs/components/movement-sensor/viam-visual-odometry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,9 @@ See the [Attributes](#attributes) section for more information on the other attr
"components": [
{
"name": "<your-camera-name>",
"type": "camera",
"model": "webcam",
"type": "camera",
"namespace": "rdk",
"attributes": {
"video_path": "<path-to-video-stream>",
"height_px": <height>,
Expand Down Expand Up @@ -152,8 +153,9 @@ See the [Attributes](#attributes) section for more information on the other attr
"components": [
{
"name": "my-camera",
"type": "camera",
"model": "webcam",
"type": "camera",
"namespace": "rdk",
"attributes": {
"video_path": "FDF90FEB-59E5-4FCF-AABD-DA03C4E19BFB",
"height_px": 720,
Expand Down
9 changes: 6 additions & 3 deletions docs/manage/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,17 @@ If you add components in **Builder** mode and click **Save Config** at the botto
"components": [
{
"name": "local",
"type": "board",
"model": "pi",
"type": "board",
"namespace": "rdk",
"attributes": {},
"depends_on": []
},
{
"name": "my-motor",
"type": "motor",
"model": "gpio",
"type": "motor",
"namespace": "rdk",
"attributes": {
"pins": {
"a": "13",
Expand All @@ -98,8 +100,9 @@ If you add components in **Builder** mode and click **Save Config** at the botto
},
{
"name": "my_camera",
"type": "camera",
"model": "webcam",
"type": "camera",
"namespace": "rdk",
"attributes": {
"video_path": "video0"
}
Expand Down
3 changes: 2 additions & 1 deletion docs/services/frame-system/frame-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ Select the `parent` frame as `world` and fill in the coordinates for `translatio
{
"depends_on": [],
"name": "myArm",
"type": "arm",
"model": "ur5e",
"type": "arm",
"namespace": "rdk",
"attributes": {
"host": "127.0.0.1"
},
Expand Down
6 changes: 4 additions & 2 deletions docs/services/frame-system/nested-frame-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ Select the `parent` frame as `myGantry` and fill in the coordinates for `transla
"components": [
{
"name": "myGantry",
"type": "gantry",
"model": "single-axis",
"type": "gantry",
"namespace": "rdk",
"attributes": {},
"depends_on": [],
"frame": {
Expand All @@ -68,8 +69,9 @@ Select the `parent` frame as `myGantry` and fill in the coordinates for `transla
{
"depends_on": [],
"name": "myArm",
"type": "arm",
"model": "ur5e",
"type": "arm",
"namespace": "rdk",
"attributes": {
"host": "127.0.0.1"
},
Expand Down
15 changes: 10 additions & 5 deletions docs/tutorials/configure/scuttlebot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,9 @@ Add the following JSON objects to the `components` array:
```json {class="line-numbers linkable-line-numbers"}
{
"name": "lenc",
"type": "encoder",
"model": "AMS-AS5048",
"type": "encoder",
"namespace": "rdk",
"attributes": {
"board": "local",
"connection_type": "i2c",
Expand All @@ -125,8 +126,9 @@ Add the following JSON objects to the `components` array:
},
{
"name": "renc",
"type": "encoder",
"model": "AMS-AS5048",
"type": "encoder",
"namespace": "rdk",
"attributes": {
"board": "local",
"connection_type": "i2c",
Expand Down Expand Up @@ -192,8 +194,9 @@ Add the following JSON objects to the `components` array:
```json
{
"name": "right",
"type": "motor",
"model": "gpio",
"type": "motor",
"namespace": "rdk",
"attributes": {
"pins": {
"a": "16",
Expand All @@ -209,8 +212,9 @@ Add the following JSON objects to the `components` array:
},
{
"name": "left",
"type": "motor",
"model": "gpio",
"type": "motor",
"namespace": "rdk",
"attributes": {
"pins": {
"a": "12",
Expand Down Expand Up @@ -375,8 +379,9 @@ If you click on the **Video Path** field while your robot is live, a drop down a
```json {class="line-numbers linkable-line-numbers"}
{
"name": "Webcam",
"type": "camera",
"model": "webcam",
"type": "camera",
"namespace": "rdk",
"attributes": {
"video_path": "video0"
}
Expand Down
3 changes: 2 additions & 1 deletion docs/tutorials/control/scuttle-gamepad.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ Inside the `components` array of your config, add the following configuration fo
```json {class="line-numbers linkable-line-numbers"}
{
"name": "my-gamepad",
"type": "input_controller",
"model": "gamepad",
"type": "input_controller",
"namespace": "rdk",
"attributes": {},
"depends_on": []
}
Expand Down
3 changes: 2 additions & 1 deletion docs/tutorials/get-started/blink-an-led.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,9 @@ Replace the contents of the config field with the following JSON configuration f
"components": [
{
"name": "local",
"type": "board",
"model": "pi",
"type": "board",
"namespace": "rdk",
"attributes": {},
"depends_on": []
}
Expand Down
6 changes: 4 additions & 2 deletions docs/tutorials/get-started/confetti-bot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,15 +166,17 @@ On the [**Raw JSON** tab](/manage/configuration/#the-config-tab), replace the co
"components": [
{
"name": "party",
"type": "board",
"model": "pi",
"type": "board",
"namespace": "rdk",
"attributes": {},
"depends_on": []
},
{
"name": "start",
"type": "motor",
"model": "gpio",
"type": "motor",
"namespace": "rdk",
"attributes": {
"pins": {
"a": "13",
Expand Down
Loading

0 comments on commit 88f36da

Please sign in to comment.