Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-1029: add sensor control view #1840

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/components/sensor/sensor-control-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/components/sensor/bme280.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ The following attributes are available for `bme280` sensors:
| `board` | string | **Required** | The `name` of the [board](/components/board/) the sensor is wired to. |
| `i2c_bus` | string | **Required** | The `name` of the [I2C bus](/components/board/#i2cs) on the board that the sensor is wired to. |
| `i2c_address` | string | Optional | Default: `0x77`. The [I2C device address](https://learn.adafruit.com/i2c-addresses/overview) of the sensor. |

{{< readfile "/static/include/components/sensor-control.md" >}}
2 changes: 2 additions & 0 deletions docs/components/sensor/ds18b20.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,5 @@ The following attributes are available for `ds18b20` sensors:
| Attribute | Type | Inclusion | Description |
| --------- | ---- | --------- | ---------- |
| `unique_id` | string | **Required** | The [unique 64-bit serial code](https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf) of your DS18B20 sensor. Laser engraved onto your sensor and available [programmatically](https://github.com/milesburton/Arduino-Temperature-Control-Library). Example: `"28EEB2B81D160127"`. Note that this ID will also be the last 16 digits of the [device file](https://en.wikipedia.org/wiki/Device_file) when the sensor is mounted in a Linux filesystem. |

{{< readfile "/static/include/components/sensor-control.md" >}}
2 changes: 2 additions & 0 deletions docs/components/sensor/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,5 @@ No attributes are available for `fake` sensors.
A call to [`Readings()`](../#getreadings) on a `fake` sensor always returns readings of `{"a":1, "b":2, "c":3}`.

{{% /alert %}}

{{< readfile "/static/include/components/sensor-control.md" >}}
2 changes: 2 additions & 0 deletions docs/components/sensor/sensirion-sht3xd.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ The following attributes are available for `sensirion-sht3xd` sensors:
| `board` | string | **Required** | The `name` of the [board](/components/board/) the sensor is wired to. |
| `i2c_bus` | string | **Required** | The `name` of the [I2C bus](/components/board/#i2cs) on the board that the sensor is wired to. |
| `i2c_address` | string | Optional | The [I2C device address](https://learn.adafruit.com/i2c-addresses/overview) of the sensor. <br> Default: `0x44` |

{{< readfile "/static/include/components/sensor-control.md" >}}
2 changes: 2 additions & 0 deletions docs/components/sensor/ultrasonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,5 @@ The following attributes are available for `ultrasonic` sensors:
| `trigger_pin` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} on the [board](/components/board/) that you have wired [the sensor's trigger pin](https://www.sparkfun.com/products/15569). |
| `echo_interrupt_pin` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the pin [the sensor's echo pin](https://www.sparkfun.com/products/15569) is wired to on the board. If you have already created a [digital interrupt](/components/board/#digital_interrupts) for this pin in the [board's configuration](/components/board/), use that digital interrupt's `name` instead. |
| `timeout_ms` | int | Optional | Time to wait in milliseconds before timing out of requesting to get readings from the sensor. <br> Default: `1000`. |

{{< readfile "/static/include/components/sensor-control.md" >}}
7 changes: 7 additions & 0 deletions static/include/components/sensor-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Test the sensor

After you configure your sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the **Sensors** dropdown panel.
If you have multiple sensors configured, your sensor will be listed here among others.
To access detailed readings from your sensor, select the **Get Readings** button.

{{<imgproc src="/components/sensor/sensor-control-tab.png" resize="800x" declaredimensions=true alt="The sensor component in the control tab">}}