ZTSportKit

• Requirements
• Installation
• Usage
• License

Requirements

• iOS 13.0+
• Xcode 11.0+

Installation

Dependency Managers

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate ZTSportKit into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'
use_frameworks!

pod 'ZTSportKit', :git => "https://github.com/zhortech/ztsportkit-ios-sdk.git"

Please add post install script at the end of Podfile if there is problem to use library:

post_install do |installer|
    installer.pods_project.targets.each do |target|
      target.build_configurations.each do |config|
        config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
      end
    end
  end

Then, run the following command:

$ pod install

Swift Package Manager

To use ZTSportKit as a Swift Package Manager package just add the following in your Package.swift file.

// swift-tools-version:5.3

import PackageDescription

let package = Package(
    name: "ZTSportKit",
    dependencies: [
        .package(url: "https://github.com/zhortech/ztsportkit-ios-sdk.git", .upToNextMajor(from: "0.0.1"))
    ],
    targets: [
        .target(name: "ZTSportKit", dependencies: ["ZTSportKit"])
    ]
)

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate ZTSportKit into your project manually.

Git Submodules

• Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

$ git init

• Add ZTSportKit as a git submodule by running the following command:

$ git submodule add https://github.com/zhortech/ztsportkit-ios-sdk.git
$ git submodule update --init --recursive

• Open the new ZTSportKit folder, and drag the ZTSportKit.xcodeproj into the Project Navigator of your application's Xcode project.

  It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the ZTSportKit.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

• In the tab bar at the top of that window, open the "General" panel.

• Click on the + button under the "Embedded Binaries" section.

• You will see two different ZTSportKit.xcodeproj folders each with two different versions of the ZTSportKit.framework nested inside a Products folder.

  It does not matter which Products folder you choose from.

• Select the ZTSportKit.framework.

• And that's it!

The ZTSportKit.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Embedded Binaries

• Download the latest release from https://github.com/zhortech/ztsportkit-ios-sdk/releases
• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
• In the tab bar at the top of that window, open the "General" panel.
• Click on the + button under the "Embedded Binaries" section.
• Add the downloaded ZTSportKit.framework.
• And that's it!

Usage

Product setup

It is required to set mode type ZTActivityMode before starting activity so activity will use corresponding algorithm.

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

ZTSport.shared.setMode(mode: .running) { (error) in
    ZTLogger.instance.debug("Error setting mode to running: \(error.localizedDescription)")
}

Activity Start

To start activity first define user parameters:

let userDataParameters = ZTUserDataParameters(bodyWeight: 80, bodyHeight: 185, shoeSize: 44)

Optionally attributes can be set:

    let attributes: [String: Any] = ["goal": ZTSport.ActivityGoal.duration.rawValue, "goalValue": 3]

And call start activity with chosen atributes and userParameters. Activity id or error why activity was not started can be seen in callback block

ZTSport.shared.startActivity(attributes: attributes, userParameters: userParameters) {[weak self] id, error in
    debugPrint("Activity started: activityId=\(id ?? ""), error=\(error?.localizedDescription ?? "")")
}

Activity stop.

Activity can be stopped by calling stopActivity. Callback may return activity id or error why activity was not stopped.

    ZTSport.shared.stopActivity { [weak self] activityId, error in
        debugPrint("Activity stopped: activityId=\(activityId ?? "") stopped, error=\(error?.localizedDescription ?? "")")
    }

Activity can be also stopped automatically because of idle state and insoles went into sleep mode or battery low level.

You can subscribe for this event to be notified:

ZTSport.shared.onActivityRestoreStarted.subscribe(with: self) { (wasRestored) in
    ZTLogger.instance.debug("Previous activity restored: \(wasRestored)")
}

Activity data

Realtime data

To request activity data in real time use:

val fields = list of desired fields
ZTApi.shared.getActivityRealtimeData(activityId: activityId,fields: ["steps_count, "cadence_avg", "activity_time"]) { response, error in
    ZTLogger.instance.debug(String(describing: response))
}

Application data

You can provide application data like gps coordinates or other information for current activity calling:

//e.g. let data = [timestamp, latitude, longitude]
ZTSport.shared.addActivityData(timestamp: timestamp, data: data) { error in
    if error != nil {
        ZTLogger.instance.debug("addActivityData error - \(String(describing: error))")
    }
}

Summary

Activity summary can be received with additional fields or informationafter after activity is stopped.

let fields: [ZTSportActivity.Field] = [.steps_count, .cadence_avg, .activity_time]
let include: [String] = ["attributes.activityTitle"]
ZTSport.shared.getActivitySummary(activityId, fields, include){ activity, error in
    ZTLogger.instance.debug("activity: \(String(describing: activity))")
}

Where fields is array of of type ZTSportActivity.Field and include is array of additional attributes which can be checked in ZCloud documentation.

Raw data

Activity can store raw data. To initiate activity with raw data recording start activity with additional parameter enableRawData. Raw data will be automatically uploaded to ZCloud after activity is stopped.

    let userDataParameters = ZTUserDataParameters(bodyWeight: 80, bodyHeight: 185, shoeSize: 44)
    let attributes: [String: Any] = ["goal": ZTSport.ActivityGoal.duration.rawValue, "goalValue": 3]
    
    ZTSport.shared.startActivity(attributes: attributes, userParameters: userParameters, enableRawData: true) {[weak self] id, error in
        debugPrint("Activity started with raw data enabled: activityId=\(id ?? ""), error=\(error?.localizedDescription ?? "")")
    }

Downloading raw data is long process and new activity can't be started during it.

There is way to know progress of this process

   ZTSport.shared.onRawDataFlowProgresss.subscribe(with: self) { progress in
       debugPrint("Raw data progress=\(progress)")
   }

And there is way to know state of this process.

   ZTSport.shared.onRawDataFlowStateChange.subscribe(with: self) { (state, error) in
       debugPrint("Raw data state changed to \(state) with error \(error?.localizedDescription ?? "")")
   }

Set activity frequency

Activity frequency can be changed using appropriate parameter to start activity. Frequency can't be changed during activity.

To initiate activity with required frequency change start activity with additional parameter samplingMode: ZTSamplingMode. samplingMode currently supports 3 standard activities: Running, Walking, Jumping and allows to set custom values, e.g.

        ZTSamplingMode.custom(sequence: [5, 6, 1, 3, 0, 5, 1, 1, 3, 0, 2, 2, 8,0])

Gyroscope parameters: 5 bytes, Accelerometer parameters: 5 bytes, Magnetometer parameters: 4 bytes Refer to the LSM6DSL AN5040 Application note and the LSM6DSL datasheet for MEMS register configurations, as well as the LIS2MDL datasheet and the LIS2MDL AN5069 Application note for Magnetometer register configuration.

Author

ZhorTech @zhortech

License

ZTSportKit is released under the MIT license. See LICENSE for details.