Sensor

概述

提供API来使用常见的传感器特性。例如，调用API来获取传感器和订阅或取消订阅传感器数据。

提供标准的开放api，定义常用传感器属性。

起始版本： 11

汇总

文件

类型定义

枚举

函数

类型定义说明

Sensor_Accuracy

typedef enum Sensor_Accuracy Sensor_Accuracy

描述：

枚举传感器报告的数据的精度级别。

起始版本： 11

Sensor_Event

typedef struct Sensor_Event Sensor_Event

描述：

定义传感器数据信息。

起始版本： 11

Sensor_EventCallback

typedef void(*Sensor_EventCallback)(Sensor_Event *event)

描述：

定义用于报告传感器数据的回调函数。

起始版本： 11

Sensor_Info

typedef struct Sensor_Info Sensor_Info

描述：

定义传感器信息。

起始版本： 11

Sensor_Result

typedef enum Sensor_Result Sensor_Result

描述：

定义传感器错误码。

起始版本： 11

Sensor_Subscriber

typedef struct Sensor_Subscriber Sensor_Subscriber

描述：

定义传感器订阅者信息。

起始版本： 11

Sensor_SubscriptionAttribute

typedef struct Sensor_SubscriptionAttribute Sensor_SubscriptionAttribute

描述：

定义传感器订阅属性。

起始版本： 11

Sensor_SubscriptionId

typedef struct Sensor_SubscriptionId Sensor_SubscriptionId

描述：

定义传感器订阅ID，唯一标识传感器。

起始版本： 11

Sensor_Type

typedef enum Sensor_Type Sensor_Type

描述：

枚举传感器类型。

起始版本： 11

枚举类型说明

Sensor_Accuracy

enum Sensor_Accuracy

描述：

枚举传感器报告的数据的精度级别。

起始版本： 11

Sensor_Result

enum Sensor_Result

描述：

定义传感器错误码。

起始版本： 11

Sensor_Type

enum Sensor_Type

描述：

枚举传感器类型。

起始版本： 11

函数说明

OH_Sensor_CreateInfos()

Sensor_Info **OH_Sensor_CreateInfos(uint32_t count)

描述：

用给定的数字创建一个实例数组，请参考 Sensor_Info。

起始版本： 11

参数：

返回：

如果操作成功，返回指向 Sensor_Info 实例数组的双指针；否则返回NULL。

OH_Sensor_CreateSubscriber()

Sensor_Subscriber *OH_Sensor_CreateSubscriber(void)

描述：

创建一个 Sensor_Subscriber 实例。

起始版本： 11

返回：

如果操作成功，返回指向 Sensor_Subscriber 实例的指针；否则返回NULL。

OH_Sensor_CreateSubscriptionAttribute()

Sensor_SubscriptionAttribute *OH_Sensor_CreateSubscriptionAttribute(void)

描述：

创建 Sensor_SubscriptionAttribute 实例。

起始版本： 11

返回：

如果操作成功，返回指向 Sensor_SubscriptionAttribute 实例的指针；否则返回NULL。

OH_Sensor_CreateSubscriptionId()

Sensor_SubscriptionId *OH_Sensor_CreateSubscriptionId(void)

描述：

创建一个 Sensor_SubscriptionId 实例。

起始版本： 11

返回：

如果操作成功，返回指向 Sensor_SubscriptionId 实例的指针；否则返回NULL。

OH_Sensor_DestroyInfos()

int32_t OH_Sensor_DestroyInfos(Sensor_Info **sensors, uint32_t count)

描述：

销毁实例数组并回收内存，请参考 Sensor_Info。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_Sensor_DestroySubscriber()

int32_t OH_Sensor_DestroySubscriber(Sensor_Subscriber *subscriber)

描述：

销毁 Sensor_Subscriber 实例并回收内存。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_Sensor_DestroySubscriptionAttribute()

int32_t OH_Sensor_DestroySubscriptionAttribute(Sensor_SubscriptionAttribute *attribute)

描述：

销毁 Sensor_SubscriptionAttribute 实例并回收内存。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_Sensor_DestroySubscriptionId()

int32_t OH_Sensor_DestroySubscriptionId(Sensor_SubscriptionId *id)

描述：

销毁 Sensor_SubscriptionId 实例并回收内存。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_Sensor_GetInfos()

Sensor_Result OH_Sensor_GetInfos(Sensor_Info **infos, uint32_t *count)

描述：

获取设备上所有传感器的信息。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_Sensor_Subscribe()

Sensor_Result OH_Sensor_Subscribe(const Sensor_SubscriptionId *id, const Sensor_SubscriptionAttribute *attribute, const Sensor_Subscriber *subscriber)

描述：

订阅传感器数据。系统将以指定的频率向用户报告传感器数据。 订阅加速度传感器，需要申请ohos.permission.ACCELEROMETER权限； 订阅陀螺仪传感器，需要申请ohos.permission.GYROSCOPE权限； 订阅计步器相关传感器时，需要申请ohos.permission.ACTIVITY_MOTION权限； 订阅与健康相关的传感器时，比如心率传感器，需要申请ohos.permission.READ_HEALTH_DATA权限，否则订阅失败。 订阅其余传感器不需要申请权限。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

Permission：

ohos.permission.ACCELEROMETER or ohos.permission.GYROSCOPE or ohos.permission.ACTIVITY_MOTION or ohos.permission.READ_HEALTH_DATA

OH_Sensor_Unsubscribe()

Sensor_Result OH_Sensor_Unsubscribe(const Sensor_SubscriptionId *id, const Sensor_Subscriber *subscriber)

描述：

取消订阅传感器数据。 取消订阅加速度计传感器，需要申请ohos.permission.ACCELEROMETER权限； 取消订阅陀螺仪传感器，需要申请ohos.permission.GYROSCOPE权限； 取消订阅计步器相关传感器时，需要申请ohos.permission.ACTIVITY_MOTION权限； 取消订阅与健康相关的传感器时，需要申请ohos.permission.READ_HEALTH_DATA权限，否则取消订阅失败。 取消订阅其余传感器不需要申请权限。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

Permission：

ohos.permission.ACCELEROMETER or ohos.permission.GYROSCOPE or ohos.permission.ACTIVITY_MOTION or ohos.permission.READ_HEALTH_DATA

OH_SensorEvent_GetAccuracy()

int32_t OH_SensorEvent_GetAccuracy(Sensor_Event* sensorEvent, Sensor_Accuracy *accuracy)

描述：

获取传感器数据的精度。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorEvent_GetData()

int32_t OH_SensorEvent_GetData(Sensor_Event* sensorEvent, float **data, uint32_t *length)

描述：

获取传感器数据。数据的长度和内容依赖于监听的传感器类型，传感器上报的数据格式如下：

SENSOR_TYPE_ACCELEROMETER:data[0]、data[1]、data[2]分别表示设备x、y、z轴的加速度分量，单位m/s²；

SENSOR_TYPE_GYROSCOPE:data[0]、data[1]、data[2]分别表示设备x、y、z轴的旋转角速度，单位弧度/s；

SENSOR_TYPE_AMBIENT_LIGHT:data[0]表示环境光强度，in lux；

SENSOR_TYPE_MAGNETIC_FIELD:data[0]、data[1]、data[2]分别表示设备x、y、z轴的地磁分量，单位微特斯拉；

SENSOR_TYPE_BAROMETER:data[0]表示气压值，单位hPa；

SENSOR_TYPE_HALL:data[0]表示皮套吸合状态，0表示打开，大于0表示吸附；

SENSOR_TYPE_PROXIMITY:data[0]表示接近状态，0表示接近，大于0表示远离；

SENSOR_TYPE_ORIENTATION:data[0]、data[1]、data[2]分别表示设备绕z、x、y轴的角度，单位度；

SENSOR_TYPE_GRAVITY:data[0]、data[1]、data[2]分别表示设备x、y、z轴的重力加速度分量，单位m/s²；

SENSOR_TYPE_ROTATION_VECTOR:data[0]、data[1]、data[2]分别表示设备x、y、z轴的旋转角度，单位度，data[3]表示旋转向量元素；

SENSOR_TYPE_PEDOMETER_DETECTION:data[0]表示计步检测状态，1表示检测到了步数变化；

SENSOR_TYPE_PEDOMETER:data[0]表示步数；

SENSOR_TYPE_HEART_RATE:data[0]表示心率数值。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorEvent_GetTimestamp()

int32_t OH_SensorEvent_GetTimestamp(Sensor_Event* sensorEvent, int64_t *timestamp)

描述：

获取传感器数据的时间戳。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorEvent_GetType()

int32_t OH_SensorEvent_GetType(Sensor_Event* sensorEvent, Sensor_Type *sensorType)

描述：

获取传感器类型。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorInfo_GetMaxSamplingInterval()

int32_t OH_SensorInfo_GetMaxSamplingInterval(Sensor_Info* sensor, int64_t *maxSamplingInterval)

描述：

获取传感器的最大数据上报间隔时间。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorInfo_GetMinSamplingInterval()

int32_t OH_SensorInfo_GetMinSamplingInterval(Sensor_Info* sensor, int64_t *minSamplingInterval)

描述：

获取传感器的最小数据上报间隔。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorInfo_GetName()

int32_t OH_SensorInfo_GetName (Sensor_Info* sensor, char *sensorName, uint32_t *length)

描述：

获取传感器名称。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorInfo_GetResolution()

int32_t OH_SensorInfo_GetResolution(Sensor_Info* sensor, float *resolution)

描述：

获取传感器分辨率。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorInfo_GetType()

int32_t OH_SensorInfo_GetType(Sensor_Info* sensor, Sensor_Type *sensorType)

描述：

获取传感器类型。

起始版本： 11

参数:

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorInfo_GetVendorName()

int32_t OH_SensorInfo_GetVendorName(Sensor_Info* sensor, char *vendorName, uint32_t *length)

描述：

获取传感器的厂商名称。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorSubscriber_GetCallback()

int32_t OH_SensorSubscriber_GetCallback(Sensor_Subscriber* subscriber, Sensor_EventCallback *callback)

描述：

获取用于报告传感器数据的回调函数。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorSubscriber_SetCallback()

int32_t OH_SensorSubscriber_SetCallback (Sensor_Subscriber* subscriber, const Sensor_EventCallback callback )

描述：

设置一个回调函数来报告传感器数据。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorSubscriptionAttribute_GetSamplingInterval()

int32_t OH_SensorSubscriptionAttribute_GetSamplingInterval (Sensor_SubscriptionAttribute * attribute, int64_t * samplingInterval )

描述：

获取传感器数据报告间隔。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorSubscriptionAttribute_SetSamplingInterval()

int32_t OH_SensorSubscriptionAttribute_SetSamplingInterval(Sensor_SubscriptionAttribute* attribute, const int64_t samplingInterval)

描述：

设置传感器数据报告间隔。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorSubscriptionId_GetType()

int32_t OH_SensorSubscriptionId_GetType(Sensor_SubscriptionId* id, Sensor_Type *sensorType)

描述：

获取传感器类型。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。

OH_SensorSubscriptionId_SetType()

int32_t OH_SensorSubscriptionId_SetType(Sensor_SubscriptionId* id, const Sensor_Type sensorType)

描述：

设置传感器类型。

起始版本： 11

参数：

返回：

如果操作成功返回SENSOR_SUCCESS；否则返回 Sensor_Result 中定义的错误代码。