Implementing full support for OpenRing (#113)

* renamed tau ring to OpenRing

* renamed folder

* added missing file

* renamed value parser

* Add OpenRing PPG sensor parsing and configuration

* small changes

* Add OpenRing payload-based config and PPG streaming command

* updates

* Fix OpenRing IMU frame parsing and add PPG packet decoding

* Swap OpenRing PPG start/stop control byte

* Harden OpenRing IMU stream handling for mixed packets

* Make OpenRing parser tolerant to partial/mixed packets

* Decode OpenRing PPG packet type 0x02 frames

* Fix OpenRing IMU payload offset and flexible waveform logs

* Fix OpenRing sample timestamps to be strictly monotonic

* Trace OpenRing parsed/emitted values and decouple timestamps by cmd

* Estimate IMU sample rate from packet timing for timestamp spacing

* Use fixed IMU sample spacing for timestamps

* Align IMU accel parsing with SDK sub-opcode behavior

* Ignore OpenRing accel-only IMU packets and parse accel+gyro only

* fully implemented imu

* added PPG support

* all sensors working

* implemented wall clock time sync for OpenRing

* implemented regular battery polling

* ensure timing logic while battery and time sync

* implemented openring

* added off state and default states for openring

* added openring image

* more gracefully handle sensor states and data targets for openring

* more gracefully handle sensor states and data targets for openring

* streamlined the system devices and bluetooth devices (ring-only split)

* made the openring implementation more stable

* made the openring implementation more stable

* improved the state handling

* rely on the 0x32 characharteristic only

* simplified the logic to pure software disable because everything else turns out to be unstable

* fixed a little bug in the battery logic

* fixed a little bug in the battery logic

* lib/src/models/devices/open_ring_factory.dart: changed units of sensors to match actual data

---------

Co-authored-by: TobiasRoeddiger <roeddiger@teco.edu>

Author: DennisMoschina

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.3.3
+
+* renamed TauRing to OpenRing
+* added support for OpenRing temperature sensors (`temp0`, `temp1`, `temp2`) as one 3-channel `Temperature` sensor (`°C`) with software-only on/off control
+
 ## 2.3.2
 
 * fixed some bugs with Esense devices
@@ -73,4 +78,4 @@ Connecting to earable now retries after first failure.
 
 ## 0.0.1
 
-* TODO: Describe initial release.
+* TODO: Describe initial release.

assets/wearable_icons/open_ring/openring.png

@@ -33,7 +33,8 @@ class _SensorConfigurationViewState extends State<SensorConfigurationView> {
   @override
   void initState() {
     super.initState();
-    _selectedValue = widget.configuration.values.first;
+    _selectedValue =
+        widget.configuration.offValue ?? widget.configuration.values.first;
   }
 
   @override

example/lib/widgets/sensor_configuration_view.dart

@@ -21,7 +21,7 @@ import 'src/managers/wearable_disconnect_notifier.dart';
 import 'src/models/capabilities/stereo_device.dart';
 import 'src/models/capabilities/system_device.dart';
 import 'src/models/devices/discovered_device.dart';
-import 'src/models/devices/tau_ring_factory.dart';
+import 'src/models/devices/open_ring_factory.dart';
 import 'src/models/devices/wearable.dart';
 
 export 'src/models/devices/discovered_device.dart';
@@ -111,7 +111,7 @@ class WearableManager {
     CosinussOneFactory(),
     PolarFactory(),
     DevKitFactory(),
-    TauRingFactory(),
+    OpenRingFactory(),
     EsenseFactory(),
   ];
 
@@ -262,16 +262,53 @@ class WearableManager {
   }
 
   String deviceErrorMessage(dynamic e, String deviceName) {
+    final normalizedDeviceName = _formatDisplayDeviceName(deviceName);
     return switch (e) {
-      UnsupportedDeviceException _ => 'Device "$deviceName" is not supported.',
+      UnsupportedDeviceException _ =>
+        'Device "$normalizedDeviceName" is not supported.',
       AlreadyConnectedException _ =>
-        'Device "$deviceName" is already connected.',
+        'Device "$normalizedDeviceName" is already connected.',
       ConnectionFailedException _ =>
-        'Failed to connect to device "$deviceName". Please try again.',
-      _ => e.toString(),
+        'Failed to connect to device "$normalizedDeviceName". Please try again.',
+      _ => _normalizeDeviceNameInMessage(
+        message: e.toString(),
+        rawDeviceName: deviceName,
+        normalizedDeviceName: normalizedDeviceName,
+      ),
     };
   }
 
+  String _formatDisplayDeviceName(String rawName) {
+    final trimmed = rawName.trim();
+    if (trimmed.isEmpty) {
+      return trimmed;
+    }
+
+    final replaced = trimmed.replaceFirst(
+      RegExp(r'^bcl[-_\s]*', caseSensitive: false),
+      'OpenRing-',
+    );
+
+    if (replaced == 'OpenRing-') {
+      return 'OpenRing';
+    }
+
+    return replaced;
+  }
+
+  String _normalizeDeviceNameInMessage({
+    required String message,
+    required String rawDeviceName,
+    required String normalizedDeviceName,
+  }) {
+    if (rawDeviceName.isEmpty ||
+        rawDeviceName == normalizedDeviceName ||
+        message.isEmpty) {
+      return message;
+    }
+    return message.replaceAll(rawDeviceName, normalizedDeviceName);
+  }
+
   void addPairingRule(PairingRule rule) {
     _pairingManager.addRule(rule);
   }