DOCS-821: Add Power Sensor Component #1766

skyleilani · 2023-09-07T16:12:50Z

Add power sensor component supporting INA219, INA226, and renogy

docs/components/power-sensor/_index.md

andf-viam

This is fantastic! Looking good overall, just some small language nits and minor corrections. Great job!!

docs/components/power-sensor/_index.md

docs/components/power-sensor/renogy.md

static/include/components/apis/power-sensor.md

docs/components/power-sensor/ina226.md

docs/components/power-sensor/ina219.md

docs/components/power-sensor/_index.md

viambot · 2023-09-12T13:53:51Z

Overall readability score: 54.7 (🟢 +0.08)

File	Readability
_index.md	59.33 (-)
fake.md	49.32 (-)
ina219.md	62.38 (-)
ina226.md	59.69 (-)
renogy.md	44.2 (-)
_index.md	49.56 (🟢 +0)
foam-dart-launcher.md	59.54 (🟢 +0)
power-sensor.md	85.77 (-)
show-secret.md	43.23 (🟢 +0)

View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File	Readability	FRE	GF	ARI	CLI	DCRS
_index.md	59.33	40.24	8.05	14.2	13.45	6.41
	-	-	-	-	-	-
fake.md	49.32	45.35	11.56	14.5	11.83	8.49
	-	-	-	-	-	-
ina219.md	62.38	58.08	9.31	11.7	10.48	8.14
	-	-	-	-	-	-
ina226.md	59.69	56.35	9.99	12.2	10.66	8.22
	-	-	-	-	-	-
renogy.md	44.2	42.82	13.1	15.6	12.53	8.33
	-	-	-	-	-	-
_index.md	49.56	37.4	10.55	15.2	13.45	7.52
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
foam-dart-launcher.md	59.54	56.89	11.12	14.4	11.09	6.51
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
power-sensor.md	85.77	67.04	7.19	6	6.54	6.76
	-	-	-	-	-	-
show-secret.md	43.23	36.49	11.06	15.3	13.8	8.97
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	54.7	46.15	10.87	13.32	11.82	7.77
	🟢 +0.08	🟢 +0.05	🟢 +0.02	🟢 +0.01	🟢 +0.01	🟢 +0

View metric targets

Metric	Range	Ideal score
Flesch Reading Ease	100 (very easy read) to 0 (extremely difficult read)	60
Gunning Fog	6 (very easy read) to 17 (extremely difficult read)	8 or less
Auto. Read. Index	6 (very easy read) to 14 (extremely difficult read)	8 or less
Coleman Liau Index	6 (very easy read) to 17 (extremely difficult read)	8 or less
Dale-Chall Readability	4.9 (very easy read) to 9.9 (extremely difficult read)	6.9 or less

andf-viam

LGTM!! Just three little language tweaks, then good to go!

docs/components/power-sensor/renogy.md

docs/tutorials/projects/foam-dart-launcher.md

oliviamiller · 2023-09-18T14:29:18Z

docs/components/power-sensor/renogy.md

-| `serial_path` | string | **Required** | 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_baud_rate` | int | **Required** | The baud rate to use for serial communications. <br> Default: `9600` |
-| `modbus_id`  | int | **Required** | Controller MODBUS address. <br> Default: `1` |
+| `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` |


might also be helpful to include a line to look in /dev/serial/by-path to find the serial path? see the roboclaw motor doc for an example.

oliviamiller · 2023-09-18T14:30:44Z

docs/components/power-sensor/renogy.md

-| `serial_path` | string | **Required** | 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_baud_rate` | int | **Required** | The baud rate to use for serial communications. <br> Default: `9600` |
-| `modbus_id`  | int | **Required** | Controller MODBUS address. <br> Default: `1` |
+| `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` |


it should start with just/dev/<file> so can remove the first <file>

oliviamiller · 2023-09-18T14:34:10Z

docs/components/power-sensor/renogy.md

 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.amazon.com/Renogy-Battery-Temperature-Sensor-Controllers/dp/B07WMMJFWY) into your robot:
+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:


this is not an accurate link to the device, can you replace with this?. and replacing the link name to Renogy Charge Controller would be more accurate.

oliviamiller · 2023-09-18T14:35:45Z

docs/components/power-sensor/renogy.md

 type: "docs"
-description: "Configure a renogy model sensor."
-tags: ["sensor", "components"]
+description: "Configure a renogy model power sensor to return battery temperature."


Instead of return battery temp this now returns battery voltage and load current/power, along with other readings.

oliviamiller · 2023-09-18T14:37:07Z

docs/components/power-sensor/ina219.md

+weight: 10
+draft: false
+type: "docs"
+description: "Configure an INA219 model power sensor to return voltage and current readings."


optional but want to also include in the description that there is a power reading

oliviamiller · 2023-09-18T14:40:12Z

docs/components/power-sensor/ina219.md

+      "model": "INA219",
+      "attributes": {
+        "board": "<your-board-name>",
+        "i2c_bus": "<your-i2c-bus-name-on-board>"


looks like the template didn't get updated to the new attributes

oliviamiller · 2023-09-18T14:43:44Z

docs/components/power-sensor/ina219.md

+
+| 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. |


I think the description can be changed to number instead of name since it was changed to an integer value.

docs/components/power-sensor/ina226.md

docs/components/power-sensor/ina219.md

viambot · 2023-09-18T18:25:06Z

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/d9d5d91601a11a6e5847d83ae82cbcf65d17759c/public

viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 7, 2023

sguequierre reviewed Sep 8, 2023

View reviewed changes

docs/components/power-sensor/_index.md Outdated Show resolved Hide resolved

sguequierre reviewed Sep 8, 2023

View reviewed changes

docs/components/power-sensor/_index.md Outdated Show resolved Hide resolved

sguequierre reviewed Sep 8, 2023

View reviewed changes

docs/components/power-sensor/_index.md Outdated Show resolved Hide resolved

Add Power Sensor component

266e92f

npentrel force-pushed the DOCS-821-Add-Power-Sensor branch from 81f17a4 to 266e92f Compare September 10, 2023 17:01

skyleilani added 7 commits September 10, 2023 13:16

resolve conflicts

cedbfde

resolve conflicts

af4d204

delete repeat file

a7c5b44

fix whitespace

1c114d8

fix whitespace

0a46d6c

add trailing slash

4370a7b

delete old links

f5220cd

andf-viam reviewed Sep 11, 2023

View reviewed changes

fix whitespace, links, and wording

82d2e32

skyleilani added 6 commits September 12, 2023 09:56

Fix trailing spaces

d99479e

fix trailing spaces

b69ce0b

integrate final reviews

537ecec

fix trailing space

1bc3b7c

fix wording

3db2168

add trailing slash

4b8a840

skyleilani requested a review from andf-viam September 13, 2023 17:46

skyleilani added 4 commits September 13, 2023 16:15

fix descriptions

59f36d7

Merge branch 'main' into DOCS-821-Add-Power-Sensor

1518979

make weight uniform

ac46f45

Merge branch 'main' into DOCS-821-Add-Power-Sensor

644d179

andf-viam approved these changes Sep 13, 2023

View reviewed changes

docs/components/power-sensor/renogy.md Show resolved Hide resolved

docs/components/power-sensor/renogy.md Outdated Show resolved Hide resolved

docs/tutorials/projects/foam-dart-launcher.md Show resolved Hide resolved

address last comments

2e47217

oliviamiller reviewed Sep 18, 2023

View reviewed changes

integrate comments

d9d5d91

skyleilani merged commit 28378ae into main Sep 18, 2023
8 checks passed

skyleilani deleted the DOCS-821-Add-Power-Sensor branch September 18, 2023 20:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-821: Add Power Sensor Component #1766

DOCS-821: Add Power Sensor Component #1766

skyleilani commented Sep 7, 2023

andf-viam left a comment

viambot commented Sep 12, 2023 •

edited

Loading

andf-viam left a comment •

edited

Loading

oliviamiller Sep 18, 2023

oliviamiller Sep 18, 2023

oliviamiller Sep 18, 2023

oliviamiller Sep 18, 2023

oliviamiller Sep 18, 2023

oliviamiller Sep 18, 2023

oliviamiller Sep 18, 2023

viambot commented Sep 18, 2023

DOCS-821: Add Power Sensor Component #1766

DOCS-821: Add Power Sensor Component #1766

Conversation

skyleilani commented Sep 7, 2023

andf-viam left a comment

Choose a reason for hiding this comment

viambot commented Sep 12, 2023 • edited Loading

andf-viam left a comment • edited Loading

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

oliviamiller Sep 18, 2023

Choose a reason for hiding this comment

viambot commented Sep 18, 2023

viambot commented Sep 12, 2023 •

edited

Loading

andf-viam left a comment •

edited

Loading