Skip to content

Commit 406ffe4

Browse files
committed
Fix readme links etc
1 parent e437b44 commit 406ffe4

File tree

1 file changed

+21
-14
lines changed
  • docs/operate/get-started/other-hardware

1 file changed

+21
-14
lines changed

docs/operate/get-started/other-hardware/_index.md

+21-14
Original file line numberDiff line numberDiff line change
@@ -708,13 +708,24 @@ Run the following command to rebuild and restart your module:
708708
viam module reload <insert relevant named args>
709709
```
710710

711-
For more information, run the command with the `-h` flag or see the [CLI documentation](/dev/tools/cli/#module).
712-
An example:
711+
{{< expand "Reload example commands" >}}
712+
713+
For example, to run on your development machine:
714+
715+
```sh {id="terminal-prompt" class="command-line" data-prompt="$"}
716+
viam module reload --local
717+
```
718+
719+
Or to run on a different machine (such as a single-board computer), specify the part ID of the remote machine, and the home directory of your development machine:
713720

714721
```sh {id="terminal-prompt" class="command-line" data-prompt="$"}
715722
viam module reload --part-id 123abc45-1234-432c-aabc-z1y111x23a00 --home /Users/jessamyt/
716723
```
717724

725+
{{< /expand >}}
726+
727+
For more information, run the command with the `-h` flag or see the [CLI documentation](/dev/tools/cli/#module).
728+
718729
{{< expand "Reload troubleshooting" >}}
719730

720731
`Error: Could not connect to machine part: context deadline exceeded; context deadline exceeded; mDNS query failed to find a candidate`
@@ -765,26 +776,21 @@ It's quite helpful to create a README to document what your module does and how
765776
````md
766777
# `meteo_PM` modular component
767778

768-
This module implements the [Viam sensor API](https://github.com/rdk/sensor-api) in a jessamy:weather:meteo_PM model.
779+
This module implements the [Viam sensor API](https://docs.viam.com/dev/reference/apis/components/sensor/) in a `jessamy:weather:meteo_PM` model.
769780
With this model, you can gather [Open-Meteo](https://open-meteo.com/en/docs/air-quality-api) PM2.5 and PM10 air quality data from anywhere in the world, at the coordinates you specify.
770781

771-
## Build and Run
772-
773-
To use this module, add it from the machines **CONFIGURE** tab and select the `rdk:sensor:jessamy:weather:meteo_PM` model from the [`jessamy:weather:meteo_PM` module](https://app.viam.com/module/rdk/jessamy:weather:_PM).
774-
775782
## Configure your `meteo_PM` sensor
776783

777-
Navigate to the **CONFIGURE** tab of your robot’s page in the [Viam app](https://app.viam.com/).
778-
Add a component.
779-
Select the `sensor` type, then select the `jessamy:weather:meteo_PM` model.
780-
Enter a name for your sensor and click **Create**.
784+
Navigate to the **CONFIGURE** tab of your machine’s page in the [Viam app](https://app.viam.com/).
785+
Click the **+** button, select **Component**, then select the `sensor / weather:meteo_PM` model provided by the [`weather` module](https://app.viam.com/module/jessamy/weather).
786+
Click **Add module**, enter a name for your sensor, and click **Create**.
781787

782788
On the new component panel, copy and paste the following attribute template into your sensor’s **Attributes** box:
783789

784790
```json
785791
{
786-
"latitude": <float>,
787-
"longitude": <float>
792+
"latitude": <float>,
793+
"longitude": <float>
788794
}
789795
```
790796

@@ -871,7 +877,8 @@ Do not change the <code>module_id</code>.</p>
871877
<td><code>models</code></td>
872878
<td>object</td>
873879
<td><strong>Required</strong></td>
874-
<td><p>A list of one or more {{< glossary_tooltip term_id="model" text="models" >}} provided by your custom module. You must provide at least one model, which consists of an <code>api</code> and <code>model</code> key pair. If you are publishing a public module (<code>"visibility": "public"</code>), the namespace of your model must match the <a href="/operate/reference/naming-modules/#create-a-namespace-for-your-organization">namespace of your organization</a>.</p></td>
880+
<td><p>A list of one or more {{< glossary_tooltip term_id="model" text="models" >}} provided by your custom module. You must provide at least one model, which consists of an <code>api</code> and <code>model</code> key pair. If you are publishing a public module (<code>"visibility": "public"</code>), the namespace of your model must match the <a href="/operate/reference/naming-modules/#create-a-namespace-for-your-organization">namespace of your organization</a>.</p>
881+
<p>You are strongly encouraged to include a <code>markdown_link</code> to the section of the README containing configuration information about each model, so that that section will be displayed alongside the configuration panel when configuring the model. For example, <code>"README.md#configure-your-meteo_pm-sensor"</code>. Please also include a <code>short_description</code> describing what hardware the model supports.</p></td>
875882
</tr>
876883
<tr>
877884
<td><code>entrypoint</code></td>

0 commit comments

Comments
 (0)