Coverage for src / bluetooth_sig / gatt / characteristics / rsc_feature.py: 97%

1"""RSC Feature characteristic implementation.""" 

2 

3from __future__ import annotations 

4 

5from enum import IntFlag 

6 

7import msgspec 

8 

9from ..context import CharacteristicContext 

10from .base import BaseCharacteristic 

11from .utils import DataParser 

12 

13 

14class RSCFeatures(IntFlag): 

15 """RSC Feature flags as per Bluetooth SIG specification.""" 

16 

17 INSTANTANEOUS_STRIDE_LENGTH_SUPPORTED = 0x01 

18 TOTAL_DISTANCE_SUPPORTED = 0x02 

19 WALKING_OR_RUNNING_STATUS_SUPPORTED = 0x04 

20 CALIBRATION_PROCEDURE_SUPPORTED = 0x08 

21 MULTIPLE_SENSOR_LOCATIONS_SUPPORTED = 0x10 

22 

23 

24class RSCFeatureData(msgspec.Struct, frozen=True, kw_only=True): # pylint: disable=too-few-public-methods 

25 """Parsed data from RSC Feature characteristic.""" 

26 

27 features: RSCFeatures 

28 instantaneous_stride_length_supported: bool 

29 total_distance_supported: bool 

30 walking_or_running_status_supported: bool 

31 calibration_procedure_supported: bool 

32 multiple_sensor_locations_supported: bool 

33 

34 

35class RSCFeatureCharacteristic(BaseCharacteristic[RSCFeatureData]): 

36 """RSC Feature characteristic (0x2A54). 

37 

38 Used to expose the supported features of an RSC sensor. 

39 Contains a 16-bit bitmask indicating supported measurement 

40 capabilities. 

41 """ 

42 

43 expected_length: int = 2 

44 

45 def _decode_value(self, data: bytearray, ctx: CharacteristicContext | None = None) -> RSCFeatureData: 

46 """Parse RSC feature data. 

47 

48 Format: 16-bit feature bitmask (little endian). 

49 

50 Args: 

51 data: Raw bytearray from BLE characteristic. 

52 ctx: Optional CharacteristicContext providing surrounding context (may be None). 

53 

54 Returns: 

55 RSCFeatureData containing parsed feature flags. 

56 

57 Raises: 

58 ValueError: If data format is invalid. 

59 

60 """ 

61 if len(data) < 2: 

62 raise ValueError("RSC Feature data must be at least 2 bytes") 

63 

64 # Parse 16-bit unsigned integer (little endian) 

65 feature_mask: int = DataParser.parse_int16(data, 0, signed=False) 

66 

67 # Parse feature flags according to specification 

68 return RSCFeatureData( 

69 features=RSCFeatures(feature_mask), 

70 instantaneous_stride_length_supported=bool( 

71 feature_mask & RSCFeatures.INSTANTANEOUS_STRIDE_LENGTH_SUPPORTED 

72 ), 

73 total_distance_supported=bool(feature_mask & RSCFeatures.TOTAL_DISTANCE_SUPPORTED), 

74 walking_or_running_status_supported=bool(feature_mask & RSCFeatures.WALKING_OR_RUNNING_STATUS_SUPPORTED), 

75 calibration_procedure_supported=bool(feature_mask & RSCFeatures.CALIBRATION_PROCEDURE_SUPPORTED), 

76 multiple_sensor_locations_supported=bool(feature_mask & RSCFeatures.MULTIPLE_SENSOR_LOCATIONS_SUPPORTED), 

77 ) 

78 

79 def _encode_value(self, data: RSCFeatureData) -> bytearray: 

80 """Encode RSC feature value back to bytes. 

81 

82 Args: 

83 data: RSCFeatureData containing RSC feature data 

84 

85 Returns: 

86 Encoded bytes representing the RSC features (uint16) 

87 

88 """ 

89 # Reconstruct the features bitmap from individual flags 

90 features_bitmap = 0 

91 if data.instantaneous_stride_length_supported: 

92 features_bitmap |= RSCFeatures.INSTANTANEOUS_STRIDE_LENGTH_SUPPORTED 

93 if data.total_distance_supported: 

94 features_bitmap |= RSCFeatures.TOTAL_DISTANCE_SUPPORTED 

95 if data.walking_or_running_status_supported: 

96 features_bitmap |= RSCFeatures.WALKING_OR_RUNNING_STATUS_SUPPORTED 

97 if data.calibration_procedure_supported: 

98 features_bitmap |= RSCFeatures.CALIBRATION_PROCEDURE_SUPPORTED 

99 if data.multiple_sensor_locations_supported: 

100 features_bitmap |= RSCFeatures.MULTIPLE_SENSOR_LOCATIONS_SUPPORTED 

101 

102 return DataParser.encode_int16(features_bitmap, signed=False)