From d9d5d91601a11a6e5847d83ae82cbcf65d17759c Mon Sep 17 00:00:00 2001 From: sky leilani <45158875+skyleilani@users.noreply.github.com> Date: Mon, 18 Sep 2023 14:21:52 -0400 Subject: [PATCH] integrate comments --- docs/components/power-sensor/ina219.md | 16 ++++++++-------- docs/components/power-sensor/ina226.md | 14 +++++++------- docs/components/power-sensor/renogy.md | 18 +++++++++--------- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/components/power-sensor/ina219.md b/docs/components/power-sensor/ina219.md index 1507457f9a..6c4e803d79 100644 --- a/docs/components/power-sensor/ina219.md +++ b/docs/components/power-sensor/ina219.md @@ -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"] @@ -32,12 +32,12 @@ Edit and fill in the attributes as applicable. { "components": [ { - "name": "", + "name": "ina1", "type": "power_sensor", - "model": "INA219", + "model": "ina19", "attributes": { - "board": "", - "i2c_bus": "" + "i2c_bus": "integer", + "i2c-addr": "integer" }, "depends_on": [] } @@ -52,7 +52,7 @@ The following attributes are available for `INA219` sensors: | Attribute | Type | Inclusion | Description | | --------- | -----| --------- | ----------- | -| `i2c_bus` | integer | **Required** | The `name` of the [I2C bus](/components/board/#i2cs) that the sensor is connected to. | +| `i2c_bus` | integer | **Required** | The `number` of the [I2C bus](/components/board/#i2cs) that the sensor is connected to. | | `i2c_address` | integer | Optional | The sensor's unique [I2C address](https://learn.adafruit.com/i2c-addresses/overview).
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 (Ω). diff --git a/docs/components/power-sensor/ina226.md b/docs/components/power-sensor/ina226.md index 84d1d76488..82230979cc 100644 --- a/docs/components/power-sensor/ina226.md +++ b/docs/components/power-sensor/ina226.md @@ -30,12 +30,12 @@ Edit and fill in the attributes as applicable. { "components": [ { - "name": "", + "name": "ina2", "type": "power_sensor", - "model": "INA226", + "model": "ina226", "attributes": { - "board": "", - "i2c_bus": "" + "i2c_bus": "integer", + "i2c_address": "integer" }, "depends_on": [] } @@ -50,7 +50,7 @@ The following attributes are available for `INA226` sensors: | Attribute | Type | Inclusion | Description | | --------- | -----| --------- | ----------- | -| `i2c_bus` | integer | **Required** | The `name` of the [I2C bus](/components/board/#i2cs) that the sensor is connected to. | +| `i2c_bus` | integer | **Required** | The `number` of the [I2C bus](/components/board/#i2cs) that the sensor is connected to. | | `i2c_address` | integer | Optional | Default: `0x40`. The sensor's unique [I2C 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 (Ω). diff --git a/docs/components/power-sensor/renogy.md b/docs/components/power-sensor/renogy.md index 9ff3f7e2ea..5616c5d186 100644 --- a/docs/components/power-sensor/renogy.md +++ b/docs/components/power-sensor/renogy.md @@ -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" %}} @@ -31,13 +31,13 @@ Edit and fill in the attributes as applicable. { "components": [ { - "name": "", - "type": "sensor", + "name": "ren1", + "type": "power_sensor", "model": "renogy", "attributes": { - "serial_path": "", - "serial_baud_rate": , - "modbus_id": + "serial_path": "string", + "serial_baud_rate": "integer", + "modbus_id": "integer" }, "depends_on": [] } @@ -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", @@ -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 /dev/. 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 /dev/ttyS0. If you omit this attribute, Viam will attempt to automatically detect the path.
Default: `/dev/serial0` | +| `serial_path` | string | Optional | The full filesystem path to the serial device, starting with /dev/. 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 /dev/ttyS0. 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.
Example: `"/dev/serial/by-path/usb-0:1.1:1.0"`
Default: `/dev/serial0` | | `serial_baud_rate` | integer | Optional | The baud rate to use for serial communications.
Default: `9600` | | `modbus_id` | integer | Optional | Controller MODBUS address.
Default: `1` |