Haptics

Interfaces for haptic devices. More...

Topics
	Device-specific Haptics API extensions

Files
file	haptics.h
	Main header file for haptics driver API.

Data Structures
struct	haptics_driver_api
	Haptic device API. More...

Typedefs
typedef int(*	haptics_stop_output_t) (const struct device *dev)
	Set the haptic device to stop output.
typedef int(*	haptics_start_output_t) (const struct device *dev)
	Set the haptic device to start output for a playback event.

Functions
int	haptics_start_output (const struct device *dev)
	Set the haptic device to start output for a playback event.
int	haptics_stop_output (const struct device *dev)
	Set the haptic device to stop output for a playback event.

Detailed Description

Interfaces for haptic devices.

Typedef Documentation

haptics_start_output_t

typedef int(* haptics_start_output_t) (const struct device *dev)

#include <zephyr/drivers/haptics.h>

Set the haptic device to start output for a playback event.

haptics_stop_output_t

typedef int(* haptics_stop_output_t) (const struct device *dev)

#include <zephyr/drivers/haptics.h>

Set the haptic device to stop output.

Parameters

dev	Pointer to the device structure for haptic device instance

Function Documentation

haptics_start_output()

int haptics_start_output

(

const struct device *

dev

)

#include <zephyr/drivers/haptics.h>

Set the haptic device to start output for a playback event.

Parameters

dev	Pointer to the device structure for haptic device instance

Return values

0	if successful
<0	if failed

haptics_stop_output()

int haptics_stop_output

(

const struct device *

dev

)

#include <zephyr/drivers/haptics.h>

Set the haptic device to stop output for a playback event.

Parameters

dev	Pointer to the device structure for haptic device instance

Return values

0	if successful
<0	if failed