Skip to content

Commit

Permalink
integrate comments
Browse files Browse the repository at this point in the history
  • Loading branch information
skyleilani authored Sep 18, 2023
1 parent 2e47217 commit d9d5d91
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 24 deletions.
16 changes: 8 additions & 8 deletions docs/components/power-sensor/ina219.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: "ina219"
weight: 10
draft: false
type: "docs"
description: "Configure an INA219 model power sensor to return voltage and current readings."
description: "Configure an INA219 model power sensor to return voltage, current, and power readings."
tags: ["power sensor", "ina219"]
icon: "/icons/components/sensor.svg"
images: ["/icons/components/sensor.svg"]
Expand Down Expand Up @@ -32,12 +32,12 @@ Edit and fill in the attributes as applicable.
{
"components": [
{
"name": "<your-INA219-sensor-name>",
"name": "ina1",
"type": "power_sensor",
"model": "INA219",
"model": "ina19",
"attributes": {
"board": "<your-board-name>",
"i2c_bus": "<your-i2c-bus-name-on-board>"
"i2c_bus": "integer",
"i2c-addr": "integer"
},
"depends_on": []
}
Expand All @@ -52,7 +52,7 @@ The following attributes are available for `INA219` sensors:

| Attribute | Type | Inclusion | Description |
| --------- | -----| --------- | ----------- |
| `i2c_bus` | integer | **Required** | The `name` of the [I<sup>2</sup>C bus](/components/board/#i2cs) that the sensor is connected to. |
| `i2c_bus` | integer | **Required** | The `number` of the [I<sup>2</sup>C bus](/components/board/#i2cs) that the sensor is connected to. |
| `i2c_address` | integer | Optional | The sensor's unique [I<sup>2</sup>C address](https://learn.adafruit.com/i2c-addresses/overview). <br>Default: `0x40`
| `max_current_amps` | number | Optional | The maximum current that the sensor can measure in amperes (A).
| `shunt_resistance` | number | Optional | The shunt resistance value of the sensor in Ohms (Ω).
| `max_current_amps` | number | Optional | Default: 3.2A. The maximum current that the sensor can measure in amperes (A).
| `shunt_resistance` | number | Optional | Default: 0.1Ω. The shunt resistance value of the sensor in Ohms (Ω).
14 changes: 7 additions & 7 deletions docs/components/power-sensor/ina226.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Edit and fill in the attributes as applicable.
{
"components": [
{
"name": "<your-INA226-sensor-name>",
"name": "ina2",
"type": "power_sensor",
"model": "INA226",
"model": "ina226",
"attributes": {
"board": "<your-board-name>",
"i2c_bus": "<your-i2c-bus-name-on-board>"
"i2c_bus": "integer",
"i2c_address": "integer"
},
"depends_on": []
}
Expand All @@ -50,7 +50,7 @@ The following attributes are available for `INA226` sensors:

| Attribute | Type | Inclusion | Description |
| --------- | -----| --------- | ----------- |
| `i2c_bus` | integer | **Required** | The `name` of the [I<sup>2</sup>C bus](/components/board/#i2cs) that the sensor is connected to. |
| `i2c_bus` | integer | **Required** | The `number` of the [I<sup>2</sup>C bus](/components/board/#i2cs) that the sensor is connected to. |
| `i2c_address` | integer | Optional | Default: `0x40`. The sensor's unique [I<sup>2</sup>C address](https://learn.adafruit.com/i2c-addresses/overview). |
| `max_current_amps` | number | Optional | The maximum current that the sensor can measure in amperes (A).
| `shunt_resistance` | number | Optional | The shunt resistance value of the sensor in Ohms (Ω).
| `max_current_amps` | number | Optional | Default: 20A. The maximum current that the sensor can measure in amperes (A).
| `shunt_resistance` | number | Optional | Default: 0.1Ω. The shunt resistance value of the sensor in Ohms (Ω).
18 changes: 9 additions & 9 deletions docs/components/power-sensor/renogy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: "Configure a renogy power sensor"
linkTitle: "renogy"
weight: 10
type: "docs"
description: "Configure a renogy model power sensor to return battery temperature."
description: "Configure a renogy model power sensor to return battery voltage and load current, power, and various other readings."
tags: ["power sensor", "components", "renogy"]
icon: "/icons/components/sensor.svg"
images: ["/icons/components/sensor.svg"]
# SME: #team-bucket
---

Configure a `renogy` sensor to integrate a [Renogy battery temperature sensor](https://www.renogy.com/battery-temperature-sensor-for-renogy-solar-charge-controllers/) into your robot:
Configure a `renogy` sensor to integrate a [Renogy battery temperature sensor](https://www.renogy.com/wanderer-10a-pwm-charge-controller/) into your robot:

{{< tabs name="Configure a Renogy Sensor" >}}
{{% tab name="Config Builder" %}}
Expand All @@ -31,13 +31,13 @@ Edit and fill in the attributes as applicable.
{
"components": [
{
"name": "<your-renogy-sensor-name>",
"type": "sensor",
"name": "ren1",
"type": "power_sensor",
"model": "renogy",
"attributes": {
"serial_path": "<your-serial-path>",
"serial_baud_rate": <int>,
"modbus_id": <int>
"serial_path": "string",
"serial_baud_rate": "integer",
"modbus_id": "integer"
},
"depends_on": []
}
Expand All @@ -53,7 +53,7 @@ Edit and fill in the attributes as applicable.
"components": [
{
"name": "your-renogy-sensor",
"type": "sensor",
"type": "power_sensor",
"model": "renogy",
"attributes": {
"serial_path": "/dev/serial0",
Expand All @@ -72,6 +72,6 @@ The following attributes are available for `renogy` sensors:

| Attribute | Type | Inclusion | Description |
| --------- | ---- | --------- | ----------- |
| `serial_path` | string | Optional | The full filesystem path to the serial device, starting with <file>/dev/</file>. With your serial device connected, you can run `sudo dmesg \| grep tty` to show relevant device connection log messages, and then match the returned device name, such as `ttyS0`, to its device file, such as <file>/dev/ttyS0</file>. If you omit this attribute, Viam will attempt to automatically detect the path.<br>Default: `/dev/serial0` |
| `serial_path` | string | Optional | The full filesystem path to the serial device, starting with /dev/</file>. With your serial device connected, you can run `sudo dmesg \| grep tty` to show relevant device connection log messages, and then match the returned device name, such as `ttyS0`, to its device file, such as <file>/dev/ttyS0</file>. If you omit this attribute, Viam will attempt to automatically detect the path. On a Raspberry Pi, you can also run `ls /dev/serial/by-path` to list USB serial devices. If you omit this attribute, Viam will attempt to automatically detect the path.<br>Example: `"/dev/serial/by-path/usb-0:1.1:1.0"` <br>Default: `/dev/serial0` |
| `serial_baud_rate` | integer | Optional | The baud rate to use for serial communications. <br> Default: `9600` |
| `modbus_id` | integer | Optional | Controller MODBUS address. <br> Default: `1` |

0 comments on commit d9d5d91

Please sign in to comment.