Vector Haptics Serial Terminal - Documentation

Getting Started

Browser Requirements

Hardware Requirements

• Vector Haptics device with CP2104 USB-to-UART bridge
• USB cable for connection
• Silicon Labs CP210x USB-to-UART Bridge VCP Drivers (if device doesn't appear)

Connecting to a Device

1. Connect your Vector Haptics device to your computer via USB
2. Open the Effects Terminal or Firmware Flasher
3. Click the Connect button
4. Select your device from the system dialog
5. The connection status will update to "Connected"

Using the Effects Terminal

Sending Commands

• Type commands in the input field and press Enter or click Send
• Use Arrow Up/Down keys to navigate command history
• Press Ctrl+Enter to switch to multi-line input mode
• Click any sample effect from the list to send it to the device

Building Custom Effects

1. Click "Open Primitives Tool" to access haptic primitives
2. Adjust parameters using sliders or input fields for:
   • Vibrate: Frequency, intensity, duration, and sharpness
   • Pulse: Intensity, duration, and sharpness
   • Tick: Intensity, duration, and sharpness
   • Pause: Duration for timing effects
   • ERM: Duration and intensity
3. Click "Play" to test the effect
4. Click "[+]" to append the primitive to your command
5. Send the complete command when ready

Configuring Baud Rate

Select the appropriate baud rate from the dropdown menu. Supported rates: 9600, 19200, 38400, 57600, 115200 (default).

Haptic Command Syntax

The terminal uses a command-based syntax for controlling haptic effects. Commands are separated by semicolons.

Basic Commands

Example Commands

Single vibration effect on channel 0.

Two vibration effects with a 500ms pause between them.

Sequence of pulses and ticks with pauses.

Firmware Flasher

Flashing Firmware

1. Open the Firmware Flasher page
2. Click Connect to Device and select your device
3. Review the firmware information in the table
4. Click Flash Firmware to begin flashing
5. Monitor progress in the console and progress bar
6. Wait for the "Firmware flashed successfully!" message

Erasing Flash

To erase all data from the device flash memory:

1. Connect to your device
2. Click Erase Flash
3. Confirm the action (this cannot be undone)

Configuring Baud Rate

For firmware flashing, select from: 115200, 230400, 460800, 921600 (default). Higher baud rates provide faster flashing but may be less stable.

Troubleshooting

Device Not Appearing

• Ensure the CP210x driver is installed
• Check that the device is properly connected via USB
• Try disconnecting and reconnecting the device
• Refresh the page and try again
• Check Device Manager (Windows) or System Information (Mac) to verify the device is recognized

Connection Issues

• Verify the baud rate matches your device configuration (default: 115200)
• Check that no other application is using the serial port
• Try a different USB port or cable
• Close other applications that might be accessing the serial port

Firmware Flashing Fails

• Ensure you're using Chrome or Edge browser (Safari is not supported)
• Check that the device is in bootloader mode if required
• Verify the firmware file is accessible
• Check the console (F12) for detailed error messages
• Try a lower baud rate if flashing fails repeatedly
• Ensure you have a stable internet connection (required for loading esptool-js library)

Browser Console

For debugging, open the browser console (F12) to view:

• Connection status messages
• Command execution logs
• Error messages and stack traces
• ESPTool library loading status (firmware flasher)

Sample Effects

The Effects Terminal includes several pre-configured haptic effects:

• Click - Simple click effect
• Rumble - Continuous rumble effect
• Impact Clicks - Series of impact-like clicks
• Frequency Sweep - Sweeps through frequency range
• Alert Buzz - Alert notification pattern
• Phone Ringing - Phone ring pattern
• Keyboard Taps - Keyboard typing simulation
• Notification Alert - Notification pattern

Click any effect name in the terminal to send it to your connected device.

Additional Resources

• TITAN Haptics Website
• Haptics Industry Forum
• Silicon Labs CP210x Drivers
• ESP32 esptool-js Documentation