Skip to content
Circadify Circadify Circadify

Installation

The Circadify Android SDK is a native Kotlin Android library for contactless vital sign measurement. Your app owns the UI, camera permission prompt, preview surface, and overlays. The SDK handles camera capture, scan quality checks, secure upload, and result polling.

Get package access

Section titled “Get package access”

The SDK is distributed as a private Maven package on GitHub Packages. Ask Circadify to grant package read access to the GitHub user or service account that will install the SDK.

  1. Send Circadify the GitHub username that needs package access.

  2. Create a GitHub token for that user with the read:packages scope.

  3. Store the token outside source control as an environment variable or CI secret.

Gradle setup

Section titled “Gradle setup”

Add the Circadify GitHub Packages Maven repository:

settings.gradle.kts
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven("https://maven.pkg.github.com/circadify/circadify-android-sdk") {
            credentials {
                username = System.getenv("GITHUB_ACTOR")
                password = System.getenv("GITHUB_TOKEN")
            }
        }
    }
}

Add the SDK dependency to your app module:

app/build.gradle.kts
dependencies {
    implementation("com.circadify:circadify-android-sdk:0.1.1")
}

Manifest

Section titled “Manifest”

The host app must declare camera and internet access. Mark camera hardware as optional unless every install target must have a camera.

AndroidManifest.xml
<uses-feature android:name="android.hardware.camera" android:required="false" />


<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />

Requirements

Section titled “Requirements”
RequirementValue
Minimum Android versionAPI 24+
Compile SDKAndroid API 36 or newer
LanguageKotlin-first Android library
UI modelHeadless SDK; your app renders preview and overlays
Camera stackCameraX with a front camera
Processing modelHeadless SDK-managed capture, quality checks, and cloud result polling
Default capture policy10 FPS analysis target, 150 minimum accepted frames

Next Steps

Section titled “Next Steps”