1# ISensorInterface 2 3 4## 概述 5 6提供Sensor设备基本控制操作接口。 7 8操作包括获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 9 10**起始版本：** 2.2 11 12**相关模块：**[Sensor](_hdi_sensor_v10.md) 13 14 15## 汇总 16 17 18### Public 成员函数 19 20| 名称 | 描述 | 21| -------- | -------- | 22| [GetAllSensorInfo](#getallsensorinfo) ([out] struct [HdfSensorInformation](_hdf_sensor_information_v10.md)[] info) | 获取当前系统中所有类型的传感器信息。 | 23| [Enable](#enable) ([in] int sensorId) | 根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 | 24| [Disable](#disable) ([in] int sensorId) | 根据传感器设备类型标识去使能传感器信息列表里存在的设备。 | 25| [SetBatch](#setbatch) ([in] int sensorId,[in] long samplingInterval, [in] long reportInterval) | 设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 | 26| [SetMode](#setmode) ([in] int sensorId, [in] int mode) | 设置指定传感器数据上报模式。 | 27| [SetOption](#setoption) ([in] int sensorId, [in] unsigned int option) | 设置指定传感器量程、精度等可选配置。 | 28| [Register](#register) ([in] int groupId, [in] [ISensorCallback](interface_i_sensor_callback_v10.md) callbackObj) | 订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 | 29| [Unregister](#unregister) ([in] int groupId, [in] [ISensorCallback](interface_i_sensor_callback_v10.md) callbackObj) | 订阅者取消注册传感器数据回调函数。 | 30 31 32## 成员函数说明 33 34 35### Disable() 36 37``` 38ISensorInterface::Disable ([in] int sensorId) 39``` 40**描述** 41根据传感器设备类型标识去使能传感器信息列表里存在的设备。 42 43**起始版本：** 2.2 44 45**参数:** 46 47| 名称 | 描述 | 48| -------- | -------- | 49| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](_hdi_sensor_v10.md#hdfsensortypetag)。 | 50 51**返回：** 52 53如果操作成功，则返回0。 54 55如果操作失败，则返回负值。 56 57 58### Enable() 59 60``` 61ISensorInterface::Enable ([in] int sensorId) 62``` 63**描述** 64根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 65 66**起始版本：** 2.2 67 68**参数:** 69 70| 名称 | 描述 | 71| -------- | -------- | 72| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](_hdi_sensor_v10.md#hdfsensortypetag)。 | 73 74**返回：** 75 76如果操作成功，则返回0。 77 78如果操作失败，则返回负值。 79 80 81### GetAllSensorInfo() 82 83``` 84ISensorInterface::GetAllSensorInfo ([out] struct HdfSensorInformation[] info) 85``` 86**描述** 87获取当前系统中所有类型的传感器信息。 88 89**起始版本：** 2.2 90 91**参数:** 92 93| 名称 | 描述 | 94| -------- | -------- | 95| 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 | 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见[HdfSensorInformation](_hdf_sensor_information_v10.md)。 | 96 97**返回：** 98 99如果操作成功，则返回0。 100 101如果操作失败，则返回负值。 102 103 104### Register() 105 106``` 107ISensorInterface::Register ([in] int groupId, [in] ISensorCallback callbackObj ) 108``` 109**描述** 110订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 111 112**起始版本：** 2.2 113 114**参数:** 115 116| 名称 | 描述 | 117| -------- | -------- | 118| groupId | 传感器组ID。 groupId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 groupId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 | 119| callbackObj | 要注册的回调函数，详见[ISensorCallback](interface_i_sensor_callback_v10.md)。 | 120 121**返回：** 122 123如果操作成功，则返回0。 124 125如果操作失败，则返回负数。 126 127 128### SetBatch() 129 130``` 131ISensorInterface::SetBatch ([in] int sensorId, [in] long samplingInterval, [in] long reportInterval ) 132``` 133**描述** 134设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 135 136**起始版本：** 2.2 137 138**参数:** 139 140| 名称 | 描述 | 141| -------- | -------- | 142| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](_hdi_sensor_v10.md#hdfsensortypetag)。 | 143| samplingInterval | 设置指定传感器的数据采样间隔，单位纳秒。 | 144| reportInterval | 表示传感器数据上报间隔，单位纳秒。 | 145 146**返回：** 147 148如果操作成功，则返回0。 149 150如果操作失败，则返回负值。 151 152 153### SetMode() 154 155``` 156ISensorInterface::SetMode ([in] int sensorId, [in] int mode ) 157``` 158**描述** 159设置指定传感器数据上报模式。 160 161**起始版本：** 2.2 162 163**参数:** 164 165| 名称 | 描述 | 166| -------- | -------- | 167| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](_hdi_sensor_v10.md#hdfsensortypetag)。 | 168| mode | 传感器的数据上报模式，详见[HdfSensorModeType](_hdi_sensor_v10.md#hdfsensormodetype)。 | 169 170**返回：** 171 172如果操作成功，则返回0。 173 174如果操作失败，则返回负数。 175 176 177### SetOption() 178 179``` 180ISensorInterface::SetOption ([in] int sensorId, [in] unsigned int option ) 181``` 182**描述** 183设置指定传感器量程、精度等可选配置。 184 185**起始版本：** 2.2 186 187**参数:** 188 189| 名称 | 描述 | 190| -------- | -------- | 191| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](_hdi_sensor_v10.md#hdfsensortypetag)。 | 192| option | 表示要设置的选项，如测量范围和精度。 | 193 194**返回：** 195 196如果操作成功，则返回0。 197 198如果操作失败，则返回负数。 199 200 201### Unregister() 202 203``` 204ISensorInterface::Unregister ([in] int groupId, [in] ISensorCallback callbackObj ) 205``` 206**描述** 207订阅者取消注册传感器数据回调函数。 208 209**起始版本：** 2.2 210 211**参数:** 212 213| 名称 | 描述 | 214| -------- | -------- | 215| groupId | 传感器组ID。 groupId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。 groupId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。 | 216| callbackObj | 要取消注册的回调函数，详见[ISensorCallback](interface_i_sensor_callback_v10.md)。 | 217 218**返回：** 219 220如果操作成功，则返回0。 221 222如果操作失败，则返回负数。 223