summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2023-08-11 12:44:50 +0200
committerLoic Guegan <manzerbredes@mailbox.org>2023-08-11 12:44:50 +0200
commit63656e1bd899ac1f5705d041349e8e459ee645a7 (patch)
tree8bdd5a40e4fb7f2b1e7e06ff2092a700014a117e /README.md
parentd43c92e2a1abc64e86c59529ec02d3eb394ccf4d (diff)
Change permissions and update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 67d37e6..055c7e1 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,23 @@
# INA260-sysfs-driver
+Link to the [ina260 datasheet](https://www.ti.com/lit/gpn/INA260).
+
## Installation
$ make
$ sudo insmod ina260.ko
-## Usage
+## Managing INA260 devices
+- Add device: `echo ina260 [devaddr] > /sys/bus/i2c/devices/<bus>/new_device`
+- Delete device: `echo [devaddr] > /sys/bus/i2c/devices/<bus>/delete_device`
+
+## Sysfs structure
+- Overview: `tree /sys/kernel/ina260`
+- You can access to each device registers in `/sys/kernel/ina260/<device>/registers/`
+- You can access to each device register fields in `/sys/kernel/ina260/<device>/fields/`
+- You can access to the currently measured current, voltage and power via `/sys/kernel/ina260/<device>/<power|current|voltage>` (units are watts, amperes and volts respectively)
-- Add device: `echo ina260 <devaddr> > /sys/bus/i2c/devices/<busid>/new_device`
+For more informations on the registers/fields, please refer to the [ina260 datasheet](https://www.ti.com/lit/gpn/INA260).
-- Next, run: `tree /sys/kernel/ina260` \ No newline at end of file
+## Notes
+- Tested so far on a [Beaglebone Black](https://www.beagleboard.org/boards/beaglebone-black) with a [Mikrobus Cape](https://www.mikroe.com/beaglebone-mikrobus-cape) with up to four ina260 devices attached. \ No newline at end of file