Haptics documentation

[mhelvens]

I have some questions about the haptics documentation:

https://dev.fitbit.com/build/reference/device-api/haptics

1. The example says `vibration.start("ring")`, which is not specified under 'available patterns'. Is that an error?
2. `vibration.start` apparently returns a boolean, but the docs don't tell me what the return value means.
3. "Exact definition of what the patterns are: TBD" - When might we expect to see these definitions?
4. Which definition would be suitable to signal that an error has occurred?

[JonFitbit · Accepted solution]

We have a pending update to address this. In the meantime:

1. Ring was removed

2. Returns `true` if the pattern is accepted and will start playing, or `false` if the pattern cannot be accepted because the vibration motor is still busy.

3. Here are the patterns:

Name (An easy to remember name),
Repeat (0-6, 7=infinite),
Time (ms) (5ms granularity),
Strength (1-7, 0=off),
Ramp "yes" to ramp to next point

Bump,0,25,3,

Nudge,0,100,7,
,,100,0,
,,100,7,

Nudge Max,0,100,7,
,,100,0,
,,100,7,

Ping,0,45,4,
,,120,0,
,,150,4,

Confirmation,0,100,3,

Confirmation Max,0,100,7,

4. Whichever you prefer. One of the nudges perhaps?

[sbtn]

Regarding question 4 there are some example scenarios for haptic feedback in the design guidelines. Hopefully it can help you find something that works for the context of your error.

[mhelvens]

@JonFitbit: Thanks!

(PS: Another message I sent earlier was incorrectly marked as spam. I would appreciate it if you could have a look: https://community.fitbit.com/t5/SDK-Development/Reliable-way-to-send-an-http-request-from-device/td-...)

[mhelvens]

Very useful, thanks! This should probably be linked in the API docs.

Also, I notice that the pattern-names are capitalised in there. That might misleading, because I assume they are case-sensitive in the API (though I haven't tested this).

[adiroiban]

I have created this little demo/example to help me understand and feel the patterns https://github.com/adiroiban/fitbit-os-haptics

[Guy_]

@mhelvens- @mhelvens  - You may find the results and tool in this post useful