Product Registration (v3.3.0)

When you upgrade from 3.2.0 to 3.3.0, there are only two things you have to change.

1. Add productInfo (the device info) to the Asleep.setup() call.
2. After you confirm that setup has finished (setupDidComplete), proceed in the order initAsleepConfig → start tracking.

The rest of the code is the same as 3.2.0 — starting and stopping tracking, getting reports, and so on.

[App launch]
   │
   ① Asleep.setup(apiKey:productInfo:delegate:)  ← only once per app launch. Registers the device
   │     ├ Failure → productRegisterFailed (retry after a while) / productRegisterRejected (check the input values and the key, do not retry)
   │     └ setupDidComplete()
   │
   ② Asleep.initAsleepConfig(apiKey:userId:delegate:)  ← existing code
   │     └ userDidJoin(userId:config:)
   │
   ③ Start tracking   ← existing code. The session created here is linked to the device
   │
   ④ Stop tracking    ← existing code

1. Upgrade the SDK version

Update asleep-sdk-ios to 3.3.0 in Swift Package Manager.

2. Prepare the ProductInfo

Prepare the three values that describe the device.

let productInfo = Asleep.ProductInfo(
    model: "model-123",             // Product model name (≤100 characters)
    identifierType: .serial,        // .serial or .macAddress
    identifierValue: deviceSerial   // The unique value of the device (≤255 characters)
)

3. Add productInfo to setup

Call setup once per app launch (before you start tracking), with the same productInfo every time.

• First run: it registers the device with the server.
• From the second run: it uses the registration information stored on the device, so it completes immediately without a registration request.

Once the registration is finished, the SDK automatically attaches the device information to requests such as session creation and data upload. There is nothing for the app to do.

3.2.0

Asleep.setup(apiKey: apiKey, delegate: self)

3.3.0 — only productInfo is added.

Asleep.setup(apiKey: apiKey, productInfo: productInfo, delegate: self)

extension SleepController: AsleepSetupDelegate {
    func setupDidComplete() {
        // Device registration finished — record the completed state and connect the user (initAsleepConfig)
    }

    func setupDidFail(error: Asleep.AsleepError) {
        switch error {
        case .productRegisterFailed:    break  // Temporary failure — call setup again after a while
        case .productRegisterRejected:  break  // Rejected — check productInfo / API Key (do not retry)
        default:                        break  // Others (e.g. an empty API Key)
        }
    }

    func setupInProgress(progress: Int) { }
}

setup results

• If it fails, the completion callback is not called.
• Do not call setup again right inside the failure callback. If the cause remains, failure → call again repeats endlessly.
• The message that comes with an error is for checking the cause and its wording can change. Branch on the error case.

Good to know

• The first registration can take time. It usually finishes quickly, but if the server does not respond and all retries are used, the failure callback comes after about 75 seconds at most. We recommend showing a loading indicator on the screen that waits for setup.
• Call setup only once per app launch. If you call it on every init result, tracking callback or screen refresh, it completes immediately from the second call, so setup ↔ init can repeat rapidly. The only exception is when the connected device has changed.
• Calling setup again while setup is in progress is ignored. In this case no callback is called.
• Calling setup during tracking is ignored as well. No callback is called in this case either, so call setup before you start tracking.

4. Connect the user — initAsleepConfig after setup is confirmed

Call your existing initAsleepConfig after you confirm that setup has finished. The parameters are the same as in 3.2.0.

• Even if init fails, do not call setup again. The device registration is already finished, so you only need to try initAsleepConfig again.

private var isSetupCompleted = false

func setupDidComplete() {
    isSetupCompleted = true
    connectUser()
}

func connectUser() {
    guard isSetupCompleted else { return }
    Asleep.initAsleepConfig(apiKey: apiKey,
                            userId: userId,
                            delegate: self)
}

// AsleepConfigDelegate
func userDidJoin(userId: String, config: Asleep.Config) {
    self.config = config   // Used for tracking and reports
}

func didFailUserJoin(error: Asleep.AsleepError) {
    // Do not call setup again. If needed, retry connectUser() only
}

func userDidDelete(userId: String) { }

5. Start and stop tracking — the existing code as it is

The code for starting and stopping tracking is the same as in 3.2.0. Just make sure of the following two things.

• Start tracking after setup is complete and the user is connected successfully. The session is linked to the device the moment it is created.
• If the connected device has changed (a different serial number), stop tracking and then call setup again with the new productInfo. The sessions created after that are linked to the new device.