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