Skip to contentSkip to conversation

iio: distance: srf08: add driver ABI documentation

PATCH Applied Andreas Klinger 2 participants 2 messages Jan 25, 2017 – Jan 28, 2017

Subsystems (3)
IIO I2C subsystem host drivers Devantech srf ultrasonic ranger IIO driver
lore
Share & tools
lore

Andreas Klinger

author maintainer
#0 lore raw

PATCH v4 3/3 iio: distance: srf08: add driver ABI documentation

Add sysfs-bus-iio-distance-srf08 for individual attributes of the driver, especially:
- sensitivity which the device documentation calls gain for amplifying the signal
- max_range for limiting the maximum distance for expected echos and therefore limiting the time waiting for telegrams

Signed-off-by Andreas Klinger <ak-n176/[email protected]>
---
 .../ABI/testing/sysfs-bus-iio-distance-srf08       | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
Documentation/ABI/testing/sysfs-bus-iio-distance-srf08 new file +22 -0
new file mode 100644
index 000000000000..0a1ca1487fa9
@@ -0,0 +1,22 @@
+What		/sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
+Date:		January 2017
+KernelVersion:	4.11
+Contact:	[email protected]
+Description:
+		Show or set the gain boost of the amp, from 0-31 range.
+		default 31
+
+What		/sys/bus/iio/devices/iio:deviceX/sensor_max_range
+Date:		January 2017
+KernelVersion:	4.11
+Contact:	[email protected]
+Description:
+                Show or set the maximum range between the sensor and the
+		first object echoed in meters. Default value is 6.020.
+		This setting limits the time the driver is waiting for a
+		echo.
+		Showing the range of available values is represented as the
+		minimum value, the step and the maximum value, all enclosed
+		in square brackets.
+		Example:
+		[0.043 0.043 11.008]
Signature · 1 line
2.1.4
maintainer Applied
#1 lore raw
Quoted 8 lines · Andreas Klinger

Add sysfs-bus-iio-distance-srf08 for individual attributes of the driver, especially:
- sensitivity which the device documentation calls gain for amplifying the signal
- max_range for limiting the maximum distance for expected echos and therefore limiting the time waiting for telegrams

Signed-off-by Andreas Klinger <[email protected]>

Nice clear docs. Thanks,

Applied.

Quoted 34 lines
---
 .../ABI/testing/sysfs-bus-iio-distance-srf08       | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
Documentation/ABI/testing/sysfs-bus-iio-distance-srf08 new file +22 -0
new file mode 100644
index 000000000000..0a1ca1487fa9
@@ -0,0 +1,22 @@
+What		/sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
+Date:		January 2017
+KernelVersion:	4.11
+Contact:	[email protected]
+Description:
+		Show or set the gain boost of the amp, from 0-31 range.
+		default 31
+
+What		/sys/bus/iio/devices/iio:deviceX/sensor_max_range
+Date:		January 2017
+KernelVersion:	4.11
+Contact:	[email protected]
+Description:
+                Show or set the maximum range between the sensor and the
+		first object echoed in meters. Default value is 6.020.
+		This setting limits the time the driver is waiting for a
+		echo.
+		Showing the range of available values is represented as the
+		minimum value, the step and the maximum value, all enclosed
+		in square brackets.
+		Example:
+		[0.043 0.043 11.008]