2 * Copyright (C) 2012 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef ANDROID_SENSORS_INTERFACE_H
18 #define ANDROID_SENSORS_INTERFACE_H
21 #include <sys/cdefs.h>
22 #include <sys/types.h>
24 #include <hardware/hardware.h>
25 #include <cutils/native_handle.h>
29 /*****************************************************************************/
31 #define SENSORS_HEADER_VERSION 1
32 #define SENSORS_MODULE_API_VERSION_0_1 HARDWARE_MODULE_API_VERSION(0, 1)
33 #define SENSORS_DEVICE_API_VERSION_0_1 HARDWARE_DEVICE_API_VERSION_2(0, 1, SENSORS_HEADER_VERSION)
34 #define SENSORS_DEVICE_API_VERSION_1_0 HARDWARE_DEVICE_API_VERSION_2(1, 0, SENSORS_HEADER_VERSION)
35 #define SENSORS_DEVICE_API_VERSION_1_1 HARDWARE_DEVICE_API_VERSION_2(1, 1, SENSORS_HEADER_VERSION)
36 #define SENSORS_DEVICE_API_VERSION_1_2 HARDWARE_DEVICE_API_VERSION_2(1, 2, SENSORS_HEADER_VERSION)
37 #define SENSORS_DEVICE_API_VERSION_1_3 HARDWARE_DEVICE_API_VERSION_2(1, 3, SENSORS_HEADER_VERSION)
38 #define SENSORS_DEVICE_API_VERSION_1_4 HARDWARE_DEVICE_API_VERSION_2(1, 4, SENSORS_HEADER_VERSION)
41 * Please see the Sensors section of source.android.com for an
42 * introduction to and detailed descriptions of Android sensor types:
43 * http://source.android.com/devices/sensors/index.html
47 * The id of this module
49 #define SENSORS_HARDWARE_MODULE_ID "sensors"
52 * Name of the sensors device to open
54 #define SENSORS_HARDWARE_POLL "poll"
57 * Handles must be higher than SENSORS_HANDLE_BASE and must be unique.
58 * A Handle identifies a given sensors. The handle is used to activate
59 * and/or deactivate sensors.
60 * In this version of the API there can only be 256 handles.
62 #define SENSORS_HANDLE_BASE 0
63 #define SENSORS_HANDLE_BITS 8
64 #define SENSORS_HANDLE_COUNT (1<<SENSORS_HANDLE_BITS)
68 * **** Deprecated *****
69 * flags for (*batch)()
70 * Availability: SENSORS_DEVICE_API_VERSION_1_0
71 * see (*batch)() documentation for details.
72 * Deprecated as of SENSORS_DEVICE_API_VERSION_1_3.
73 * WAKE_UP_* sensors replace WAKE_UPON_FIFO_FULL concept.
76 SENSORS_BATCH_DRY_RUN = 0x00000001,
77 SENSORS_BATCH_WAKE_UPON_FIFO_FULL = 0x00000002
81 * what field for meta_data_event_t
84 /* a previous flush operation has completed */
85 META_DATA_FLUSH_COMPLETE = 1,
86 META_DATA_VERSION /* always last, leave auto-assigned */
90 * The permission to use for body sensors (like heart rate monitors).
91 * See sensor types for more details on what sensors should require this
94 #define SENSOR_PERMISSION_BODY_SENSORS "android.permission.BODY_SENSORS"
97 * Availability: SENSORS_DEVICE_API_VERSION_1_4
98 * Sensor HAL modes uses in set_operation_mode method
102 * Operating modes for the HAL.
106 * Normal mode operation. This is the default state of operation.
107 * The HAL shall initialize into this mode on device startup.
109 SENSOR_HAL_NORMAL_MODE = 0,
111 /* Loopback mode. In this mode, the device shall not source data from the
112 * physical sensors as it would in normal mode. Instead sensor data is
113 * injected by the sensor service.
115 SENSOR_HAL_LOOPBACK_MODE = 0x1
119 * Availability: SENSORS_DEVICE_API_VERSION_1_3
120 * Sensor flags used in sensor_t.flags.
124 * Whether this sensor wakes up the AP from suspend mode when data is available. Whenever
125 * sensor events are delivered from a wake_up sensor, the driver needs to hold a wake_lock till
126 * the events are read by the SensorService i.e till sensors_poll_device_t.poll() is called the
127 * next time. Once poll is called again it means events have been read by the SensorService, the
128 * driver can safely release the wake_lock. SensorService will continue to hold a wake_lock till
129 * the app actually reads the events.
131 SENSOR_FLAG_WAKE_UP = 1U << 0,
133 * Reporting modes for various sensors. Each sensor will have exactly one of these modes set.
134 * The least significant 2nd, 3rd and 4th bits are used to represent four possible reporting
137 SENSOR_FLAG_CONTINUOUS_MODE = 0, // 0000
138 SENSOR_FLAG_ON_CHANGE_MODE = 0x2, // 0010
139 SENSOR_FLAG_ONE_SHOT_MODE = 0x4, // 0100
140 SENSOR_FLAG_SPECIAL_REPORTING_MODE = 0x6 // 0110
144 * Mask and shift for reporting mode sensor flags defined above.
146 #define REPORTING_MODE_MASK (0xE)
147 #define REPORTING_MODE_SHIFT (1)
152 * Each sensor has a type which defines what this sensor measures and how
153 * measures are reported. See the Base sensors and Composite sensors lists
154 * for complete descriptions:
155 * http://source.android.com/devices/sensors/base_triggers.html
156 * http://source.android.com/devices/sensors/composite_sensors.html
158 * Device manufacturers (OEMs) can define their own sensor types, for
159 * their private use by applications or services provided by them. Such
160 * sensor types are specific to an OEM and can't be exposed in the SDK.
161 * These types must start at SENSOR_TYPE_DEVICE_PRIVATE_BASE.
163 * All sensors defined outside of the device private range must correspond to
164 * a type defined in this file, and must satisfy the characteristics listed in
165 * the description of the sensor type.
167 * Starting with version SENSORS_DEVICE_API_VERSION_1_2, each sensor also
169 * - StringType of sensors inside of the device private range MUST be prefixed
170 * by the sensor provider's or OEM reverse domain name. In particular, they
171 * cannot use the "android.sensor" prefix.
172 * - StringType of sensors outside of the device private range MUST correspond
173 * to the one defined in this file (starting with "android.sensor").
174 * For example, accelerometers must have
175 * type=SENSOR_TYPE_ACCELEROMETER and
176 * stringType=SENSOR_STRING_TYPE_ACCELEROMETER
178 * When android introduces a new sensor type that can replace an OEM-defined
179 * sensor type, the OEM must use the official sensor type and stringType on
180 * versions of the HAL that support this new official sensor type.
182 * Example (made up): Suppose Google's Glass team wants to surface a sensor
183 * detecting that Glass is on a head.
184 * - Such a sensor is not officially supported in android KitKat
185 * - Glass devices launching on KitKat can implement a sensor with
186 * type = 0x10001 and stringType = "com.google.glass.onheaddetector"
187 * - In L android release, if android decides to define
188 * SENSOR_TYPE_ON_HEAD_DETECTOR and STRING_SENSOR_TYPE_ON_HEAD_DETECTOR,
189 * those types should replace the Glass-team-specific types in all future
191 * - When launching Glass on the L release, Google should now use the official
192 * type (SENSOR_TYPE_ON_HEAD_DETECTOR) and stringType.
193 * - This way, all applications can now use this sensor.
197 * Base for device manufacturers private sensor types.
198 * These sensor types can't be exposed in the SDK.
200 #define SENSOR_TYPE_DEVICE_PRIVATE_BASE 0x10000
203 * SENSOR_TYPE_META_DATA
204 * reporting-mode: n/a
205 * wake-up sensor: n/a
207 * NO SENSOR OF THAT TYPE MUST BE RETURNED (*get_sensors_list)()
209 * SENSOR_TYPE_META_DATA is a special token used to populate the
210 * sensors_meta_data_event structure. It doesn't correspond to a physical
211 * sensor. sensors_meta_data_event are special, they exist only inside
212 * the HAL and are generated spontaneously, as opposed to be related to
215 * sensors_meta_data_event_t.version must be META_DATA_VERSION
216 * sensors_meta_data_event_t.sensor must be 0
217 * sensors_meta_data_event_t.type must be SENSOR_TYPE_META_DATA
218 * sensors_meta_data_event_t.reserved must be 0
219 * sensors_meta_data_event_t.timestamp must be 0
221 * The payload is a meta_data_event_t, where:
222 * meta_data_event_t.what can take the following values:
224 * META_DATA_FLUSH_COMPLETE
225 * This event indicates that a previous (*flush)() call has completed for the sensor
226 * handle specified in meta_data_event_t.sensor.
227 * see (*flush)() for more details
229 * All other values for meta_data_event_t.what are reserved and
233 #define SENSOR_TYPE_META_DATA (0)
237 * Each sensor may have either or both a wake-up and a non-wake variant.
238 * When registered in batch mode, wake-up sensors will wake up the AP when
239 * their FIFOs are full or when the batch timeout expires. A separate FIFO has
240 * to be maintained for wake up sensors and non wake up sensors. The non wake-up
241 * sensors need to overwrite their FIFOs when they are full till the AP wakes up
242 * and the wake-up sensors will wake-up the AP when their FIFOs are full or when
243 * the batch timeout expires without losing events. Wake-up and non wake-up variants
244 * of each sensor can be activated at different rates independently of each other.
246 * Note: Proximity sensor and significant motion sensor which were defined in previous
247 * releases are also wake-up sensors and should be treated as such. Wake-up one-shot
248 * sensors like SIGNIFICANT_MOTION cannot be batched, hence the text about batch above
249 * doesn't apply to them. See the definitions of SENSOR_TYPE_PROXIMITY and
250 * SENSOR_TYPE_SIGNIFICANT_MOTION for more info.
252 * Set SENSOR_FLAG_WAKE_UP flag for all wake-up sensors.
254 * For example, A device can have two sensors both of SENSOR_TYPE_ACCELEROMETER and
255 * one of them can be a wake_up sensor (with SENSOR_FLAG_WAKE_UP flag set) and the other
256 * can be a regular non wake_up sensor. Both of these sensors must be activated/deactivated
257 * independently of the other.
261 * SENSOR_TYPE_ACCELEROMETER
262 * reporting-mode: continuous
264 * All values are in SI units (m/s^2) and measure the acceleration of the
265 * device minus the force of gravity.
267 * Implement the non-wake-up version of this sensor and implement the wake-up
268 * version if the system possesses a wake up fifo.
270 #define SENSOR_TYPE_ACCELEROMETER (1)
271 #define SENSOR_STRING_TYPE_ACCELEROMETER "android.sensor.accelerometer"
274 * SENSOR_TYPE_GEOMAGNETIC_FIELD
275 * reporting-mode: continuous
277 * All values are in micro-Tesla (uT) and measure the geomagnetic
278 * field in the X, Y and Z axis.
280 * Implement the non-wake-up version of this sensor and implement the wake-up
281 * version if the system possesses a wake up fifo.
283 #define SENSOR_TYPE_GEOMAGNETIC_FIELD (2)
284 #define SENSOR_TYPE_MAGNETIC_FIELD SENSOR_TYPE_GEOMAGNETIC_FIELD
285 #define SENSOR_STRING_TYPE_MAGNETIC_FIELD "android.sensor.magnetic_field"
288 * SENSOR_TYPE_ORIENTATION
289 * reporting-mode: continuous
291 * All values are angles in degrees.
293 * Orientation sensors return sensor events for all 3 axes at a constant
294 * rate defined by setDelay().
296 * Implement the non-wake-up version of this sensor and implement the wake-up
297 * version if the system possesses a wake up fifo.
299 #define SENSOR_TYPE_ORIENTATION (3)
300 #define SENSOR_STRING_TYPE_ORIENTATION "android.sensor.orientation"
303 * SENSOR_TYPE_GYROSCOPE
304 * reporting-mode: continuous
306 * All values are in radians/second and measure the rate of rotation
307 * around the X, Y and Z axis.
309 * Implement the non-wake-up version of this sensor and implement the wake-up
310 * version if the system possesses a wake up fifo.
312 #define SENSOR_TYPE_GYROSCOPE (4)
313 #define SENSOR_STRING_TYPE_GYROSCOPE "android.sensor.gyroscope"
317 * reporting-mode: on-change
319 * The light sensor value is returned in SI lux units.
321 * Both wake-up and non wake-up versions are useful.
323 #define SENSOR_TYPE_LIGHT (5)
324 #define SENSOR_STRING_TYPE_LIGHT "android.sensor.light"
327 * SENSOR_TYPE_PRESSURE
328 * reporting-mode: continuous
330 * The pressure sensor return the athmospheric pressure in hectopascal (hPa)
332 * Implement the non-wake-up version of this sensor and implement the wake-up
333 * version if the system possesses a wake up fifo.
335 #define SENSOR_TYPE_PRESSURE (6)
336 #define SENSOR_STRING_TYPE_PRESSURE "android.sensor.pressure"
338 /* SENSOR_TYPE_TEMPERATURE is deprecated in the HAL */
339 #define SENSOR_TYPE_TEMPERATURE (7)
340 #define SENSOR_STRING_TYPE_TEMPERATURE "android.sensor.temperature"
343 * SENSOR_TYPE_PROXIMITY
344 * reporting-mode: on-change
346 * The proximity sensor which turns the screen off and back on during calls is the
347 * wake-up proximity sensor. Implement wake-up proximity sensor before implementing
348 * a non wake-up proximity sensor. For the wake-up proximity sensor set the flag
349 * SENSOR_FLAG_WAKE_UP.
350 * The value corresponds to the distance to the nearest object in centimeters.
352 #define SENSOR_TYPE_PROXIMITY (8)
353 #define SENSOR_STRING_TYPE_PROXIMITY "android.sensor.proximity"
356 * SENSOR_TYPE_GRAVITY
357 * reporting-mode: continuous
359 * A gravity output indicates the direction of and magnitude of gravity in
360 * the devices's coordinates.
362 * Implement the non-wake-up version of this sensor and implement the wake-up
363 * version if the system possesses a wake up fifo.
365 #define SENSOR_TYPE_GRAVITY (9)
366 #define SENSOR_STRING_TYPE_GRAVITY "android.sensor.gravity"
369 * SENSOR_TYPE_LINEAR_ACCELERATION
370 * reporting-mode: continuous
372 * Indicates the linear acceleration of the device in device coordinates,
373 * not including gravity.
375 * Implement the non-wake-up version of this sensor and implement the wake-up
376 * version if the system possesses a wake up fifo.
378 #define SENSOR_TYPE_LINEAR_ACCELERATION (10)
379 #define SENSOR_STRING_TYPE_LINEAR_ACCELERATION "android.sensor.linear_acceleration"
383 * SENSOR_TYPE_ROTATION_VECTOR
384 * reporting-mode: continuous
386 * The rotation vector symbolizes the orientation of the device relative to the
387 * East-North-Up coordinates frame.
389 * Implement the non-wake-up version of this sensor and implement the wake-up
390 * version if the system possesses a wake up fifo.
392 #define SENSOR_TYPE_ROTATION_VECTOR (11)
393 #define SENSOR_STRING_TYPE_ROTATION_VECTOR "android.sensor.rotation_vector"
396 * SENSOR_TYPE_RELATIVE_HUMIDITY
397 * reporting-mode: on-change
399 * A relative humidity sensor measures relative ambient air humidity and
400 * returns a value in percent.
402 * Both wake-up and non wake-up versions are useful.
404 #define SENSOR_TYPE_RELATIVE_HUMIDITY (12)
405 #define SENSOR_STRING_TYPE_RELATIVE_HUMIDITY "android.sensor.relative_humidity"
408 * SENSOR_TYPE_AMBIENT_TEMPERATURE
409 * reporting-mode: on-change
411 * The ambient (room) temperature in degree Celsius.
413 * Both wake-up and non wake-up versions are useful.
415 #define SENSOR_TYPE_AMBIENT_TEMPERATURE (13)
416 #define SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE "android.sensor.ambient_temperature"
419 * SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED
420 * reporting-mode: continuous
422 * Similar to SENSOR_TYPE_MAGNETIC_FIELD, but the hard iron calibration is
423 * reported separately instead of being included in the measurement.
425 * Implement the non-wake-up version of this sensor and implement the wake-up
426 * version if the system possesses a wake up fifo.
428 #define SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED (14)
429 #define SENSOR_STRING_TYPE_MAGNETIC_FIELD_UNCALIBRATED "android.sensor.magnetic_field_uncalibrated"
432 * SENSOR_TYPE_GAME_ROTATION_VECTOR
433 * reporting-mode: continuous
435 * Similar to SENSOR_TYPE_ROTATION_VECTOR, but not using the geomagnetic
438 * Implement the non-wake-up version of this sensor and implement the wake-up
439 * version if the system possesses a wake up fifo.
441 #define SENSOR_TYPE_GAME_ROTATION_VECTOR (15)
442 #define SENSOR_STRING_TYPE_GAME_ROTATION_VECTOR "android.sensor.game_rotation_vector"
445 * SENSOR_TYPE_GYROSCOPE_UNCALIBRATED
446 * reporting-mode: continuous
448 * All values are in radians/second and measure the rate of rotation
449 * around the X, Y and Z axis.
451 * Implement the non-wake-up version of this sensor and implement the wake-up
452 * version if the system possesses a wake up fifo.
454 #define SENSOR_TYPE_GYROSCOPE_UNCALIBRATED (16)
455 #define SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED "android.sensor.gyroscope_uncalibrated"
458 * SENSOR_TYPE_SIGNIFICANT_MOTION
459 * reporting-mode: one-shot
461 * A sensor of this type triggers an event each time significant motion
462 * is detected and automatically disables itself.
463 * For Significant Motion sensor to be useful, it must be defined as a
464 * wake-up sensor. (set SENSOR_FLAG_WAKE_UP). Implement the wake-up significant motion
465 * sensor. A non wake-up version is not useful.
466 * The only allowed value to return is 1.0.
469 #define SENSOR_TYPE_SIGNIFICANT_MOTION (17)
470 #define SENSOR_STRING_TYPE_SIGNIFICANT_MOTION "android.sensor.significant_motion"
473 * SENSOR_TYPE_STEP_DETECTOR
474 * reporting-mode: special
476 * A sensor of this type triggers an event each time a step is taken
477 * by the user. The only allowed value to return is 1.0 and an event
478 * is generated for each step.
480 * Both wake-up and non wake-up versions are useful.
483 #define SENSOR_TYPE_STEP_DETECTOR (18)
484 #define SENSOR_STRING_TYPE_STEP_DETECTOR "android.sensor.step_detector"
488 * SENSOR_TYPE_STEP_COUNTER
489 * reporting-mode: on-change
491 * A sensor of this type returns the number of steps taken by the user since
492 * the last reboot while activated. The value is returned as a uint64_t and is
493 * reset to zero only on a system / android reboot.
495 * Implement the non-wake-up version of this sensor and implement the wake-up
496 * version if the system possesses a wake up fifo.
499 #define SENSOR_TYPE_STEP_COUNTER (19)
500 #define SENSOR_STRING_TYPE_STEP_COUNTER "android.sensor.step_counter"
503 * SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR
504 * reporting-mode: continuous
506 * Similar to SENSOR_TYPE_ROTATION_VECTOR, but using a magnetometer instead
507 * of using a gyroscope.
509 * Implement the non-wake-up version of this sensor and implement the wake-up
510 * version if the system possesses a wake up fifo.
512 #define SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR (20)
513 #define SENSOR_STRING_TYPE_GEOMAGNETIC_ROTATION_VECTOR "android.sensor.geomagnetic_rotation_vector"
516 * SENSOR_TYPE_HEART_RATE
517 * reporting-mode: on-change
519 * A sensor of this type returns the current heart rate.
520 * The events contain the current heart rate in beats per minute (BPM) and the
521 * status of the sensor during the measurement. See heart_rate_event_t for more
524 * Because this sensor is on-change, events must be generated when and only
525 * when heart_rate.bpm or heart_rate.status have changed since the last
526 * event. In particular, upon the first activation, unless the device is known
527 * to not be on the body, the status field of the first event must be set to
528 * SENSOR_STATUS_UNRELIABLE. The event should be generated no faster than every
529 * period_ns passed to setDelay() or to batch().
530 * See the definition of the on-change reporting mode for more information.
532 * sensor_t.requiredPermission must be set to SENSOR_PERMISSION_BODY_SENSORS.
534 * Both wake-up and non wake-up versions are useful.
536 #define SENSOR_TYPE_HEART_RATE (21)
537 #define SENSOR_STRING_TYPE_HEART_RATE "android.sensor.heart_rate"
540 * SENSOR_TYPE_WAKE_UP_TILT_DETECTOR
541 * reporting-mode: special (setDelay has no impact)
543 * A sensor of this type generates an event each time a tilt event is detected. A tilt event
544 * should be generated if the direction of the 2-seconds window average gravity changed by at least
545 * 35 degrees since the activation or the last trigger of the sensor.
546 * reference_estimated_gravity = average of accelerometer measurements over the first
547 * 1 second after activation or the estimated gravity at the last
549 * current_estimated_gravity = average of accelerometer measurements over the last 2 seconds.
550 * trigger when angle (reference_estimated_gravity, current_estimated_gravity) > 35 degrees
552 * Large accelerations without a change in phone orientation should not trigger a tilt event.
553 * For example, a sharp turn or strong acceleration while driving a car should not trigger a tilt
554 * event, even though the angle of the average acceleration might vary by more than 35 degrees.
556 * Typically, this sensor is implemented with the help of only an accelerometer. Other sensors can
557 * be used as well if they do not increase the power consumption significantly. This is a low power
558 * sensor that should allow the AP to go into suspend mode. Do not emulate this sensor in the HAL.
559 * Like other wake up sensors, the driver is expected to a hold a wake_lock with a timeout of 200 ms
560 * while reporting this event. The only allowed return value is 1.0.
562 * Implement only the wake-up version of this sensor.
564 #define SENSOR_TYPE_TILT_DETECTOR (22)
565 #define SENSOR_STRING_TYPE_TILT_DETECTOR "android.sensor.tilt_detector"
568 * SENSOR_TYPE_WAKE_GESTURE
569 * reporting-mode: one-shot
571 * A sensor enabling waking up the device based on a device specific motion.
573 * When this sensor triggers, the device behaves as if the power button was
574 * pressed, turning the screen on. This behavior (turning on the screen when
575 * this sensor triggers) might be deactivated by the user in the device
576 * settings. Changes in settings do not impact the behavior of the sensor:
577 * only whether the framework turns the screen on when it triggers.
579 * The actual gesture to be detected is not specified, and can be chosen by
580 * the manufacturer of the device.
581 * This sensor must be low power, as it is likely to be activated 24/7.
582 * The only allowed value to return is 1.0.
584 * Implement only the wake-up version of this sensor.
586 #define SENSOR_TYPE_WAKE_GESTURE (23)
587 #define SENSOR_STRING_TYPE_WAKE_GESTURE "android.sensor.wake_gesture"
590 * SENSOR_TYPE_GLANCE_GESTURE
591 * reporting-mode: one-shot
593 * A sensor enabling briefly turning the screen on to enable the user to
594 * glance content on screen based on a specific motion. The device should
595 * turn the screen off after a few moments.
597 * When this sensor triggers, the device turns the screen on momentarily
598 * to allow the user to glance notifications or other content while the
599 * device remains locked in a non-interactive state (dozing). This behavior
600 * (briefly turning on the screen when this sensor triggers) might be deactivated
601 * by the user in the device settings. Changes in settings do not impact the
602 * behavior of the sensor: only whether the framework briefly turns the screen on
605 * The actual gesture to be detected is not specified, and can be chosen by
606 * the manufacturer of the device.
607 * This sensor must be low power, as it is likely to be activated 24/7.
608 * The only allowed value to return is 1.0.
610 * Implement only the wake-up version of this sensor.
612 #define SENSOR_TYPE_GLANCE_GESTURE (24)
613 #define SENSOR_STRING_TYPE_GLANCE_GESTURE "android.sensor.glance_gesture"
616 * SENSOR_TYPE_PICK_UP_GESTURE
617 * reporting-mode: one-shot
619 * A sensor of this type triggers when the device is picked up regardless of wherever is was
620 * before (desk, pocket, bag). The only allowed return value is 1.0.
621 * This sensor de-activates itself immediately after it triggers.
623 * Implement only the wake-up version of this sensor.
625 #define SENSOR_TYPE_PICK_UP_GESTURE (25)
626 #define SENSOR_STRING_TYPE_PICK_UP_GESTURE "android.sensor.pick_up_gesture"
629 * SENSOR_TYPE_WRIST_TILT_GESTURE
630 * trigger-mode: special
631 * wake-up sensor: yes
633 * A sensor of this type triggers an event each time a tilt of the wrist-worn
634 * device is detected.
636 * This sensor must be low power, as it is likely to be activated 24/7.
637 * The only allowed value to return is 1.0.
639 * Implement only the wake-up version of this sensor.
641 #define SENSOR_TYPE_WRIST_TILT_GESTURE (26)
642 #define SENSOR_STRING_TYPE_WRIST_TILT_GESTURE "android.sensor.wrist_tilt_gesture"
645 * SENSOR_TYPE_TIME_SYNC
646 * reporting-mode: continuous
648 * A time synchronization mechanism sensor to synchronize timing between
649 * differnt parts of the device.
650 * This sensor returns the following values in the sensor_event
651 * Time_stamp of the event
652 * u64.data[0] -> Type of event latched
653 * u64.data[1] -> count
655 * Implement only the wake-up version of this sensor.
657 #define SENSOR_TYPE_TIME_SYNC (SENSOR_TYPE_DEVICE_PRIVATE_BASE + 0x10)
658 #define SENSOR_STRING_TYPE_TIME_SYNC "android.sensor.time_sync"
661 * SENSOR_TYPE_NUDGE_GESTURE
662 * reporting-mode: one-shot
664 * A sensor of this type triggers when the device is nudged.
666 * The only allowed return value is 1.0. This sensor
667 * de-activates itself immediately after it triggers.
669 * Implement only the wake-up version of this sensor.
671 #define SENSOR_TYPE_NUDGE_GESTURE (SENSOR_TYPE_DEVICE_PRIVATE_BASE + 0x11)
672 #define SENSOR_STRING_NUDGE_UP_GESTURE "android.sensor.nudge_gesture"
675 * Values returned by the accelerometer in various locations in the universe.
676 * all values are in SI units (m/s^2)
678 #define GRAVITY_SUN (275.0f)
679 #define GRAVITY_EARTH (9.80665f)
681 /** Maximum magnetic field on Earth's surface */
682 #define MAGNETIC_FIELD_EARTH_MAX (60.0f)
684 /** Minimum magnetic field on Earth's surface */
685 #define MAGNETIC_FIELD_EARTH_MIN (30.0f)
688 * Possible values of the status field of sensor events.
690 #define SENSOR_STATUS_NO_CONTACT -1
691 #define SENSOR_STATUS_UNRELIABLE 0
692 #define SENSOR_STATUS_ACCURACY_LOW 1
693 #define SENSOR_STATUS_ACCURACY_MEDIUM 2
694 #define SENSOR_STATUS_ACCURACY_HIGH 3
718 * uncalibrated gyroscope and magnetometer event data
737 } uncalibrated_event_t;
740 * Meta data event data
742 typedef struct meta_data_event {
748 * Heart rate event data
751 // Heart rate in beats per minute.
752 // Set to 0 when status is SENSOR_STATUS_UNRELIABLE or ..._NO_CONTACT
754 // Status of the sensor for this reading. Set to one SENSOR_STATUS_...
755 // Note that this value should only be set for sensors that explicitly define
756 // the meaning of this field. This field is not piped through the framework
757 // for other sensors.
759 } heart_rate_event_t;
762 * Union of the various types of sensor data
763 * that can be returned.
765 typedef struct sensors_event_t {
766 /* must be sizeof(struct sensors_event_t) */
769 /* sensor identifier */
778 /* time is in nanosecond */
785 /* acceleration values are in meter per second per second (m/s^2) */
786 sensors_vec_t acceleration;
788 /* magnetic vector values are in micro-Tesla (uT) */
789 sensors_vec_t magnetic;
791 /* orientation values are in degrees */
792 sensors_vec_t orientation;
794 /* gyroscope values are in rad/s */
797 /* temperature is in degrees centigrade (Celsius) */
800 /* distance in centimeters */
803 /* light in SI lux units */
806 /* pressure in hectopascal (hPa) */
809 /* relative humidity in percent */
810 float relative_humidity;
812 /* uncalibrated gyroscope values are in rad/s */
813 uncalibrated_event_t uncalibrated_gyro;
815 /* uncalibrated magnetometer values are in micro-Teslas */
816 uncalibrated_event_t uncalibrated_magnetic;
818 /* heart rate data containing value in bpm and status */
819 heart_rate_event_t heart_rate;
821 /* this is a special event. see SENSOR_TYPE_META_DATA above.
822 * sensors_meta_data_event_t events are all reported with a type of
823 * SENSOR_TYPE_META_DATA. The handle is ignored and must be zero.
825 meta_data_event_t meta_data;
832 uint64_t step_counter;
836 /* Reserved flags for internal use. Set to zero. */
839 uint32_t reserved1[3];
843 /* see SENSOR_TYPE_META_DATA */
844 typedef sensors_event_t sensors_meta_data_event_t;
850 * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM
851 * and the fields of this data structure must begin with hw_module_t
852 * followed by module specific information.
854 struct sensors_module_t {
855 struct hw_module_t common;
858 * Enumerate all available sensors. The list is returned in "list".
859 * @return number of sensors in the list
861 int (*get_sensors_list)(struct sensors_module_t* module,
862 struct sensor_t const** list);
865 * Place the module in a specific mode. The following modes are defined
867 * 0 - Normal operation. Default state of the module.
868 * 1 - Loopback mode. Data is injected for the the supported sensors by
869 * the sensor service in this mode.
871 int (*set_operation_mode)(unsigned int mode);
876 /* Name of this sensor.
877 * All sensors of the same "type" must have a different "name".
881 /* vendor of the hardware part */
884 /* version of the hardware part + driver. The value of this field
885 * must increase when the driver is updated in a way that changes the
886 * output of this sensor. This is important for fused sensors when the
887 * fusion algorithm is updated.
891 /* handle that identifies this sensors. This handle is used to reference
892 * this sensor throughout the HAL API.
896 /* this sensor's type. */
899 /* maximum range of this sensor's value in SI units */
902 /* smallest difference between two values reported by this sensor */
905 /* rough estimate of this sensor's power consumption in mA */
908 /* this value depends on the reporting mode:
910 * continuous: minimum sample period allowed in microseconds
913 * special : 0, unless otherwise noted
917 /* number of events reserved for this sensor in the batch mode FIFO.
918 * If there is a dedicated FIFO for this sensor, then this is the
919 * size of this FIFO. If the FIFO is shared with other sensors,
920 * this is the size reserved for that sensor and it can be zero.
922 uint32_t fifoReservedEventCount;
924 /* maximum number of events of this sensor that could be batched.
925 * This is especially relevant when the FIFO is shared between
926 * several sensors; this value is then set to the size of that FIFO.
928 uint32_t fifoMaxEventCount;
930 /* type of this sensor as a string. Set to corresponding
931 * SENSOR_STRING_TYPE_*.
932 * When defining an OEM specific sensor or sensor manufacturer specific
933 * sensor, use your reserve domain name as a prefix.
934 * ex: com.google.glass.onheaddetector
935 * For sensors of known type, the android framework might overwrite this
936 * string automatically.
938 const char* stringType;
940 /* permission required to see this sensor, register to it and receive data.
941 * Set to "" if no permission is required. Some sensor types like the
942 * heart rate monitor have a mandatory require_permission.
943 * For sensors that always require a specific permission, like the heart
944 * rate monitor, the android framework might overwrite this string
947 const char* requiredPermission;
949 /* This value is defined only for continuous mode and on-change sensors. It is the delay between
950 * two sensor events corresponding to the lowest frequency that this sensor supports. When lower
951 * frequencies are requested through batch()/setDelay() the events will be generated at this
952 * frequency instead. It can be used by the framework or applications to estimate when the batch
955 * NOTE: 1) period_ns is in nanoseconds where as maxDelay/minDelay are in microseconds.
956 * continuous, on-change: maximum sampling period allowed in microseconds.
957 * one-shot, special : 0
958 * 2) maxDelay should always fit within a 32 bit signed integer. It is declared as 64 bit
959 * on 64 bit architectures only for binary compatibility reasons.
960 * Availability: SENSORS_DEVICE_API_VERSION_1_3
968 /* Flags for sensor. See SENSOR_FLAG_* above. Only the least significant 32 bits are used here.
969 * It is declared as 64 bit on 64 bit architectures only for binary compatibility reasons.
970 * Availability: SENSORS_DEVICE_API_VERSION_1_3
978 /* reserved fields, must be zero */
984 * sensors_poll_device_t is used with SENSORS_DEVICE_API_VERSION_0_1
985 * and is present for backward binary and source compatibility.
986 * See the Sensors HAL interface section for complete descriptions of the
987 * following functions:
988 * http://source.android.com/devices/sensors/index.html#hal
990 struct sensors_poll_device_t {
991 struct hw_device_t common;
992 int (*activate)(struct sensors_poll_device_t *dev,
993 int sensor_handle, int enabled);
994 int (*setDelay)(struct sensors_poll_device_t *dev,
995 int sensor_handle, int64_t sampling_period_ns);
996 int (*poll)(struct sensors_poll_device_t *dev,
997 sensors_event_t* data, int count);
1001 * struct sensors_poll_device_1 is used in HAL versions >= SENSORS_DEVICE_API_VERSION_1_0
1003 typedef struct sensors_poll_device_1 {
1005 /* sensors_poll_device_1 is compatible with sensors_poll_device_t,
1006 * and can be down-cast to it
1008 struct sensors_poll_device_t v0;
1011 struct hw_device_t common;
1013 /* Activate/de-activate one sensor. Return 0 on success, negative
1015 * sensor_handle is the handle of the sensor to change.
1016 * enabled set to 1 to enable, or 0 to disable the sensor.
1018 * Return 0 on success, negative errno code otherwise.
1020 int (*activate)(struct sensors_poll_device_t *dev,
1021 int sensor_handle, int enabled);
1024 * Set the events's period in nanoseconds for a given sensor.
1025 * If sampling_period_ns > max_delay it will be truncated to
1026 * max_delay and if sampling_period_ns < min_delay it will be
1027 * replaced by min_delay.
1029 int (*setDelay)(struct sensors_poll_device_t *dev,
1030 int sensor_handle, int64_t sampling_period_ns);
1033 * Returns an array of sensor data.
1035 int (*poll)(struct sensors_poll_device_t *dev,
1036 sensors_event_t* data, int count);
1042 * Sets a sensor’s parameters, including sampling frequency and maximum
1043 * report latency. This function can be called while the sensor is
1044 * activated, in which case it must not cause any sensor measurements to
1045 * be lost: transitioning from one sampling rate to the other cannot cause
1046 * lost events, nor can transitioning from a high maximum report latency to
1047 * a low maximum report latency.
1048 * See the Batching sensor results page for details:
1049 * http://source.android.com/devices/sensors/batching.html
1051 int (*batch)(struct sensors_poll_device_1* dev,
1052 int sensor_handle, int flags, int64_t sampling_period_ns,
1053 int64_t max_report_latency_ns);
1056 * Flush adds a META_DATA_FLUSH_COMPLETE event (sensors_event_meta_data_t)
1057 * to the end of the "batch mode" FIFO for the specified sensor and flushes
1059 * If the FIFO is empty or if the sensor doesn't support batching (FIFO size zero),
1060 * it should return SUCCESS along with a trivial META_DATA_FLUSH_COMPLETE event added to the
1061 * event stream. This applies to all sensors other than one-shot sensors.
1062 * If the sensor is a one-shot sensor, flush must return -EINVAL and not generate
1063 * any flush complete metadata.
1064 * If the sensor is not active at the time flush() is called, flush() should return
1067 int (*flush)(struct sensors_poll_device_1* dev, int sensor_handle);
1070 * Inject a sensor samples to be to this device.
1072 int (*inject_sensor_data)(struct sensors_poll_device_1 *dev, const sensors_event_t *data);
1074 void (*reserved_procs[7])(void);
1076 } sensors_poll_device_1_t;
1079 /** convenience API for opening and closing a device */
1081 static inline int sensors_open(const struct hw_module_t* module,
1082 struct sensors_poll_device_t** device) {
1083 return module->methods->open(module,
1084 SENSORS_HARDWARE_POLL, (struct hw_device_t**)device);
1087 static inline int sensors_close(struct sensors_poll_device_t* device) {
1088 return device->common.close(&device->common);
1091 static inline int sensors_open_1(const struct hw_module_t* module,
1092 sensors_poll_device_1_t** device) {
1093 return module->methods->open(module,
1094 SENSORS_HARDWARE_POLL, (struct hw_device_t**)device);
1097 static inline int sensors_close_1(sensors_poll_device_1_t* device) {
1098 return device->common.close(&device->common);
1103 #endif // ANDROID_SENSORS_INTERFACE_H