src/shared/sensor_internal_deprecated.h

   1 /*
   2  * libsensord
   3  *
   4  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 #ifndef __SENSOR_INTERNAL_DEPRECATED__
  21 #define __SENSOR_INTERNAL_DEPRECATED__
  22
  23 #ifndef DEPRECATED
  24 #define DEPRECATED __attribute__((deprecated))
  25 #endif
  26
  27 #include "stdbool.h"
  28
  29 #include <sys/types.h>
  30
  31 /*header for common sensor type*/
  32 #include <sensor_common.h>
  33
  34 /*header for each sensor type*/
  35 #include <sensor_types.h>
  36
  37 #include <sensor_deprecated.h>
  38
  39
  40 #ifdef __cplusplus
  41 extern "C"
  42 {
  43 #endif
  44
  45 #define MAX_KEY_LEN 30
  46
  47 typedef struct {
  48         condition_op_t cond_op;
  49         float cond_value1;
  50 } event_condition_t;
  51
  52 typedef struct {
  53         size_t event_data_size;
  54         void *event_data;
  55 } sensor_event_data_t;
  56
  57 typedef void (*sensor_callback_func_t)(unsigned int, sensor_event_data_t *, void *);
  58 typedef sensor_callback_func_t sensor_legacy_cb_t;
  59
  60 typedef struct {
  61         int x;
  62         int y;
  63         int z;
  64 } sensor_panning_data_t;
  65
  66 typedef struct {
  67         int sensor_unit_idx;
  68         float sensor_min_range;
  69         float sensor_max_range;
  70         float sensor_resolution;
  71         char sensor_name[MAX_KEY_LEN];
  72         char sensor_vendor[MAX_KEY_LEN];
  73 } sensor_properties_t;
  74
  75 typedef struct {
  76         int sensor_unit_idx;
  77         float sensor_min_range;
  78         float sensor_max_range;
  79         float sensor_resolution;
  80 } sensor_data_properties_t;
  81
  82 DEPRECATED int sf_is_sensor_event_available(sensor_type_t sensor_type , unsigned int event_type);
  83
  84 DEPRECATED int sf_get_data_properties(unsigned int data_id, sensor_data_properties_t *return_data_properties);
  85
  86 DEPRECATED int sf_get_properties(sensor_type_t sensor_type, sensor_properties_t *return_properties);
  87
  88 DEPRECATED int sf_check_rotation(unsigned long *rotation);
  89
  90 /**
  91  * @fn int sf_connect(sensor_type_t sensor)
  92  * @brief  This API connects a sensor type to respective sensor. The application calls with the type of the sensor (ex. ACCELEROMETER_SENSOR) and on basis of that server takes decision of which plug-in to be connected. Once sensor connected application can proceed for data processing. This API returns a positive handle which should be used by application to communicate on sensor type.
  93  * @param[in] sensor_type your desired sensor type
  94  * @return if it succeed, it return handle value( >=0 ) , otherwise negative value return
  95  */
  96 DEPRECATED int sf_connect(sensor_type_t sensor_type);
  97
  98 /**
  99  * @fn int sf_disconnect(int handle)
 100  * @brief This API disconnects an attached sensor from an application. Application must use the handle retuned after attaching the sensor. After detaching, the corresponding handle will be released.
 101  * @param[in] handle received handle value by sf_connect()
 102  * @return if it succeed, it return zero value , otherwise negative value return
 103  */
 104 DEPRECATED int sf_disconnect(int handle);
 105
 106 /**
 107  * @fn int sf_start(int handle , int option)
 108  * @brief This API sends a start command to sensor server. This intimates server that the client side is ready to handle data and start processing. The parameter option should be '0' for current usages.
 109  * @param[in] handle received handle value by sf_connect()
 110  * @param[in] option With SENSOR_OPTION_DEFAULT, it stops to sense when LCD is off, and with SENSOR_OPTION_ALWAYS_ON, it continues to sense even when LCD is off
 111  * @return if it succeed, it return zero value , otherwise negative value return
 112  */
 113 DEPRECATED int sf_start(int handle , int option);
 114
 115 /**
 116  * @fn int sf_stop(int handle)
 117  * @brief This API sends a stop command to the Sensor server indicating that the data processing is stopped from application side for this time.
 118  * @param[in] handle received handle value by sf_connect()
 119  * @return if it succeed, it return zero value , otherwise negative value return
 120  */
 121 DEPRECATED int sf_stop(int handle);
 122
 123 /**
 124  * @fn int sf_register_event(int handle , unsigned int event_type , event_conditon_t *event_condition , sensor_callback_func_t cb , void *user_data )
 125  * @brief This API registers a user defined callback function with a connected sensor for a particular event. This callback function will be called when there is a change in the state of respective sensor. user_data will be the parameter used during the callback call. Callback interval can be adjusted using even_contion_t argument.
 126  * @param[in] handle received handle value by sf_connect()
 127  * @param[in] event_type your desired event_type to register it
 128  * @param[in] event_condition input event_condition for special event. if you want to register without event_condition, just use a NULL value
 129  * @param[in] cb your define callback function
 130  * @param[in] user_data your option data that will be send when your define callback function called. if you don't have any option data, just use a NULL value
 131  * @return if it succeed, it return zero value , otherwise negative value return
 132  */
 133 DEPRECATED int sf_register_event(int handle , unsigned int event_type , event_condition_t *event_condition , sensor_callback_func_t cb , void *user_data );
 134
 135 /**
 136  * @fn int sf_unregister_event(int handle, unsigned int event_type)
 137  * @brief This API de-registers a user defined callback function with a sensor registered with the specified handle. After unsubscribe, no event will be sent to the application.
 138  * @param[in] handle received handle value by sf_connect()
 139  * @param[in] event_type your desired event_type that you want to unregister event
 140  * @return if it succeed, it return zero value , otherwise negative value return
 141  */
 142 DEPRECATED int sf_unregister_event(int handle, unsigned int event_type);
 143
 144 /**
 145  * @fn int sf_get_data(int handle , unsigned int data_id , sensor_data_t* values)
 146  * @brief This API gets raw data from a sensor with connecting the sensor-server. The type of sensor is supplied and return data is stored in the output parameter values [].
 147  * @param[in] handle received handle value by sf_connect()
 148  * @param[in] data_id predefined data_ID as every sensor in own header - sensor_xxx.h , enum xxx_data_id {}
 149  * @param[out] values return values
 150  * @return if it succeed, it return zero value , otherwise negative value return
 151  */
 152 DEPRECATED int sf_get_data(int handle , unsigned int data_id , sensor_data_t* values);
 153
 154 /**
 155  * @fn int sf_change_event_condition(int handle, unsigned int event_type, event_condition_t *event_condition)
 156  * @brief This API change a user defined callback function condition with a sensor registered with the specified handle.
 157  * @param[in] handle received handle value by sf_connect()
 158  * @param[in] event_type your desired event_type that you want to unregister event
 159  * @param[in] event_condition your desired event condition that you want to change event
 160  * @return if it succeed, it return zero value , otherwise negative value return
 161  */
 162 DEPRECATED int sf_change_event_condition(int handle, unsigned int event_type, event_condition_t *event_condition);
 163
 164 /**
 165  * @fn int sf_change_sensor_option(int handle, int option)
 166  * @brief This API change sensor option .
 167  * @param[in] handle received handle value by sf_connect()
 168  * @param[in] option your desired option that you want to turn on sensor during LCD OFF
 169  * @return if it succeed, it return zero value , otherwise negative value return
 170  */
 171
 172 DEPRECATED int sf_change_sensor_option(int handle, int option);
 173
 174 /**
 175  * @fn int sf_send_sensorhub_data(int handle, const char* buffer, int data_len)
 176  * @brief This API sends data to sensorhub.
 177  * @param[in] handle received handle by sf_connect()
 178  * @param[in] data it holds data to send to sensorhub
 179  * @param[in] data_len the length of data
 180  * @return if it succeed, it returns zero, otherwise negative value
 181  */
 182 DEPRECATED int sf_send_sensorhub_data(int handle, const char* data, int data_len);
 183
 184
 185 #ifdef __cplusplus
 186 }
 187 #endif
 188
 189
 190 #endif