**FTMS TypeScript API**

***

# FTMS TypeScript API

## Classes

- [RawCodecError](https://deancochran.github.io/ftms/api/typescript/classes/RawCodecError.md)

## Interfaces

- [DecodedIndoorBikeData](https://deancochran.github.io/ftms/api/typescript/interfaces/DecodedIndoorBikeData.md)
- [FtmsCapabilityC7Evidence](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsCapabilityC7Evidence.md)
- [FtmsCapabilityCharacteristic](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsCapabilityCharacteristic.md)
- [FtmsCapabilityReport](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsCapabilityReport.md)
- [FtmsCapabilitySnapshot](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsCapabilitySnapshot.md)
- [FtmsControlFormatOptions](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsControlFormatOptions.md)
- [FtmsControlRequestRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsControlRequestRaw.md)
- [FtmsControlResponseContext](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsControlResponseContext.md)
- [FtmsControlResponseRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsControlResponseRaw.md)
- [FtmsDecodeErrorDetails](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsDecodeErrorDetails.md)
- [FtmsDiagnostic](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsDiagnostic.md)
- [FtmsEncodeError](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsEncodeError.md)
- [FTMSFeatures](https://deancochran.github.io/ftms/api/typescript/interfaces/FTMSFeatures.md)
- [FtmsFeaturesRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsFeaturesRaw.md)
- [FtmsMachineStatusRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsMachineStatusRaw.md)
- [FtmsMeasurementFormatOptions](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsMeasurementFormatOptions.md)
- [FtmsMeasurementRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsMeasurementRaw.md)
- [FtmsParserDefinition](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsParserDefinition.md)
- [FtmsParserDiagnostics](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsParserDiagnostics.md)
- [FtmsRange](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsRange.md)
- [FtmsRangeFormatOptions](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsRangeFormatOptions.md)
- [FtmsRangeInspection](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsRangeInspection.md)
- [FtmsRangeInspectionCandidate](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsRangeInspectionCandidate.md)
- [FtmsRangeRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsRangeRaw.md)
- [FTMSResponse](https://deancochran.github.io/ftms/api/typescript/interfaces/FTMSResponse.md)
- [FtmsResponseDecodeError](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsResponseDecodeError.md)
- [FtmsRuntimeMetrics](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsRuntimeMetrics.md)
- [FtmsStatusPayload](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsStatusPayload.md)
- [FtmsSupportedRange](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsSupportedRange.md)
- [FtmsTrainingStatusDetails](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsTrainingStatusDetails.md)
- [FtmsTrainingStatusRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsTrainingStatusRaw.md)
- [FtmsUniversalMeasurementDiagnostics](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsUniversalMeasurementDiagnostics.md)
- [FtmsUniversalMeasurementMetrics](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsUniversalMeasurementMetrics.md)
- [FtmsUniversalMeasurementRaw](https://deancochran.github.io/ftms/api/typescript/interfaces/FtmsUniversalMeasurementRaw.md)
- [IndoorBikeDiagnostics](https://deancochran.github.io/ftms/api/typescript/interfaces/IndoorBikeDiagnostics.md)
- [IndoorBikeMeasurement](https://deancochran.github.io/ftms/api/typescript/interfaces/IndoorBikeMeasurement.md)
- [IndoorBikeRawFields](https://deancochran.github.io/ftms/api/typescript/interfaces/IndoorBikeRawFields.md)
- [ParsedFtmsIndoorBikeData](https://deancochran.github.io/ftms/api/typescript/interfaces/ParsedFtmsIndoorBikeData.md)
- [ParsedFtmsPayload](https://deancochran.github.io/ftms/api/typescript/interfaces/ParsedFtmsPayload.md)

## Type Aliases

- [FtmsCapabilityDeclaration](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityDeclaration.md)
- [FtmsCapabilityDecode](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityDecode.md)
- [FtmsCapabilityDiagnostic](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityDiagnostic.md)
- [FtmsCapabilityDiscovery](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityDiscovery.md)
- [FtmsCapabilityFeature](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityFeature.md)
- [FtmsCapabilityKnownKind](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityKnownKind.md)
- [FtmsCapabilityObservation](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityObservation.md)
- [FtmsCapabilityOperation](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityOperation.md)
- [FtmsCapabilityPrerequisite](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityPrerequisite.md)
- [FtmsCapabilityPresence](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityPresence.md)
- [FtmsCapabilityRange](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityRange.md)
- [FtmsCapabilityRangeValue](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityRangeValue.md)
- [FtmsCapabilityReadReason](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityReadReason.md)
- [FtmsCapabilityReadState](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityReadState.md)
- [FtmsCapabilityScope](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCapabilityScope.md)
- [FtmsCharacteristicKind](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsCharacteristicKind.md)
- [FtmsControlRequest](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsControlRequest.md)
- [FtmsControlResponseParameter](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsControlResponseParameter.md)
- [FtmsDecodeError](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsDecodeError.md)
- [FtmsDecodeResult](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsDecodeResult.md)
- [FtmsDecodeSuccess](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsDecodeSuccess.md)
- [FtmsDiagnosticCode](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsDiagnosticCode.md)
- [FtmsEncodeResult](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsEncodeResult.md)
- [FtmsMachineStatusParameter](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsMachineStatusParameter.md)
- [FtmsMachineType](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsMachineType.md)
- [FtmsMeasurementDecodeResult](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsMeasurementDecodeResult.md)
- [FtmsMeasurementFamily](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsMeasurementFamily.md)
- [FtmsRangeInspectionStatus](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsRangeInspectionStatus.md)
- [FtmsRangeKind](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsRangeKind.md)
- [FtmsRangeProfile](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsRangeProfile.md)
- [FtmsRangeRawKind](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsRangeRawKind.md)
- [FtmsResponseDecodeResult](https://deancochran.github.io/ftms/api/typescript/type-aliases/FtmsResponseDecodeResult.md)

## Variables

- [FTMS\_CHARACTERISTICS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_CHARACTERISTICS.md)
- [FTMS\_DATA\_CHARACTERISTICS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_DATA_CHARACTERISTICS.md)
- [FTMS\_FEATURE\_BITS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_FEATURE_BITS.md)
- [FTMS\_MACHINE\_DATA\_CHARACTERISTIC\_UUIDS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_MACHINE_DATA_CHARACTERISTIC_UUIDS.md)
- [FTMS\_MACHINE\_STATUS\_LABELS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_MACHINE_STATUS_LABELS.md)
- [FTMS\_MACHINE\_STATUS\_OPCODES](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_MACHINE_STATUS_OPCODES.md)
- [FTMS\_MEASUREMENT\_AND\_STATUS\_CHARACTERISTIC\_UUIDS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_MEASUREMENT_AND_STATUS_CHARACTERISTIC_UUIDS.md)
- [FTMS\_OPCODES](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_OPCODES.md)
- [FTMS\_PARSER\_DEFINITIONS\_BY\_UUID](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_PARSER_DEFINITIONS_BY_UUID.md)
- [FTMS\_RESULT\_CODES](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_RESULT_CODES.md)
- [FTMS\_SERVICE\_UUIDS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_SERVICE_UUIDS.md)
- [FTMS\_STATUS\_CHARACTERISTICS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_STATUS_CHARACTERISTICS.md)
- [FTMS\_TARGET\_SETTING\_BITS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_TARGET_SETTING_BITS.md)
- [FTMS\_TRAINING\_STATUS\_LABELS](https://deancochran.github.io/ftms/api/typescript/variables/FTMS_TRAINING_STATUS_LABELS.md)

## Functions

- [decodeFtmsControlRequestRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsControlRequestRaw.md)
- [decodeFtmsControlResponse](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsControlResponse.md)
- [decodeFtmsControlResponseRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsControlResponseRaw.md)
- [decodeFtmsFeatures](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsFeatures.md)
- [decodeFtmsFeaturesRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsFeaturesRaw.md)
- [decodeFtmsMachineStatusRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsMachineStatusRaw.md)
- [decodeFtmsMeasurement](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsMeasurement.md)
- [decodeFtmsMeasurementRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsMeasurementRaw.md)
- [decodeFtmsRange](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsRange.md)
- [decodeFtmsRangeRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsRangeRaw.md)
- [decodeFtmsTrainingStatusRaw](https://deancochran.github.io/ftms/api/typescript/functions/decodeFtmsTrainingStatusRaw.md)
- [decodeIndoorBikeData](https://deancochran.github.io/ftms/api/typescript/functions/decodeIndoorBikeData.md)
- [decodeSupportedHeartRateRange](https://deancochran.github.io/ftms/api/typescript/functions/decodeSupportedHeartRateRange.md)
- [decodeSupportedInclinationRange](https://deancochran.github.io/ftms/api/typescript/functions/decodeSupportedInclinationRange.md)
- [decodeSupportedPowerRange](https://deancochran.github.io/ftms/api/typescript/functions/decodeSupportedPowerRange.md)
- [decodeSupportedResistanceRange](https://deancochran.github.io/ftms/api/typescript/functions/decodeSupportedResistanceRange.md)
- [decodeSupportedSpeedRange](https://deancochran.github.io/ftms/api/typescript/functions/decodeSupportedSpeedRange.md)
- [encodeFtmsControlRequest](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsControlRequest.md)
- [encodeFtmsControlRequestRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsControlRequestRaw.md)
- [encodeFtmsControlResponseRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsControlResponseRaw.md)
- [encodeFtmsFeaturesRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsFeaturesRaw.md)
- [encodeFtmsMachineStatusRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsMachineStatusRaw.md)
- [encodeFtmsMeasurementRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsMeasurementRaw.md)
- [encodeFtmsRangeRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsRangeRaw.md)
- [encodeFtmsTrainingStatusRaw](https://deancochran.github.io/ftms/api/typescript/functions/encodeFtmsTrainingStatusRaw.md)
- [evaluateFtmsCapabilities](https://deancochran.github.io/ftms/api/typescript/functions/evaluateFtmsCapabilities.md)
- [getFtmsParserDefinition](https://deancochran.github.io/ftms/api/typescript/functions/getFtmsParserDefinition.md)
- [getFtmsResultCodeName](https://deancochran.github.io/ftms/api/typescript/functions/getFtmsResultCodeName.md)
- [inspectFtmsRangeRaw](https://deancochran.github.io/ftms/api/typescript/functions/inspectFtmsRangeRaw.md)
- [listFtmsParserDefinitions](https://deancochran.github.io/ftms/api/typescript/functions/listFtmsParserDefinitions.md)
- [parseFtmsCrossTrainerData](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsCrossTrainerData.md)
- [~~parseFtmsIndoorBikeData~~](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsIndoorBikeData.md)
- [parseFtmsIndoorBikeMeasurement](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsIndoorBikeMeasurement.md)
- [parseFtmsMachineStatus](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsMachineStatus.md)
- [parseFtmsRowerData](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsRowerData.md)
- [parseFtmsStairClimberData](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsStairClimberData.md)
- [parseFtmsStepClimberData](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsStepClimberData.md)
- [parseFtmsTrainingStatus](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsTrainingStatus.md)
- [parseFtmsTreadmillData](https://deancochran.github.io/ftms/api/typescript/functions/parseFtmsTreadmillData.md)
- [parseRegisteredFtmsPayload](https://deancochran.github.io/ftms/api/typescript/functions/parseRegisteredFtmsPayload.md)
- [tryEncodeFtmsControlRequest](https://deancochran.github.io/ftms/api/typescript/functions/tryEncodeFtmsControlRequest.md)
