Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2019 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package com.android.systemui.util.sensors; |
| 18 | |
Dave Mankoff | d94c969 | 2019-10-18 12:38:21 -0400 | [diff] [blame^] | 19 | import android.content.res.Resources; |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 20 | import android.hardware.Sensor; |
| 21 | import android.hardware.SensorEvent; |
| 22 | import android.hardware.SensorEventListener; |
| 23 | import android.hardware.SensorManager; |
| 24 | import android.os.Handler; |
| 25 | import android.util.Log; |
| 26 | |
Dave Mankoff | bf52f4b | 2019-09-20 14:34:28 -0400 | [diff] [blame] | 27 | import com.android.internal.annotations.VisibleForTesting; |
Dave Mankoff | d94c969 | 2019-10-18 12:38:21 -0400 | [diff] [blame^] | 28 | import com.android.systemui.DependencyProvider; |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 29 | import com.android.systemui.R; |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 30 | |
| 31 | import java.util.ArrayList; |
| 32 | import java.util.List; |
| 33 | import java.util.Locale; |
| 34 | import java.util.function.Consumer; |
| 35 | |
| 36 | import javax.inject.Inject; |
| 37 | |
| 38 | /** |
| 39 | * Simple wrapper around SensorManager customized for the Proximity sensor. |
| 40 | */ |
Dave Mankoff | bc3091c | 2019-09-18 11:44:29 -0400 | [diff] [blame] | 41 | public class ProximitySensor { |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 42 | private static final String TAG = "ProxSensor"; |
| 43 | private static final boolean DEBUG = false; |
| 44 | |
| 45 | private final Sensor mSensor; |
| 46 | private final AsyncSensorManager mSensorManager; |
| 47 | private final boolean mUsingBrightnessSensor; |
| 48 | private final float mMaxRange; |
| 49 | private List<ProximitySensorListener> mListeners = new ArrayList<>(); |
| 50 | private String mTag = null; |
Dave Mankoff | bf52f4b | 2019-09-20 14:34:28 -0400 | [diff] [blame] | 51 | @VisibleForTesting ProximityEvent mLastEvent; |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 52 | private int mSensorDelay = SensorManager.SENSOR_DELAY_NORMAL; |
| 53 | private boolean mPaused; |
| 54 | private boolean mRegistered; |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 55 | |
| 56 | private SensorEventListener mSensorEventListener = new SensorEventListener() { |
| 57 | @Override |
| 58 | public synchronized void onSensorChanged(SensorEvent event) { |
| 59 | onSensorEvent(event); |
| 60 | } |
| 61 | |
| 62 | @Override |
| 63 | public void onAccuracyChanged(Sensor sensor, int accuracy) { |
| 64 | } |
| 65 | }; |
| 66 | |
| 67 | @Inject |
Dave Mankoff | d94c969 | 2019-10-18 12:38:21 -0400 | [diff] [blame^] | 68 | public ProximitySensor(@DependencyProvider.MainResources Resources resources, |
| 69 | AsyncSensorManager sensorManager) { |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 70 | mSensorManager = sensorManager; |
Dave Mankoff | d94c969 | 2019-10-18 12:38:21 -0400 | [diff] [blame^] | 71 | Sensor sensor = findBrightnessSensor(resources); |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 72 | |
| 73 | if (sensor == null) { |
| 74 | mUsingBrightnessSensor = false; |
| 75 | sensor = sensorManager.getDefaultSensor(Sensor.TYPE_PROXIMITY); |
| 76 | } else { |
| 77 | mUsingBrightnessSensor = true; |
| 78 | } |
| 79 | mSensor = sensor; |
| 80 | if (mSensor != null) { |
| 81 | mMaxRange = mSensor.getMaximumRange(); |
| 82 | } else { |
| 83 | mMaxRange = 0; |
| 84 | } |
| 85 | } |
| 86 | |
| 87 | public void setTag(String tag) { |
| 88 | mTag = tag; |
| 89 | } |
| 90 | |
| 91 | public void setSensorDelay(int sensorDelay) { |
| 92 | mSensorDelay = sensorDelay; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Unregister with the {@link SensorManager} without unsetting listeners on this object. |
| 97 | */ |
| 98 | public void pause() { |
| 99 | mPaused = true; |
| 100 | unregisterInternal(); |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Register with the {@link SensorManager}. No-op if no listeners are registered on this object. |
| 105 | */ |
| 106 | public void resume() { |
| 107 | mPaused = false; |
| 108 | registerInternal(); |
| 109 | } |
| 110 | |
Dave Mankoff | d94c969 | 2019-10-18 12:38:21 -0400 | [diff] [blame^] | 111 | private Sensor findBrightnessSensor(Resources resources) { |
| 112 | String sensorType = resources.getString(R.string.doze_brightness_sensor_type); |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 113 | List<Sensor> sensorList = mSensorManager.getSensorList(Sensor.TYPE_ALL); |
| 114 | Sensor sensor = null; |
| 115 | for (Sensor s : sensorList) { |
| 116 | if (sensorType.equals(s.getStringType())) { |
| 117 | sensor = s; |
| 118 | break; |
| 119 | } |
| 120 | } |
| 121 | |
| 122 | return sensor; |
| 123 | } |
| 124 | |
| 125 | /** |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 126 | * Returns true if we are registered with the SensorManager. |
| 127 | */ |
| 128 | public boolean isRegistered() { |
| 129 | return mRegistered; |
| 130 | } |
| 131 | |
| 132 | /** |
| 133 | * Returns {@code false} if a Proximity sensor is not available. |
| 134 | */ |
| 135 | public boolean getSensorAvailable() { |
| 136 | return mSensor != null; |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Add a listener. |
| 141 | * |
| 142 | * Registers itself with the {@link SensorManager} if this is the first listener |
| 143 | * added. If a cool down is currently running, the sensor will be registered when it is over. |
| 144 | */ |
| 145 | public boolean register(ProximitySensorListener listener) { |
| 146 | if (!getSensorAvailable()) { |
| 147 | return false; |
| 148 | } |
| 149 | |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 150 | mListeners.add(listener); |
| 151 | registerInternal(); |
| 152 | |
| 153 | return true; |
| 154 | } |
| 155 | |
Dave Mankoff | bf52f4b | 2019-09-20 14:34:28 -0400 | [diff] [blame] | 156 | protected void registerInternal() { |
Dave Mankoff | bc3091c | 2019-09-18 11:44:29 -0400 | [diff] [blame] | 157 | if (mRegistered || mPaused || mListeners.isEmpty()) { |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 158 | return; |
| 159 | } |
Dave Mankoff | bf52f4b | 2019-09-20 14:34:28 -0400 | [diff] [blame] | 160 | logDebug("Using brightness sensor? " + mUsingBrightnessSensor); |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 161 | logDebug("Registering sensor listener"); |
| 162 | mRegistered = true; |
| 163 | mSensorManager.registerListener(mSensorEventListener, mSensor, mSensorDelay); |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Remove a listener. |
| 168 | * |
| 169 | * If all listeners are removed from an instance of this class, |
| 170 | * it will unregister itself with the SensorManager. |
| 171 | */ |
| 172 | public void unregister(ProximitySensorListener listener) { |
| 173 | mListeners.remove(listener); |
| 174 | if (mListeners.size() == 0) { |
| 175 | unregisterInternal(); |
| 176 | } |
| 177 | } |
| 178 | |
Dave Mankoff | bf52f4b | 2019-09-20 14:34:28 -0400 | [diff] [blame] | 179 | protected void unregisterInternal() { |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 180 | if (!mRegistered) { |
| 181 | return; |
| 182 | } |
| 183 | logDebug("unregistering sensor listener"); |
| 184 | mSensorManager.unregisterListener(mSensorEventListener); |
| 185 | mRegistered = false; |
| 186 | } |
| 187 | |
| 188 | public Boolean isNear() { |
| 189 | return getSensorAvailable() && mLastEvent != null ? mLastEvent.getNear() : null; |
| 190 | } |
| 191 | |
| 192 | /** Update all listeners with the last value this class received from the sensor. */ |
| 193 | public void alertListeners() { |
| 194 | mListeners.forEach(proximitySensorListener -> |
| 195 | proximitySensorListener.onSensorEvent(mLastEvent)); |
| 196 | } |
| 197 | |
| 198 | private void onSensorEvent(SensorEvent event) { |
| 199 | boolean near = event.values[0] < mMaxRange; |
| 200 | if (mUsingBrightnessSensor) { |
| 201 | near = event.values[0] == 0; |
| 202 | } |
| 203 | mLastEvent = new ProximityEvent(near, event.timestamp); |
| 204 | alertListeners(); |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 205 | } |
| 206 | |
| 207 | @Override |
| 208 | public String toString() { |
Dave Mankoff | bc3091c | 2019-09-18 11:44:29 -0400 | [diff] [blame] | 209 | return String.format("{registered=%s, paused=%s, near=%s, sensor=%s}", |
| 210 | isRegistered(), mPaused, isNear(), mSensor); |
Dave Mankoff | 63a1282 | 2019-09-16 14:38:06 -0400 | [diff] [blame] | 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Convenience class allowing for briefly checking the proximity sensor. |
| 215 | */ |
| 216 | public static class ProximityCheck implements Runnable { |
| 217 | |
| 218 | private final ProximitySensor mSensor; |
| 219 | private final Handler mHandler; |
| 220 | private List<Consumer<Boolean>> mCallbacks = new ArrayList<>(); |
| 221 | |
| 222 | @Inject |
| 223 | public ProximityCheck(ProximitySensor sensor, Handler handler) { |
| 224 | mSensor = sensor; |
| 225 | mSensor.setTag("prox_check"); |
| 226 | mHandler = handler; |
| 227 | mSensor.pause(); |
| 228 | ProximitySensorListener listener = proximityEvent -> { |
| 229 | mCallbacks.forEach( |
| 230 | booleanConsumer -> |
| 231 | booleanConsumer.accept( |
| 232 | proximityEvent == null ? null : proximityEvent.getNear())); |
| 233 | mCallbacks.clear(); |
| 234 | mSensor.pause(); |
| 235 | }; |
| 236 | mSensor.register(listener); |
| 237 | } |
| 238 | |
| 239 | /** Set a descriptive tag for the sensors registration. */ |
| 240 | public void setTag(String tag) { |
| 241 | mSensor.setTag(tag); |
| 242 | } |
| 243 | |
| 244 | @Override |
| 245 | public void run() { |
| 246 | mSensor.pause(); |
| 247 | mSensor.alertListeners(); |
| 248 | } |
| 249 | |
| 250 | /** |
| 251 | * Query the proximity sensor, timing out if no result. |
| 252 | */ |
| 253 | public void check(long timeoutMs, Consumer<Boolean> callback) { |
| 254 | if (!mSensor.getSensorAvailable()) { |
| 255 | callback.accept(null); |
| 256 | } |
| 257 | mCallbacks.add(callback); |
| 258 | if (!mSensor.isRegistered()) { |
| 259 | mSensor.resume(); |
| 260 | mHandler.postDelayed(this, timeoutMs); |
| 261 | } |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | /** Implement to be notified of ProximityEvents. */ |
| 266 | public interface ProximitySensorListener { |
| 267 | /** Called when the ProximitySensor changes. */ |
| 268 | void onSensorEvent(ProximityEvent proximityEvent); |
| 269 | } |
| 270 | |
| 271 | /** |
| 272 | * Returned when the near/far state of a {@link ProximitySensor} changes. |
| 273 | */ |
| 274 | public static class ProximityEvent { |
| 275 | private final boolean mNear; |
| 276 | private final long mTimestampNs; |
| 277 | |
| 278 | public ProximityEvent(boolean near, long timestampNs) { |
| 279 | mNear = near; |
| 280 | mTimestampNs = timestampNs; |
| 281 | } |
| 282 | |
| 283 | public boolean getNear() { |
| 284 | return mNear; |
| 285 | } |
| 286 | |
| 287 | public long getTimestampNs() { |
| 288 | return mTimestampNs; |
| 289 | } |
| 290 | |
| 291 | public long getTimestampMs() { |
| 292 | return mTimestampNs / 1000000; |
| 293 | } |
| 294 | |
| 295 | @Override |
| 296 | public String toString() { |
| 297 | return String.format((Locale) null, "{near=%s, timestamp_ns=%d}", mNear, mTimestampNs); |
| 298 | } |
| 299 | |
| 300 | } |
| 301 | |
| 302 | private void logDebug(String msg) { |
| 303 | if (DEBUG) { |
| 304 | Log.d(TAG, (mTag != null ? "[" + mTag + "] " : "") + msg); |
| 305 | } |
| 306 | } |
| 307 | } |