* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] type A sensor type to check
- * @param[out] supported If supported, @c true; Otherwise @c false
+ * @param[out] supported If supported, @c true; otherwise @c false
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*/
*
* @param[in] sensor A sensor handle to check
* @param[out] wakeup If the sensor is a wake-up sensor, @c true;
- * Otherwise @c false
+ * otherwise @c false
*
* @return #SENSOR_ERROR_NONE on success, otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
/**
* @brief Gets the handle for the default sensor of a given type.
- * @details This function returns the handle for the sensor of a given type,
- * if the device has one sensor of the given type.
+ * @details This function returns the handle for the sensor of a given type.
* In case that the device has more than one sensors of the type,
- * this returns only the default sensor, which is designated by the device.@n
+ * this returns only the default sensor, which is designated by the device.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks Some sensor types are privileged. An application should have the privilege
* @param[in] type A sensor type to get the handle of its default sensor
* @param[out] sensor The sensor handle of the default sensor
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SENSOR_ERROR_NOT_SUPPORTED The sensor type is not supported in the current device
* #SENSOR_HRM, #SENSOR_HRM_LED_GREEN, #SENSOR_HRM_LED_IR, #SENSOR_HRM_LED_RED,
* #SENSOR_HUMAN_PEDOMETER, #SENSOR_HUMAN_SLEEP_MONITOR, #SENSOR_HUMAN_SLEEP_DETECTOR,
* and #SENSOR_HUMAN_STRESS_MONITOR.@n
- * Instead of specifying a sensor type, by using #SENSOR_ALL,
- * applications can get the list of handles for all available sensors.@n
- * The @c list must be released using @c free(), if not being used anymore.@n
+ * Instead of specifying a sensor type,
+ * it is able to get the handles for all available sensors by using #SENSOR_ALL.@n
+ * The @c list must be released using @c free(), if not being used anymore.
*
* @param[in] type A sensor type to get the list of sensor handles
* @param[out] list An array of the sensor handles
* @param[out] sensor_count The number of handles contained in @c list
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SENSOR_ERROR_NOT_SUPPORTED The sensor type is not supported in the current device
/**
- * @brief Gets the possible shorted update interval of a sensor.
+ * @brief Gets the possible shortest update interval of a sensor.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] sensor A sensor handle
- * @param[out] min_interval The shorted interval in milliseconds
+ * @param[out] min_interval The shortest interval in milliseconds
*
* @return #SENSOR_ERROR_NONE on success, otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
*
* @param[in] sensor A sensor handle
* @param[out] max_batch_count If the sensor does not support batching, 0;
- * Otherwise a positive integer.
+ * otherwise a positive integer.
*
* @return #SENSOR_ERROR_NONE on success, otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
/**
- * @brief Enumeration for reference orientations of sensor data
+ * @brief Enumeration for reference orientations of sensor data.
* @details The sensor's physical orientation may differ from what applications are aware of,
* in cases that the device has a rotated screen, physically or logically.
* For example, a watch device may have right hand mode, which logically rotates
/**
- * @brief Enumeration for pause policies of sensor listeners
+ * @brief Enumeration for pause policies of sensor listeners.
* @details To be power-efficient, you can set the policy of how to pause and resume
* a sensor listener regarding the system status.
* By default, #SENSOR_PAUSE_ALL is used to obtain the maximum power efficiency.
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SENSOR_ERROR_OPERATION_FAILED Operation failed
*
- * @pre The @c listener needs to be started to get the change callbacks.
+ * @pre The @c listener needs to be started to get the changed callbacks.
* @see sensor_listener_unset_accuracy_cb()
*/
int sensor_listener_set_accuracy_cb(sensor_listener_h listener, sensor_accuracy_changed_cb callback, void *data);
* @details The specified interval is only a suggested interval between sensor measurements.
* You will get at least one sensor measurement within the interval you specify,
* but the actual interval between sensor measurements can be affected by other applications and the system.
- * To reduce the system overhead, it is recommended to set the longest interval that you can,
+ * It is recommended to set the longest interval that satisfies your purpose,
* because the system usually chooses the shortest interval among all intervals specified.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks Normally, a sensor's default update interval is 100 ms,
* and you can use the default interval by setting the interval to 0.
- * However, please note that, the default interval varies with the sensor and the device.@n
+ * However, please note that the default interval varies with the sensor and the device.@n
* In addition, a sensor has the lower and the upper bound of its update interval,
* usually 10 and 1000 ms respectively.
* These lower and upper bounds also can vary with the sensor and the device,
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks Even if you set a batch latency, the sensor may not work as you intended,
- * as one sensor can be used by more than one listeners.
+ * as one sensor can be used by more than one listener.
* In addition, some batch sensors may already have fixed batching latency
* or batching queue size, which cannot be altered by applications.
*
/**
* @brief Option handle to contain recording policies and parameters.
- * @details one or more sensor options can be created by using sensor_recorder_create_option().
+ * @details One or more sensor options can be created by using sensor_recorder_create_option().
* @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*/
typedef void *sensor_recorder_option_h;
/**
* @brief Query handle to contain filtering and aggregation parameters for recorded data.
- * @details one or more sensor options can be created by using sensor_recorder_create_query().
+ * @details One or more sensor options can be created by using sensor_recorder_create_query().
* @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*/
typedef void *sensor_recorder_query_h;
/**
* @brief Enumeration for intervals between data records.
* @details Some sensor types including #SENSOR_HRM may not fit to continuous monitoring and recording.
- * To reduce the battery use for recoridng such sensors, recording interval between each
- * sensor data is chosen. For example, an application set the interval of 1 hour,
+ * To reduce the battery use for recording such sensors, recording interval between each
+ * sensor data is chosen. For example, an application sets the interval of 1 hour,
* the platform tries to retrieve the sensor data only once per hour, thus it will be more
* battery efficient than to listen the sensor data continuously.@n
- * If the application does not set the interval explicitely, the default value is chosen.
- * The default values are differ from sensor to sensor.
+ * If the application does not set the interval explicitly, the default value is chosen.
+ * The default values differ from sensor to sensor.
* @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
- * @remarks If more than one applications set different intervals, the shortest value is chosen.
+ * @remarks If more than one application set different intervals, the shortest value is chosen.
*/
typedef enum
{
} sensor_recorder_interval_e;
/**
- * @brief Enumeration for filtering and aggregation parameters for queyring sensor records.
+ * @brief Enumeration for filtering and aggregation parameters for querying sensor records.
* @details None, one, or more query parameters can be set to #sensor_recorder_query_h,
* to specify the data to be retrieved via sensor_recorder_read().
* If a necessary parameter is not set, the default value is chosen.
} sensor_recorder_data_e;
/**
- * @brief Checks whether it is suppored to record a given sensor type.
+ * @brief Checks whether it is supported to record a given sensor type.
* @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*
* @param[in] type A sensor type to check
- * @param[out] supported If supported, @c true; Otherwise @c false
+ * @param[out] supported If supported, @c true; otherwise @c false
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SENSOR_ERROR_OPERATION_FAILED Operation failed
int sensor_recorder_destroy_query(sensor_recorder_query_h query);
/**
- * @brief Sets an integer-type query parameter
+ * @brief Sets an integer-type query parameter.
* @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
*
* @param[in] query Query handle
int sensor_recorder_query_set_time(sensor_recorder_query_h query, sensor_recorder_query_e param, time_t t);
/**
- * @brief Called when the query results are retieved.
+ * @brief Called when the query results are retrieved.
* @details One of the following errors can be delivered.\n
* #SENSOR_ERROR_NONE, Successful\n
* #SENSOR_ERROR_OPERATION_FAILED, Operation failed\n
* @param[in] error Error
* @param[in] user_data The user data passed from sensor_recorder_read() or sensor_recorder_read_sync()
*
- * @return If @c true, it continues to iterate to the next record; If @c false, the iteration stops
+ * @return If @c true, it continues to iterate to the next record; if @c false, the iteration stops
*/
typedef bool (*sensor_recorder_data_cb)(sensor_type_e type, sensor_recorder_data_h data, int remains, sensor_error_e error, void *user_data);
* @details [0 0 g] = R * gravity (g = magnitude of gravity) \n
* [0 m 0] = I * R * geomagnetic (m = magnitude of the geomagnetic field) \n
* R is the identity matrix when the device is aligned with the world's coordinate system, that is, when the device's X axis points towards the East, the Y axis points to the North Pole and the device is facing the sky. \n
- * I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis. \n
+ * I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks Parameters Gx, Gy, and Gz can be obtained from the values returned by #SENSOR_GRAVITY. \n
- * Parameters Mx, My, and Mz can be obtained from the values returned by #SENSOR_MAGNETIC.
+ * Parameters Mx, My, and Mz can be obtained from the values returned by #SENSOR_MAGNETIC. \n
* Output parameter R and I are always returned as a 3x3 matrix array of 9 floats like this form:
* <pre>
* { R[0], R[1], R[2],
* @param[out] I The array of 9 floats that represent the inclination matrix "I" \n
* It can be null.
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*/
* @details This is typically used when an application needs to compute the three orientation angles of the device in a different coordinate system.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks inR and outR can be the same array, but this is not recommended for performance reasons.
- * This returns an error when X and Y define the same axis.
+ * @remarks inR and outR can be the same array, but this is not recommended for performance reasons.@n
+ * @c x and @c y should be perpendicular to each other. Otherwise, this function returns an error.
*
* @param[in] inR The rotation matrix (3x3) to be transformed
* @param[in] x The world axis and direction on which the X axis of the device is mapped
* @param[in] y The world axis and direction on which the Y axis of the device is mapped
* @param[out] outR The transformed rotation matrix (3x3)
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] I The inclination matrix from sensor_util_get_rotation_matrix()
* @param[out] inclination The geomagnetic inclination angle in radians
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] R A 9 element rotation matrix in the array
* @param[out] values An array of 3 floats to hold the result
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*
*
* @details Given a current rotation matrix (R) and a previous rotation matrix (prevR), it computes
* the rotation around the x,y, and z axes which transforms prevR to R.
- * It outputs a 3 element vector containing the x,y, and z angle change at indexes 0, 1, and 2 respectively. \n
+ * It outputs a 3 element vector containing the x,y, and z angle change at indexes 0, 1, and 2 respectively.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks Each input matrix is a 3x3 matrix like this form:
* @param[in] prevR The previous rotation matrix
* @param[out] angleChange An array of floats in which the angle change is stored
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*/
* @param[in] altitude The altitude in geodetic coordinates
* @param[out] declination The declination of the horizontal component of the magnetic field in degrees
*
- * @return #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return #SENSOR_ERROR_NONE on success; otherwise a negative error value
* @retval #SENSOR_ERROR_NONE Successful
* @retval #SENSOR_ERROR_INVALID_PARAMETER Invalid parameter
*/
projects / platform / core / api / sensor.git / commitdiff