ZTSport

public final class ZTSport

ZTSport provides methods to ork with ZTSport insoles & shoes

Show on GitHub

sdkVersion
ZTSportKit SDK version
Declaration
Swift

public static let sdkVersion: String
Show on GitHub
activityPluginVersion
ZTSportKit SDK activity version
Declaration
Swift

public static let activityPluginVersion: String
Show on GitHub
shared
Shared instance
Declaration
Swift

public static let shared: ZTSport
Show on GitHub
connectedDevice
Connected ZTDevice. Connection is done using ZTCoreKit.
Declaration
Swift

public var connectedDevice: ZTDevice? { get }
Show on GitHub
isActivityRunning
Activity is runnign on modules If nil is returned ZTSport.shared.readGeneralState() should be called to update it
Declaration
Swift

public var isActivityRunning: Bool? { get }
Show on GitHub


                    
                    
                    currentActivity

Current running activity instance

Declaration

Swift

public internal(set) var currentActivity: ZTSportActivity? { get set }

Show on GitHub

lastSerialNumber
Last serial number of device connected
Declaration
Swift

public var lastSerialNumber: String? { get }
Show on GitHub


                    
                    
                    currentMode

Current algorithm mode

Declaration

Swift

public private(set) var currentMode: ZTActivityMode? { get set }

Show on GitHub


                    
                    
                    onActivityStateChange

Activity state change observer

Declaration

Swift

public let onActivityStateChange: ZTSignal<(String?, ZTDeviceActualState, Error?)>

Show on GitHub


                    
                    
                    onActivityStopped

Activity state change observer

Declaration

Swift

public let onActivityStopped: ZTSignal<(String?, ZTDeviceActualState, Error?)>

Show on GitHub

onActivityDataReceived
Activity segment data received
Declaration
Swift

public let onActivityDataReceived: ZTSignal<(Data?)>
Show on GitHub
onActivityRestoreStarted
Notify about activity from previous session exist without calling stop
Declaration
Swift

public let onActivityRestoreStarted: ZTSignal<(Bool)>
Show on GitHub
onActivityStopRequestSent
Notify about activity data was sent when activity is stopped
Declaration
Swift

public let onActivityStopRequestSent: ZTSignal<(String?, Error?)>
Show on GitHub
onRawDataFlowStateChange
Notify about raw data transfer state change
Declaration
Swift

public let onRawDataFlowStateChange: ZTSignal<(ZTSport.RawDataFlowState?, Error?)>
Show on GitHub
onRawDataFlowProgresss
Notify about raw data transfer progress
Declaration
Swift

public let onRawDataFlowProgresss: ZTSignal<(Float)>
Show on GitHub

Private methods


                    
                    
                    readGeneralState(completion:)

Get actual state of connected device

Declaration

Swift

public func readGeneralState(completion: @escaping ((ZTDeviceActualState?) -> Void))

Parameters


                                completion

ZTDeviceActualState?

Show on GitHub


                    
                    
                    setMode(mode:completion:)

Algorithm selection to use with activity

Declaration

Swift

public func setMode(mode: ZTActivityMode, completion: @escaping ZTBaseResult)

Parameters


                                mode

ZTActivityMode - algo type

Show on GitHub

Data related methods


                    
                    
                    getMapRouteData(activityId:completion:)

Retrieve routing data for activity

Declaration

Swift

public func getMapRouteData(activityId: String, completion: @escaping (([String : Any]?, Data?, Error?) -> Void))

Parameters

`id`	Activity id
`completion`	( array of `ZTSportActivitySummary`, `Error`)

Show on GitHub


                    
                    
                    getSegmentDetails(activityId:segmentId:completion:)

Retrieve route segment details

Declaration

Swift

public func getSegmentDetails(activityId: String, segmentId: String, completion: @escaping ((ZTActivityRunAnalysis?, Error?) -> Void))

Parameters

`activityId`	activity id
`segmentId`	segment id
`completion`	( `ZTSportSegmentDetails`, `Error`)

Show on GitHub


                    
                    
                    getSegmentDetails(activityId:segmentId:completion:)

Retrieve route segment details

Declaration

Swift

public func getSegmentDetails(activityId: String, segmentId: String, completion: @escaping (([String : Any]?, Data?, Error?) -> Void))

Parameters

`activityId`	activity id
`segmentId`	segment id
`completion`	( `[String: Any]]`, `Error`)

Show on GitHub


                    
                    
                    getActivitySummary(id:fields:include:completion:)

Retrieve activity data for time range

Declaration

Swift

public func getActivitySummary(id: String,
                               fields: [ZTSportActivity.Field] = [],
                               include: [String]? = nil,
                               completion: @escaping (ZTResultObject<ZTSportActivitySummary>))

Parameters

`id`	activity ID
`fields`	Array of `ZTSportActivity.Field` to include in response
`include`	addtitional information to include, e.g. “supplimentalData.geoThumbnail” , “attributes.goalType”, “attributes.goalValue”
`completion`	( `ZTSportActivitySummary`, `Error`)

Show on GitHub


                    
                    
                    getActivitiesSummary(code:offset:limit:fields:include:whereOptions:duration:start:end:completion:)

Retrieve activity summary list

Declaration

Swift

public func getActivitiesSummary(code: String?,
                                 offset: Int,
                                 limit: Int,
                                 fields: [ZTSportActivity.Field] = [],
                                 include: [String]? = nil,
                                 whereOptions: [String: Any]? = nil,
                                 duration: [String: Any]? = nil,
                                 start: Date? = nil,
                                 end: Date? = nil,
                                 completion: @escaping (ZTResultArray<ZTSportActivitySummary>))

Parameters

`code`	shoe code `Optional`
`offset`	starting index of the activities
`limit`	number of objects to return
`fields`	Array of `ZTSportActivity.Field` to include in response
`include`	addtitional information to include, e.g. “supplimentalData.geoThumbnail” , “attributes.goalType”, “attributes.goalValue”
`completion`	callback with array of activities

Show on GitHub


                    
                    
                    getActivitySummary(id:fields:include:whereOptions:duration:start:end:completion:)

Retrieve activity data for time range

Declaration

Swift

public func getActivitySummary(id: String,
                               fields: [String] = [],
                               include: [String]? = nil,
                               whereOptions: [String: Any]? = nil,
                               duration: [String: Any]? = nil,
                               start: Date? = nil,
                               end: Date? = nil,
                               completion: @escaping (ZTResultObject<ZTSportActivitySummary>))

Parameters

`id`	activity ID
`fields`	Array of `ZTSportActivity.Field` to include in response
`include`	addtitional information to include, e.g. “supplimentalData.geoThumbnail” , “attributes.goalType”, “attributes.goalValue”
`completion`	( `ZTSportActivitySummary`, `Error`)

Show on GitHub


                    
                    
                    getActivitiesSummary(code:offset:limit:fields:include:whereOptions:duration:start:end:completion:)

Retrieve activity summary list

Declaration

Swift

public func getActivitiesSummary(code: String?,
                                 offset: Int,
                                 limit: Int,
                                 fields: [String],
                                 include: [String]? = nil,
                                 whereOptions: [String: Any]? = nil,
                                 duration: [String: Any]? = nil,
                                 start: Date? = nil,
                                 end: Date? = nil,
                                 completion: @escaping (ZTResultArray<ZTSportActivitySummary>))

Parameters

`code`	shoe code `Optional`
`offset`	starting index of the activities
`limit`	number of objects to return
`fields`	Array of `ZTSportActivity.Field` to include in response
`include`	addtitional information to include, e.g. “supplimentalData.geoThumbnail” , “attributes.goalType”, “attributes.goalValue”
`completion`	callback with array of activities

Show on GitHub


                    
                    
                    addActivityData(timestamp:data:completion:)

Add activity data for current activity

Declaration

Swift

public func addActivityData(timestamp: TimeInterval, data: [Any], completion: @escaping (ZTBaseResult))

Parameters

`timestamp`	`TimeInterval` current timestamp
`data`	`[Any]` array of activity data
`completion`	The closure called when the `Data` is saved.

Show on GitHub


                    
                    
                    getActivityTimelineRollup(start:end:completion:)

Retrieve timeline rollup

Declaration

Swift

public func getActivityTimelineRollup(start: Date,
                                      end: Date,
                                      completion: @escaping (ZTResultObject<ZTTimelineRollup>))

Parameters

`start`	to include activities from `Date`
`end`	to include activites up to `Date`
`completion`	(`ZTSportTimelineRollup`?,`Error`?)

Show on GitHub


                    
                    
                    getActivityRunAnalysis(activityId:completion:)

Retrieve run analysis for activity

Declaration

Swift

public func getActivityRunAnalysis(activityId: String, completion: @escaping (ZTResultObject<ZTActivityRunAnalysis>))

Parameters

`activityId`	Activity id
`completion`	callback with array of activities

Show on GitHub


                    
                    
                    getPeriodActivityAnalysis(code:period:completion:)

Retrieve activity analysis

Declaration

Swift

public func getPeriodActivityAnalysis(code: String?,
                                 period: ZTPeriod,
                                 completion: @escaping (ZTResultObject<ZTActivityAnalysis>))

Parameters

`code`	shoe code
`period`	to include activities from `Date`
`completion`	callback with array of activities

Show on GitHub


                    
                    
                    getAnalysisSqiOptimisation(activityId:completion:)

Retrieve sqi optimisation to get range of the SQI and its optimized value for stepLength and cadence

Declaration

Swift

public func getAnalysisSqiOptimisation(activityId: String, completion: @escaping (([String : Any]?, Error?) -> Void))

Parameters

`activityId`	Activity id
`completion`	callback with optional dictionary `[String: Any]?` and `Error`

Show on GitHub


                    
                    
                    startActivity(attributes:userParameters:enableRawData:samplingMode:timeout:completion:)

Start activity. Result of activity start command can be observed in completion handler.

Declaration

Swift

public func startActivity(attributes: [String: Any],
                          userParameters: ZTUserDataParameters? = nil,
                          enableRawData: Bool = false,
                          samplingMode: ZTSamplingMode? = nil,
                          timeout: Double = 15,
                          completion: ZTActivityResult?)

Parameters

`attributes`	attributes for activity. It may include `goal` and `goalValue` or any additional attributes for this activity
`userParameters`	`ZTUserDataParameters?` optional with height, weight and shoe size
`enableRawData`	enable raw data mode to write raw data
`enableFastSampling`	enable 208Hz mode (default is 104Hz)
`timeout`	timeout to start activity
`completion`	`(activityId?, ZTError?)`

Show on GitHub


                    
                    
                    stopActivity(timeout:completion:)

Stop activity

Declaration

Swift

public func stopActivity(timeout: Double = 30, completion: ZTActivityResult?)

Parameters

`timeout`	timeout to stop activity in seconds
`completion`	`(activityId?, Error?)`

Show on GitHub

ActivityGoal
Goals enum
Declaration
Swift

enum ActivityGoal : String, Codable
Show on GitHub