Warning

You are reading an old version of this documentation. If you want up-to-date information, please have a look at 2024.6 .

C - Set platform vibration

Command

C<vibration><duration>

Parameters

  • vibration - Vibration type given by a letter (A-D-E-F-I-J-K), refer to vibration types.

  • duration - Duration of the vibration

    • if set to 0, the vibration will continue until the vibration timeout is reached (30000 ms) or until it is stopped by the command HC.

    • if set to a value between 1 and 30000 ms, the vibration will last for the specified amount of time.

    • if the parameter is not specified, it will vibrate for the time configured in Asycube Studio, refer to Duration of vibration.

Returns

C<vibration><duration>, where

  • <vibration> is the requested vibration type

  • <duration> is the total duration required by the system to perform the requested vibration duration (communication time not included).

Note

The effective vibration duration always corresponds to the value requested in the command. However, the duration value returned in the response depends on different conditions. Please refer to vibration timing for more details.

Description

Use this command to vibrate the platform with a specific vibration and duration. The platform vibration can be edited in Asycube Studio, please refer to the Recipe Wizard Platform Vibration.

During an on-going vibration, use the command ?42 - Get platform remaining duration to get its remaining duration.

Types of vibration

An Asycube has different types of vibration corresponding to a direction of vibration. A letter is assigned to each type of vibration as followed:

  • A - Forward

  • D - Left

  • E - Right

  • F - Backward

  • I - Flip

  • K - Cross Axis centering

  • J - Long Axis centering

../../../../_images/vibration_type.png

Fig. 117 Vibration types

Note

The vibration types K and J are only available on Asycube 240, 380 and 530.

Usage Example

In the first example below, the selected vibration type is F and the requested duration is 100 milliseconds. In the response a duration of 60 milliseconds is added as explained in vibration timing.

command : CF100
response : CF00160

In the second example below, the selected vibration type is A and the parameter duration is not specified. The platform vibrates for the time configured in Asycube Studio (100 milliseconds in this case).

Command : CA
Response : CA00160

In this last example, the selected vibration type is I and it vibrates forever. Command HC can be used to stop the vibration.

Command : CI0
Response : CI00000