You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
viam module reload --part-id 123abc45-1234-432c-aabc-z1y111x23a00 --home /Users/jessamyt/
716
723
```
717
724
725
+
{{< /expand >}}
726
+
727
+
For more information, run the command with the `-h` flag or see the [CLI documentation](/dev/tools/cli/#module).
728
+
718
729
{{< expand "Reload troubleshooting" >}}
719
730
720
731
`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
765
776
````md
766
777
# `meteo_PM` modular component
767
778
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.
769
780
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.
770
781
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
-
775
782
## Configure your `meteo_PM` sensor
776
783
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**.
781
787
782
788
On the new component panel, copy and paste the following attribute template into your sensor’s **Attributes** box:
783
789
784
790
```json
785
791
{
786
-
"latitude": <float>,
787
-
"longitude": <float>
792
+
"latitude": <float>,
793
+
"longitude": <float>
788
794
}
789
795
```
790
796
@@ -871,7 +877,8 @@ Do not change the <code>module_id</code>.</p>
871
877
<td><code>models</code></td>
872
878
<td>object</td>
873
879
<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 <ahref="/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 <ahref="/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>
0 commit comments