UX improvements

CHANGELOG.md

@@ -1,15 +1,28 @@
-#### 2.0.3 (2025-04-08)
+### 2.0.7 (2025-04-18)
+- add Biketerra.com keymap
+- some UX improvements
+
+### 2.0.6 (2025-04-15)
+- fix MyWhoosh up / downshift button assignment (I key vs K key)
+
+### 2.0.5 (2025-04-13)
+- fix Zwift Click button assignment (#12)
+
+### 2.0.4 (2025-04-10)
+- vibrate Zwift Play / Zwift Ride controller on gear shift (thanks @cagnulein, closes #16)
+
+### 2.0.3 (2025-04-08)
 - adjust TrainingPeaks Virtual key mapping (#12)
 - attempt to reconnect device if connection is lost 
 - Android: detect freeform windows for MyWhoosh + TrainingPeaks Virtual keymaps 
 
-#### 2.0.2 (2025-04-07)
+### 2.0.2 (2025-04-07)
 - fix bluetooth scan issues on older Android devices by asking for location permission
 
-#### 2.0.1 (2025-04-06)
+### 2.0.1 (2025-04-06)
 - long pressing a button will trigger the action again every 250ms
 
-#### 2.0.0 (2025-04-06)
+### 2.0.0 (2025-04-06)
 - You can now customize the actions (touches, mouse clicks or keyboard keys) for all buttons on all supported Zwift devices
 - now shows the battery level of the connected devices
 - add more troubleshooting information

README.md

@@ -23,6 +23,7 @@ Get the latest version here: https://github.com/jonasbark/swiftcontrol/releases
 ## Supported Apps
 - MyWhoosh
 - indieVelo / Training Peaks
+- Biketerra.com
 - any other: 
   - Android: you can customize simulated touch points of all your buttons in the app
   - Desktop: you can customize keyboard shortcuts and mouse clicks in the app
@@ -35,7 +36,9 @@ Get the latest version here: https://github.com/jonasbark/swiftcontrol/releases
 ## Supported Platforms
 - Android
 - macOS
-- Windows (make sure you have installed the "[Microsoft Visual C++ Runtime libraries](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)")
+- Windows 
+  - make sure you have installed the "[Microsoft Visual C++ Runtime libraries](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)"
+  - Windows may flag the app as virus. I think it does so because the app does control the mouse and keyboard.
 - [Web](https://jonasbark.github.io/swiftcontrol/) (you won't be able to do much)
 
 ## Troubleshooting

lib/bluetooth/ble.dart

@@ -23,6 +23,7 @@ class Constants {
   static const BC1 = 0x09;
 
   static final RIDE_ON = Uint8List.fromList([0x52, 0x69, 0x64, 0x65, 0x4f, 0x6e]);
+  static final VIBRATE_PATTERN = Uint8List.fromList([0x12, 0x12, 0x08, 0x0A, 0x06, 0x08, 0x02, 0x10, 0x00, 0x18]);
 
   // these don't actually seem to matter, its just the header has to be 7 bytes RIDEON + 2
   static final REQUEST_START = Uint8List.fromList([0, 9]); //byteArrayOf(1, 2)

lib/bluetooth/devices/base_device.dart

@@ -27,6 +27,7 @@ abstract class BaseDevice {
 
   bool supportsEncryption = true;
 
+  BleCharacteristic? syncRxCharacteristic;
   Timer? _longPressTimer;
 
   List<int> get startCommand => Constants.RIDE_ON + Constants.RESPONSE_START_CLICK;
@@ -114,7 +115,7 @@ abstract class BaseDevice {
     final syncTxCharacteristic = customService.characteristics.firstOrNullWhere(
       (characteristic) => characteristic.uuid == BleUuid.ZWIFT_SYNC_TX_CHARACTERISTIC_UUID,
     );
-    final syncRxCharacteristic = customService.characteristics.firstOrNullWhere(
+    syncRxCharacteristic = customService.characteristics.firstOrNullWhere(
       (characteristic) => characteristic.uuid == BleUuid.ZWIFT_SYNC_RX_CHARACTERISTIC_UUID,
     );
 
@@ -135,15 +136,15 @@ abstract class BaseDevice {
       BleInputProperty.indication,
     );
 
-    await _setupHandshake(syncRxCharacteristic);
+    await _setupHandshake();
   }
 
-  Future<void> _setupHandshake(BleCharacteristic syncRxCharacteristic) async {
+  Future<void> _setupHandshake() async {
     if (supportsEncryption) {
       await UniversalBle.writeValue(
         device.deviceId,
         customServiceId,
-        syncRxCharacteristic.uuid,
+        syncRxCharacteristic!.uuid,
         Uint8List.fromList([
           ...Constants.RIDE_ON,
           ...Constants.REQUEST_START,
@@ -155,7 +156,7 @@ abstract class BaseDevice {
       await UniversalBle.writeValue(
         device.deviceId,
         customServiceId,
-        syncRxCharacteristic.uuid,
+        syncRxCharacteristic!.uuid,
         Constants.RIDE_ON,
         BleOutputProperty.withoutResponse,
       );
@@ -246,15 +247,11 @@ abstract class BaseDevice {
                   // we don't want to trigger the long press timer for the on/off buttons
                   _longPressTimer?.cancel();
                   _longPressTimer = Timer.periodic(const Duration(milliseconds: 250), (timer) async {
-                    for (final action in buttonsClicked) {
-                      actionStreamInternal.add(LogNotification(await actionHandler.performAction(action)));
-                    }
+                    _performActions(buttonsClicked, true);
                   });
                 }
 
-                for (final action in buttonsClicked) {
-                  actionStreamInternal.add(LogNotification(await actionHandler.performAction(action)));
-                }
+                _performActions(buttonsClicked, false);
               }
             })
             .catchError((e) {
@@ -265,4 +262,25 @@ abstract class BaseDevice {
   }
 
   Future<List<ZwiftButton>?> processClickNotification(Uint8List message);
+
+  Future<void> _performActions(List<ZwiftButton> buttonsClicked, bool repeated) async {
+    if (!repeated &&
+        buttonsClicked.any(((e) => e.action == InGameAction.shiftDown || e.action == InGameAction.shiftUp))) {
+      await _vibrate();
+    }
+    for (final action in buttonsClicked) {
+      actionStreamInternal.add(LogNotification(await actionHandler.performAction(action)));
+    }
+  }
+
+  Future<void> _vibrate() async {
+    final vibrateCommand = Uint8List.fromList([...Constants.VIBRATE_PATTERN, 0x20]);
+    await UniversalBle.writeValue(
+      device.deviceId,
+      customServiceId,
+      syncRxCharacteristic!.uuid,
+      supportsEncryption ? zapEncryption.encrypt(vibrateCommand) : vibrateCommand,
+      BleOutputProperty.withoutResponse,
+    );
+  }
 }

lib/bluetooth/messages/click_notification.dart

@@ -12,8 +12,8 @@ class ClickNotification extends BaseNotification {
   ClickNotification(Uint8List message) {
     final status = ClickKeyPadStatus.fromBuffer(message);
     buttonsClicked = [
-      if (status.buttonPlus == PlayButtonStatus.ON) ZwiftButton.shiftUpLeft,
-      if (status.buttonMinus == PlayButtonStatus.ON) ZwiftButton.shiftDownRight,
+      if (status.buttonPlus == PlayButtonStatus.ON) ZwiftButton.shiftUpRight,
+      if (status.buttonMinus == PlayButtonStatus.ON) ZwiftButton.shiftDownLeft,
     ];
   }
 

lib/main.dart

@@ -45,7 +45,7 @@ class SwiftPlayApp extends StatelessWidget {
       title: 'SwiftControl',
       theme: AppTheme.light,
       darkTheme: AppTheme.dark,
-      themeMode: ThemeMode.system,
+      themeMode: ThemeMode.dark,
       home: const RequirementsPage(),
     );
   }

lib/pages/touch_area.dart

@@ -85,7 +85,9 @@ class _TouchAreaSetupPageState extends State<TouchAreaSetupPage> {
           final KeyPair keyPair;
           actionHandler.supportedApp!.keymap.keyPairs.add(
             keyPair = KeyPair(
-              touchPosition: context.size!.center(Offset.zero),
+              touchPosition: context.size!
+                  .center(Offset.zero)
+                  .translate(actionHandler.supportedApp!.keymap.keyPairs.length * 40, 0),
               buttons: [_pressedButton!],
               physicalKey: null,
               logicalKey: null,
@@ -130,6 +132,49 @@ class _TouchAreaSetupPageState extends State<TouchAreaSetupPage> {
                   setState(() {});
                 },
               ),
+              PopupMenuItem(
+                child: PopupMenuButton<PhysicalKeyboardKey>(
+                  padding: EdgeInsets.zero,
+                  itemBuilder:
+                      (context) => [
+                        PopupMenuItem<PhysicalKeyboardKey>(
+                          value: PhysicalKeyboardKey.mediaPlayPause,
+                          child: const Text('Media: Play/Pause'),
+                        ),
+                        PopupMenuItem<PhysicalKeyboardKey>(
+                          value: PhysicalKeyboardKey.mediaStop,
+                          child: const Text('Media: Stop'),
+                        ),
+                        PopupMenuItem<PhysicalKeyboardKey>(
+                          value: PhysicalKeyboardKey.mediaTrackPrevious,
+                          child: const Text('Media: Previous'),
+                        ),
+                        PopupMenuItem<PhysicalKeyboardKey>(
+                          value: PhysicalKeyboardKey.mediaTrackNext,
+                          child: const Text('Media: Next'),
+                        ),
+                        PopupMenuItem<PhysicalKeyboardKey>(
+                          value: PhysicalKeyboardKey.audioVolumeUp,
+                          child: const Text('Media: Volume Up'),
+                        ),
+                        PopupMenuItem<PhysicalKeyboardKey>(
+                          value: PhysicalKeyboardKey.audioVolumeDown,
+                          child: const Text('Media: Volume Down'),
+                        ),
+                      ],
+                  onSelected: (key) {
+                    keyPair.physicalKey = key;
+                    keyPair.logicalKey = null;
+
+                    setState(() {});
+                  },
+                  child: SizedBox(
+                    height: 50,
+                    width: 180,
+                    child: Align(alignment: Alignment.centerLeft, child: Text('Set Media key')),
+                  ),
+                ),
+              ),
               PopupMenuItem<PhysicalKeyboardKey>(
                 value: null,
                 child: const Text('Use as touch button'),
@@ -282,17 +327,25 @@ class _TouchDot extends StatelessWidget {
           ),
         ),
 
-        Text(label, style: TextStyle(color: Colors.black, fontSize: 12)),
-        if (keyPair.physicalKey != null)
-          Text(switch (keyPair.physicalKey) {
-            PhysicalKeyboardKey.mediaPlayPause => 'Media: Play/Pause',
-            PhysicalKeyboardKey.mediaStop => 'Media: Stop',
-            PhysicalKeyboardKey.mediaTrackPrevious => 'Media: Previous',
-            PhysicalKeyboardKey.mediaTrackNext => 'Media: Next',
-            PhysicalKeyboardKey.audioVolumeUp => 'Media: Volume Up',
-            PhysicalKeyboardKey.audioVolumeDown => 'Media: Volume Down',
-            _ => keyPair.logicalKey?.keyLabel ?? 'Unknown',
-          }, style: TextStyle(color: Colors.grey, fontSize: 12)),
+        Container(
+          color: Colors.white.withAlpha(180),
+          child: Column(
+            crossAxisAlignment: CrossAxisAlignment.start,
+            children: [
+              Text(label, style: TextStyle(color: Colors.black, fontSize: 12)),
+              if (keyPair.physicalKey != null)
+                Text(switch (keyPair.physicalKey) {
+                  PhysicalKeyboardKey.mediaPlayPause => 'Media: Play/Pause',
+                  PhysicalKeyboardKey.mediaStop => 'Media: Stop',
+                  PhysicalKeyboardKey.mediaTrackPrevious => 'Media: Previous',
+                  PhysicalKeyboardKey.mediaTrackNext => 'Media: Next',
+                  PhysicalKeyboardKey.audioVolumeUp => 'Media: Volume Up',
+                  PhysicalKeyboardKey.audioVolumeDown => 'Media: Volume Down',
+                  _ => keyPair.logicalKey?.keyLabel ?? 'Unknown',
+                }, style: TextStyle(color: Colors.black87, fontSize: 12)),
+            ],
+          ),
+        ),
       ],
     );
   }

lib/utils/keymap/apps/biketerra.dart

@@ -0,0 +1,49 @@
+import 'package:accessibility/accessibility.dart';
+import 'package:dartx/dartx.dart';
+import 'package:flutter/services.dart';
+import 'package:swift_control/utils/keymap/apps/supported_app.dart';
+
+import '../buttons.dart';
+import '../keymap.dart';
+
+class Biketerra extends SupportedApp {
+  Biketerra()
+    : super(
+        name: 'Biketerra',
+        packageName: "biketerra",
+        keymap: Keymap(
+          keyPairs: [
+            KeyPair(
+              buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.shiftDown).toList(),
+              physicalKey: PhysicalKeyboardKey.keyS,
+              logicalKey: LogicalKeyboardKey.keyS,
+            ),
+            KeyPair(
+              buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.shiftUp).toList(),
+              physicalKey: PhysicalKeyboardKey.keyW,
+              logicalKey: LogicalKeyboardKey.keyW,
+            ),
+            KeyPair(
+              buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.navigateRight).toList(),
+              physicalKey: PhysicalKeyboardKey.arrowRight,
+              logicalKey: LogicalKeyboardKey.arrowRight,
+            ),
+            KeyPair(
+              buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.navigateLeft).toList(),
+              physicalKey: PhysicalKeyboardKey.arrowLeft,
+              logicalKey: LogicalKeyboardKey.arrowLeft,
+            ),
+            KeyPair(
+              buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.toggleUi).toList(),
+              physicalKey: PhysicalKeyboardKey.keyU,
+              logicalKey: LogicalKeyboardKey.keyU,
+            ),
+          ],
+        ),
+      );
+}
+
+extension WindowSize on WindowEvent {
+  int get width => right - left;
+  int get height => bottom - top;
+}

lib/utils/keymap/apps/my_whoosh.dart

@@ -17,13 +17,13 @@ class MyWhoosh extends SupportedApp {
           keyPairs: [
             KeyPair(
               buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.shiftDown).toList(),
-              physicalKey: PhysicalKeyboardKey.keyK,
-              logicalKey: LogicalKeyboardKey.keyK,
+              physicalKey: PhysicalKeyboardKey.keyI,
+              logicalKey: LogicalKeyboardKey.keyI,
             ),
             KeyPair(
               buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.shiftUp).toList(),
-              physicalKey: PhysicalKeyboardKey.keyI,
-              logicalKey: LogicalKeyboardKey.keyI,
+              physicalKey: PhysicalKeyboardKey.keyK,
+              logicalKey: LogicalKeyboardKey.keyK,
             ),
             KeyPair(
               buttons: ZwiftButton.values.filter((e) => e.action == InGameAction.navigateRight).toList(),

lib/utils/keymap/apps/supported_app.dart

@@ -1,6 +1,7 @@
 import 'dart:ui';
 
 import 'package:accessibility/accessibility.dart';
+import 'package:swift_control/utils/keymap/apps/biketerra.dart';
 import 'package:swift_control/utils/keymap/apps/training_peaks.dart';
 
 import '../../single_line_exception.dart';
@@ -27,7 +28,7 @@ abstract class SupportedApp {
 
   const SupportedApp({required this.name, required this.packageName, required this.keymap});
 
-  static final List<SupportedApp> supportedApps = [MyWhoosh(), TrainingPeaks(), CustomApp()];
+  static final List<SupportedApp> supportedApps = [MyWhoosh(), TrainingPeaks(), Biketerra(), CustomApp()];
 
   @override
   String toString() {

lib/widgets/custom_keymap_selector.dart

@@ -99,43 +99,6 @@ class _HotKeyListenerState extends State<HotKeyListenerDialog> {
                   children: [
                     Text("Press a key on your keyboard to assign to ${_pressedButton.toString()}"),
                     Text(_formatKey(_pressedKey)),
-                    PopupMenuButton<PhysicalKeyboardKey>(
-                      tooltip: 'Drag or click for special keys',
-                      itemBuilder:
-                          (context) => [
-                            PopupMenuItem<PhysicalKeyboardKey>(
-                              value: PhysicalKeyboardKey.mediaPlayPause,
-                              child: const Text('Media: Play/Pause'),
-                            ),
-                            PopupMenuItem<PhysicalKeyboardKey>(
-                              value: PhysicalKeyboardKey.mediaStop,
-                              child: const Text('Media: Stop'),
-                            ),
-                            PopupMenuItem<PhysicalKeyboardKey>(
-                              value: PhysicalKeyboardKey.mediaTrackPrevious,
-                              child: const Text('Media: Previous'),
-                            ),
-                            PopupMenuItem<PhysicalKeyboardKey>(
-                              value: PhysicalKeyboardKey.mediaTrackNext,
-                              child: const Text('Media: Next'),
-                            ),
-                            PopupMenuItem<PhysicalKeyboardKey>(
-                              value: PhysicalKeyboardKey.audioVolumeUp,
-                              child: const Text('Media: Volume Up'),
-                            ),
-                            PopupMenuItem<PhysicalKeyboardKey>(
-                              value: PhysicalKeyboardKey.audioVolumeDown,
-                              child: const Text('Media: Volume Down'),
-                            ),
-                          ],
-                      onSelected: (key) {
-                        widget.customApp.setKey(_pressedButton!, physicalKey: key, logicalKey: null);
-                        Navigator.pop(context, key);
-                      },
-                      child: IgnorePointer(
-                        child: ElevatedButton(onPressed: () {}, child: Text('Or choose special key')),
-                      ),
-                    ),
                   ],
                 ),
               ),

pubspec.yaml

@@ -1,7 +1,7 @@
 name: swift_control
 description: "SwiftControl - Control your virtual riding"
 publish_to: 'none' # Remove this line if you wish to publish to pub.dev
-version: 2.0.3+0
+version: 2.0.7+0
 
 environment:
   sdk: ^3.7.0