Touch FW test: Change "Sample" rate to "Report"
No functional changes here, just that the rate at which the events are
reported back to the kernel by the touchpad FW was referred to as the
"sample" rate, which is a bit of a misnomer since in other places the
"sample" rate is defined as the rate at which the fw scans the finger
locations and how often it reports back to the kernel is called the
"report" rate. This is fine for people who are aware of the difference,
but it seems like it would be less prone to confusion if it was just
changed to match.
BUG=chromium-os:37494
TEST=manually ran the test suite and made sure everything still ran and
I hadn't missed any of the "sample" rates when changing them over.
Change-Id: I0bc0717e346334d31d20f37b79981333188a7c87
Signed-off-by: Charlie Mooney <charliemooney@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/41764
Reviewed-by: Joseph Shyh-In Hwang <josephsih@chromium.org>
diff --git a/client/site_tests/firmware_TouchpadMTB/firmware_summary.py b/client/site_tests/firmware_TouchpadMTB/firmware_summary.py
index 0587bd8..daa949d 100644
--- a/client/site_tests/firmware_TouchpadMTB/firmware_summary.py
+++ b/client/site_tests/firmware_TouchpadMTB/firmware_summary.py
@@ -25,7 +25,7 @@
NoGapValidator : 0.74 0.24 12
NoReversedMotionBothEndsValidator : 0.68 0.34 12
NoReversedMotionMiddleValidator : 1.00 1.00 12
- SampleRateValidator : 1.00 1.00 12
+ ReportRateValidator : 1.00 1.00 12
one_finger_to_edge
CountTrackingIDValidator : 1.00 1.00 4
LinearityBothEndsValidator : 0.88 0.89 4
diff --git a/client/site_tests/firmware_TouchpadMTB/mtb.py b/client/site_tests/firmware_TouchpadMTB/mtb.py
index daec9c1..a9c78be 100644
--- a/client/site_tests/firmware_TouchpadMTB/mtb.py
+++ b/client/site_tests/firmware_TouchpadMTB/mtb.py
@@ -751,16 +751,16 @@
list_x, list_y = self.get_x_y(target_slot)
return len(list_x)
- def get_sample_rate(self):
- """Get the sample rate of the packets in Hz."""
+ def get_report_rate(self):
+ """Get the report rate of the packets in Hz."""
first_sync_event = self.packets[0][-1]
first_sync_time = first_sync_event.get(MTB.EV_TIME)
last_sync_event = self.packets[-1][-1]
last_sync_time = last_sync_event.get(MTB.EV_TIME)
duration = last_sync_time - first_sync_time
num_packets = len(self.packets) - 1
- sample_rate = float(num_packets) / duration
- return sample_rate
+ report_rate = float(num_packets) / duration
+ return report_rate
def _call_check_event_func(self, event, expected_value, check_event_result,
check_event_func):
diff --git a/client/site_tests/firmware_TouchpadMTB/test_conf.py b/client/site_tests/firmware_TouchpadMTB/test_conf.py
index 3296e6f..5d81008 100644
--- a/client/site_tests/firmware_TouchpadMTB/test_conf.py
+++ b/client/site_tests/firmware_TouchpadMTB/test_conf.py
@@ -17,7 +17,7 @@
PhysicalClickValidator,
PinchValidator,
RangeValidator,
- SampleRateValidator,
+ ReportRateValidator,
StationaryFingerValidator,
)
@@ -41,7 +41,7 @@
no_reversed_motion_criteria = '<= 5, ~ +30'
pinch_criteria = '>= 200, ~ -100'
range_criteria = '<= 0.05, ~ +0.05'
-sample_rate_criteria = '>= 60'
+report_rate_criteria = '>= 60'
stationary_finger_criteria = '<= 20, ~ +20'
relaxed_stationary_finger_criteria = '<= 100, ~ +100'
@@ -224,7 +224,7 @@
segments=VAL.MIDDLE),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0,
segments=VAL.BOTH_ENDS),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -251,7 +251,7 @@
NoGapValidator(no_gap_criteria, slot=0),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
RangeValidator(range_criteria),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -287,7 +287,7 @@
NoGapValidator(no_gap_criteria, slot=1),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -316,7 +316,7 @@
CountTrackingIDValidator('== 2'),
NoGapValidator(no_gap_criteria, slot=1),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
),
),
@@ -334,7 +334,7 @@
CountPacketsValidator(count_packets_criteria, slot=0),
CountTrackingIDValidator('== 1'),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -353,7 +353,7 @@
CountTrackingIDValidator('== 2'),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -369,7 +369,7 @@
validators=(
CountTrackingIDValidator('== 2'),
PinchValidator(pinch_criteria),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -394,7 +394,7 @@
CountTrackingIDValidator('== 1'),
PhysicalClickValidator('== 0', fingers=1),
PhysicalClickValidator('== 0', fingers=2),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
),
),
@@ -413,7 +413,7 @@
CountTrackingIDValidator('== 2'),
PhysicalClickValidator('== 0', fingers=1),
PhysicalClickValidator('== 0', fingers=2),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
StationaryFingerValidator(stationary_finger_criteria, slot=1),
),
@@ -433,7 +433,7 @@
validators=(
CountTrackingIDValidator('== 1'),
PhysicalClickValidator('== 1', fingers=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
),
),
@@ -447,7 +447,7 @@
validators=(
CountTrackingIDValidator('== 2'),
PhysicalClickValidator('== 1', fingers=2),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(relaxed_stationary_finger_criteria,
slot=0),
StationaryFingerValidator(relaxed_stationary_finger_criteria,
@@ -464,7 +464,7 @@
validators=(
CountTrackingIDValidator('== 3'),
PhysicalClickValidator('== 1', fingers=3),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -477,7 +477,7 @@
validators=(
CountTrackingIDValidator('== 4'),
PhysicalClickValidator('== 1', fingers=4),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -490,7 +490,7 @@
validators=(
CountTrackingIDValidator('== 5'),
PhysicalClickValidator('== 1', fingers=5),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -503,7 +503,7 @@
subprompt=None,
validators=(
CountTrackingIDValidator('>= 2'),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
),
),
@@ -529,7 +529,7 @@
NoGapValidator(no_gap_criteria, slot=1),
NoLevelJumpValidator(no_level_jump_criteria, slots=[1,]),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
),
),
@@ -554,7 +554,7 @@
NoGapValidator(no_gap_criteria, slot=0),
NoLevelJumpValidator(no_level_jump_criteria, slots=[0,]),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -586,7 +586,7 @@
NoLevelJumpValidator(no_level_jump_criteria, slots=[0,]),
NoGapValidator(no_gap_criteria, slot=0),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -611,7 +611,7 @@
segments=VAL.BOTH_ENDS),
NoGapValidator(no_gap_criteria, slot=1),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
StationaryFingerValidator(stationary_finger_criteria, slot=0),
),
),
@@ -641,7 +641,7 @@
NoLevelJumpValidator(no_level_jump_criteria, slots=[0,]),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=1),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
@@ -664,7 +664,7 @@
segments=VAL.BOTH_ENDS),
NoGapValidator(no_gap_criteria, slot=0),
NoReversedMotionValidator(no_reversed_motion_criteria, slots=0),
- SampleRateValidator(sample_rate_criteria),
+ ReportRateValidator(report_rate_criteria),
),
),
diff --git a/client/site_tests/firmware_TouchpadMTB/tests/mtb_unittest.py b/client/site_tests/firmware_TouchpadMTB/tests/mtb_unittest.py
index 8769a49..7a1f3e1 100755
--- a/client/site_tests/firmware_TouchpadMTB/tests/mtb_unittest.py
+++ b/client/site_tests/firmware_TouchpadMTB/tests/mtb_unittest.py
@@ -340,23 +340,23 @@
else largest_level_jumps[filename][axis])
self.assertTrue(jump == expected_jump)
- def _test_get_sample_rate(self, filename, value):
- """Test get_sample_rate."""
+ def _test_get_report_rate(self, filename, value):
+ """Test get_report_rate."""
gesture_filename = self._get_filepath(filename)
mtb_packets = get_mtb_packets(gesture_filename)
- sample_rate = round(mtb_packets.get_sample_rate(), 2)
- self.assertAlmostEqual(sample_rate, value)
+ report_rate = round(mtb_packets.get_report_rate(), 2)
+ self.assertAlmostEqual(report_rate, value)
- def test_get_sample_rate(self):
- """Test get_sample_rate."""
+ def test_get_report_rate(self):
+ """Test get_report_rate."""
filename = '2f_scroll_diagonal.dat'
- self._test_get_sample_rate('2f_scroll_diagonal.dat', 40.31)
+ self._test_get_report_rate('2f_scroll_diagonal.dat', 40.31)
filename = 'one_finger_with_slot_0.dat'
- self._test_get_sample_rate(filename, 148.65)
+ self._test_get_report_rate(filename, 148.65)
filename = 'two_close_fingers_merging_changed_ids_gaps.dat'
- self._test_get_sample_rate(filename, 53.12)
+ self._test_get_report_rate(filename, 53.12)
if __name__ == '__main__':
diff --git a/client/site_tests/firmware_TouchpadMTB/tests/validators_unittest.py b/client/site_tests/firmware_TouchpadMTB/tests/validators_unittest.py
index 619575c..ab893e9 100755
--- a/client/site_tests/firmware_TouchpadMTB/tests/validators_unittest.py
+++ b/client/site_tests/firmware_TouchpadMTB/tests/validators_unittest.py
@@ -24,7 +24,7 @@
PhysicalClickValidator,
PinchValidator,
RangeValidator,
- SampleRateValidator,
+ ReportRateValidator,
StationaryFingerValidator,
)
@@ -438,14 +438,14 @@
self.assertTrue(self._get_score(filename, device) == 1.0)
-class SampleRateValidatorTest(BaseValidatorTest):
- """Unit tests for SampleRateValidator class."""
+class ReportRateValidatorTest(BaseValidatorTest):
+ """Unit tests for ReportRateValidator class."""
def setUp(self):
- super(SampleRateValidatorTest, self).setUp()
- self.criteria = conf.sample_rate_criteria
+ super(ReportRateValidatorTest, self).setUp()
+ self.criteria = conf.report_rate_criteria
def _get_score(self, filename, device):
- validator = SampleRateValidator(self.criteria, device=device)
+ validator = ReportRateValidator(self.criteria, device=device)
packets = parse_tests_data(filename)
vlog = validator.check(packets)
score = vlog.get_score()
diff --git a/client/site_tests/firmware_TouchpadMTB/validators.py b/client/site_tests/firmware_TouchpadMTB/validators.py
index d459a05..fa6cc0e 100644
--- a/client/site_tests/firmware_TouchpadMTB/validators.py
+++ b/client/site_tests/firmware_TouchpadMTB/validators.py
@@ -645,26 +645,26 @@
return self.log
-class SampleRateValidator(BaseValidator):
- """Validator to check the sample rate.
+class ReportRateValidator(BaseValidator):
+ """Validator to check the report rate.
Example:
- To verify that the sample rate is around 80 Hz. It gets 0 points
- if the sample rate drops below 60 Hz.
- SampleRateValidator('== 80 ~ -20')
+ To verify that the report rate is around 80 Hz. It gets 0 points
+ if the report rate drops below 60 Hz.
+ ReportRateValidator('== 80 ~ -20')
"""
def __init__(self, criteria_str, mf=None, device=None):
name = self.__class__.__name__
- super(SampleRateValidator, self).__init__(criteria_str, mf, device,
+ super(ReportRateValidator, self).__init__(criteria_str, mf, device,
name)
def check(self, packets, variation=None):
- """The Sample rate should be within the specified range."""
+ """The Report rate should be within the specified range."""
self.init_check(packets)
- # Get the sample rate
- sample_rate = self.packets.get_sample_rate()
- msg = 'Sample rate: %.2f Hz'
- self.log_details(msg % sample_rate)
- self.log_score(self.fc.mf.grade(sample_rate))
+ # Get the report rate
+ report_rate = self.packets.get_report_rate()
+ msg = 'Report rate: %.2f Hz'
+ self.log_details(msg % report_rate)
+ self.log_score(self.fc.mf.grade(report_rate))
return self.log