conf change: sensors: read and write path rename
Rename the readpath and writepath for camelcase styling to make all
configuration variables consistent.
Change-Id: I33f475075c8f40cd2029a5c0bfda950846cd5d44
Signed-off-by: Patrick Venture <venture@google.com>
diff --git a/scripts/README b/scripts/README
index f884fc6..8695774 100644
--- a/scripts/README
+++ b/scripts/README
@@ -5,7 +5,7 @@
accessor. This provides read-only access to information. The goal of the
configuration is to specify how it can be read and if it's a fan, how the PID
output can be written. Initially there'll only be sysfs and passive dbus
-access. If a writepath for a sensor is a dbus path, then the system will need
+access. If a writePath for a sensor is a dbus path, then the system will need
to verify which Control.Fan* interfaces is registered and send values to the
Target property of that interface.
@@ -14,7 +14,7 @@
fan PID control objects may not, and they can leave the fields as 0 & 0.
The only requirement for a sensor is that it isn't writeonly. Only fans are
-expected to have a writepath set, and in this current version non-fan sensors
+expected to have a writePath set, and in this current version non-fan sensors
are assumed readonly.
The sensor names are unique across all zones.
diff --git a/scripts/sensor-example.txt b/scripts/sensor-example.txt
index 0915163..b1318b8 100644
--- a/scripts/sensor-example.txt
+++ b/scripts/sensor-example.txt
@@ -1,9 +1,9 @@
fan2: /* Name of the sensor. */
type: fan /* Type of sensor, fan, temp, margin */
/* How the sensor can be read[1] */
- readpath: /xyz/openbmc_project/sensors/fan_tach/fan2
+ readPath: /xyz/openbmc_project/sensors/fan_tach/fan2
/* How the sensor can be set[2] */
- writepath: /sys/class/hwmon/hwmon0/pwm1
+ writePath: /sys/class/hwmon/hwmon0/pwm1
/* The minimum value used for scaling writes (int64) */
min: 0
/* The maximum value used for scaling writes (int64) */
@@ -13,7 +13,7 @@
*/
timeout: 0
-[1] readpath has multiple options:
+[1] readPath has multiple options:
* If it has "/xyz/openbmc_project/extsensors/" in it, it's an EXTERNAL or
host-provided sensor.
* If it has "/xyz/openbmc_project/" in it, it's a sensor whose value is
diff --git a/scripts/sensor-example.yaml b/scripts/sensor-example.yaml
index 7378bff..1debe3e 100644
--- a/scripts/sensor-example.yaml
+++ b/scripts/sensor-example.yaml
@@ -1,31 +1,31 @@
fan2:
type: fan
- readpath: /xyz/openbmc_project/sensors/fan_tach/fan2
- writepath: /sys/class/hwmon/hwmon0/pwm1
+ readPath: /xyz/openbmc_project/sensors/fan_tach/fan2
+ writePath: /sys/class/hwmon/hwmon0/pwm1
min: 0
max: 255
timeout: 0
fan6:
type: fan
- readpath: /xyz/openbmc_project/sensors/fan_tach/fan6
- writepath:
+ readPath: /xyz/openbmc_project/sensors/fan_tach/fan6
+ writePath:
min: 0
max: 0
timeout: 0
temp1:
type: temp
- readpath: /xyz/openbmc_project/sensors/temperature/temp1
- writepath:
+ readPath: /xyz/openbmc_project/sensors/temperature/temp1
+ writePath:
min: 0
max: 0
timeout: 0
sluggish0:
type: margin
- readpath: /xyz/openbmc_project/extsensors/margin/sluggish0
- writepath:
+ readPath: /xyz/openbmc_project/extsensors/margin/sluggish0
+ writePath:
min: 0
max: 0
timeout: 0
diff --git a/scripts/writesensor.mako.cpp b/scripts/writesensor.mako.cpp
index 70cd019..56e7965 100644
--- a/scripts/writesensor.mako.cpp
+++ b/scripts/writesensor.mako.cpp
@@ -12,8 +12,8 @@
<%
sensor = sensorDict[key]
type = sensor["type"]
- readpath = sensor["readpath"]
- writepath = sensor.get("writepath", "")
+ readPath = sensor["readPath"]
+ writePath = sensor.get("writePath", "")
min = sensor.get("min", 0)
max = sensor.get("max", 0)
# Presently only thermal inputs have their timeout
@@ -27,7 +27,7 @@
timeout = sensor.get("timeout", 2)
%>
{"${key}",
- {"${type}","${readpath}","${writepath}", ${min}, ${max}, ${timeout}},
+ {"${type}","${readPath}","${writePath}", ${min}, ${max}, ${timeout}},
},
% endif
% endfor