Haptic

---

The Haptic provides functions for controlling haptic device.

Required Header

#include <hal-device-haptic.h>

Overview

The Haptic provides the way to control haptic device like open/close, vibration and stop.

The Haptic functions provide haptic control including:

• Load/Unload for haptic hal-backend module
• Open/Close haptic device
• Getter for number of haptic device
• Check haptic validation
• Vibration haptic device

For more information on the Haptic features and the macros, see HAL Haptic programming guides and tutorials.

Typedefs
typedef struct _hal_backend_device_haptic_funcs	hal_backend_device_haptic_funcs
	Structure for Haptic functions.

---

Data Structure Documentation

struct _hal_backend_device_haptic_funcs

Structure for Haptic functions.

Since:

HAL_MODULE_DEVICE_HAPTIC 1.0

Data Fields
int(*	get_device_count )(int *count)
int(*	open_device )(int *dev_handle)
int(*	close_device )(int dev_handle)
bool(*	is_valid )(void)
int(*	vibrate_monotone )(int device_handle, int duration, int frequency, int overdrive, int level, int intensity, int priority)
int(*	stop_device )(int dev_handle)

---

Field Documentation

int(* _hal_backend_device_haptic_funcs::close_device)(int dev_handle)

Close a haptic device

int(* _hal_backend_device_haptic_funcs::get_device_count)(int *count)

Get the number of haptic devices

bool(* _hal_backend_device_haptic_funcs::is_valid)(void)

Check if the haptic device is valid

int(* _hal_backend_device_haptic_funcs::open_device)(int *dev_handle)

Open a haptic device

int(* _hal_backend_device_haptic_funcs::stop_device)(int dev_handle)

Stop haptic device

int(* _hal_backend_device_haptic_funcs::vibrate_monotone)(int device_handle, int duration, int frequency, int overdrive, int level, int intensity, int priority)

Vibrate with a monotone pattern

---

Typedef Documentation

typedef struct _hal_backend_device_haptic_funcs hal_backend_device_haptic_funcs

Structure for Haptic functions.

Since:

HAL_MODULE_DEVICE_HAPTIC 1.0

---

Enumeration Type Documentation

enum hal_device_haptic_module_duration_e

Enumerations of unlimited duration for the Haptic API.

Since:

HAL_MODULE_DEVICE_HAPTIC 1.0

Enumerator:

HAL_DEVICE_HAPTIC_MODULE_DURATION_UNLIMITED

Unlimited duration