Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Haptics Interface

Haptics Interface . More...

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

Haptics Interface .

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
devPointer 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
devPointer to the device structure for haptic device instance
Return values
0if successful
<0if 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
devPointer to the device structure for haptic device instance
Return values
0if successful
<0if failed