All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups

Detailed Description

Controlling the vibration motor.

The Vibes API provides calls that let you control Pebble’s vibration motor.

The vibration motor can be used as a visceral mechanism for giving immediate feedback to the user. You can use it to highlight important moments in games, or to draw the attention of the user. However, you should use the vibration feature sparingly, because sustained use will rapidly deplete Pebble’s battery, and vibrating Pebble too much and too often can become annoying for users.

Note
When using these calls, if there is an ongoing vibration, calling any of the functions to emit (another) vibration will have no effect.

Function Documentation

void vibes_cancel ( void  )

Cancel any in-flight vibe patterns; this is a no-op if there is no on-going vibe.

void vibes_double_pulse ( void  )

Makes the watch emit two brief vibrations.

void vibes_enqueue_custom_pattern ( VibePattern  pattern)

Makes the watch emit a ‘custom’ vibration pattern.

Parameters
patternAn arbitrary vibration pattern
See Also
VibePattern
void vibes_long_pulse ( void  )

Makes the watch emit one long vibration.

void vibes_short_pulse ( void  )

Makes the watch emit one short vibration.


Data Structure Documentation

struct VibePattern

Data structure describing a vibration pattern.

A pattern consists of at least 1 vibe-on duration, optionally followed by alternating vibe-off + vibe-on durations. Each segment may have a different duration.

Example code:

// Vibe pattern: ON for 200ms, OFF for 100ms, ON for 400ms:
static const uint32_t const segments[] = { 200, 100, 400 };
VibePattern pat = {
.durations = segments,
.num_segments = ARRAY_LENGTH(segments),
};
See Also
vibes_enqueue_custom_pattern
Data Fields
const uint32_t * durations Pointer to an array of segment durations, measured in milli-seconds.

The maximum allowed duration is 10000ms.

uint32_t num_segments The length of the array of durations.