Skip to content

Commit

Permalink
DOCS-1366: Update I2C attributes for bme280 sensor (#2297)
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre authored Dec 6, 2023
1 parent 56c4c9f commit cc4345d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
Binary file modified assets/components/sensor/bme280-sensor-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 4 additions & 8 deletions docs/components/sensor/bme280.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ Then remove and fill in the attributes as applicable to your sensor, according t

```json {class="line-numbers linkable-line-numbers"}
{
"board": "<your-board-name>",
"i2c_bus": "<your-i2c-bus-name-on-board>",
"i2c_bus": "<your-i2c-bus-index-on-board>",
"i2c_address": "<your-i2c-address>"
}
```
Expand All @@ -43,8 +42,7 @@ Then remove and fill in the attributes as applicable to your sensor, according t

```json {class="line-numbers linkable-line-numbers"}
{
"board": "local",
"i2c_bus": "i2c_bus1"
"i2c_bus": "1"
}
```

Expand All @@ -63,8 +61,7 @@ Then remove and fill in the attributes as applicable to your sensor, according t
"type": "sensor",
"namespace": "rdk",
"attributes": {
"board": "<your-board-name>",
"i2c_bus": "<your-i2c-bus-name-on-board>",
"i2c_bus": "<your-i2c-bus-index-on-board>",
"i2c_address": "<your-i2c-address>"
},
"depends_on": []
Expand All @@ -81,8 +78,7 @@ The following attributes are available for `bme280` sensors:
<!-- prettier-ignore -->
| Attribute | Type | Inclusion | Description |
| --------- | ---- | --------- | ---------- |
| `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_bus` | string | **Required** | The index 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/test-control/sensor-control.md" >}}

0 comments on commit cc4345d

Please sign in to comment.